Add LaCrosse sensor platform #10195

hthiery · 2017-10-28T21:07:21Z

Signed-off-by: Heiko Thiery [email protected]

Description:

Pull request in home-assistant.github.io with documentation: home-assistant/home-assistant.io#3829

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: lacrosse
    sensors:
      wohnzimmer_temperature:
        friendly_name: Wohnzimmer Temperatur
        type: temperature
        id: 60
      wohnzimmer_humidity:
        friendly_name: Wohnzimmer Luftfeuchtigkeit
        type: humidity
        id: 60
      wohnzimmer_battery:
        friendly_name: Wohnzimmer Sensor Batterie
        type: battery
        id: 60

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant · 2017-10-28T21:07:21Z

Hi @hthiery,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+            self._expiration_trigger = async_track_point_in_utc_time(
+                self.hass, self.value_is_expired, expiration_at)
+
+        self._temperature = round(lacrosse_sensor.temperature * 2) /2


missing whitespace around operator

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+        return self._name
+
+
+    def update(self, *args):


too many blank lines (2)

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+        self._expiration_trigger = None
+
+        lacrosse.register_callback(int(self._config["id"]),
+            self._callback_lacrosse, None)


continuation line under-indented for visual indent

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+            expire_after, config):
+        self.hass = hass
+        self.entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, device_id,
+                                                      hass=hass)


continuation line over-indented for visual indent

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+    _new_battery = None
+
+    def __init__(self, hass, lacrosse, device_id, friendly_name,
+            expire_after, config):


continuation line under-indented for visual indent

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+
+    add_devices(sensors)
+
+def close_serial_port(*args):


expected 2 blank lines, found 1

houndci-bot · 2017-10-28T21:07:24Z

homeassistant/components/sensor/lacrosse.py

+        )
+
+
+    if not sensors:


too many blank lines (2)

houndci-bot · 2017-10-28T21:07:25Z

homeassistant/components/sensor/lacrosse.py

+
+lacrosse = None
+
+def setup_platform(hass, config, add_devices, discovery_info=None):


expected 2 blank lines, found 1

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant · 2017-10-28T21:13:57Z

Hi @hthiery,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-10-28T21:14:04Z

homeassistant/components/sensor/lacrosse.py

+        self._expiration_trigger = None
+
+        lacrosse.register_callback(int(self._config["id"]), \
+            self._callback_lacrosse, None)


continuation line under-indented for visual indent

houndci-bot · 2017-10-28T21:14:04Z

homeassistant/components/sensor/lacrosse.py

+        self._expire_after = expire_after
+        self._expiration_trigger = None
+
+        lacrosse.register_callback(int(self._config["id"]), \


the backslash is redundant between brackets

houndci-bot · 2017-10-28T21:14:04Z

homeassistant/components/sensor/lacrosse.py

+    def __init__(self, hass, lacrosse, device_id, friendly_name, \
+            expire_after, config):
+        self.hass = hass
+        self.entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, \


the backslash is redundant between brackets

houndci-bot · 2017-10-28T21:14:04Z

homeassistant/components/sensor/lacrosse.py

+    _new_battery = None
+
+    def __init__(self, hass, lacrosse, device_id, friendly_name, \
+            expire_after, config):


continuation line under-indented for visual indent

houndci-bot · 2017-10-28T21:14:04Z

homeassistant/components/sensor/lacrosse.py

+    _low_battery = None
+    _new_battery = None
+
+    def __init__(self, hass, lacrosse, device_id, friendly_name, \


the backslash is redundant between brackets

Signed-off-by: Heiko Thiery <[email protected]>

houndci-bot · 2017-10-29T11:28:42Z

homeassistant/components/sensor/lacrosse.py

+
+
+
+class LaCrosseSensor(Entity):


too many blank lines (4)

Signed-off-by: Heiko Thiery <[email protected]>

hthiery · 2017-10-29T18:37:55Z

Currently I cannot figure out why build fails. Has anyone an idea?

Signed-off-by: Heiko Thiery <[email protected]>

fabaff · 2017-10-30T16:46:17Z

homeassistant/components/sensor/lacrosse.py

+    def state(self):
+        """Return the state of the sensor."""
+        if self._low_battery is None:
+            state = 'na/a'


I guess that is like None.

fabaff · 2017-10-30T16:46:59Z

homeassistant/components/sensor/lacrosse.py

+        return icon
+
+
+TYPE_CLASSES = {


Could you please move that to the file header.

If I move this to the beginning of the file I get the following error;
NameError: name 'LaCrosseTemperature' is not defined.
So that was the reason to keep the dict at the end. Any suggestions how to handle this?

fabaff · 2017-10-30T16:47:32Z

homeassistant/components/sensor/lacrosse.py

+                                                  device_id, hass=hass)
+        self._config = config
+        self._name = friendly_name
+        self._value = STATE_UNKNOWN


Set it to None and let Home Assistant handle it.

fabaff · 2017-10-30T16:48:34Z

homeassistant/components/sensor/lacrosse.py

+
+    usb_device = config.get(CONF_DEVICE, DEFAULT_DEVICE)
+    baud = int(config.get(CONF_BAUD, DEFAULT_BAUD))
+    expire_after = config.get(CONF_EXPIRE_AFTER, DEFAULT_EXPIRE_AFTER)


The configuration validation is already setting the default.

fabaff · 2017-10-30T16:49:40Z

homeassistant/components/sensor/lacrosse.py

+SENSOR_SCHEMA = vol.Schema({
+    vol.Required(CONF_TYPE): vol.In(TYPES),
+    vol.Required(CONF_ID): cv.positive_int,
+    vol.Optional(CONF_FRIENDLY_NAME): cv.string,


Please use CONF_NAME to be in sync with a bunch of other platforms.

fabaff · 2017-10-30T16:52:25Z

homeassistant/components/sensor/lacrosse.py

+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Optional(CONF_DEVICE, default=DEFAULT_DEVICE): cv.string,
+    vol.Optional(CONF_BAUD, default=DEFAULT_BAUD): cv.string,


You need something like vol.Required(CONF_SENSORS): vol.Schema({cv.slug: SENSOR_SCHEMA}), in the platform validation.

fabaff · 2017-10-30T16:53:49Z

homeassistant/components/sensor/lacrosse.py

+
+_LOGGER = logging.getLogger(__name__)
+
+DOMAIN = 'lacrosse'


fabaff · 2017-10-30T16:55:21Z

homeassistant/components/sensor/lacrosse.py

+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the LaCrosse component."""


Must be something like """Set up the.... Docstrings need to pass PEP257 validation.

Signed-off-by: Heiko Thiery <[email protected]>

fabaff · 2017-10-31T11:35:49Z

homeassistant/components/sensor/lacrosse.py

+        try:
+            sensor_class = TYPE_CLASSES[typ]
+        except KeyError:
+            _LOGGER.exception("Unknown LaCrosse sensor type: %s", typ)


Not needed as the validation only allows TYPES.

Signed-off-by: Heiko Thiery <[email protected]>

hthiery · 2017-11-02T07:47:45Z

Do I need to add tests for the PR?

fabaff · 2017-11-02T08:15:39Z

You could if you want. It's not a requirement as you depend on a module and often the module itself contains already tests.

hthiery · 2017-11-02T11:46:24Z

Ok that means I can remove the checkbox for tests from the checklist?

fabaff · 2017-11-02T14:33:30Z

Oh, you were talking about the local tox tests. We run tox on the Pull requests automatically. If a local tests fails the chances are high that it will fails here too.

fabaff

Thanks 🐦

MartinHjelmare

If the devices use callbacks to update state, you should set should_poll to False on the entities.

MartinHjelmare · 2017-11-03T11:21:52Z

homeassistant/components/sensor/lacrosse.py

+            ENTITY_ID_FORMAT, device_id, hass=hass)
+        self._config = config
+        self._name = name
+        self._value = None


This doesn't seem to be used, only assigned.

MartinHjelmare · 2017-11-03T11:25:05Z

homeassistant/components/sensor/lacrosse.py

+        """Return the name of the sensor."""
+        return self._name
+
+    def update(self, *args):


Remove this if you don't need it.

MartinHjelmare · 2017-11-03T11:29:23Z

homeassistant/components/sensor/lacrosse.py

+    def __init__(self, hass, lacrosse, device_id, name, expire_after, config):
+        """Initialize the sensor."""
+        self.hass = hass
+        self.entity_id = async_generate_entity_id(


You should not use the async version of the function, since it will be called from within a thread. Just use generate_entity_id instead.

MartinHjelmare · 2017-11-03T11:44:12Z

homeassistant/components/sensor/lacrosse.py

+        self._expire_after = expire_after
+        self._expiration_trigger = None
+
+        lacrosse.register_callback(


It might be safer to move the registering of the callback into the coroutine method async_added_to_hass that you can define on the entity. Reason is you need access to the hass object in the callback.

Initial commit of LaCrosse sensor component

f472916

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added new-platform platform: sensor.lacrosse cla-needed labels Oct 28, 2017

houndci-bot reviewed Oct 28, 2017

View reviewed changes

fix review comments from houndci-bot

fd54729

Signed-off-by: Heiko Thiery <[email protected]>

balloobbot added the platform label Oct 28, 2017

houndci-bot reviewed Oct 28, 2017

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Oct 28, 2017

fix review comments from houndci-bot

37a2d0a

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added the cla-signed label Oct 28, 2017

hthiery added 4 commits October 29, 2017 06:52

add pylacrosse version to REQUIREMENTS

29895f3

Signed-off-by: Heiko Thiery <[email protected]>

add lacrosse to .coveragerc

0f0ad74

Signed-off-by: Heiko Thiery <[email protected]>

import 3rd party libraries inside methods

8c919cd

Signed-off-by: Heiko Thiery <[email protected]>

add pylacrosse to requirements_all.txt

e0ea39a

Signed-off-by: Heiko Thiery <[email protected]>

hthiery requested a review from andrey-git as a code owner October 29, 2017 08:04

homeassistant added the cla-signed label Oct 29, 2017

balloobbot added the requirement label Oct 29, 2017

hthiery added 3 commits October 29, 2017 09:37

add missing docstring

803b322

Signed-off-by: Heiko Thiery <[email protected]>

fix pylint warning

37598bd

Signed-off-by: Heiko Thiery <[email protected]>

fix pylint warning

f56cd9d

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added the cla-signed label Oct 29, 2017

hthiery changed the title ~~Initial commit of LaCrosse sensor component~~ Add LaCrosse sensor component Oct 29, 2017

fix pylint warnings

7af1dfc

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added the cla-signed label Oct 29, 2017

houndci-bot reviewed Oct 29, 2017

View reviewed changes

homeassistant/components/sensor/lacrosse.py Outdated

class LaCrosseSensor(Entity):

Copy link

houndci-bot Oct 29, 2017

Choose a reason for hiding this comment

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

too many blank lines (4)

remove too many blank lines

50fa56c

Signed-off-by: Heiko Thiery <[email protected]>

some minor cleanup

13b3bfe

Signed-off-by: Heiko Thiery <[email protected]>

hthiery mentioned this pull request Oct 29, 2017

Add documenation for LaCrosse platform home-assistant/home-assistant.io#3829

Merged

change to single quote

55836ce

Signed-off-by: Heiko Thiery <[email protected]>

fabaff changed the title ~~Add LaCrosse sensor component~~ Add LaCrosse sensor platform Oct 30, 2017

fabaff reviewed Oct 30, 2017

View reviewed changes

incorporate review comments

a8731ec

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added the cla-signed label Oct 30, 2017

fabaff reviewed Oct 31, 2017

View reviewed changes

home-assistant deleted a comment from houndci-bot Oct 31, 2017

remove type check as validation only allows TYPES

5cde900

Signed-off-by: Heiko Thiery <[email protected]>

homeassistant added the cla-signed label Oct 31, 2017

Adjust log level and update ordering

f28332e

fabaff approved these changes Nov 3, 2017

View reviewed changes

fabaff merged commit 23809bf into home-assistant:dev Nov 3, 2017

MartinHjelmare reviewed Nov 3, 2017

View reviewed changes

balloob mentioned this pull request Nov 17, 2017

0.58 #10630

Merged

home-assistant locked and limited conversation to collaborators Mar 2, 2018

ghost added integration: lacrosse and removed platform: sensor.lacrosse labels Mar 21, 2019


		lacrosse = None

		def setup_platform(hass, config, add_devices, discovery_info=None):



		def setup_platform(hass, config, add_devices, discovery_info=None):
		"""Setup the LaCrosse component."""


		_LOGGER = logging.getLogger(__name__)

		DOMAIN = 'lacrosse'

Uh oh!

Add LaCrosse sensor platform #10195

Add LaCrosse sensor platform #10195

Uh oh!

Conversation

hthiery commented Oct 28, 2017 • edited by fabaff Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

homeassistant commented Oct 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

homeassistant commented Oct 28, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hthiery commented Oct 29, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hthiery commented Nov 2, 2017

Uh oh!

fabaff commented Nov 2, 2017

Uh oh!

hthiery commented Nov 2, 2017

Uh oh!

fabaff commented Nov 2, 2017

Uh oh!

fabaff left a comment

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

hthiery commented Oct 28, 2017 •

edited by fabaff

Loading

Example entry for `configuration.yaml` (if applicable):