coordinator

Documentation

Index

• Variables
• type Configuration
  • func (c *Configuration) GetNetworkKey() (zigbee.NetworkKey, error)
  • func (c *Configuration) Valid() error
• type Coordinator
  • func New(config *Configuration) *Coordinator
  • func (c *Coordinator) ActiveEndpoints(nwkAddress string) (*znp.ZdoActiveEpRsp, error)
  • func (c *Coordinator) Bind(dstAddr string, srcAddress zigbee.IEEEAddress, srcEndpoint zigbee.EndpointId, ...) (*znp.ZdoBindRsp, error)
  • func (c *Coordinator) DataRequest(dstAddr string, dstEndpoint zigbee.EndpointId, srcEndpoint zigbee.EndpointId, ...) (*znp.AfIncomingMessage, error)
  • func (c *Coordinator) NetworkConf() *NetworkConfiguration
  • func (c *Coordinator) NodeDescription(nwkAddress string) (*znp.ZdoNodeDescRsp, error)
  • func (c *Coordinator) OnDeviceAnnounce() chan *znp.ZdoEndDeviceAnnceInd
  • func (c *Coordinator) OnDeviceLeave() chan *znp.ZdoLeaveInd
  • func (c *Coordinator) OnDeviceTc() chan *znp.ZdoTcDevInd
  • func (c *Coordinator) OnError() chan error
  • func (c *Coordinator) OnIncomingMessage() chan *znp.AfIncomingMessage
  • func (c *Coordinator) Reset() error
  • func (c *Coordinator) Run(ctx context.Context, joinEnable bool, networkProcessor *znp.Znp, ...) error
  • func (c *Coordinator) SimpleDescription(nwkAddress string, endpoint zigbee.EndpointId) (*znp.ZdoSimpleDescRsp, error)
  • func (c *Coordinator) Unbind(dstAddr string, srcAddress zigbee.IEEEAddress, srcEndpoint zigbee.EndpointId, ...) (*znp.ZdoUnbindRsp, error)
• type MessageChannels
• type NetworkConfiguration
  • func (c NetworkConfiguration) Equal(other NetworkConfiguration) bool
• type Serial
  • func (s Serial) BaudRateOrDefault() int

Variables

var SysResetIndType = reflect.TypeOf(&znp.SysResetInd{})

var ZdoActiveEpRspType = reflect.TypeOf(&znp.ZdoActiveEpRsp{})

var ZdoBindRspType = reflect.TypeOf(&znp.ZdoBindRsp{})

var ZdoNodeDescRspType = reflect.TypeOf(&znp.ZdoNodeDescRsp{})

var ZdoSimpleDescRspType = reflect.TypeOf(&znp.ZdoSimpleDescRsp{})

var ZdoUnbindRspType = reflect.TypeOf(&znp.ZdoUnbindRsp{})

Types

type Configuration

type Configuration struct {
	NetworkConfiguration
	Led    bool `json:"LED,omitempty"`
	Serial *Serial
}

func (*Configuration) GetNetworkKey

func (c *Configuration) GetNetworkKey() (zigbee.NetworkKey, error)

func (*Configuration) Valid

func (c *Configuration) Valid() error

type Coordinator

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

func New

func New(config *Configuration) *Coordinator

func (*Coordinator) ActiveEndpoints

func (c *Coordinator) ActiveEndpoints(nwkAddress string) (*znp.ZdoActiveEpRsp, error)

func (*Coordinator) Bind

func (c *Coordinator) Bind(
	dstAddr string,
	srcAddress zigbee.IEEEAddress,
	srcEndpoint zigbee.EndpointId,
	clusterId cluster.ClusterId,
	dstAddress zigbee.IEEEAddress,
	dstEndpoint zigbee.EndpointId,
) (*znp.ZdoBindRsp, error)

func (*Coordinator) DataRequest

func (c *Coordinator) DataRequest(dstAddr string, dstEndpoint zigbee.EndpointId, srcEndpoint zigbee.EndpointId, clusterId uint16, options *znp.AfDataRequestOptions, radius uint8, data []uint8) (*znp.AfIncomingMessage, error)

func (*Coordinator) NetworkConf

func (c *Coordinator) NetworkConf() *NetworkConfiguration

func (*Coordinator) NodeDescription

func (c *Coordinator) NodeDescription(nwkAddress string) (*znp.ZdoNodeDescRsp, error)

func (*Coordinator) OnDeviceAnnounce

func (c *Coordinator) OnDeviceAnnounce() chan *znp.ZdoEndDeviceAnnceInd

func (*Coordinator) OnDeviceLeave

func (c *Coordinator) OnDeviceLeave() chan *znp.ZdoLeaveInd

func (*Coordinator) OnDeviceTc

func (c *Coordinator) OnDeviceTc() chan *znp.ZdoTcDevInd

func (*Coordinator) OnError

func (c *Coordinator) OnError() chan error

func (*Coordinator) OnIncomingMessage

func (c *Coordinator) OnIncomingMessage() chan *znp.AfIncomingMessage

func (*Coordinator) Reset

func (c *Coordinator) Reset() error

func (*Coordinator) Run

func (c *Coordinator) Run(ctx context.Context, joinEnable bool, networkProcessor *znp.Znp, settingsFlash bool) error

func (*Coordinator) SimpleDescription

func (c *Coordinator) SimpleDescription(nwkAddress string, endpoint zigbee.EndpointId) (*znp.ZdoSimpleDescRsp, error)

func (*Coordinator) Unbind

func (c *Coordinator) Unbind(
	dstAddr string,
	srcAddress zigbee.IEEEAddress,
	srcEndpoint zigbee.EndpointId,
	clusterId cluster.ClusterId,
	dstAddress zigbee.IEEEAddress,
	dstEndpoint zigbee.EndpointId,
) (*znp.ZdoUnbindRsp, error)

type MessageChannels

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

type NetworkConfiguration

type NetworkConfiguration struct {
	IEEEAddress zigbee.IEEEAddress // coordinator's
	PanId       zigbee.PANID
	ExtPanId    zigbee.ExtendedPANID
	NetworkKey  []byte
	Channel     uint8
}

func (NetworkConfiguration) Equal

func (c NetworkConfiguration) Equal(other NetworkConfiguration) bool

type Serial

type Serial struct {
	Port     string
	BaudRate *int `json:"BaudRate,omitempty"` // if nil, optimal default is used
}

func (Serial) BaudRateOrDefault

func (s Serial) BaudRateOrDefault() int