homekitwatcher

package

v0.28.0 Latest Latest Go to latest Published: Feb 3, 2024 License: Apache-2.0 Imports: 18 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/choria-io/go-choria

Links

Documentation ¶

Index ¶

func ChoriaPlugin() *plugin.WatcherPlugin
func New(machine model.Machine, name string, states []string, failEvent string, ...) (any, error)
type State
type StateNotification
type Watcher

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ChoriaPlugin ¶ added in v0.19.0

func ChoriaPlugin() *plugin.WatcherPlugin

func New ¶

func New(machine model.Machine, name string, states []string, failEvent string, successEvent string, interval string, ai time.Duration, rawprop map[string]any) (any, error)

Types ¶

type State ¶

type State int

const (
	Unknown State = iota
	On
	Off
	// used to indicate that an external event - rpc or other watcher - initiated a transition
	OnNoTransition
	OffNoTransition
)

type StateNotification ¶

type StateNotification struct {
	event.Event

	Path            string `json:"path"`
	PreviousOutcome string `json:"previous_outcome"`
}

StateNotification describes the current state of the watcher described by io.choria.machine.watcher.homekit.v1.state

func (*StateNotification) CloudEvent ¶

func (s *StateNotification) CloudEvent() cloudevents.Event

CloudEvent creates a CloudEvent from the state notification

func (*StateNotification) JSON ¶

func (s *StateNotification) JSON() ([]byte, error)

JSON creates a JSON representation of the notification

func (*StateNotification) String ¶

func (s *StateNotification) String() string

String is a string representation of the notification suitable for printing

type Watcher ¶

type Watcher struct {
	*watcher.Watcher
	// contains filtered or unexported fields
}

func (*Watcher) CurrentState ¶

func (w *Watcher) CurrentState() any

func (*Watcher) Delete ¶

func (w *Watcher) Delete()

func (*Watcher) Run ¶

func (w *Watcher) Run(ctx context.Context, wg *sync.WaitGroup)

Source Files ¶

View all Source files

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