-
-
Notifications
You must be signed in to change notification settings - Fork 37.8k
update broadlink.py to add support for MP1 switch #9222
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 9 commits
055fc5b
b9cb96b
2649cad
54467a4
47a1c81
4cd6a81
6e4ffad
448416f
37f9bc7
0d67060
4118aca
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,16 +14,20 @@ | |
| import voluptuous as vol | ||
|
|
||
| from homeassistant.util.dt import utcnow | ||
| from homeassistant.util import Throttle | ||
| from homeassistant.components.switch import (SwitchDevice, PLATFORM_SCHEMA) | ||
| from homeassistant.const import ( | ||
| CONF_FRIENDLY_NAME, CONF_SWITCHES, CONF_COMMAND_OFF, CONF_COMMAND_ON, | ||
| CONF_FRIENDLY_NAME, CONF_SWITCHES, CONF_SLOTS, | ||
| CONF_COMMAND_OFF, CONF_COMMAND_ON, | ||
| CONF_TIMEOUT, CONF_HOST, CONF_MAC, CONF_TYPE) | ||
| import homeassistant.helpers.config_validation as cv | ||
|
|
||
| REQUIREMENTS = ['broadlink==0.5'] | ||
|
|
||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
| TIME_BETWEEN_UPDATES = timedelta(seconds=5) | ||
|
|
||
| DOMAIN = 'broadlink' | ||
| DEFAULT_NAME = 'Broadlink switch' | ||
| DEFAULT_TIMEOUT = 10 | ||
|
|
@@ -36,18 +40,27 @@ | |
| 'rm2_pro_plus_bl', 'rm_mini_shate'] | ||
| SP1_TYPES = ['sp1'] | ||
| SP2_TYPES = ['sp2', 'honeywell_sp2', 'sp3', 'spmini2', 'spminiplus'] | ||
| MP1_TYPES = ["mp1"] | ||
|
|
||
| SWITCH_TYPES = RM_TYPES + SP1_TYPES + SP2_TYPES | ||
| SWITCH_TYPES = RM_TYPES + SP1_TYPES + SP2_TYPES + MP1_TYPES | ||
|
|
||
| SWITCH_SCHEMA = vol.Schema({ | ||
| vol.Optional(CONF_COMMAND_OFF, default=None): cv.string, | ||
| vol.Optional(CONF_COMMAND_ON, default=None): cv.string, | ||
| vol.Optional(CONF_FRIENDLY_NAME): cv.string, | ||
| }) | ||
|
|
||
| MP1_SWITCH_SLOT_SCHEMA = vol.Schema({ | ||
| vol.Optional('slot_1', default=None): cv.string, | ||
| vol.Optional('slot_2', default=None): cv.string, | ||
| vol.Optional('slot_3', default=None): cv.string, | ||
| vol.Optional('slot_4', default=None): cv.string | ||
| }) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do not set default
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. removed. btw, could u explain why we should not set default |
||
|
|
||
| PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ | ||
| vol.Optional(CONF_SWITCHES, default={}): | ||
| vol.Schema({cv.slug: SWITCH_SCHEMA}), | ||
| vol.Optional(CONF_SLOTS, default={}): MP1_SWITCH_SLOT_SCHEMA, | ||
| vol.Required(CONF_HOST): cv.string, | ||
| vol.Required(CONF_MAC): cv.string, | ||
| vol.Optional(CONF_FRIENDLY_NAME, default=DEFAULT_NAME): cv.string, | ||
|
|
@@ -60,6 +73,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None): | |
| """Set up Broadlink switches.""" | ||
| import broadlink | ||
| devices = config.get(CONF_SWITCHES, {}) | ||
| slots = config.get('slots', {}) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No need to specify default, the platform schema provides a default. |
||
| ip_addr = config.get(CONF_HOST) | ||
| friendly_name = config.get(CONF_FRIENDLY_NAME) | ||
| mac_addr = binascii.unhexlify( | ||
|
|
@@ -114,6 +128,11 @@ def _send_packet(call): | |
| if retry == DEFAULT_RETRY-1: | ||
| _LOGGER.error("Failed to send packet to device") | ||
|
|
||
| def _get_mp1_slot_name(switch_friendly_name, slot): | ||
| if not slots['slot_' + str(slot)]: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use string |
||
| return switch_friendly_name + ' slot ' + str(slot) | ||
| return slots['slot_' + str(slot)] | ||
|
|
||
| if switch_type in RM_TYPES: | ||
| broadlink_device = broadlink.rm((ip_addr, 80), mac_addr) | ||
| hass.services.register(DOMAIN, SERVICE_LEARN + '_' + | ||
|
|
@@ -136,6 +155,15 @@ def _send_packet(call): | |
| elif switch_type in SP2_TYPES: | ||
| broadlink_device = broadlink.sp2((ip_addr, 80), mac_addr) | ||
| switches = [BroadlinkSP2Switch(friendly_name, broadlink_device)] | ||
| elif switch_type in MP1_TYPES: | ||
| switches = [] | ||
| broadlink_device = broadlink.mp1((ip_addr, 80), mac_addr) | ||
| parent_device = BroadlinkMP1Switch(broadlink_device) | ||
| for i in range(1, 5): | ||
| slot = BroadlinkMP1Slot( | ||
| _get_mp1_slot_name(friendly_name, i), | ||
| broadlink_device, i, parent_device) | ||
| switches.append(slot) | ||
|
|
||
| broadlink_device.timeout = config.get(CONF_TIMEOUT) | ||
| try: | ||
|
|
@@ -268,3 +296,84 @@ def _update(self, retry=2): | |
| if state is None and retry > 0: | ||
| return self._update(retry-1) | ||
| self._state = state | ||
|
|
||
|
|
||
| class BroadlinkMP1Slot(BroadlinkRMSwitch): | ||
| """Representation of a slot of Broadlink switch.""" | ||
|
|
||
| def __init__(self, friendly_name, device, slot, parent_device): | ||
| """Initialize the slot of switch.""" | ||
| super().__init__(friendly_name, device, None, None) | ||
| self._command_on = 1 | ||
| self._command_off = 0 | ||
| self._slot = slot | ||
| self._parent_device = parent_device | ||
|
|
||
| @property | ||
| def assumed_state(self): | ||
| """Return true if unable to access real state of entity.""" | ||
| return False | ||
|
|
||
| def _sendpacket(self, packet, retry=2): | ||
| """Send packet to device.""" | ||
| try: | ||
| self._device.set_power(self._slot, packet) | ||
| except (socket.timeout, ValueError) as error: | ||
| if retry < 1: | ||
| _LOGGER.error(error) | ||
| return False | ||
| if not self._auth(): | ||
| return False | ||
| return self._sendpacket(packet, max(0, retry-1)) | ||
| return True | ||
|
|
||
| @property | ||
| def should_poll(self): | ||
| """Polling needed.""" | ||
| return True | ||
|
|
||
| def update(self): | ||
| """Trigger update for all switches on the parent device.""" | ||
| self._parent_device.update() | ||
| self._state = self._parent_device.get_outlet_status(self._slot) | ||
|
|
||
|
|
||
| class BroadlinkMP1Switch(object): | ||
| """Representation of a Broadlink switch - To fetch states of all slots.""" | ||
|
|
||
| def __init__(self, device): | ||
| """Initialize the switch.""" | ||
| self._device = device | ||
| self._states = None | ||
|
|
||
| def get_outlet_status(self, slot): | ||
| """Get status of outlet from cached status list.""" | ||
| return self._states['s' + str(slot)] | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For string concatenation, please use the return self._states['s{}'.format(slot)] |
||
|
|
||
| @Throttle(TIME_BETWEEN_UPDATES) | ||
| def update(self): | ||
| """Fetch new state data for this device.""" | ||
| self._update() | ||
|
|
||
| def _update(self, retry=2): | ||
| try: | ||
| states = self._device.check_power() | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we here will ask for the same data 4 times (once for each slot).
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. updated |
||
| except (socket.timeout, ValueError) as error: | ||
| if retry < 1: | ||
| _LOGGER.error(error) | ||
| return | ||
| if not self._auth(): | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you try to get this kind of logic added to the broadlink lib that is being used? It would be more suitable to be added there.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would do it in other PR and let people who know more about broadlink lib do it. I am not familiar with it :( |
||
| return | ||
| return self._update(max(0, retry-1)) | ||
| if states is None and retry > 0: | ||
| return self._update(max(0, retry-1)) | ||
| self._states = states | ||
|
|
||
| def _auth(self, retry=2): | ||
| try: | ||
| auth = self._device.auth() | ||
| except socket.timeout: | ||
| auth = False | ||
| if not auth and retry > 0: | ||
| return self._auth(retry-1) | ||
| return auth | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -148,6 +148,7 @@ | |
| CONF_STATE = 'state' | ||
| CONF_STRUCTURE = 'structure' | ||
| CONF_SWITCHES = 'switches' | ||
| CONF_SLOTS = 'slots' | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. new config to define slot's friendly names
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's keep this in the local file instead of adding it to the general constants. |
||
| CONF_TEMPERATURE_UNIT = 'temperature_unit' | ||
| CONF_TIME_ZONE = 'time_zone' | ||
| CONF_TIMEOUT = 'timeout' | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
slot's schema to define slot's friendly names