Documentation
¶
Index ¶
- func MqttName(sensorId string) string
- type AlarmSensorConfig
- func (a AlarmSensorConfig) ConvertValue(value float64) string
- func (a AlarmSensorConfig) Decimals() int
- func (a AlarmSensorConfig) DeviceClass() string
- func (a AlarmSensorConfig) Name() string
- func (a AlarmSensorConfig) SensorId() string
- func (a AlarmSensorConfig) SensorType() string
- func (a AlarmSensorConfig) StateClass() string
- func (a AlarmSensorConfig) UnitOfMeasurement() string
- func (a AlarmSensorConfig) ValueTemplate() string
- type AvailabilityMessage
- type Client
- func (hassioClient *Client) SendAvailability() (err error)
- func (hassioClient *Client) SendConfigurationData() (err error)
- func (hassioClient *Client) SendLastWill() (err error)
- func (hassioClient *Client) SendSensorData(sensorType string, sensorStates map[string]string) (err error)
- func (hassioClient *Client) SubscribeToHomeAssistantStatus() (err error)
- type Device
- type DiscoveryMessage
- type FloatSensorConfig
- func (f *FloatSensorConfig) ConvertValue(value float64) string
- func (f *FloatSensorConfig) DeviceClass() string
- func (f *FloatSensorConfig) Name() string
- func (f *FloatSensorConfig) SensorId() string
- func (f *FloatSensorConfig) SensorType() string
- func (f *FloatSensorConfig) StateClass() string
- func (f *FloatSensorConfig) UnitOfMeasurement() string
- func (f *FloatSensorConfig) ValueTemplate() string
- type SensorConfig
- type SensorConfigX
- type SensorState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AlarmSensorConfig ¶
type AlarmSensorConfig struct {
// contains filtered or unexported fields
}
func NewAlarmSensorConfig ¶
func NewAlarmSensorConfig(sensorId string, name string) *AlarmSensorConfig
func (AlarmSensorConfig) ConvertValue ¶
func (a AlarmSensorConfig) ConvertValue(value float64) string
func (AlarmSensorConfig) Decimals ¶
func (a AlarmSensorConfig) Decimals() int
func (AlarmSensorConfig) DeviceClass ¶
func (a AlarmSensorConfig) DeviceClass() string
func (AlarmSensorConfig) Name ¶
func (a AlarmSensorConfig) Name() string
func (AlarmSensorConfig) SensorId ¶ added in v1.0.8
func (a AlarmSensorConfig) SensorId() string
func (AlarmSensorConfig) SensorType ¶
func (a AlarmSensorConfig) SensorType() string
func (AlarmSensorConfig) StateClass ¶ added in v1.0.1
func (a AlarmSensorConfig) StateClass() string
func (AlarmSensorConfig) UnitOfMeasurement ¶
func (a AlarmSensorConfig) UnitOfMeasurement() string
func (AlarmSensorConfig) ValueTemplate ¶
func (a AlarmSensorConfig) ValueTemplate() string
type AvailabilityMessage ¶
type AvailabilityMessage struct { DeviceID string `json:"device_id"` Status string `json:"status"` }
AvailabilityMessage represents the MQTT availability message
type Client ¶
type Client struct { Device *Device SensorConfigurationData map[string]SensorConfig // contains filtered or unexported fields }
func ConnectMqtt ¶
func (*Client) SendAvailability ¶
func (*Client) SendConfigurationData ¶
func (*Client) SendLastWill ¶
func (*Client) SendSensorData ¶
func (*Client) SubscribeToHomeAssistantStatus ¶
type Device ¶
type Device struct { Identifiers []string `json:"identifiers"` Name string `json:"name"` SWVersion string `json:"sw_version"` HWVersion string `json:"hw_version"` SerialNumber string `json:"serial_number"` Model string `json:"model"` ModelID string `json:"model_id"` Manufacturer string `json:"manufacturer"` ConfigurationURL string `json:"configuration_url"` }
Device represents the device information for Home Assistant.
type DiscoveryMessage ¶
type DiscoveryMessage struct { Name string `json:"name"` DeviceClass string `json:"device_class"` UniqueID string `json:"unique_id"` // The sensor id StateTopic string `json:"state_topic"` // Shared by all devices CommandTopic string `json:"command_topic,omitempty"` // Not used by this device ValueTemplate string `json:"value_template"` // Converts the sensor state payload to string, e.g. '{{ value_json.power_meter}}' UnitOfMeasurement string `json:"unit_of_measurement,omitempty"` Device *Device `json:"device"` StateClass string `json:"state_class,omitempty"` }
DiscoveryMessage represents the discovery payload to be sent to Home Assistant.
type FloatSensorConfig ¶
type FloatSensorConfig struct {
// contains filtered or unexported fields
}
func NewFloatSensorConfig ¶
func (*FloatSensorConfig) ConvertValue ¶
func (f *FloatSensorConfig) ConvertValue(value float64) string
func (*FloatSensorConfig) DeviceClass ¶
func (f *FloatSensorConfig) DeviceClass() string
func (*FloatSensorConfig) Name ¶
func (f *FloatSensorConfig) Name() string
func (*FloatSensorConfig) SensorId ¶ added in v1.0.8
func (f *FloatSensorConfig) SensorId() string
func (*FloatSensorConfig) SensorType ¶
func (f *FloatSensorConfig) SensorType() string
func (*FloatSensorConfig) StateClass ¶ added in v1.0.1
func (f *FloatSensorConfig) StateClass() string
func (*FloatSensorConfig) UnitOfMeasurement ¶
func (f *FloatSensorConfig) UnitOfMeasurement() string
func (*FloatSensorConfig) ValueTemplate ¶
func (f *FloatSensorConfig) ValueTemplate() string
type SensorConfig ¶
type SensorConfigX ¶
type SensorState ¶
type SensorState struct {
State string `json:"state"`
}
Click to show internal directories.
Click to hide internal directories.