mqtt

package

v0.15.0 Latest Latest Go to latest Published: Jan 25, 2024 License: GPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/e154/smart-home

Links

Open Source Insights

README ¶

MQTT Plugin

Documentation

Documentation ¶

Index ¶

Constants
Variables
func New() supervisor.Pluggable
func NewSettings() m.Attributes
type Actor
- func NewActor(entity *m.Entity, service supervisor.Service, mqttClient mqtt.MqttCli) (actor *Actor, err error)
type Message
- func NewMessage() (m *Message)
type Storage
- func NewStorage() Storage
- func (s *Storage) GetVar(key string) (value interface{})
- func (s *Storage) SetVar(key string, value interface{})

Constants ¶

View Source

const (
	// Name ...
	Name = "mqtt"
	// EntityMqtt ...
	EntityMqtt = string("mqtt")
)

View Source

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

	Version = "0.1.0"
)

View Source

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

Variables ¶

View Source

var F embed.FS

Functions ¶

func New ¶

func New() supervisor.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 supervisor.Service,
	mqttClient mqtt.MqttCli) (actor *Actor, err error)

NewActor ...

func (*Actor) Destroy ¶ added in v0.12.0

func (e *Actor) Destroy()

func (*Actor) SetState ¶

func (e *Actor) SetState(params supervisor.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 supervisor.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 ...

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL