mqtt

README

MQTT Plugin

Documentation

Documentation

Index

• Constants
• Variables
• func New() plugins.Pluggable
• func NewSettings() m.Attributes
• type Actor
  • func NewActor(entity *m.Entity, service plugins.Service, mqttClient mqtt.MqttCli) (actor *Actor, err error)
  • func (e *Actor) Destroy()
  • func (e *Actor) SetState(params plugins.EntityStateParams) error
  • func (e *Actor) Spawn()
• 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 ...
	Name = "mqtt"
	// EntityMqtt ...
	EntityMqtt = string("mqtt")
)

const (
	// FuncMqttEvent ...
	FuncMqttEvent = "mqttEvent"
	// FuncEntityAction ...
	FuncEntityAction = "entityAction"
)

const (
	// AttrSubscribeTopic ...
	AttrSubscribeTopic = "subscribe_topic"
)

Variables

var F embed.FS

Functions

func New

func New() plugins.Pluggable

New ...

func NewSettings

func NewSettings() m.Attributes

NewSettings ...

Types

type Actor

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

Actor ...

func NewActor

func NewActor(entity *m.Entity,
	service plugins.Service,
	mqttClient mqtt.MqttCli) (actor *Actor, err error)

NewActor ...

func (*Actor) Destroy

func (e *Actor) Destroy()

func (*Actor) SetState

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

SetState ...

func (*Actor) Spawn

func (e *Actor) Spawn()

Spawn ...

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 plugins.EntityStateParams `json:"new_state"`
	// contains filtered or unexported fields
}

Message ...

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 ...