package
1.4.22
Repository: https://github.com/jayme-github/fritzctl.git
Documentation: pkg.go.dev

# Functions

AuthEndpoint configures the the endpoint for authentication.
Caching activates (or deactivates) caching of obtained data, such as the list of devices.
Certificate actives TLS verification of the FRITZ!Box server, where the certificate is explicitly specified as byte array, encoded in PEM format.
Credentials configures the username and password for authentication.
NewClient creates a new Client with values read from a config file, given by the parameter configfile.
NewClientFromConfig creates a new Client with the passed configuration.
NewHomeAuto a HomeAuto that communicates with the FRITZ!Box by means of the Home Automation HTTP Interface.
NewInternal creates a Fritz/internal API from a given client.
NewPhone creates a client for interaction with the FB phone sector.
SkipTLSVerify omits TLS verification of the FRITZ!Box server.
URL sets the target host of the FRITZ!Box.

# Variables

HkrErrorDescriptions has a translation of error code to a warning/error/status description.

# Structs

BoxData contains runtime information of the FRITZ!Box.
Call contains the data for one phone call record.
Client encapsulates the FRITZ!Box interaction API.
Device models a smart home device.
DeviceGroup is an inflated version of one Group with multiple Device members.
Devicelist wraps a list of devices.
FirmwareVersion represent the FRITZ!OS version.
Group models a grouping of smart home devices.
GroupInfo contains the topological data of the grouping, in particular the members of the group.
LanDevices is the top-level wrapper for the FRITZ!Box answer upon a query for lan devices.
MessageLog is the top-level wrapper for the FRITZ!Box answer upon a query for log events.
Model contains information about the type of the box.
NetworkElement corresponds to a single entry in LanDevices.
NextChange corresponds to the next HKR switch event.
Powermeter models a power measurement.
Rights wrap set of pairs (name, access-level).
Runtime contains data on how long the FRITZ!Box has been running.
SessionInfo models the xml upon accessing the login endpoint.
Switch models the state of a switch.
Temperature models a temperature measurement.
Thermostat models the "HKR" device.
TrafficMonitoringData holds the data for the up- and downstream traffic reported by the FRITZ!Box.

# Interfaces

HomeAuto is a client for the Home Automation HTTP Interface, see https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf.
Internal exposes Fritz!Box internal and undocumented API.
Phone describes the supported operations.

# Type aliases

Message corresponds to a single log message.
Option applies fine-grained configuration to the HomeAuto client.