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

188 lines
6.3 KiB
Go

package mmHa
import (
"encoding/json"
"github.com/MickMake/GoUnify/Only"
"strings"
)
const LabelNumber = "number"
func (m *Mqtt) NumberPublishConfig(config EntityConfig) error {
for range Only.Once {
if !config.IsNumber() {
break
}
ok, newDevice := m.NewDevice(config)
if !ok {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
payload := Number {
Device: newDevice,
Name: String(JoinStrings(m.DeviceName, config.Name)),
// StateTopic: JoinStringsForTopic(m.switchPrefix, id, "state"),
CommandTopic: String(JoinStringsForTopic(m.Prefix, LabelNumber, m.ClientId, 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, LabelNumber, m.ClientId, id, "config")
m.err = m.Publish(tag, 0, true, payload.Json())
}
return m.err
}
func (m *Mqtt) NumberPublishValue(config EntityConfig) error {
for range Only.Once {
if !config.IsNumber() {
break
}
if config.IgnoreUpdate {
break
}
id := JoinStringsForId(m.DeviceName, config.FullId)
tag := JoinStringsForTopic(m.Prefix, LabelNumber, 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, payload.Json())
}
return m.err
}
type Number 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 generate the payload to send to command_topic.
CommandTemplate Template `json:"command_template,omitempty"`
// The MQTT topic to publish commands to change the number.
CommandTopic String `json:"command_topic,omitempty" required:"true"`
// Information about the device this Number 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"`
// The type/class of the number.
DeviceClass DeviceClass `json:"device_class,omitempty" default:"None"`
// 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 number attributes. Implies force_update of the current number state when a message is received on this topic.
JsonAttributesTopic String `json:"json_attributes_topic,omitempty"`
// Minimum value.
Min Float `json:"min,omitempty" default:"1"`
// Maximum value.
Max Float `json:"max,omitempty" default:"100"`
// Control how the number should be displayed in the UI. Can be set to box or slider to force a display mode.
Mode String `json:"mode,omitempty"(optional, default: “auto”)`
// The name of the Number.
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 number works in optimistic mode.
Optimistic Boolean `json:"optimistic,omitempty"`
// Default: true if no state_topic defined, else false.
// A special payload that resets the state to None when received on the state_topic.
PayloadReset String `json:"payload_reset,omitempty"(optional, default: “None”)`
// 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 number values.
StateTopic String `json:"state_topic,omitempty"`
// Step value. Smallest value 0.001.
Step Float `json:"step,omitempty" default:"1"`
// An ID that uniquely identifies this Number. If two Numbers have the same unique ID Home Assistant will raise an exception.
UniqueId String `json:"unique_id,omitempty"`
// Defines the unit of measurement of the sensor, if any.
UnitOfMeasurement String `json:"unit_of_measurement,omitempty"`
// Defines a template to extract the value.
ValueTemplate Template `json:"value_template,omitempty"`
}
func (c *Number) Json() string {
j, _ := json.Marshal(*c)
return string(j)
}
func (config *EntityConfig) IsNumber() bool {
var ok bool
for range Only.Once {
if config.Units == LabelNumber {
ok = true
break
}
}
return ok
}