agent

Documentation

Index

• Constants
• Variables
• func Register(options AgentOptions, server, token string)
• func Run(options AgentOptions)
• func ShowInfo(options AgentOptions)
• func ShowVersion(options AgentOptions)
• type Agent
  • func (agent *Agent) AppConfigVersion() string
  • func (agent *Agent) DeviceDetails() (string, string)
  • func (agent *Agent) IsRegistered() bool
  • func (agent *Agent) LoadConfig() *agentConfig
  • func (agent *Agent) SetPref(pref string, value interface{})
• type AgentOptions

Constants

const (
	Name = "go-hass-agent"
)

Variables

var Version string

Functions

func Register

func Register(options AgentOptions, server, token string)

Register runs a registration flow. It either prompts the user for needed information or parses what is already provided. It will send a registration request to Home Assistant and handles the response. It will handle either a UI or non-UI registration flow.

func Run

func Run(options AgentOptions)

Run is the "main loop" of the agent. It sets up the agent, loads the config then spawns a sensor tracker and the workers to gather sensor data and publish it to Home Assistant

func ShowInfo

func ShowInfo(options AgentOptions)

func ShowVersion

func ShowVersion(options AgentOptions)

Types

type Agent

type Agent struct {
	Name, Version string
	// contains filtered or unexported fields
}

Agent holds the data and structure representing an instance of the agent. This includes the data structure for the UI elements and tray and some strings such as app name and version.

func (*Agent) AppConfigVersion

func (agent *Agent) AppConfigVersion() string

func (*Agent) DeviceDetails

func (agent *Agent) DeviceDetails() (string, string)

func (*Agent) IsRegistered

func (agent *Agent) IsRegistered() bool

func (*Agent) LoadConfig

func (agent *Agent) LoadConfig() *agentConfig

func (*Agent) SetPref

func (agent *Agent) SetPref(pref string, value interface{})

type AgentOptions

type AgentOptions struct {
	ID                 string
	Headless, Register bool
}

AgentOptions holds options taken from the command-line that was used to invoke go-hass-agent that are relevant for agent functionality.