Part 2: Add signal sensor (#34406)

This commit is contained in:
Oscar Calvo 2020-06-22 20:41:55 -07:00 committed by GitHub
parent 63baf6fb0f
commit 82058f0b50
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 100 additions and 4 deletions

View file

@ -1,4 +1,5 @@
"""The sms component.""" """The sms component."""
import asyncio
import logging import logging
import voluptuous as vol import voluptuous as vol
@ -13,6 +14,8 @@ from .gateway import create_sms_gateway
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
PLATFORMS = ["sensor"]
CONFIG_SCHEMA = vol.Schema( CONFIG_SCHEMA = vol.Schema(
{DOMAIN: vol.Schema({vol.Required(CONF_DEVICE): cv.isdevice})}, {DOMAIN: vol.Schema({vol.Required(CONF_DEVICE): cv.isdevice})},
extra=vol.ALLOW_EXTRA, extra=vol.ALLOW_EXTRA,
@ -44,13 +47,27 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
if not gateway: if not gateway:
return False return False
hass.data[DOMAIN][SMS_GATEWAY] = gateway hass.data[DOMAIN][SMS_GATEWAY] = gateway
for component in PLATFORMS:
hass.async_create_task(
hass.config_entries.async_forward_entry_setup(entry, component)
)
return True return True
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry): async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
"""Unload a config entry.""" """Unload a config entry."""
unload_ok = all(
await asyncio.gather(
*[
hass.config_entries.async_forward_entry_unload(entry, component)
for component in PLATFORMS
]
)
)
gateway = hass.data[DOMAIN].pop(SMS_GATEWAY) if unload_ok:
await gateway.terminate_async() gateway = hass.data[DOMAIN].pop(SMS_GATEWAY)
return True await gateway.terminate_async()
return unload_ok

View file

@ -24,6 +24,10 @@ class Gateway:
"""Get the IMEI of the device.""" """Get the IMEI of the device."""
return await self._worker.get_imei_async() return await self._worker.get_imei_async()
async def get_signal_quality_async(self):
"""Get the current signal level of the modem."""
return await self._worker.get_signal_quality_async()
async def terminate_async(self): async def terminate_async(self):
"""Terminate modem connection.""" """Terminate modem connection."""
return await self._worker.terminate_async() return await self._worker.terminate_async()

View file

@ -0,0 +1,76 @@
"""Support for SMS dongle sensor."""
import logging
import gammu # pylint: disable=import-error, no-member
from homeassistant.const import DEVICE_CLASS_SIGNAL_STRENGTH
from homeassistant.helpers.entity import Entity
from .const import DOMAIN, SMS_GATEWAY
_LOGGER = logging.getLogger(__name__)
async def async_setup_entry(hass, config_entry, async_add_entities):
"""Set up the GSM Signal Sensor sensor."""
gateway = hass.data[DOMAIN][SMS_GATEWAY]
entities = []
imei = await gateway.get_imei_async()
name = f"gsm_signal_imei_{imei}"
entities.append(GSMSignalSensor(hass, gateway, name,))
async_add_entities(entities, True)
class GSMSignalSensor(Entity):
"""Implementation of a GSM Signal sensor."""
def __init__(
self, hass, gateway, name,
):
"""Initialize the GSM Signal sensor."""
self._hass = hass
self._gateway = gateway
self._name = name
self._state = None
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def unit_of_measurement(self):
"""Return the unit the value is expressed in."""
return "dB"
@property
def device_class(self):
"""Return the class of this sensor."""
return DEVICE_CLASS_SIGNAL_STRENGTH
@property
def available(self):
"""Return if the sensor data are available."""
return self._state is not None
@property
def state(self):
"""Return the state of the device."""
return self._state["SignalStrength"]
async def async_update(self):
"""Get the latest data from the modem."""
try:
self._state = await self._gateway.get_signal_quality_async()
except gammu.GSMError as exc: # pylint: disable=no-member
_LOGGER.error("Failed to read signal quality: %s", exc)
@property
def device_state_attributes(self):
"""Return the sensor attributes."""
return self._state
@property
def entity_registry_enabled_default(self) -> bool:
"""Return if the entity should be enabled when first added to the entity registry."""
return False

View file

@ -14,6 +14,5 @@
"already_configured": "[%key:common::config_flow::abort::already_configured_device%]", "already_configured": "[%key:common::config_flow::abort::already_configured_device%]",
"single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]" "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]"
} }
} }
} }