Document new attributes (#4042)

* Document new attributes

Add documentation for the new attributes `transmission_rate_upstream` and `transmission_rate_downstream`.

* Shorter names
This commit is contained in:
Sven-Hendrik Haase 2017-11-22 08:41:07 +01:00 committed by Fabian Affolter
parent 5dc71643b8
commit daf517b0c0

View File

@ -34,16 +34,18 @@ Configuration variables:
The following statistics will be exposed as attributes. The following statistics will be exposed as attributes.
|Attribute |Description | |Attribute |Description |
|:-----------------|:------------------------------------------------------------| |:----------------------|:------------------------------------------------------------|
|is_linked |True if the FritzBox is physically linked to the provider | |is_linked |True if the FritzBox is physically linked to the provider |
|is_connected |True if the FritzBox has established an internet-connection | |is_connected |True if the FritzBox has established an internet-connection |
|wan_access_type |Connection-type, can be `DSL` or `Cable` | |wan_access_type |Connection-type, can be `DSL` or `Cable` |
|external_ip |External ip address | |external_ip |External ip address |
|uptime |Uptime in seconds | |uptime |Uptime in seconds |
|bytes_sent |Bytes sent | |bytes_sent |Bytes sent |
|bytes_received |Bytes received | |bytes_received |Bytes received |
|max_byte_rate_up |Maximum upstream-rate in bytes/s | |transmission_rate_up |Current upstream speed in bytes/s |
|max_byte_rate_down|Maximum downstream-rate in bytes/s | |transmission_rate_down |Current downstream speed in bytes/s |
|max_byte_rate_up |Maximum upstream-rate in bytes/s |
|max_byte_rate_down |Maximum downstream-rate in bytes/s |
The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost). The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost).