device

package

v0.0.0-...-4ac2c6e Latest Latest Go to latest Published: Apr 21, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/touchardv/myhome-presence

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Register(name string, f NewTrackerFunc)
type NewTrackerFunc
type Registry
- func NewRegistry(cfg config.Config) *Registry
type ReportPresenceFunc
type Tracker

Constants ¶

View Source

const (
	ReportDataSuggestedIdentifier  = "Identifier"
	ReportDataSuggestedDescription = "Description"
)

Variables ¶

View Source

var (
	ErrNotFound       = errors.New("device not found")
	ErrInvalidID      = errors.New("invalid device identifier")
	ErrIDAlreadyTaken = errors.New("device identifier already taken")
)

Functions ¶

func Register ¶

func Register(name string, f NewTrackerFunc)

Register records a Tracker factory function by name.

Types ¶

type NewTrackerFunc ¶

type NewTrackerFunc func(config.Settings) Tracker

NewTrackerFunc is a factory function for instantiating a new Tracker.

type Registry ¶

type Registry struct {
	// contains filtered or unexported fields
}

Registry maintains the status of all tracked devices together with their presence status.

func NewRegistry ¶

func NewRegistry(cfg config.Config) *Registry

NewRegistry builds a new device registry.

func (*Registry) AddDevice ¶

func (r *Registry) AddDevice(d model.Device) error

AddDevice adds a new device to the registry.

func (*Registry) ExecuteDeviceAction ¶

func (r *Registry) ExecuteDeviceAction(id string, action string) error

ExecuteDeviceAction executes an action on a device given its identifier.

func (*Registry) FindDevice ¶

func (r *Registry) FindDevice(id string) (model.Device, error)

FindDevice lookups a device given its identifier.

func (*Registry) GetDevices ¶

func (r *Registry) GetDevices(status model.Status) []model.Device

GetDevices returns all known devices.

func (*Registry) RemoveDevice ¶

func (r *Registry) RemoveDevice(id string) error

RemoveDevice removes a device.

func (*Registry) Start ¶

func (r *Registry) Start(ctx context.Context)

Start activates the tracking of devices.

func (*Registry) Stop ¶

func (r *Registry) Stop()

Stop de-activates the tracking of devices.

func (*Registry) UpdateDevice ¶

func (r *Registry) UpdateDevice(id string, ud model.Device) (model.Device, error)

UpdateDevice updates an existing device.

func (*Registry) UpdateDevicesPresence ¶

func (r *Registry) UpdateDevicesPresence(t time.Time)

type ReportPresenceFunc ¶

type ReportPresenceFunc func(model.Interface, map[string]string)

ReportPresenceFunc is a function that can be used by a Tracker to report the presence of a given device interface. Optionally some data related to the inteface/device may be provided.

type Tracker ¶

type Tracker interface {
	Loop(deviceReport ReportPresenceFunc, ctx context.Context, wg *sync.WaitGroup) error

	Ping(model.Device)
}

Tracker tracks the presence of devices.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL