public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[tr064] improve documentation (#9667)

Browse Source 
* improve documentation

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>
Co-authored-by: Stefan Giehl <stefan@matomo.org>
This commit is contained in:
J-N-K 2021-01-06 20:38:14 +01:00 committed by GitHub
parent 0816045a59
commit 4077a2732a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
bundles/org.openhab.binding.tr064/README.md
View File

@ -64,9 +64,12 @@ Values need to be IPv4 addresses in the format `a.b.c.d`.
This is an optional parameter and multiple values are allowed: add one value per line in the Main User Interface. This is an optional parameter and multiple values are allowed: add one value per line in the Main User Interface.
If the `PHONEBOOK` profile shall be used, it is necessary to retrieve the phonebooks from the FritzBox. If the `PHONEBOOK` profile shall be used, it is necessary to retrieve the phonebooks from the FritzBox.
The `phonebookInterval` is uses to set the refresh cycle for phonebooks. It defaults to 600 seconds, The `phonebookInterval` is used to set the refresh cycle for phonebooks.
and it can be set to 0 if phoneooks are not to be used. It defaults to 600 seconds, and it can be set to 0 if phonebooks are not used.
Parameters that accept lists (e.g. `macOnline`, `wanBlockIPs`) can contain comments.
Comments are separated from the value with a '#' (e.g. `192.168.0.77 # Daughter's iPhone`).
The full string is used for the channel label.
### `subdevice`, `subdeviceLan` ### `subdevice`, `subdeviceLan`
@ -78,16 +81,13 @@ by examining the SCPD of the root device, the simplest way to obtain it is throu
Auto discovery may find several sub-devices, each one holding channels as described in the following. Auto discovery may find several sub-devices, each one holding channels as described in the following.
The LAN sub-device, in particular, is also used for presence detection. The LAN sub-device, in particular, is also used for presence detection.
It therefore optionally contains It therefore optionally contains a channel for each MAC address (in a format 11:11:11:11:11:11, different than the old v1 version of this binding), defined by the parameter `macOnline`.
a channel for each MAC address (in a format 11:11:11:11:11:11, different than the old v1 version of this binding),
defined by the parameter `macOnline`.
This is an optional parameter and multiple values are allowed: add one value per line in the Main User Interface.
## Channels ## Channels
Channels are grouped according to the subdevice they belong to. Channels are grouped according to the subdevice they belong to.
### fritzbox Bridge channels ### `fritzbox` bridge channels
Advanced channels appear only if the corresponding parameters are set in the Thing definition. Advanced channels appear only if the corresponding parameters are set in the Thing definition.
@ -106,7 +106,11 @@ Advanced channels appear only if the corresponding parameters are set in the Thi
| `tamNewMessages` | `Number` | x | The number of new messages of the given answering machine. | | `tamNewMessages` | `Number` | x | The number of new messages of the given answering machine. |
| `uptime` | `Number:Time` | | Uptime of the device | | `uptime` | `Number:Time` | | Uptime of the device |
### LAN subdeviceLan channels Call lists are provided via the `callList` channel for one or more days (as configured) as JSON.
The JSON consists of an array of individual calls with the fields `date`, `type`, `localNumber`, `remoteNumber`, `duration`.
The call-types are the same as provided by the FritzBox, i.e. `1` (inbound), `2` (missed), `3` (outbound), `10` (rejected).
### LAN `subdeviceLan` channels
| channel | item-type | advanced | description | | channel | item-type | advanced | description |
|----------------------------|---------------------------|:--------:|----------------------------------------------------------------| |----------------------------|---------------------------|:--------:|----------------------------------------------------------------|
@ -115,7 +119,10 @@ Advanced channels appear only if the corresponding parameters are set in the Thi
| `wifiGuestEnable` | `Switch` | | Enable/Disable the guest WiFi. | | `wifiGuestEnable` | `Switch` | | Enable/Disable the guest WiFi. |
| `macOnline` | `Switch` | x | Online status of the device with the given MAC | | `macOnline` | `Switch` | x | Online status of the device with the given MAC |
### WANConnection subdevice channels Older FritzBox devices may not support 5 GHz WiFi.
In this case you have to use the `wifi5GHzEnable` channel for switching the guest WiFi.
### WANConnection `subdevice` channels
| channel | item-type | advanced | description | | channel | item-type | advanced | description |
|----------------------------|---------------------------|:--------:|----------------------------------------------------------------| |----------------------------|---------------------------|:--------:|----------------------------------------------------------------|
@ -126,7 +133,7 @@ Advanced channels appear only if the corresponding parameters are set in the Thi
| `wanIpAddress` | `String` | x | WAN IP Address | | `wanIpAddress` | `String` | x | WAN IP Address |
| `wanPppIpAddress` | `String` | x | WAN IP Address (if using PPP) | | `wanPppIpAddress` | `String` | x | WAN IP Address (if using PPP) |
### WAN subdevice channels ### WAN `subdevice` channels
| channel | item-type | advanced | description | | channel | item-type | advanced | description |
|----------------------------|---------------------------|:--------:|----------------------------------------------------------------| |----------------------------|---------------------------|:--------:|----------------------------------------------------------------|
@ -150,17 +157,6 @@ Advanced channels appear only if the corresponding parameters are set in the Thi
| `wanTotalBytesReceived` | `Number:DataAmount` | x | Total Bytes Received | | `wanTotalBytesReceived` | `Number:DataAmount` | x | Total Bytes Received |
| `wanTotalBytesSent` | `Number:DataAmount` | x | Total Bytes Sent | | `wanTotalBytesSent` | `Number:DataAmount` | x | Total Bytes Sent |
Parameters that accept lists (e.g. `macOnline`, `wanBlockIPs`) can contain comments.
Comments are separated from the value with a '#' (e.g. `192.168.0.77 # Daughter's iPhone`).
The full string is used for the channel label.
### Channel `callList`
Call lists are provided for one or more days (as configured) as JSON.
The JSON consists of an array of individual calls with the fields `date`, `type`, `localNumber`, `remoteNumber`, `duration`.
The call-types are the same as provided by the FritzBox, i.e. `1` (inbound), `2` (missed), `3` (outbound), `10` (rejected).
## `PHONEBOOK` Profile ## `PHONEBOOK` Profile
The binding provides a profile for using the FritzBox phonebooks for resolving numbers to names. The binding provides a profile for using the FritzBox phonebooks for resolving numbers to names.