zigbee2mqtt

Documentation

Index

• type Clusters
• type ConnectedHandler
• type ConnectionLostHandler
• type Connector
  • func NewConnector(configuration config.Zigbee2MqttConfig) (*Connector, error)
  • func (c *Connector) ActivateDevice(id device.Id) error
  • func (c *Connector) ControlActor(id device.Id, actor device.Actor, value any) bool
  • func (c *Connector) DeactivateDevice(id device.Id) error
  • func (c *Connector) DisplayName() string
  • func (c *Connector) EnumerateDevices() []device.Spec
  • func (c *Connector) Id() string
  • func (c *Connector) Operational() bool
  • func (c *Connector) Setup(controller system.Controller)
  • func (c *Connector) Teardown()
• type Data
• type Definition
• type DeviceEvent
• type Exposes
• type MessageHandler
• type Options
• type Z2MDeviceInfo

Types

type Clusters

type Clusters struct {
	Input  []string      `json:"input"`
	Output []interface{} `json:"output"`
}

type ConnectedHandler

type ConnectedHandler func(conn *connection)

type ConnectionLostHandler

type ConnectionLostHandler func(conn *connection, err error)

type Connector

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

func NewConnector

func NewConnector(configuration config.Zigbee2MqttConfig) (*Connector, error)

func (*Connector) ActivateDevice

func (c *Connector) ActivateDevice(id device.Id) error

func (*Connector) ControlActor

func (c *Connector) ControlActor(id device.Id, actor device.Actor, value any) bool

func (*Connector) DeactivateDevice

func (c *Connector) DeactivateDevice(id device.Id) error

func (*Connector) DisplayName

func (c *Connector) DisplayName() string

func (*Connector) EnumerateDevices

func (c *Connector) EnumerateDevices() []device.Spec

func (*Connector) Id

func (c *Connector) Id() string

func (*Connector) Operational

func (c *Connector) Operational() bool

func (*Connector) Setup

func (c *Connector) Setup(controller system.Controller)

func (*Connector) Teardown

func (c *Connector) Teardown()

type Data

type Data struct {
	FriendlyName string `json:"friendly_name"`
	IeeeAddress  string `json:"ieee_address"`
}

type Definition

type Definition struct {
	Model       string    `json:"model"`
	Vendor      string    `json:"vendor"`
	Description string    `json:"description"`
	Options     []Options `json:"options"`
	Exposes     []Exposes `json:"exposes"`
}

type DeviceEvent

type DeviceEvent struct {
	Data Data   `json:"data"`
	Type string `json:"type"`
}

type Exposes

type Exposes struct {
	Name     string `json:"name"`
	Property string `json:"property"`
	Type     string `json:"type"`
}

type MessageHandler

type MessageHandler func(mqtt.Message)

type Options

type Options struct {
	Name     string `json:"name"`
	Property string `json:"property"`
	Type     string `json:"type"`
}

type Z2MDeviceInfo

type Z2MDeviceInfo struct {
	IeeeAddress        string     `json:"ieee_address"`
	Type               string     `json:"type"`
	Supported          bool       `json:"supported"`
	FriendlyName       string     `json:"friendly_name"`
	Definition         Definition `json:"definition"`
	PowerSource        string     `json:"power_source"`
	DateCode           string     `json:"date_code"`
	ModelId            string     `json:"model_id"`
	Interviewing       bool       `json:"interviewing"`
	InterviewCompleted bool       `json:"interview_completed"`
	Manufacturer       string     `json:"manufacturer"`
}