fritz_api v1.0.2 FritzApi.Actor View Source

A smart home actor.

Properties:

  • ain: identification of the actor, e.g. "012340000123" or MAC address for network devices
  • fwversion: firmware version of the device
  • id: interal device ID
  • manufacturer: should always be "AVM"
  • productname: product name of the device; nil if undefined / unknown
  • present: indicates whether the devices is connected with the FritzBox; either [true | false | nil]
  • name: name of the device

Optional Properties

Depending on the device type different properties can be available.

Switch

  • state: switching state; either [true | false | nil]
  • mode: :auto if in timer switch mode, otherwise :manual; can also be nil if undefined / unknown
  • lock: state of the shift lock (via UI/API); either [true | false | nil]
  • devicelock: state of the shift lock (via hardware button); either [true | false | nil]

Powermeter

  • power: current power consumption (Watts); gets updated roughly every 2 minutes
  • energy: total energy usage (kWh) since first use

Temperature

  • celsius: last measured temperature
  • offsset: configured offsset value

Alert

  • state: last known alert state; either [true | false | nil]

Hkr (Thermostat)

Not yet implemented.

Link to this section Summary

Link to this section Types

Link to this type

t()

View Source
t() :: %FritzApi.Actor{
  ain: String.t(),
  alert: none() | [%{state: boolean() | nil}],
  fwversion: String.t(),
  id: integer(),
  manufacturer: String.t(),
  name: String.t(),
  powermeter: none() | [%{power: float() | nil, energy: float() | nil}],
  present: boolean() | nil,
  productname: String.t(),
  switch:
    none()
    | [
        %{
          state: boolean() | nil,
          mode: String.t() | nil,
          lock: boolean() | nil,
          devicelock: boolean() | nil
        }
      ],
  temperature: none() | [%{celsius: float() | nil, offset: float() | nil}]
}