102 lines
2.8 KiB
Go
102 lines
2.8 KiB
Go
// Copyright (c) 2024 Joshua Rich <joshua.rich@gmail.com>
|
|
//
|
|
// This software is released under the MIT License.
|
|
// https://opensource.org/licenses/MIT
|
|
|
|
package preferences
|
|
|
|
import (
|
|
"context"
|
|
|
|
mqtthass "github.com/joshuar/go-hass-anything/v11/pkg/hass"
|
|
mqttapi "github.com/joshuar/go-hass-anything/v11/pkg/mqtt"
|
|
|
|
"github.com/joshuar/go-hass-agent/internal/device"
|
|
)
|
|
|
|
type MQTT struct {
|
|
MQTTServer string `toml:"server,omitempty" validate:"omitempty,uri" kong:"required,help='MQTT server URI. Required.',placeholder='scheme://some.host:port'"` //nolint:lll
|
|
MQTTUser string `toml:"user,omitempty" validate:"omitempty" kong:"optional,help='MQTT username.'"`
|
|
MQTTPassword string `toml:"password,omitempty" validate:"omitempty" kong:"optional,help='MQTT password.'"`
|
|
MQTTTopicPrefix string `toml:"topic_prefix,omitempty" validate:"omitempty,ascii" kong:"optional,help='MQTT topic prefix.'"`
|
|
MQTTEnabled bool `toml:"enabled" validate:"boolean" kong:"-"`
|
|
}
|
|
|
|
func DefaultMQTTPreferences() *MQTT {
|
|
return &MQTT{MQTTEnabled: false}
|
|
}
|
|
|
|
// Server returns the broker URI from the preferences.
|
|
func (p *MQTT) Server() string {
|
|
return p.MQTTServer
|
|
}
|
|
|
|
// User returns any username required for connecting to the broker from the
|
|
// preferences.
|
|
func (p *MQTT) User() string {
|
|
return p.MQTTUser
|
|
}
|
|
|
|
// Password returns any password required for connecting to the broker from the
|
|
// preferences.
|
|
func (p *MQTT) Password() string {
|
|
return p.MQTTPassword
|
|
}
|
|
|
|
// TopicPrefix returns the prefix for topics on MQTT.
|
|
func (p *MQTT) TopicPrefix() string {
|
|
if p.MQTTTopicPrefix == "" {
|
|
return MQTTTopicPrefix
|
|
}
|
|
|
|
return p.MQTTTopicPrefix
|
|
}
|
|
|
|
// MQTTOrigin defines Go Hass Agent as the origin for MQTT functionality.
|
|
func MQTTOrigin() *mqtthass.Origin {
|
|
return &mqtthass.Origin{
|
|
Name: AppName,
|
|
Version: AppVersion,
|
|
URL: AppURL,
|
|
}
|
|
}
|
|
|
|
// IsMQTTEnabled is a conveinience function to determine whether MQTT
|
|
// functionality has been enabled in the agent.
|
|
func (p *Preferences) IsMQTTEnabled() bool {
|
|
if p.MQTT != nil {
|
|
return p.MQTT.MQTTEnabled
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
func (p *Preferences) GetMQTTPreferences() mqttapi.Preferences {
|
|
if p.MQTT != nil {
|
|
return p.MQTT
|
|
}
|
|
|
|
return DefaultMQTTPreferences()
|
|
}
|
|
|
|
func (p *Preferences) SaveMQTTPreferences(mqttPrefs *MQTT) error {
|
|
p.MQTT = mqttPrefs
|
|
return p.Save()
|
|
}
|
|
|
|
func (p *Preferences) GenerateMQTTDevice(ctx context.Context) *mqtthass.Device {
|
|
appID := AppIDFromContext(ctx)
|
|
|
|
// Retrieve the hardware model and manufacturer.
|
|
model, manufacturer, _ := device.GetHWProductInfo() //nolint:errcheck // error doesn't matter
|
|
|
|
return &mqtthass.Device{
|
|
Name: p.DeviceName(),
|
|
URL: AppURL,
|
|
SWVersion: AppVersion,
|
|
Manufacturer: manufacturer,
|
|
Model: model,
|
|
Identifiers: []string{appID, p.DeviceName(), p.DeviceID()},
|
|
}
|
|
}
|