homekitwatcher

Documentation

Index

• func ChoriaPlugin() *plugin.WatcherPlugin
• func New(machine watcher.Machine, name string, states []string, failEvent string, ...) (interface{}, error)
• type State
• type StateNotification
  • func (s *StateNotification) CloudEvent() cloudevents.Event
  • func (s *StateNotification) JSON() ([]byte, error)
  • func (s *StateNotification) String() string
• type Watcher
  • func (w *Watcher) CurrentState() interface{}
  • func (w *Watcher) Delete()
  • func (w *Watcher) Run(ctx context.Context, wg *sync.WaitGroup)

Functions

func ChoriaPlugin

func ChoriaPlugin() *plugin.WatcherPlugin

func New

func New(machine watcher.Machine, name string, states []string, failEvent string, successEvent string, interval string, ai time.Duration, rawprop map[string]interface{}) (interface{}, 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() interface{}

func (*Watcher) Delete

func (w *Watcher) Delete()

func (*Watcher) Run

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