Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.fritz.sensor Namespace Reference

Classes

class  FritzBoxSensor
 
class  FritzSensorEntityDescription
 

Functions

datetime _retrieve_connection_uptime_state (FritzStatus status, datetime|None last_value)
 
datetime _retrieve_device_uptime_state (FritzStatus status, datetime last_value)
 
str _retrieve_external_ip_state (FritzStatus status, str last_value)
 
str _retrieve_external_ipv6_state (FritzStatus status, str last_value)
 
float _retrieve_gb_received_state (FritzStatus status, str last_value)
 
float _retrieve_gb_sent_state (FritzStatus status, str last_value)
 
float _retrieve_kb_s_received_state (FritzStatus status, str last_value)
 
float _retrieve_kb_s_sent_state (FritzStatus status, str last_value)
 
float _retrieve_link_attenuation_received_state (FritzStatus status, str last_value)
 
float _retrieve_link_attenuation_sent_state (FritzStatus status, str last_value)
 
float _retrieve_link_kb_s_received_state (FritzStatus status, str last_value)
 
float _retrieve_link_kb_s_sent_state (FritzStatus status, str last_value)
 
float _retrieve_link_noise_margin_received_state (FritzStatus status, str last_value)
 
float _retrieve_link_noise_margin_sent_state (FritzStatus status, str last_value)
 
float _retrieve_max_kb_s_received_state (FritzStatus status, str last_value)
 
float _retrieve_max_kb_s_sent_state (FritzStatus status, str last_value)
 
datetime _uptime_calculation (float seconds_uptime, datetime|None last_value)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

AVM FRITZ!Box binary sensors.

Function Documentation

◆ _retrieve_connection_uptime_state()

datetime homeassistant.components.fritz.sensor._retrieve_connection_uptime_state ( FritzStatus  status,
datetime | None   last_value 
)
private
Return uptime from connection.

Definition at line 57 of file sensor.py.

◆ _retrieve_device_uptime_state()

datetime homeassistant.components.fritz.sensor._retrieve_device_uptime_state ( FritzStatus  status,
datetime   last_value 
)
private
Return uptime from device.

Definition at line 50 of file sensor.py.

◆ _retrieve_external_ip_state()

str homeassistant.components.fritz.sensor._retrieve_external_ip_state ( FritzStatus  status,
str  last_value 
)
private
Return external ip from device.

Definition at line 64 of file sensor.py.

◆ _retrieve_external_ipv6_state()

str homeassistant.components.fritz.sensor._retrieve_external_ipv6_state ( FritzStatus  status,
str  last_value 
)
private
Return external ipv6 from device.

Definition at line 69 of file sensor.py.

◆ _retrieve_gb_received_state()

float homeassistant.components.fritz.sensor._retrieve_gb_received_state ( FritzStatus  status,
str  last_value 
)
private
Return download total data.

Definition at line 99 of file sensor.py.

◆ _retrieve_gb_sent_state()

float homeassistant.components.fritz.sensor._retrieve_gb_sent_state ( FritzStatus  status,
str  last_value 
)
private
Return upload total data.

Definition at line 94 of file sensor.py.

◆ _retrieve_kb_s_received_state()

float homeassistant.components.fritz.sensor._retrieve_kb_s_received_state ( FritzStatus  status,
str  last_value 
)
private
Return download transmission rate.

Definition at line 79 of file sensor.py.

◆ _retrieve_kb_s_sent_state()

float homeassistant.components.fritz.sensor._retrieve_kb_s_sent_state ( FritzStatus  status,
str  last_value 
)
private
Return upload transmission rate.

Definition at line 74 of file sensor.py.

◆ _retrieve_link_attenuation_received_state()

float homeassistant.components.fritz.sensor._retrieve_link_attenuation_received_state ( FritzStatus  status,
str   last_value 
)
private
Return download line attenuation.

Definition at line 135 of file sensor.py.

◆ _retrieve_link_attenuation_sent_state()

float homeassistant.components.fritz.sensor._retrieve_link_attenuation_sent_state ( FritzStatus  status,
str   last_value 
)
private
Return upload line attenuation.

Definition at line 128 of file sensor.py.

◆ _retrieve_link_kb_s_received_state()

float homeassistant.components.fritz.sensor._retrieve_link_kb_s_received_state ( FritzStatus  status,
str  last_value 
)
private
Return download link rate.

Definition at line 109 of file sensor.py.

◆ _retrieve_link_kb_s_sent_state()

float homeassistant.components.fritz.sensor._retrieve_link_kb_s_sent_state ( FritzStatus  status,
str  last_value 
)
private
Return upload link rate.

Definition at line 104 of file sensor.py.

◆ _retrieve_link_noise_margin_received_state()

float homeassistant.components.fritz.sensor._retrieve_link_noise_margin_received_state ( FritzStatus  status,
str   last_value 
)
private
Return download noise margin.

Definition at line 121 of file sensor.py.

◆ _retrieve_link_noise_margin_sent_state()

float homeassistant.components.fritz.sensor._retrieve_link_noise_margin_sent_state ( FritzStatus  status,
str   last_value 
)
private
Return upload noise margin.

Definition at line 114 of file sensor.py.

◆ _retrieve_max_kb_s_received_state()

float homeassistant.components.fritz.sensor._retrieve_max_kb_s_received_state ( FritzStatus  status,
str  last_value 
)
private
Return download max transmission rate.

Definition at line 89 of file sensor.py.

◆ _retrieve_max_kb_s_sent_state()

float homeassistant.components.fritz.sensor._retrieve_max_kb_s_sent_state ( FritzStatus  status,
str  last_value 
)
private
Return upload max transmission rate.

Definition at line 84 of file sensor.py.

◆ _uptime_calculation()

datetime homeassistant.components.fritz.sensor._uptime_calculation ( float  seconds_uptime,
datetime | None  last_value 
)
private
Calculate uptime with deviation.

Definition at line 37 of file sensor.py.

◆ async_setup_entry()

None homeassistant.components.fritz.sensor.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback   async_add_entities 
)
Set up entry.

Definition at line 269 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.fritz.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 34 of file sensor.py.