97 lines
2.9 KiB
Python
97 lines
2.9 KiB
Python
"""
|
|
Demo fan platform that has a fake fan.
|
|
|
|
For more details about this platform, please refer to the documentation
|
|
https://home-assistant.io/components/demo/
|
|
"""
|
|
from homeassistant.components.fan import (SPEED_LOW, SPEED_MEDIUM, SPEED_HIGH,
|
|
FanEntity, SUPPORT_SET_SPEED,
|
|
SUPPORT_OSCILLATE, SUPPORT_DIRECTION)
|
|
from homeassistant.const import STATE_OFF
|
|
|
|
FULL_SUPPORT = SUPPORT_SET_SPEED | SUPPORT_OSCILLATE | SUPPORT_DIRECTION
|
|
LIMITED_SUPPORT = SUPPORT_SET_SPEED
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config, add_devices_callback, discovery_info=None):
|
|
"""Set up the demo fan platform."""
|
|
add_devices_callback([
|
|
DemoFan(hass, "Living Room Fan", FULL_SUPPORT),
|
|
DemoFan(hass, "Ceiling Fan", LIMITED_SUPPORT),
|
|
])
|
|
|
|
|
|
class DemoFan(FanEntity):
|
|
"""A demonstration fan component."""
|
|
|
|
def __init__(self, hass, name: str, supported_features: int) -> None:
|
|
"""Initialize the entity."""
|
|
self.hass = hass
|
|
self._supported_features = supported_features
|
|
self._speed = STATE_OFF
|
|
self.oscillating = None
|
|
self.direction = None
|
|
self._name = name
|
|
|
|
if supported_features & SUPPORT_OSCILLATE:
|
|
self.oscillating = False
|
|
if supported_features & SUPPORT_DIRECTION:
|
|
self.direction = "forward"
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""Get entity name."""
|
|
return self._name
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed for a demo fan."""
|
|
return False
|
|
|
|
@property
|
|
def speed(self) -> str:
|
|
"""Return the current speed."""
|
|
return self._speed
|
|
|
|
@property
|
|
def speed_list(self) -> list:
|
|
"""Get the list of available speeds."""
|
|
return [STATE_OFF, SPEED_LOW, SPEED_MEDIUM, SPEED_HIGH]
|
|
|
|
def turn_on(self, speed: str=None) -> None:
|
|
"""Turn on the entity."""
|
|
if speed is None:
|
|
speed = SPEED_MEDIUM
|
|
self.set_speed(speed)
|
|
|
|
def turn_off(self) -> None:
|
|
"""Turn off the entity."""
|
|
self.oscillate(False)
|
|
self.set_speed(STATE_OFF)
|
|
|
|
def set_speed(self, speed: str) -> None:
|
|
"""Set the speed of the fan."""
|
|
self._speed = speed
|
|
self.schedule_update_ha_state()
|
|
|
|
def set_direction(self, direction: str) -> None:
|
|
"""Set the direction of the fan."""
|
|
self.direction = direction
|
|
self.schedule_update_ha_state()
|
|
|
|
def oscillate(self, oscillating: bool) -> None:
|
|
"""Set oscillation."""
|
|
self.oscillating = oscillating
|
|
self.schedule_update_ha_state()
|
|
|
|
@property
|
|
def current_direction(self) -> str:
|
|
"""Fan direction."""
|
|
return self.direction
|
|
|
|
@property
|
|
def supported_features(self) -> int:
|
|
"""Flag supported features."""
|
|
return self._supported_features
|