FritzConnection. Eine Python-Schnittstelle zur AVM FritzBox. FritzConnection pythoncamp 2013 Klaus Bremer

Transcription

1 FritzConnection Eine Python-Schnittstelle zur AVM FritzBox 1

2 Detailinformationen von AVM: Per Navigation auf (für mich) unauffindbar. 2

3 FritzConnection FritzTools FritzStatus FritzMonitor fritzconnection: fritzstatus: fritzmonitor: Schnittstelle zur FritzBox FritzBox-Statusinformationen GUI-Aktivitätsmonitor (TkInter) 3

4 FritzBox liefert Schnittstellenbeschreibung via xml-dateien: igddesc.xml tr64desc.xml Zugriff per http: IP: Port:

5 TR-064: basierend auf UPnP (Universal Plug and Play) Informationen TR-064: _Konfiguration_ueber_TR-064.pdf Informationen UPnP: 5

6 igddesc.xml (Internet Gateway Device Description) <service> <servicetype>urn:schemas-upnp-org:service:wancommoninterfaceconfig:1</servicetype> <serviceid>urn:upnp-org:serviceid:wancommonifc1</serviceid> <controlurl>/upnp/control/wancommonifc1</controlurl> <eventsuburl>/upnp/control/wancommonifc1</eventsuburl> <SCPDURL>/igdicfgSCPD.xml</SCPDURL> </service> Service Control Protocol Document 6

7 igdicfgscpd.xml (Internet Gateway Device Internal Configuration Service Control Protocol Document) <action> <name>gettotalbytesreceived</name> <argumentlist> <argument> <name>newtotalbytesreceived</name> <direction>out</direction> <relatedstatevariable>totalbytesreceived</relatedstatevariable> </argument> </argumentlist> </action>... <statevariable sendevents="no"> <name>totalbytesreceived</name> <datatype>ui4</datatype> </statevariable> 7

8 FritzConnection: Anwendungsbeispiel if name == ' main ': print('fritzconnection:') fc = FritzConnection() print(fc.modelname) print(fc.actionnames) print(fc.get_action_arguments('getstatusinfo')) print(fc.call_action('getstatusinfo')) print(fc.call_action('gettotalbytessent')) print(fc.call_action('gettotalbytesreceived')) print(fc.call_action('getexternalipaddress')) print(fc.call_action('getcommonlinkproperties')) 8

9 Output: FritzConnection: FRITZ!Box Fon WLAN 7390 ['AddPortMapping', 'DeletePortMapping', 'ForceTermination', 'GetATMEncapsulation', 'GetAddonInfos', 'GetAutoConfig', 'GetCommonLinkProperties', 'GetConnectionTypeInfo', 'GetDSLLinkInfo', 'GetDestinationAddress', 'GetExternalIPAddress', 'GetFCSPreserved', 'GetGenericPortMappingEntry', 'GetModulationType', 'GetNATRSIPStatus', 'GetSpecificPortMappingEntry', 'GetStatusInfo', 'GetTotalBytesReceived', 'GetTotalBytesSent', 'GetTotalPacketsReceived', 'GetTotalPacketsSent', 'RequestConnection', 'SetATMEncapsulation', 'SetConnectionType', 'SetDSLLinkType', 'SetDestinationAddress', 'SetFCSPreserved'] [('NewUptime', 'out', 'ui4'), ('NewLastConnectionError', 'out', 'string'), ('NewConnectionStatus', 'out', 'string')] {'NewConnectionStatus': u'connected', 'NewLastConnectionError': u'error_none', 'NewUptime': 50301} {'NewTotalBytesSent': } {'NewTotalBytesReceived': } {'NewExternalIPAddress': u' '} {'NewWANAccessType': u'dsl', 'NewLayer1DownstreamMaxBitRate': , 'NewPhysicalLinkStatus': u'up', 'NewLayer1UpstreamMaxBitRate': } 9

10 IO: if name == ' main ': print('fritzconnection:') fc = FritzConnection() -- print(fc.modelname) FritzConnection: FRITZ!Box Fon WLAN

11 IO: if name == ' main ':... print(fc.actionnames) -- ['AddPortMapping', 'DeletePortMapping', 'ForceTermination', 'GetATMEncapsulation', 'GetAddonInfos', 'GetAutoConfig', 'GetCommonLinkProperties', 'GetConnectionTypeInfo', 'GetDSLLinkInfo', 'GetDestinationAddress', 'GetExternalIPAddress', 'GetFCSPreserved', 'GetGenericPortMappingEntry', 'GetModulationType', 'GetNATRSIPStatus', 'GetSpecificPortMappingEntry', 'GetStatusInfo', 'GetTotalBytesReceived', 'GetTotalBytesSent', 'GetTotalPacketsReceived', 'GetTotalPacketsSent', 'RequestConnection', 'SetATMEncapsulation', 'SetConnectionType', 'SetDSLLinkType', 'SetDestinationAddress', 'SetFCSPreserved'] 11

12 IO: if name == ' main ':... print(fc.get_action_arguments('getstatusinfo')) print(fc.call_action('getstatusinfo')) -- [('NewUptime', 'out', 'ui4'), ('NewLastConnectionError', 'out', 'string'), ('NewConnectionStatus', 'out', 'string')] {'NewConnectionStatus': u'connected', 'NewLastConnectionError': u'error_none', 'NewUptime': 50301} 12

13 IO: if name == ' main ':... print(fc.call_action('gettotalbytessent')) print(fc.call_action('gettotalbytesreceived')) print(fc.call_action('getexternalipaddress')) print(fc.call_action('getcommonlinkproperties')) -- {'NewTotalBytesSent': } {'NewTotalBytesReceived': } {'NewExternalIPAddress': u' '} {'NewWANAccessType': u'dsl', 'NewLayer1DownstreamMaxBitRate': , 'NewPhysicalLinkStatus': u'up', 'NewLayer1UpstreamMaxBitRate': } 13

14 FritzStatus: class FritzStatus(object): """ Class for requsting status-informations: def modelname(self): return def is_linked(self): """Returns True if the FritzBox is physically linked to the provider.""" status = self.fc.call_action('getcommonlinkproperties') return status['newphysicallinkstatus'] == def is_connected(self): """ Returns True if the FritzBox has established an internet-connection. """ status = self.fc.call_action('getstatusinfo') return status['newconnectionstatus'] == 'Connected' 14

15 FritzStatus: if name == ' main ': fs = FritzStatus() print(fs.modelname) print(fs.bytes_sent) print(fs.bytes_received) print(fs.is_linked) print(fs.is_connected) print(fs.external_ip) print(fs.uptime) print(fs.str_uptime) print(fs.max_bit_rate) print(fs.max_byte_rate) print(fs.str_max_bit_rate) FRITZ!Box Fon WLAN True True :19:35 ( , ) ( , ) ('9.0 MBit/s', '48.0 MBit/s') 15

16 FritzMonitor: 16

17 17