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

Classes

class  DSMREntity
 
class  DSMRSensorEntityDescription
 
class  MbusDeviceType
 

Functions

None async_setup_entry (HomeAssistant hass, DsmrConfigEntry entry, AddEntitiesCallback async_add_entities)
 
Generator[DSMREntitycreate_mbus_entities (HomeAssistant hass, Telegram telegram, ConfigEntry entry, str dsmr_version)
 
tuple[SensorDeviceClass|None, str|None] device_class_and_uom (Telegram|MbusDevice data, DSMRSensorEntityDescription entity_description)
 
DSMRObject|None get_dsmr_object (Telegram|None telegram, int mbus_id, str obis_reference)
 
bool is_supported_description (Telegram|MbusDevice data, DSMRSensorEntityDescription description, str dsmr_version)
 
None rename_old_gas_to_mbus (HomeAssistant hass, ConfigEntry entry, str mbus_device_id)
 

Variables

string EVENT_FIRST_TELEGRAM = "dsmr_first_telegram_{}"
 
dictionary UNIT_CONVERSION = {"m3": UnitOfVolume.CUBIC_METERS}
 

Detailed Description

Support for Dutch Smart Meter (also known as Smartmeter or P1 port).

Function Documentation

◆ async_setup_entry()

None homeassistant.components.dsmr.sensor.async_setup_entry ( HomeAssistant  hass,
DsmrConfigEntry  entry,
AddEntitiesCallback   async_add_entities 
)
Set up the DSMR sensor.

Definition at line 545 of file sensor.py.

◆ create_mbus_entities()

Generator[DSMREntity] homeassistant.components.dsmr.sensor.create_mbus_entities ( HomeAssistant  hass,
Telegram  telegram,
ConfigEntry  entry,
str   dsmr_version 
)
Create MBUS Entities.

Definition at line 496 of file sensor.py.

◆ device_class_and_uom()

tuple[SensorDeviceClass | None, str | None] homeassistant.components.dsmr.sensor.device_class_and_uom ( Telegram | MbusDevice  data,
DSMRSensorEntityDescription  entity_description 
)
Get native unit of measurement from telegram,.

Definition at line 425 of file sensor.py.

◆ get_dsmr_object()

DSMRObject | None homeassistant.components.dsmr.sensor.get_dsmr_object ( Telegram | None  telegram,
int  mbus_id,
str   obis_reference 
)
Extract DSMR object from telegram.

Definition at line 529 of file sensor.py.

◆ is_supported_description()

bool homeassistant.components.dsmr.sensor.is_supported_description ( Telegram | MbusDevice  data,
DSMRSensorEntityDescription  description,
str  dsmr_version 
)
Check if this is a supported description for this telegram.

Definition at line 485 of file sensor.py.

◆ rename_old_gas_to_mbus()

None homeassistant.components.dsmr.sensor.rename_old_gas_to_mbus ( HomeAssistant  hass,
ConfigEntry  entry,
str   mbus_device_id 
)
Rename old gas sensor to mbus variant.

Definition at line 442 of file sensor.py.

Variable Documentation

◆ EVENT_FIRST_TELEGRAM

string homeassistant.components.dsmr.sensor.EVENT_FIRST_TELEGRAM = "dsmr_first_telegram_{}"

Definition at line 67 of file sensor.py.

◆ UNIT_CONVERSION

dictionary homeassistant.components.dsmr.sensor.UNIT_CONVERSION = {"m3": UnitOfVolume.CUBIC_METERS}

Definition at line 69 of file sensor.py.