fritz_tr064 library

A Dart library for accessing Fritz!Box routers via the TR-064 protocol.

Classes

AlarmClock
Result of X_VoIP:X_AVM-DE_GetAlarmClock action.
AppMessageReceiverResult
Result of X_AVM-DE_AppSetup:SetAppMessageReceiver action.
AppRemoteInfo
Result of X_AVM-DE_AppSetup:GetAppRemoteInfo action.
AppSetupConfig
Result of X_AVM-DE_AppSetup:GetConfig action.
AppSetupInfo
Result of X_AVM-DE_AppSetup:GetInfo action.
AppSetupService
TR-064 X_AVM-DE_AppSetup service.
AreaCode
Area code result from X_AVM-DE_GetVoIPCommonAreaCode.
AuthConfigResult
Result of X_AVM-DE_Auth:SetConfig action.
AuthMethod
A second-factor authentication method.
AuthMethodButton
Press any button on the device to authenticate.
AuthMethodDtmf
Enter a DTMF sequence on a connected phone.
AuthMethodUnknown
An unrecognised authentication method.
AuthService
TR-064 X_AVM-DE_Auth service (second-factor authentication).
AuthState
Tracks the authentication state for a TR-064 session.
CallListEntry
A single entry from the call list XML.
CountryCode
Country code result from X_AVM-DE_GetVoIPCommonCountryCode.
CurrentUser
Result of X_AVM-DE_GetCurrentUser action.
DDNSInfo
Result of X_AVM-DE_RemoteAccess:GetDDNSInfo action.
DDNSProvider
A DDNS provider from the provider list XML.
DectHandsetInfo
Information about a DECT handset.
Deflection
A call deflection rule.
DeviceDescription
Parsed device description from tr64desc.xml.
DeviceInfo
Result of DeviceInfo:GetInfo action.
DeviceInfoService
TR-064 DeviceInfo service.
DeviceNode
A device node in the TR-064 device tree.
HomeautoDeviceInfo
Result of GetGenericDeviceInfos / GetSpecificDeviceInfos actions.
HomeautoInfo
Result of X_AVM-DE_Homeauto:GetInfo action.
HomeautoService
TR-064 X_AVM-DE_Homeauto service.
HomePlugDeviceEntry
Result of GetGenericDeviceEntry / GetSpecificDeviceEntry actions.
HomePlugService
TR-064 X_AVM-DE_Homeplug service.
LanConfigSecurityInfo
Result of LANConfigSecurity:GetInfo action.
LanConfigSecurityService
TR-064 LANConfigSecurity service.
MyFritzInfo
Result of X_AVM-DE_MyFritz:GetInfo action.
MyFritzService
TR-064 X_AVM-DE_MyFritz service.
MyFritzServiceInfo
Result of X_AVM-DE_MyFritz:GetServiceByIndex action.
OnlinePhonebookInfo
Information about an online (remote) phonebook account.
OnlinePhonebookServiceId
Known service IDs for online phonebook accounts.
OnlinePhonebookStatus
Known status codes for online phonebook accounts.
OnTelService
TR-064 X_AVM-DE_OnTel service (contacts / phonebook).
Phonebook
Result of OnTel:GetPhonebook action.
PhonebookEntry
A parsed phonebook contact entry.
PhoneNumber
A phone number from a phonebook contact.
RemoteAccessInfo
Result of X_AVM-DE_RemoteAccess:GetInfo action.
RemoteAccessService
TR-064 X_AVM-DE_RemoteAccess service.
ServiceDescription
A TR-064 service descriptor from the device description XML.
SoapEnvelope
Builds SOAP 1.1 envelopes for TR-064 requests.
SoapResponse
Parsed SOAP response.
TAMInfo
Result of X_AVM-DE_TAM:GetInfo action.
TAMList
Result of parsing the GetList XML document.
TAMListItem
An item from the TAM list XML returned by GetList.
TAMMessage
A single message from the TAM message list XML.
TAMService
TR-064 X_AVM-DE_TAM service (telephone answering machine).
Tr64Auth
Handles TR-064 content-level SOAP digest authentication.
Tr64Client
Main entry point for the TR-064 protocol.
Tr64Service
Base class for TR-064 service wrappers.
User
A user entry from the user list.
UserRight
A single user right entry.
VoIPAccount
Result of X_VoIP:GetVoIPAccount action.
VoIPClient
Result of X_VoIP:X_AVM-DE_GetClient3 action.
VoIPInfo
Result of X_VoIP:GetInfo action.
VoIPInfoEx
Result of X_VoIP:GetInfoEx action.
VoIPNumber
A VoIP number entry from the GetNumbers XML list.
VoIPService
TR-064 X_VoIP service (VoIP telephony).

Enums

AccessRight
Access level for a user right.
AppEventId
Known event IDs for the ResetEvent action.
AppRight
Access right level for an app instance.
CallType
Type of call in the call list.
DDNSMode
DDNS update mode.
DDNSStatus
DDNS update status for IPv4 or IPv6.
DeflectionMode
Deflection mode from the spec's ModeEnum (section 3.1).
DeflectionType
Deflection type from the spec's TypeEnum (section 3.2).
EnabledEnum
Whether a smart home device feature is supported.
IPv4ForwardingWarning
IPv4 forwarding warning for a MyFRITZ service entry.
LetsEncryptState
State of the Let's Encrypt certificate.
MyFritzState
MyFRITZ registration state.
MyFritzStatus
MyFRITZ registration status (integer values).
NumberType
Number type of a call list entry (spec table 69).
PhoneNumberType
Well-known phone number types per the TR-064 contact spec.
PresentEnum
Connection status of a smart home device.
SecondFactorState
State of the second-factor authentication process.
SwModeEnum
Switch timer control mode.
SwStateEnum
Switch state.
TAMMode
Operating mode of a telephone answering machine.
UpdateSuccessful
Firmware update result for a HomePlug device.
ValidEnum
Whether a smart home value is valid.
VentilEnum
Radiator valve status.
VoiceCoding
Voice coding mode.
VoIPNumberType
Type of a VoIP number entry.
VoIPStatus
VoIP account registration status.

Extensions

AppSetupClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_AppSetup service.
AuthClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_Auth service.
DeviceInfoClientExtension on Tr64Client
Extension on Tr64Client to access the DeviceInfo service.
HomeautoClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_Homeauto service.
HomePlugClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_Homeplug service.
LanConfigSecurityClientExtension on Tr64Client
Extension on Tr64Client to access the LANConfigSecurity service.
MyFritzClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_MyFritz service.
OnTelClientExtension on Tr64Client
Extension on Tr64Client to access the OnTel (phonebook) service.
RemoteAccessClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_RemoteAccess service.
TAMClientExtension on Tr64Client
Extension on Tr64Client to access the X_AVM-DE_TAM service.
VoIPClientExtension on Tr64Client
Extension on Tr64Client to access the X_VoIP service.

Exceptions / Errors

SoapFaultException
Exception thrown when a SOAP fault is returned.