code.pfad.fr/fritzgox/aha ↑

aha package

import "code.pfad.fr/fritzgox/aha"

package aha allows to interact with the AVM Home Automation HTTP Interface (AHA), to control the connected smart devices.

Index

Constants

❖ 
const ThermostatTempOff = ThermostatTemp(0)
❖ 
const ThermostatTempOn = ThermostatTemp(37)
❖ 
const ThermostatTempUndefined = ThermostatTemp(-1)

func LoginV2

❖ 
func LoginV2(c *Client) error

LoginV2 asks the fritzbox for the PBKDF2 challenge on login.

func TrustOnFirstUse

❖ 
func TrustOnFirstUse(c *Client) error

TrustOnFirstUse retrieves the certificate and marks it as trusted for subsequent calls.

type Client

❖ 
type Client struct {
	URL       url.URL
	Transport *http.Transport
	// if Username is empty, it will be auto-discovered
	Username string
	LoginV2  bool
	// contains filtered or unexported fields
}

func NewClient

❖ 
func NewClient(addr, password string, options ...Option) (*Client, error)

NewClient creates a new client to interact with the AHA interface.

func (*Client) GetDeviceListInfos

❖ 
func (c *Client) GetDeviceListInfos() (info *DeviceListInfos, err error)

GetDeviceListInfos returns the connected smart devices.

func (*Client) SetThermostatBoost

❖ 
func (c *Client) SetThermostatBoost(identifier string, d time.Duration) error

SetThermostatBoost

func (*Client) SetThermostatTargetTemp

❖ 
func (c *Client) SetThermostatTargetTemp(identifier string, t ThermostatTemp) error

SetThermostatTargetTemp

type Device

❖ 
type Device struct {
	Identifier      string
	ID              string
	Function        DeviceFunction
	FirmwareVersion string
	Manufacturer    string
	Productname     string
	Present         bool
	Txbusy          bool
	Name            string
	BatteryLow      bool
	BatteryLevel    int

	TemperatureSensor *TemperatureSensor
	Thermostat        *Thermostat
}

type DeviceFunction

❖ 
type DeviceFunction uint64
❖ 
const (
	DeviceHANFUN DeviceFunction = 1 << iota

	DeviceLight

	DeviceAlarm
	DeviceButton
	DeviceThermostat
	DeviceEnergieSensor
	DeviceTemperatureSensor
	DeviceSwitch
)

type DeviceListInfos

❖ 
type DeviceListInfos struct {
	XMLName         xml.Name
	Version         string
	FirmwareVersion string
	Devices         []Device
}

type Float32Tenth

❖ 
type Float32Tenth float32

func (Float32Tenth) String

❖ 
func (f Float32Tenth) String() string

func (*Float32Tenth) UnmarshalXML

❖ 
func (f *Float32Tenth) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type Option

❖ 
type Option func(*Client) error

func TrustCertificate

❖ 
func TrustCertificate(bs []byte) Option

TrustCertificate adds a PEM certificate to be trusted. Be aware that self-signed certificates may be re-created on reboot. You might prefer to use TrustOnFirstUse.

See also https://en.avm.de/service/knowledge-base/dok/FRITZ-Box-7490/1523_Downloading-your-FRITZ-Box-s-certificate-and-importing-it-to-your-computer/

func WithUsername

❖ 
func WithUsername(username string) Option

WithUsername disables the auto-discovery of the username.

type TemperatureSensor

❖ 
type TemperatureSensor struct {
	Celsius Float32Tenth // adjusted temperature
	Offset  Float32Tenth // operated adjustment
}

type Thermostat

❖ 
type Thermostat struct {
	// you should use the TemperatureSensor instead of ActualTemp
	ActualTemp        ThermostatTemp
	TargetTemp        ThermostatTemp
	LowTemp           ThermostatTemp
	ComfortTemp       ThermostatTemp
	APILocked         bool
	DeviceLocked      bool
	ErrorCode         int
	WindowOpened      bool
	WindowOpenedUntil UnixSecond
	BoostActive       bool
	BoostActiveUntil  UnixSecond
	BatteryLow        bool
	BatteryLevel      int
	NextChange        struct {
		At UnixSecond

		WishTemp ThermostatTemp
	}
	SummerActive  bool
	HolidayActive bool
}

type ThermostatTemp

❖ 
type ThermostatTemp float32

func (ThermostatTemp) String

❖ 
func (t ThermostatTemp) String() string

func (*ThermostatTemp) UnmarshalXML

❖ 
func (t *ThermostatTemp) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

type UnixSecond

❖ 
type UnixSecond struct{ time.Time }

func (*UnixSecond) UnmarshalXML

❖ 
func (u *UnixSecond) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error

Source Files

challenge.go getdevicelistinfos.go session.go thermostat.go

code.pfad.fr/fritzgox/aha
main