system

Documentation

Index

• type Controller
• type DeviceConnector
• type NotificationAdapter
• type State
  • func (s State) Armed() bool
• type Waechter
  • func NewWaechter() *Waechter
  • func (w *Waechter) AddDeviceConnector(connector DeviceConnector)
  • func (w *Waechter) AddNotificationAdapter(adapter NotificationAdapter)
  • func (w *Waechter) DeliverSensorValue(id device.Id, sensor device.Sensor, value any) bool
  • func (w *Waechter) DeviceAvailable(id device.Id)
  • func (w *Waechter) DeviceListUpdated(system DeviceConnector)
  • func (w *Waechter) DeviceUnavailable(id device.Id)
  • func (w *Waechter) DevicesWithTamper() []*device.Device
  • func (w *Waechter) OpenContactSensors() []*device.Device
  • func (w *Waechter) OperationalStateChanged(connector DeviceConnector)
  • func (w *Waechter) RemoveDeviceConnector(id string)
  • func (w *Waechter) SystemState() State

Types

type Controller

type Controller interface {
	DeliverSensorValue(id device.Id, sensor device.Sensor, value any) bool

	DeviceListUpdated(connector DeviceConnector)

	OperationalStateChanged(connector DeviceConnector)

	DeviceUnavailable(id device.Id)
	DeviceAvailable(id device.Id)

	SystemState() State
}

type DeviceConnector

type DeviceConnector interface {
	Setup(controller Controller)
	Teardown()

	Id() string
	DisplayName() string

	Operational() bool

	EnumerateDevices() []device.Spec

	ActivateDevice(id device.Id) error
	DeactivateDevice(id device.Id) error

	ControlActor(id device.Id, actor device.Actor, value any) bool
}

type NotificationAdapter

type NotificationAdapter interface {
	Name() string
	NotifyAlarm(person config.Person, systemName string, a alarm.Type, device device.Spec, zone zone.Zone) bool
	NotifyRecovery(person config.Person, systemName string, device device.Spec, zone zone.Zone) bool
	NotifyLowBattery(person config.Person, systemName string, device device.Spec, zone zone.Zone, batteryLevel float32) bool
	NotifyLowLinkQuality(person config.Person, systemName string, device device.Spec, zone zone.Zone, quality float32) bool
	NotifyAutoArm(person config.Person, systemName string) bool
	NotifyAutoDisarm(person config.Person, systemName string) bool
}

type State

type State struct {
	ArmMode        arm.Mode   `json:"armMode"`
	Alarm          alarm.Type `json:"alarm"`
	ArmModeUpdated time.Time  `json:"ArmModeUpdated"`
}

func (State) Armed

func (s State) Armed() bool

type Waechter

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

func NewWaechter

func NewWaechter() *Waechter

func (*Waechter) AddDeviceConnector

func (w *Waechter) AddDeviceConnector(connector DeviceConnector)

func (*Waechter) AddNotificationAdapter

func (w *Waechter) AddNotificationAdapter(adapter NotificationAdapter)

func (*Waechter) DeliverSensorValue

func (w *Waechter) DeliverSensorValue(id device.Id, sensor device.Sensor, value any) bool

func (*Waechter) DeviceAvailable

func (w *Waechter) DeviceAvailable(id device.Id)

func (*Waechter) DeviceListUpdated

func (w *Waechter) DeviceListUpdated(system DeviceConnector)

func (*Waechter) DeviceUnavailable

func (w *Waechter) DeviceUnavailable(id device.Id)

func (*Waechter) DevicesWithTamper

func (w *Waechter) DevicesWithTamper() []*device.Device

func (*Waechter) OpenContactSensors

func (w *Waechter) OpenContactSensors() []*device.Device

func (*Waechter) OperationalStateChanged

func (w *Waechter) OperationalStateChanged(connector DeviceConnector)

func (*Waechter) RemoveDeviceConnector

func (w *Waechter) RemoveDeviceConnector(id string)

func (*Waechter) SystemState

func (w *Waechter) SystemState() State