hqtt

type Component[TPlatform Platform] struct {
	Platform    TPlatform
	TopicPrefix string

	// The name of the entity. Set to the empty string if only the device name is relevant.
	Name string

	// The category of the entity. See https://developers.home-assistant.io/docs/core/entity/#generic-properties
	EntityCategory string

	// The Icon to use in the frontend for this entity
	Icon string

	// Picture URL for the entity.
	Picture *url.URL

	// Identifies to home assistant whether this entity is available
	Availability *mqtt.Value[hass.Availability] `hqtt:"required"`
	// Custom values to use for available and unavailable states
	CustomAvailabilityValues hass.CustomAvailability

	// Use this value instead of name for automatic generation of the entity ID. For example, `light.foobar`. When used
	// without a UniqueID, the entity ID will update during restart or reload if the entity ID is available. If the
	// entity ID already exists, the entity ID will be created with a number at the end. When used with a UniqueID, the
	// DefaultEntityID is only used when the entity is added for the first time. When set, this overrides a
	// user-customized entity ID if the entity was deleted and added again.
	DefaultEntityID string

	// An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an
	// exception. Required when used with device-based discovery.
	UniqueID string `hqtt:"required"`

	// MQTT Options to use when publishing updates for this device
	WriteOptions mqtt.WriteOptions
	// contains filtered or unexported fields
}

type Device struct {
	// The ID to use for discovery. If empty, an ID is calculated from other fields.
	DiscoveryID string `json:"-"`

	// The name of the device.
	Name string `json:"name,omitempty"`

	// The serial number of the device
	Serial string `json:"sn,omitempty"`

	// The manufacturer of the device.
	Manufacturer string `json:"mf,omitempty"`

	// The model of the device.
	Model string `json:"mdl,omitempty"`

	// The model identifier of the device.
	ModelID string `json:"mdl_id,omitempty"`

	// A link to the webpage that can manage the configuration of this device. Can be either a http://, https:// or an
	// internal homeassistant:// URL.
	ConfigurationURL *url.URL `json:"cu,omitempty"`

	// A list of connections of the device to the outside world. For example, `[]DeviceConnection{{Kind: "mac", Value: "02:5b:26:a8:dc:12"]}}`
	Connections []DeviceConnection `json:"cns,omitempty"`

	// The hardware version of the device.
	HardwareVersion string `json:"hw,omitempty"`

	// The firmware version of the device
	FirmwareVersion string `json:"sw,omitempty"`

	// A list of IDs that uniquely identify the device. For example a serial number.
	Identifiers []string `json:"ids,omitempty"`

	// Suggest an area if the devic e isn't in one yet
	SuggestedArea string `json:"sa,omitempty"`

	// It is recommended to add information about the origin of MQTT entities. The origin details will be logged in the
	// core event log when an item is discovered or updated. Adding origin information helps with troubleshooting and
	// provides valuable context about the source of MQTT messages in your Home Assistant setup. Home Assistant requires
	// origin information be specified when using Device-based Discovery. If omitted, DefaultOrigin will be used when
	// serializing the discovery payload instead.
	Origin *Origin `json:"-"`

	// Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are
	// hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.
	ViaDevice string `json:"via_device,omitempty"`
}

type DeviceConnection struct {
	Kind  string
	Value string
}

type Origin struct {
	// The name of the application that is the origin of the discovered MQTT item.
	Name string `json:"name"`
	// Software version of the application that supplies the discovered MQTT item.
	SoftwareVersion string `json:"sw,omitempty"`
	// Support URL of the application that supplies the discovered MQTT item.
	SupportURL *url.URL `json:"url,omitempty"`
}

type Platform interface {
	mqtt.Handler

	// MarshalDiscoveryTo marshals MQTT Device Discovery information to the specified jsontext.Encoder using the
	// provided prefix for all MQTT Topics.
	MarshalDiscoveryTo(e *jsontext.Encoder, prefix string) error

	// PlatformName returns the value for the `platform` field when configuring a component using this platform for MQTT
	// Device Discovery.
	PlatformName() string

	// Subscriptions returns the set of paho.SubscribeOptions for configured fields of this component. Only fields that
	// are properly configured should be included. Typically, each subscription is individually subscribed to, but other
	// mqtt.Subscriber implementations may choose to group topics with wildcards.
	Subscriptions(prefix string) []mqtt.Subscription
}

type RemoveComponent struct {
	Platform string `json:"platform"`
}