mqtt

type Command struct {
	Name                string `yaml:"name"`                  // e.g. `open` or `close`
	Payload             string `yaml:"payload"`               // this could be the same or different than Name depending on the mqtt implementation
	TopicSuffix         string `yaml:"topic_suffix"`          // location where the command will be published; prefixed by MqttSettings.Topics.Prefix
	RequiredStartState  string `yaml:"required_start_state"`  // if set, garage door will not operate if current state does not equal this
	RequiredFinishState string `yaml:"required_finish_state"` // if set, garage door will monitor the door state compared to this value to determine success
	Timeout             int    `yaml:"timeout"`               // time to wait for garage door to operate if monitored
}

type MqttGdo interface {
	// InitializeMqttClient initializes the client by setting the connection options, connecting
	// to the mqtt broker, and subscribing to topics
	InitializeMqttClient()

	// SetGarageDoor operates the garage door by publishing to the configured mqtt topic with the configured payload
	SetGarageDoor(string) error
	// process any required shutdown events, such as service disconnects
	ProcessShutdown()
	// contains filtered or unexported methods
}