hass_mqtt

README

hass-mqtt

Idea and generation code taken from https://github.com/W-Floyd/ha-mqtt-iot which is a very well done project but setup for a singular use. I wanted to be able to just use Home Assistant Devices/Entities in other programs so extending what was done there.

Massive work in progress right now.

Documentation

Index

• Variables
• type Client
  • func NewClient(c Config) (*Client, error)
  • func NewClientWithLogger(c Config, logger logr.Logger) (*Client, error)
  • func (c *Client) Add(dev *device.Device) error
  • func (c *Client) Connect() error
  • func (c *Client) Disconnect()
  • func (c *Client) Get(identifier string) *device.Device
  • func (c *Client) Logger() *logr.Logger
  • func (c *Client) Publish(topic string, qos byte, retained bool, payload interface{}) mqtt.Token
  • func (c *Client) Subscribe(topic string, qos byte, callback mqtt.MessageHandler) mqtt.Token
  • func (c *Client) Unsubscribe(topics ...string) mqtt.Token
• type Config

Variables

var (
	ErrNoDeviceFound = fmt.Errorf("no device found")
)

Types

type Client

type Client struct {
	NodeID string

	OnConnect func(client mqtt.Client)
	// contains filtered or unexported fields
}

func NewClient

func NewClient(c Config) (*Client, error)

func NewClientWithLogger

func NewClientWithLogger(c Config, logger logr.Logger) (*Client, error)

func (*Client) Add

func (c *Client) Add(dev *device.Device) error

func (*Client) Connect

func (c *Client) Connect() error

func (*Client) Disconnect

func (c *Client) Disconnect()

func (*Client) Get

func (c *Client) Get(identifier string) *device.Device

func (*Client) Logger

func (c *Client) Logger() *logr.Logger

func (*Client) Publish

func (c *Client) Publish(topic string, qos byte, retained bool, payload interface{}) mqtt.Token

func (*Client) Subscribe

func (c *Client) Subscribe(topic string, qos byte, callback mqtt.MessageHandler) mqtt.Token

Subscribe is a pass-through of MQTT Subscribe

func (*Client) Unsubscribe

func (c *Client) Unsubscribe(topics ...string) mqtt.Token

Unsubscribe is a pass-through of MQTT Unsubscribe

type Config

type Config struct {
	NodeID string `json:"node_id" yaml:"node_id"`
	MQTT   struct {
		Host     string  `json:"host" yaml:"host"`
		Port     int     `json:"port" yaml:"port"`
		SSL      bool    `json:"ssl" yaml:"ssl"`
		UserName *string `json:"user_name,omitempty" yaml:"user_name"`
		Password *string `json:"password,omitempty" yaml:"password"`
	} `json:"MQTT" yaml:"mqtt"`
}