Skip to content

Updated RainMachine to play better with the entity registry #12315

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.

Sign up for GitHub

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

Merged
balloob merged 2 commits into from
Feb 12, 2018
Merged

Updated RainMachine to play better with the entity registry #12315

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d19971f
Updated RainMachine to play better with the entity registry
bachya Feb 11, 2018
2d9b951
Owner-requested changes
bachya Feb 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 62 additions & 69 deletions homeassistant/components/switch/rainmachine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,16 @@
vol.All(
cv.has_at_least_one_key(CONF_IP_ADDRESS, CONF_EMAIL),
{
vol.Required(CONF_PLATFORM):
cv.string,
vol.Optional(CONF_SCAN_INTERVAL):
cv.time_period,
vol.Exclusive(CONF_IP_ADDRESS, 'auth'):
cv.string,
vol.Required(CONF_PLATFORM): cv.string,
vol.Optional(CONF_SCAN_INTERVAL): cv.time_period,
vol.Exclusive(CONF_IP_ADDRESS, 'auth'): cv.string,
vol.Exclusive(CONF_EMAIL, 'auth'):
vol.Email(), # pylint: disable=no-value-for-parameter
vol.Required(CONF_PASSWORD):
cv.string,
vol.Optional(CONF_PORT, default=DEFAULT_PORT):
cv.port,
vol.Optional(CONF_SSL, default=DEFAULT_SSL):
cv.boolean,
vol.Email(), # pylint: disable=no-value-for-parameter
vol.Required(CONF_PASSWORD): cv.string,
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
vol.Optional(CONF_ZONE_RUN_TIME, default=DEFAULT_ZONE_RUN_SECONDS):
cv.positive_int
cv.positive_int
}),
extra=vol.ALLOW_EXTRA)

Expand All @@ -56,27 +50,19 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set this component up under its platform."""
import regenmaschine as rm

ip_address = config.get(CONF_IP_ADDRESS)
_LOGGER.debug('IP address: %s', ip_address)
_LOGGER.debug('Config data: %s', config)

email_address = config.get(CONF_EMAIL)
_LOGGER.debug('Email address: %s', email_address)

password = config.get(CONF_PASSWORD)
_LOGGER.debug('Password: %s', password)

zone_run_time = config.get(CONF_ZONE_RUN_TIME)
_LOGGER.debug('Zone run time: %s', zone_run_time)
ip_address = config.get(CONF_IP_ADDRESS, None)
email_address = config.get(CONF_EMAIL, None)
password = config[CONF_PASSWORD]
zone_run_time = config[CONF_ZONE_RUN_TIME]

try:
if ip_address:
port = config.get(CONF_PORT)
_LOGGER.debug('Port: %s', port)

ssl = config.get(CONF_SSL)
_LOGGER.debug('SSL: %s', ssl)

_LOGGER.debug('Configuring local API')

port = config[CONF_PORT]
ssl = config[CONF_SSL]
auth = rm.Authenticator.create_local(
ip_address, password, port=port, https=ssl)
elif email_address:
Expand All @@ -85,32 +71,27 @@ def setup_platform(hass, config, add_devices, discovery_info=None):

_LOGGER.debug('Querying against: %s', auth.url)

_LOGGER.debug('Instantiating RainMachine client')
client = rm.Client(auth)

rainmachine_device_name = client.provision.device_name().get('name')
device_name = client.provision.device_name()['name']
device_mac = client.provision.wifi()['macAddress']

entities = []
for program in client.programs.all().get('programs'):
for program in client.programs.all().get('programs', {}):
if not program.get('active'):
continue

_LOGGER.debug('Adding program: %s', program)
entities.append(
RainMachineProgram(
client, program, device_name=rainmachine_device_name))
RainMachineProgram(client, device_name, device_mac, program))

for zone in client.zones.all().get('zones'):
for zone in client.zones.all().get('zones', {}):
if not zone.get('active'):
continue

_LOGGER.debug('Adding zone: %s', zone)
entities.append(
RainMachineZone(
client,
zone,
zone_run_time,
device_name=rainmachine_device_name, ))
RainMachineZone(client, device_name, device_mac, zone,
zone_run_time))

add_devices(entities)
except rm.exceptions.HTTPError as exc_info:
Expand Down Expand Up @@ -149,16 +130,17 @@ def decorator(function):
class RainMachineEntity(SwitchDevice):
"""A class to represent a generic RainMachine entity."""

def __init__(self, client, entity_json, **kwargs):
def __init__(self, client, device_name, device_mac, entity_json):
"""Initialize a generic RainMachine entity."""
self._api_type = 'remote' if client.auth.using_remote_api else 'local'
self._client = client
self._device_name = kwargs.get('device_name')
self._entity_json = entity_json
self.device_mac = device_mac
self.device_name = device_name

self._attrs = {
ATTR_ATTRIBUTION: '© RainMachine',
ATTR_DEVICE_CLASS: self._device_name
ATTR_DEVICE_CLASS: self.device_name
}

@property
Expand All @@ -173,15 +155,10 @@ def is_enabled(self) -> bool:
return self._entity_json.get('active')

@property
def rainmachine_id(self) -> int:
def rainmachine_entity_id(self) -> int:
"""Return the RainMachine ID for this entity."""
return self._entity_json.get('uid')

@property
def unique_id(self) -> str:
"""Return a unique, HASS-friendly identifier for this entity."""
return self.rainmachine_id

@aware_throttle('local')
def _local_update(self) -> None:
"""Call an update with scan times appropriate for the local API."""
Expand Down Expand Up @@ -217,56 +194,62 @@ def name(self) -> str:
"""Return the name of the program."""
return 'Program: {}'.format(self._entity_json.get('name'))

@property
def unique_id(self) -> str:
"""Return a unique, HASS-friendly identifier for this entity."""
return '{0}_program_{1}'.format(self.device_mac.replace(':', ''),

@balloob balloob Feb 11, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't just the uid be enough? (assuming that stands for "unique id". Also just the MAC would be enough.

@bachya bachya Feb 11, 2018

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would love your thoughts:

There are situations where one might have multiple sprinkler controllers (e.g., I have one and I manage one at another property, all through the same HASS interface). Let's say we have a program called "Landscaping" as the first program (UID: 1) for each controller – wouldn't there need to be some way to differentiate? I was thinking that the combination of the device MAC and the program/zone UID would cover everything. If that's overkill, let me know.

@balloob balloob Feb 11, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I didn't realize that uid was unique per instance. Combining it is 👍

self.rainmachine_entity_id)

def turn_off(self, **kwargs) -> None:
"""Turn the program off."""
import regenmaschine.exceptions as exceptions

try:
self._client.programs.stop(self.rainmachine_id)
self._client.programs.stop(self.rainmachine_entity_id)
except exceptions.BrokenAPICall:
_LOGGER.error('programs.stop currently broken in remote API')
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to turn off program "%s"',
self.rainmachine_id)
self.rainmachine_entity_id)
_LOGGER.debug(exc_info)

def turn_on(self, **kwargs) -> None:
"""Turn the program on."""
import regenmaschine.exceptions as exceptions

try:
self._client.programs.start(self.rainmachine_id)
self._client.programs.start(self.rainmachine_entity_id)
except exceptions.BrokenAPICall:
_LOGGER.error('programs.start currently broken in remote API')
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to turn on program "%s"',
self.rainmachine_id)
self.rainmachine_entity_id)
_LOGGER.debug(exc_info)

def _update(self) -> None:
"""Update info for the program."""
import regenmaschine.exceptions as exceptions

try:
self._entity_json = self._client.programs.get(self.rainmachine_id)
self._entity_json = self._client.programs.get(
self.rainmachine_entity_id)
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to update info for program "%s"',
self.rainmachine_id)
self.rainmachine_entity_id)

@balloob balloob Feb 11, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to refer to the entity ID, since that is how it is known inside Home Assistant

_LOGGER.debug(exc_info)


class RainMachineZone(RainMachineEntity):
"""A RainMachine zone."""

def __init__(self, client, zone_json, zone_run_time, **kwargs):
def __init__(self, client, device_name, device_mac, zone_json,
zone_run_time):
"""Initialize a RainMachine zone."""
super().__init__(client, zone_json, **kwargs)
super().__init__(client, device_name, device_mac, zone_json)
self._run_time = zone_run_time
self._attrs.update({
ATTR_CYCLES:
self._entity_json.get('noOfCycles'),
ATTR_TOTAL_DURATION:
self._entity_json.get('userDuration')
ATTR_CYCLES: self._entity_json.get('noOfCycles'),
ATTR_TOTAL_DURATION: self._entity_json.get('userDuration')
})

@property
Expand All @@ -279,33 +262,43 @@ def name(self) -> str:
"""Return the name of the zone."""
return 'Zone: {}'.format(self._entity_json.get('name'))

@property
def unique_id(self) -> str:
"""Return a unique, HASS-friendly identifier for this entity."""
return '{0}_zone_{1}'.format(self.device_mac.replace(':', ''),
self.rainmachine_entity_id)

def turn_off(self, **kwargs) -> None:
"""Turn the zone off."""
import regenmaschine.exceptions as exceptions

try:
self._client.zones.stop(self.rainmachine_id)
self._client.zones.stop(self.rainmachine_entity_id)
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to turn off zone "%s"', self.rainmachine_id)
_LOGGER.error('Unable to turn off zone "%s"',
self.rainmachine_entity_id)
_LOGGER.debug(exc_info)

def turn_on(self, **kwargs) -> None:
"""Turn the zone on."""
import regenmaschine.exceptions as exceptions

try:
self._client.zones.start(self.rainmachine_id, self._run_time)
self._client.zones.start(self.rainmachine_entity_id,
self._run_time)
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to turn on zone "%s"', self.rainmachine_id)
_LOGGER.error('Unable to turn on zone "%s"',
self.rainmachine_entity_id)
_LOGGER.debug(exc_info)

def _update(self) -> None:
"""Update info for the zone."""
import regenmaschine.exceptions as exceptions

try:
self._entity_json = self._client.zones.get(self.rainmachine_id)
self._entity_json = self._client.zones.get(
self.rainmachine_entity_id)
except exceptions.HTTPError as exc_info:
_LOGGER.error('Unable to update info for zone "%s"',
self.rainmachine_id)
self.rainmachine_entity_id)
_LOGGER.debug(exc_info)