GoSungrow/mmHa/select.go
2022-12-23 18:16:12 +11:00

183 lines
6.4 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"
"fmt"
"github.com/MickMake/GoUnify/Only"
mqtt "github.com/eclipse/paho.mqtt.golang"
)
const LabelSelect = "select"
func (m *Mqtt) SelectPublishConfig(config EntityConfig, fn mqtt.MessageHandler) error {
for range Only.Once {
if !config.IsSelect() {
break
}
ok, newDevice := m.NewDevice(config)
if !ok {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
cmdTopic := JoinStringsForTopic(m.Prefix, LabelSelect, m.ClientId, id, "cmd")
payload := Select {
Device: newDevice,
Name: String(JoinStrings(m.DeviceName, config.Name)),
StateTopic: String(JoinStringsForTopic(m.Prefix, LabelSelect, m.ClientId, id, "state")),
// CommandTemplate: Template(fmt.Sprintf(`"%s":"{{ value }}"`, config.FullId)),
// CommandTemplate: Template(fmt.Sprintf(`{{ value_json.value }}`)),
CommandTemplate: Template(fmt.Sprintf(`{{ value }}`)),
CommandTopic: String(cmdTopic),
ObjectId: String(id),
UniqueId: String(id),
Qos: 0,
Retain: true,
EnabledByDefault: true,
Encoding: "utf-8",
Options: config.Options,
ValueTemplate: Template(config.ValueTemplate),
Icon: Icon(config.Icon),
}
tag := JoinStringsForTopic(m.Prefix, LabelSelect, m.ClientId, id, "config")
m.err = m.Publish(tag, 0, true, payload.Json())
if m.err != nil {
break
}
m.err = m.Subscribe(cmdTopic, fn)
if m.err != nil {
break
}
}
return m.err
}
func (m *Mqtt) SelectPublishValue(config EntityConfig) error {
for range Only.Once {
if !config.IsSelect() {
break
}
if config.IgnoreUpdate {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
tag := JoinStringsForTopic(m.Prefix, LabelSelect, 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, `":`) {
// m.err = m.Publish(tag, 0, true, value)
// break
// }
//
// payload := MqttState {
// LastReset: config.LastReset, // m.GetLastReset(config.FullId),
// Value: value,
// }
m.err = m.Publish(tag, 0, true, value)
}
return m.err
}
type Select 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"`
// The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
AvailabilityTopic String `json:"availability_topic,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"`
// Defines a template to generate the payload to send to command_topic.
CommandTemplate Template `json:"command_template,omitempty"`
// The MQTT topic to publish commands to change the selected option.
CommandTopic String `json:"command_topic,omitempty" required:"true"`
// Information about the device this Select is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
Device Device `json:"device,omitempty"`
// Flag which defines if the entity should be enabled when first added.
EnabledByDefault Boolean `json:"enabled_by_default,omitempty" default:"true"`
// The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
Encoding String `json:"encoding,omitempty" default:"utf"`
// The category of the entity.
EntityCategory String `json:"entity_category,omitempty" default:"None"`
// 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.
JsonAttributesTemplate Template `json:"json_attributes_template,omitempty"`
// The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes. Implies force_update of the current select state when a message is received on this topic.
JsonAttributesTopic String `json:"json_attributes_topic,omitempty"`
// The name of the Select.
Name String `json:"name,omitempty"`
// Used instead of name for automatic generation of entity_id
ObjectId String `json:"object_id,omitempty"`
// Flag that defines if the select works in optimistic mode.
Optimistic Boolean `json:"optimistic,omitempty"`
// Default: true if no state_topic defined, else false.
// List of options that can be selected. An empty list or a list with a single item is allowed.
Options List `json:"options,omitempty" required:"true"`
// The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
Qos Integer `json:"qos,omitempty" default:"0"`
// If the published message should have the retain flag on or not.
Retain Boolean `json:"retain,omitempty" default:"false"`
// The MQTT topic subscribed to receive update of the selected option.
StateTopic String `json:"state_topic,omitempty"`
// An ID that uniquely identifies this Select. If two Selects have the same unique ID Home Assistant will raise an exception.
UniqueId String `json:"unique_id,omitempty"`
// Defines a template to extract the value.
ValueTemplate Template `json:"value_template,omitempty"`
}
func (c *Select) Json() string {
j, _ := json.Marshal(*c)
return string(j)
}
func (config *EntityConfig) IsSelect() bool {
var ok bool
for range Only.Once {
if config.Units == LabelSelect {
ok = true
break
}
}
return ok
}