hubtypes

type AttrBool struct {
	Value      bool      `json:"value"`
	LastReport time.Time `json:"reported"`
}

type AttrBuilder struct {
	Reported time.Time
}

type AttrColor struct {
	Red        uint8     `json:"r"` // [0..255]
	Green      uint8     `json:"g"` // [0..255]
	Blue       uint8     `json:"b"` // [0..255]
	LastReport time.Time `json:"reported"`
}

type AttrEvent struct {
	LastReport time.Time `json:"reported"`
}

type AttrFloat struct {
	Value      float64   `json:"value"`
	LastReport time.Time `json:"reported"`
}

type AttrInt struct {
	Value      int64     `json:"value"`
	LastReport time.Time `json:"reported"`
}

type AttrOrientation struct {
	X          int
	Y          int
	Z          int
	LastReport time.Time `json:"reported"`
}

type AttrPlaybackControl struct {
	Control    PlaybackControl `json:"control"`
	LastReport time.Time       `json:"reported"`
}

type AttrPress struct {
	// key press, identified by Linux evdev code. examples (below Key{VOLUMEUP} means evdevcodes.KeyVOLUMEUP):
	// - Key{BRIGHTNESSUP, BRIGHTNESSDOWN} if key is for ± brightness
	// - Key{VOLUMEUP, VOLUMEDOWN} if key is for ± volume
	// - Key{OK, SELECT, CANCEL, BACK} for generic selections and navigation
	// - Key{POWER} if key is for power (toggling) generic devices (not just lights)
	// - Key{OPEN, CLOSE} if key is for power opening or closing something (curtains, shades, door etc.)
	// - Key{LIGHTS_TOGGLE} if key can be used only for toggling lights (like if the key has a light symbol instead of a power symbol)
	// - Btn{0,...,9} for generic buttons or un-numbered buttons whose press isn't intended to produce their number: "button 1", "button 2", ... or "leftmost button", "the second button", "third button" etc.
	// - Key{NUMERIC_0,...NUMERIC_9,NUMERIC_STAR,NUMERIC_POUND} for keypads, remote controls **where the buttons have number labels**
	// - Key{NEXT, PREVIOUS} if key is for selecting a list item, be it playlist, scene list or similar
	// - Key{NEXTSONG, PREVIOUSSONG} if key is for controlling audio. prefer {NEXT,PREVIOUS} if playlist can contain video or other non-audio items.
	// - Key{PLAYPAUSE, PLAY, STOP, MUTE, etc.} if key is for media control
	// - Key{LEFT, RIGHT} if key has horizontal directionality and no distinct evdev property to control (volume, brightness)
	// - Key{UP, DOWN} if key has vertical directionality and no distinct evdev property to control (volume, brightness)
	// - Most suitable evdev code if above instructions don't cover your use case
	Key            evdevcodes.KeyOrButton   `json:"key"`                       // primary (or first) key. for convenience because usually we get only single-key presses
	KeysAdditional []evdevcodes.KeyOrButton `json:"keys_additional,omitempty"` // in rare occasion there are multiple keys pressed at once. additional keys to primary are here. see AllKeys()
	Kind           PressKind                `json:"kind,omitempty"`            // usually PressKindUp, but can be down/hold if we have hold detection or get separate keyup, keydown events
	CountRaw       *int                     `json:"count,omitempty"`           // double, triple etc. clicks. only specify if >= 2. see Count()

	LastReport time.Time `json:"reported"`
}

type AttrString struct {
	Value      string    `json:"value"`
	LastReport time.Time `json:"reported"`
}

type Attribute interface {
	LastChange() time.Time
}

type Attributes struct {
	Presence         *AttrBool  `json:"presence,omitempty"`   // user is present in a room
	Brightness       *AttrInt   `json:"brightness,omitempty"` // 0-255
	Color            *AttrColor `json:"color,omitempty"`      // color in (R,G,B)
	ColorTemperature *AttrInt   `json:"color_temp,omitempty"` // mireds
	On               *AttrBool  `json:"on,omitempty"`         // on/off state
	Press            *AttrPress `json:"press,omitempty"`      // generalized version of push
	Contact          *AttrBool  `json:"contact,omitempty"`    // true=> door/window closed
	WaterDetected    *AttrBool  `json:"water_detected,omitempty"`
	Vibration        *AttrEvent `json:"vibration,omitempty"`
	Tilt             *AttrEvent `json:"tilt,omitempty"`
	AlertSelect      *AttrEvent `json:"alert_select,omitempty"` // light blinks
	Drop             *AttrEvent `json:"drop,omitempty"`
	BatteryVoltage   *AttrFloat `json:"battery_voltage,omitempty"` // [V]
	// BatteryLevel   *AttrFloat       `json:"battery_level,omitempty"` // [0-100 %]. only set if reported by device. calculated % levels to Home Assistant are usually calculated on-the-fly
	Temperature      *AttrFloat       `json:"temperature,omitempty"`  // [°C]
	HumidityRelative *AttrFloat       `json:"humidity_rel,omitempty"` // [0-100 %]
	Pressure         *AttrFloat       `json:"pressure,omitempty"`     // [hPa]
	Illuminance      *AttrFloat       `json:"illuminance,omitempty"`  // lux?
	Orientation      *AttrOrientation `json:"orientation,omitempty"`
	ShadePosition    *AttrInt         `json:"shade_position,omitempty"` // 0-100. 100 % = covers whole window, i.e. closed
	ShadeStop        *AttrEvent       `json:"shade_stop,omitempty"`

	PlaybackControl *AttrPlaybackControl `json:"playback_control,omitempty"`

	CustomFloat  map[string]*AttrFloat  `json:"custom_float,omitempty"`
	CustomString map[string]*AttrString `json:"custom_string,omitempty"`
}

type AttrsCtx struct {
	AttrBuilder
	Attrs    *Attributes
	Endpoint zigbee.EndpointId
}

type BatteryType struct {
	// it'd be nice if we could just define simple linear (empty, full) voltage ranges,
	// but in reality it's a curve and thus different battery types need functions map points on curve
	// to the percentage of energy left. example curve for CR2032:
	// https://components101.com/asset/sites/default/files/inline-images/CR2032-Discharge-Time.png
	ToVoltage func(voltage float64) float64
}

type Device struct {
	FriendlyName string          `json:"friendly_name"`
	Area         string          `json:"area"`          // added to Home Assistant only if this is set
	ZigbeeDevice *ezstack.Device `json:"zigbee_device"` // zigbee-level details
	State        *DeviceState    `json:"state"`
}

type DeviceState struct {
	LinkQuality   *AttrInt                          `json:"link_quality,omitempty"` // signal quality, "LQI" 0-255
	EndpointAttrs map[zigbee.EndpointId]*Attributes `json:"attrs"`                  // endpoint-specific attrs
}

type PlaybackControl string

type PressKind uint8