forked from home-assistant/core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add light platform to MyQ (home-assistant#54611)
Co-authored-by: J. Nick Koston <[email protected]>
- Loading branch information
1 parent
c68253b
commit f40c672
Showing
7 changed files
with
199 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| """Support for MyQ-Enabled lights.""" | ||
| import logging | ||
|
|
||
| from pymyq.const import ( | ||
| DEVICE_STATE as MYQ_DEVICE_STATE, | ||
| DEVICE_STATE_ONLINE as MYQ_DEVICE_STATE_ONLINE, | ||
| KNOWN_MODELS, | ||
| MANUFACTURER, | ||
| ) | ||
| from pymyq.errors import MyQError | ||
|
|
||
| from homeassistant.components.light import LightEntity | ||
| from homeassistant.const import STATE_OFF, STATE_ON | ||
| from homeassistant.exceptions import HomeAssistantError | ||
| from homeassistant.helpers.update_coordinator import CoordinatorEntity | ||
|
|
||
| from .const import DOMAIN, MYQ_COORDINATOR, MYQ_GATEWAY, MYQ_TO_HASS | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| async def async_setup_entry(hass, config_entry, async_add_entities): | ||
| """Set up myq lights.""" | ||
| data = hass.data[DOMAIN][config_entry.entry_id] | ||
| myq = data[MYQ_GATEWAY] | ||
| coordinator = data[MYQ_COORDINATOR] | ||
|
|
||
| async_add_entities( | ||
| [MyQLight(coordinator, device) for device in myq.lamps.values()], True | ||
| ) | ||
|
|
||
|
|
||
| class MyQLight(CoordinatorEntity, LightEntity): | ||
| """Representation of a MyQ light.""" | ||
|
|
||
| _attr_supported_features = 0 | ||
|
|
||
| def __init__(self, coordinator, device): | ||
| """Initialize with API object, device id.""" | ||
| super().__init__(coordinator) | ||
| self._device = device | ||
| self._attr_unique_id = device.device_id | ||
| self._attr_name = device.name | ||
|
|
||
| @property | ||
| def available(self): | ||
| """Return if the device is online.""" | ||
| if not super().available: | ||
| return False | ||
|
|
||
| # Not all devices report online so assume True if its missing | ||
| return self._device.device_json[MYQ_DEVICE_STATE].get( | ||
| MYQ_DEVICE_STATE_ONLINE, True | ||
| ) | ||
|
|
||
| @property | ||
| def is_on(self): | ||
| """Return true if the light is on, else False.""" | ||
| return MYQ_TO_HASS.get(self._device.state) == STATE_ON | ||
|
|
||
| @property | ||
| def is_off(self): | ||
| """Return true if the light is off, else False.""" | ||
| return MYQ_TO_HASS.get(self._device.state) == STATE_OFF | ||
|
|
||
| async def async_turn_on(self, **kwargs): | ||
| """Issue on command to light.""" | ||
| if self.is_on: | ||
| return | ||
|
|
||
| try: | ||
| await self._device.turnon(wait_for_state=True) | ||
| except MyQError as err: | ||
| raise HomeAssistantError( | ||
| f"Turning light {self._device.name} on failed with error: {err}" | ||
| ) from err | ||
|
|
||
| # Write new state to HASS | ||
| self.async_write_ha_state() | ||
|
|
||
| async def async_turn_off(self, **kwargs): | ||
| """Issue off command to light.""" | ||
| if self.is_off: | ||
| return | ||
|
|
||
| try: | ||
| await self._device.turnoff(wait_for_state=True) | ||
| except MyQError as err: | ||
| raise HomeAssistantError( | ||
| f"Turning light {self._device.name} off failed with error: {err}" | ||
| ) from err | ||
|
|
||
| # Write opening state to HASS | ||
| self.async_write_ha_state() | ||
|
|
||
| @property | ||
| def device_info(self): | ||
| """Return the device_info of the device.""" | ||
| device_info = { | ||
| "identifiers": {(DOMAIN, self._device.device_id)}, | ||
| "name": self._device.name, | ||
| "manufacturer": MANUFACTURER, | ||
| "sw_version": self._device.firmware_version, | ||
| } | ||
| if model := KNOWN_MODELS.get(self._device.device_id[2:4]): | ||
| device_info["model"] = model | ||
| if self._device.parent_device_id: | ||
| device_info["via_device"] = (DOMAIN, self._device.parent_device_id) | ||
| return device_info | ||
|
|
||
| async def async_added_to_hass(self): | ||
| """Subscribe to updates.""" | ||
| self.async_on_remove( | ||
| self.coordinator.async_add_listener(self.async_write_ha_state) | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| """The scene tests for the myq platform.""" | ||
|
|
||
| from homeassistant.const import STATE_OFF, STATE_ON | ||
|
|
||
| from .util import async_init_integration | ||
|
|
||
|
|
||
| async def test_create_lights(hass): | ||
| """Test creation of lights.""" | ||
|
|
||
| await async_init_integration(hass) | ||
|
|
||
| state = hass.states.get("light.garage_door_light_off") | ||
| assert state.state == STATE_OFF | ||
| expected_attributes = { | ||
| "friendly_name": "Garage Door Light Off", | ||
| "supported_features": 0, | ||
| } | ||
| # Only test for a subset of attributes in case | ||
| # HA changes the implementation and a new one appears | ||
| assert all( | ||
| state.attributes[key] == expected_attributes[key] for key in expected_attributes | ||
| ) | ||
|
|
||
| state = hass.states.get("light.garage_door_light_on") | ||
| assert state.state == STATE_ON | ||
| expected_attributes = { | ||
| "friendly_name": "Garage Door Light On", | ||
| "supported_features": 0, | ||
| } | ||
| # Only test for a subset of attributes in case | ||
| # HA changes the implementation and a new one appears | ||
|
|
||
| assert all( | ||
| state.attributes[key] == expected_attributes[key] for key in expected_attributes | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters