-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for the PUREi9 Robot Vacuum (#145)
* Implemented support for the PUREi9 vacuum * Cleaned up unessessary changes * Cleaned up unessessary changes * Fixed bug introduces by cleanup * Fixed error that kept vacuum battery from updating * Added labels to all 14 robot states * Reimplemented battery state similar to speed range to allow for model dependent ranges
- Loading branch information
1 parent
dc56ed2
commit 5434f30
Showing
3 changed files
with
237 additions
and
5 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
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,151 @@ | ||
| """Vacuum platform for Wellbeing.""" | ||
|
|
||
| import asyncio | ||
| import logging | ||
| import math | ||
|
|
||
| from homeassistant.components.vacuum import StateVacuumEntity, VacuumEntityFeature | ||
| from homeassistant.components.vacuum import ( | ||
| STATE_CLEANING, | ||
| STATE_PAUSED, | ||
| STATE_RETURNING, | ||
| STATE_IDLE, | ||
| STATE_DOCKED, | ||
| STATE_ERROR, | ||
| ) | ||
| from homeassistant.const import Platform | ||
| from homeassistant.util.percentage import ranged_value_to_percentage | ||
|
|
||
| from . import WellbeingDataUpdateCoordinator | ||
| from .const import DOMAIN | ||
| from .entity import WellbeingEntity | ||
|
|
||
| _LOGGER: logging.Logger = logging.getLogger(__package__) | ||
|
|
||
| SUPPORTED_FEATURES = ( | ||
| VacuumEntityFeature.START | ||
| | VacuumEntityFeature.STOP | ||
| | VacuumEntityFeature.PAUSE | ||
| | VacuumEntityFeature.RETURN_HOME | ||
| | VacuumEntityFeature.BATTERY | ||
| ) | ||
|
|
||
| VACUUM_STATES = { | ||
| 1: STATE_CLEANING, # Regular Cleaning | ||
| 2: STATE_PAUSED, | ||
| 3: STATE_CLEANING, # Stop cleaning | ||
| 4: STATE_PAUSED, # Pause Spot cleaning | ||
| 5: STATE_RETURNING, | ||
| 6: STATE_PAUSED, # Paused returning | ||
| 7: STATE_RETURNING, # Returning for pitstop | ||
| 8: STATE_PAUSED, # Paused returning for pitstop | ||
| 9: STATE_DOCKED, # Charging | ||
| 10: STATE_IDLE, | ||
| 11: STATE_ERROR, | ||
| 12: STATE_DOCKED, # Pitstop | ||
| 13: STATE_IDLE, # Manual stearing | ||
| 14: STATE_IDLE, # Firmware upgrading | ||
| } | ||
|
|
||
| VACUUM_CHARGING_STATE = 9 # For selecting battery icon | ||
|
|
||
|
|
||
| async def async_setup_entry(hass, entry, async_add_devices): | ||
| """Setup vacuum platform.""" | ||
| coordinator = hass.data[DOMAIN][entry.entry_id] | ||
| appliances = coordinator.data.get("appliances", None) | ||
|
|
||
| if appliances is not None: | ||
| for pnc_id, appliance in appliances.appliances.items(): | ||
| async_add_devices( | ||
| [ | ||
| WellbeingVacuum( | ||
| coordinator, entry, pnc_id, entity.entity_type, entity.attr | ||
| ) | ||
| for entity in appliance.entities | ||
| if entity.entity_type == Platform.VACUUM | ||
| ] | ||
| ) | ||
|
|
||
|
|
||
| class WellbeingVacuum(WellbeingEntity, StateVacuumEntity): | ||
| """wellbeing Sensor class.""" | ||
|
|
||
| def __init__( | ||
| self, | ||
| coordinator: WellbeingDataUpdateCoordinator, | ||
| config_entry, | ||
| pnc_id, | ||
| entity_type, | ||
| entity_attr, | ||
| ): | ||
| super().__init__(coordinator, config_entry, pnc_id, entity_type, entity_attr) | ||
| self._fan_speeds = self.get_appliance.vacuum_fan_speeds | ||
|
|
||
| @property | ||
| def _battery_range(self) -> tuple[int, int]: | ||
| return self.get_appliance.battery_range | ||
|
|
||
| @property | ||
| def supported_features(self) -> int: | ||
| return SUPPORTED_FEATURES | ||
|
|
||
| @property | ||
| def state(self): | ||
| """Return the state of the vacuum.""" | ||
| return VACUUM_STATES.get(self.get_entity.state, STATE_ERROR) | ||
|
|
||
| @property | ||
| def battery_level(self): | ||
| """Return the battery level of the vacuum.""" | ||
| return ranged_value_to_percentage(self._battery_range, self.get_appliance.battery_status) | ||
|
|
||
| @property | ||
| def battery_icon(self): | ||
| """Return the battery icon of the vacuum based on the battery level.""" | ||
| level = self.battery_level | ||
| charging = self.get_entity.state == VACUUM_CHARGING_STATE | ||
| level = 10*round(level / 10) # Round level to nearest 10 for icon selection | ||
| # Special cases given available icons | ||
| if level == 100 and charging: | ||
| return "mdi:battery-charging-100" | ||
| if level == 100 and not charging: | ||
| return "mdi:battery" | ||
| if level == 0 and charging: | ||
| return "mdi:battery-charging-outline" | ||
| if level == 0 and not charging: | ||
| return "mdi:battery-alert-variant-outline" | ||
| # General case | ||
| if level > 0 and level < 100: | ||
| return "mdi:battery-" + ("charging-" if charging else "") + f"{level}" | ||
| else: | ||
| return "mdi:battery-unknown" | ||
|
|
||
| @property | ||
| def fan_speed(self): | ||
| """Return the fan speed of the vacuum cleaner.""" | ||
| return self._fan_speeds.get(self.get_appliance.power_mode, "Unknown") | ||
|
|
||
| @property | ||
| def fan_speed_list(self): | ||
| """Get the list of available fan speed steps of the vacuum cleaner.""" | ||
| return list(self._fan_speeds.values()) | ||
|
|
||
| async def async_start(self): | ||
| await self.api.command_vacuum(self.pnc_id, "play") | ||
|
|
||
| async def async_stop(self): | ||
| await self.api.command_vacuum(self.pnc_id, "stop") | ||
|
|
||
| async def async_pause(self): | ||
| await self.api.command_vacuum(self.pnc_id, "pause") | ||
|
|
||
| async def async_return_to_base(self): | ||
| await self.api.command_vacuum(self.pnc_id, "home") | ||
|
|
||
| async def async_set_fan_speed(self, fan_speed: str): | ||
| """Set the fan speed of the vacuum cleaner.""" | ||
| for mode, name in FAN_SPEEDS.items(): | ||
| if name == fan_speed: | ||
| await self.api.set_vacuum_power_mode(self.pnc_id, mode) | ||
| break |