omni

Documentation

Index

• Variables
• type AudioSourceStatus
• type Client
  • func NewClient(addr string, key string) (*Client, error)
  • func (c *Client) GetObjectProperties(objectType ObjectType) (properties interface{}, numObject int, e error)
  • func (c *Client) GetObjectStatus(objectType ObjectType, numObjects int) (interface{}, error)
  • func (c *Client) GetObjectTypeCapacity(t ObjectType) (ObjectTypeCapacities, error)
  • func (c *Client) GetSystemFeatures() (SystemFeatures, error)
  • func (c *Client) GetSystemFormats() (SystemFormats, error)
  • func (c *Client) GetSystemInformation() (SystemInfo, error)
  • func (c *Client) GetSystemStatus() (SystemStatus, error)
  • func (c *Client) GetSystemTroubles() (SystemTroubles, error)
• type ConnectedSecuritySystemStatus
• type DateFormat
  • func (i DateFormat) String() string
• type ObjectProperties
• type ObjectStatus
• type ObjectType
  • func (i ObjectType) String() string
• type ObjectTypeCapacities
• type SystemFeature
  • func (i SystemFeature) String() string
• type SystemFeatures
• type SystemFormats
• type SystemInfo
• type SystemStatus
• type SystemTrouble
  • func (i SystemTrouble) String() string
• type SystemTroubles
• type TempFormat
  • func (i TempFormat) String() string
• type ThermostatProperties
• type ThermostatStatus
• type TimeFormat
  • func (i TimeFormat) String() string
• type ZoneReadyStatus

Variables

var StatusSizes = map[ObjectType]int{
	Zone:       4,
	Unit:       5,
	Thermostat: 9,
}

Types

type AudioSourceStatus

type AudioSourceStatus struct {
}

type Client

type Client struct {
	Addr string // IP:Port
	// contains filtered or unexported fields
}

Client is an Omni-link II client.

func NewClient

func NewClient(addr string, key string) (*Client, error)

NewClient returns a Client

func (*Client) GetObjectProperties

func (c *Client) GetObjectProperties(objectType ObjectType) (properties interface{}, numObject int, e error)

func (*Client) GetObjectStatus

func (c *Client) GetObjectStatus(objectType ObjectType, numObjects int) (interface{}, error)

func (*Client) GetObjectTypeCapacity

func (c *Client) GetObjectTypeCapacity(t ObjectType) (ObjectTypeCapacities, error)

func (*Client) GetSystemFeatures

func (c *Client) GetSystemFeatures() (SystemFeatures, error)

func (*Client) GetSystemFormats

func (c *Client) GetSystemFormats() (SystemFormats, error)

func (*Client) GetSystemInformation

func (c *Client) GetSystemInformation() (SystemInfo, error)

func (*Client) GetSystemStatus

func (c *Client) GetSystemStatus() (SystemStatus, error)

func (*Client) GetSystemTroubles

func (c *Client) GetSystemTroubles() (SystemTroubles, error)

type ConnectedSecuritySystemStatus

type ConnectedSecuritySystemStatus struct {
}

type DateFormat

type DateFormat uint8

const (
	MMDD DateFormat = 1 + iota
	DDMM
)

func (DateFormat) String

func (i DateFormat) String() string

type ObjectProperties

type ObjectProperties struct {
	ObjectType uint8
}

type ObjectStatus

type ObjectStatus struct {
}

type ObjectType

type ObjectType uint8

const (
	Zone ObjectType = 1 + iota
	Unit
	Button
	Code
	Area
	Thermostat
	Message
	AuxilarySensor
	AudioSource
	AudioZone
	ExpansionEnclosure
	Console
	UserSetting
	AccessControlReader
	AccessControlLock

	StatusSizeThermostat = 9
)

func (ObjectType) String

func (i ObjectType) String() string

type ObjectTypeCapacities

type ObjectTypeCapacities struct {
	CapacityType ObjectType
	CapacityMSB  uint8
	CapacityLSB  uint8
}

type SystemFeature

type SystemFeature uint8

const (
	NuVoConcerto SystemFeature = 1 + iota
	NuVoEssentia
	NuVoGrandConcerto
	Russound
	HAIHiFi
	XanTech
	SpeakerCraft
	Proficient
	DSCSecurity
)

func (SystemFeature) String

func (i SystemFeature) String() string

type SystemFeatures

type SystemFeatures struct {
	Features []SystemFeature
}

type SystemFormats

type SystemFormats struct {
	TempFormat TempFormat
	TimeFormat TimeFormat
	DateFormat DateFormat
}

type SystemInfo

type SystemInfo struct {
	ModelNumber      uint8
	MajorVersion     uint8
	MinorVersion     uint8
	Revision         uint8
	LocalPhoneNumber [25]byte
}

type SystemStatus

type SystemStatus struct {
	DateValid   uint8
	Year        uint8
	Month       uint8
	Day         uint8
	DayOfWeek   uint8
	Hour        uint8
	Minute      uint8
	Second      uint8
	Daylight    uint8
	SunriseHour uint8
	SunriseMin  uint8
	SunsetHour  uint8
	SunsetMin   uint8
	Battery     uint8
}

type SystemTrouble

type SystemTrouble uint8

const (
	Freeze SystemTrouble = 1 + iota
	BatteryLow
	ACPower
	PhoneLine
	DigitalCommunicator
	Fuse
	Freeze2
	BatteryLow2 // Listed twice in spec
)

func (SystemTrouble) String

func (i SystemTrouble) String() string

type SystemTroubles

type SystemTroubles struct {
	Troubles []SystemTrouble
}

type TempFormat

type TempFormat uint8

const (
	Fahrenheit TempFormat = 1 + iota
	Celsius
)

func (TempFormat) String

func (i TempFormat) String() string

type ThermostatProperties

type ThermostatProperties struct {
	ObjectType         uint8
	NumberMSB          uint8
	NumberLSB          uint8
	Communicating      uint8
	Temperature        uint8
	HeatSetPoint       uint8
	CoolSetPoint       uint8
	SystemMode         uint8
	FanMode            uint8
	HoldStatus         uint8
	Type               uint8
	Name               [12]byte
	Humidty            uint8
	HumidifySetPoint   uint8
	DehumidifySetPoint uint8
	OutdoorTemperature uint8
	ActionStatus       uint8
}

type ThermostatStatus

type ThermostatStatus struct {
	NumberMSB    uint8
	NumberLSB    uint8
	Status       uint8
	CurrentTemp  uint8
	HeatSetPoint uint8
	CoolSetPoint uint8
	SystemMode   uint8
	FanMode      uint8
	HoldStatus   uint8
}

type TimeFormat

type TimeFormat uint8

const (
	Twelve TimeFormat = 1 + iota
	TwentyFour
)

func (TimeFormat) String

func (i TimeFormat) String() string

type ZoneReadyStatus

type ZoneReadyStatus struct {
}