zigbee2mqtt

Documentation

Index

• Constants
• func New() plugins.Plugable
• type Actor
  • func NewActor(entity *m.Entity, params map[string]interface{}, adaptors *adaptors.Adaptors, ...) (actor *Actor, err error)
  • func (e *Actor) SetState(params entity_manager.EntityStateParams) error
  • func (e *Actor) Spawn() entity_manager.PluginActor
• type Message
  • func NewMessage() (m *Message)
  • func (m *Message) Clear()
  • func (m *Message) Copy() (msg *Message)
  • func (m *Message) GetVar(key string) (value interface{})
  • func (m *Message) Ok()
  • func (m *Message) SetError(err string)
  • func (m *Message) SetVar(key string, value interface{})
  • func (m *Message) Update(newMsg *Message)
• type Storage
  • func NewStorage() Storage
  • func (s *Storage) GetVar(key string) (value interface{})
  • func (s *Storage) SetVar(key string, value interface{})

Constants

const (
	Name              = "zigbee2mqtt"
	EntityZigbee2mqtt = common.EntityType("zigbee2mqtt")
)

const (
	FuncZigbee2mqttEvent = "zigbee2mqttEvent"
	FuncEntityAction     = "entityAction"
)

Functions

func New

func New() plugins.Plugable

Types

type Actor

type Actor struct {
	entity_manager.BaseActor
	// contains filtered or unexported fields
}

func NewActor

func NewActor(entity *m.Entity,
	params map[string]interface{},
	adaptors *adaptors.Adaptors,
	scriptService scripts.ScriptService,
	entityManager entity_manager.EntityManager,
	eventBus event_bus.EventBus) (actor *Actor, err error)

func (*Actor) SetState

func (e *Actor) SetState(params entity_manager.EntityStateParams) error

func (*Actor) Spawn

func (e *Actor) Spawn() entity_manager.PluginActor

type Message

type Message struct {
	Payload   string `json:"payload"`
	Topic     string `json:"topic"`
	Qos       uint8  `json:"qos"`
	Duplicate bool   `json:"duplicate"`

	Error    string                           `json:"error"`
	Success  bool                             `json:"success"`
	NewState entity_manager.EntityStateParams `json:"new_state"`
	// contains filtered or unexported fields
}

Javascript Binding

message

.SetState(params)

.

func NewMessage

func NewMessage() (m *Message)

NewMessage ...

func (*Message) Clear

func (m *Message) Clear()

Clear ...

func (*Message) Copy

func (m *Message) Copy() (msg *Message)

Copy ...

func (*Message) GetVar

func (m *Message) GetVar(key string) (value interface{})

GetVar ...

func (*Message) Ok

func (m *Message) Ok()

Ok ...

func (*Message) SetError

func (m *Message) SetError(err string)

SetError ...

func (*Message) SetVar

func (m *Message) SetVar(key string, value interface{})

SetVar ...

func (*Message) Update

func (m *Message) Update(newMsg *Message)

Update ...

type Storage

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

Storage ...

func NewStorage

func NewStorage() Storage

NewStorage ...

func (*Storage) GetVar

func (s *Storage) GetVar(key string) (value interface{})

GetVar ...

func (*Storage) SetVar

func (s *Storage) SetVar(key string, value interface{})

SetVar ...