GoSungrow/mmHa/device_tracker.go
2022-12-20 20:28:51 +11:00

174 lines
5.8 KiB
Go
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package mmHa
import (
"encoding/json"
"github.com/MickMake/GoUnify/Only"
"strings"
)
const LabelDeviceTracker = "device_tracker"
func (m *Mqtt) DeviceTrackerPublishConfig(config EntityConfig) error {
for range Only.Once {
config.FixConfig()
if !config.IsDeviceTracker() {
break
}
ok, newDevice := m.NewDevice(config)
if !ok {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
payload := DeviceTracker {
Device: newDevice,
Name: String(JoinStrings(m.DeviceName, config.Name)),
// StateTopic: JoinStringsForTopic(m.switchPrefix, id, "state"),
// CommandTopic: String(JoinStringsForTopic(m.switchPrefix, id, "cmd")),
ObjectId: String(id),
UniqueId: String(id),
Qos: 0,
// Retain: true,
// PayloadOn: "true",
// PayloadOff: "false",
// StateOn: "true",
// StateOff: "false",
// ValueTemplate: config.ValueTemplate,
Icon: Icon(config.Icon),
}
tag := JoinStringsForTopic(m.Prefix, LabelDeviceTracker, m.ClientId, id, "config")
t := m.client.Publish(tag, 0, true, payload.Json())
if !t.WaitTimeout(m.Timeout) {
m.err = t.Error()
}
}
return m.err
}
func (m *Mqtt) DeviceTrackerPublishValue(config EntityConfig) error {
for range Only.Once {
if !config.IsDeviceTracker() {
break
}
if config.IgnoreUpdate {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
tag := JoinStringsForTopic(m.Prefix, LabelDeviceTracker, m.ClientId, id, "state")
value := config.Value.String()
if value == "--" {
value = ""
}
// @TODO - Real hack here. Need to properly check for JSON.
if strings.Contains(value, `{`) || strings.Contains(value, `":`) {
t := m.client.Publish(tag, 0, true, value)
if !t.WaitTimeout(m.Timeout) {
m.err = t.Error()
}
break
}
payload := MqttState{
LastReset: config.LastReset, // m.GetLastReset(config.FullId),
Value: value,
}
t := m.client.Publish(tag, 0, true, payload.Json())
if !t.WaitTimeout(m.Timeout) {
m.err = t.Error()
}
}
return m.err
}
type DeviceTracker struct {
// A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
Availability *Availability `json:"availability,omitempty"`
// When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.
AvailabilityMode String `json:"availability_mode,omitempty" default:"latest"`
// Defines a template to extract devices availability from the availability_topic. To determine the devicess availability result of this template will be compared to payload_available and payload_not_available.
AvailabilityTemplate Template `json:"availability_template,omitempty"`
// The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
AvailabilityTopic String `json:"availability_topic,omitempty"`
// Information about the device this device tracker is a part of that ties it into the device registry. At least one of identifiers or connections must be present to identify the device.
Device Device `json:"device,omitempty"`
// Icon for the entity.
Icon Icon `json:"icon,omitempty"`
// Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.
JsonAttributesTemplate Template `json:"json_attributes_template,omitempty"`
// The MQTT topic subscribed to receive a JSON dictionary payload and then set as device_tracker attributes. Usage example can be found in MQTT sensor documentation.
JsonAttributesTopic String `json:"json_attributes_topic,omitempty"`
// The name of the MQTT device_tracker.
Name String `json:"name,omitempty"`
// Used instead of name for automatic generation of entity_id
ObjectId String `json:"object_id,omitempty"`
// The payload that represents the available state.
PayloadAvailable String `json:"payload_available,omitempty" default:"online"`
// The payload value that represents the home state for the device.
PayloadHome String `json:"payload_home,omitempty" default:"home"`
// The payload that represents the unavailable state.
PayloadNotAvailable String `json:"payload_not_available,omitempty" default:"offline"`
// The payload value that represents the not_home state for the device.
PayloadNotHome String `json:"payload_not_home,omitempty" default:"not_home"`
// The maximum QoS level of the state topic.
Qos Integer `json:"qos,omitempty" default:"0"`
// Attribute of a device tracker that affects state when being used to track a person. Valid options are gps, router, bluetooth, or bluetooth_le.
SourceType String `json:"source_type,omitempty"`
// The MQTT topic subscribed to receive device tracker state changes.
StateTopic String `json:"state_topic,omitempty" required:"true"`
// An ID that uniquely identifies this device_tracker. If two device_trackers have the same unique ID, Home Assistant will raise an exception.
UniqueId String `json:"unique_id,omitempty"`
// Defines a template that returns a device tracker state.
ValueTemplate Template `json:"value_template,omitempty"`
}
func (c *DeviceTracker) Json() string {
j, _ := json.Marshal(*c)
return string(j)
}
func (config *EntityConfig) IsDeviceTracker() bool {
var ok bool
for range Only.Once {
if config.Units == LabelDeviceTracker {
ok = true
break
}
}
return ok
}