Create a binary_sensor using the `gpiozero` library #12105

maihde · 2018-02-01T03:12:08Z

Description:

The gpiozero library provides a unified interface for both local GPIO
pins and remote GPIO pins (via pigpiod). This allows it to replace
the standard rpi_gpio component while also adding new capabilities to
easily interact with GPIO pins on networked Raspberry Pis.

I chose to use pigpiod over other alternatives because it is the de-facto standard that is installed via raspi-config. Until this issue is resolved in pigpio there is a possibility for the component to enter a deadlock state if network connectivity between Home Assistant and pigpiod is lost. I have provided a pull request to address this issue; as a workaround my fork of pigpio can be installed instead.

I chose to use gpiozero instead of directly using the pigpio library so that one unified component could interact with both local and remote ports, reducing duplicate code.

**Documentation has been started (here)[https://github.com/maihde/hass-rpi-gpiozero] and will be migrated to home-assistant.io when this component is accepted.

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

binary_sensor:
  - platform: rpi_gpiozero
    ports:
      12: Local Input
  - platform: rpi_gpiozero
    host: 192.168.3.76
    ports:
      12: Remote Input 1
      13: Remote Input 2

Checklist:

The code change is tested and works locally.

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.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2018-02-01T03:12:10Z

Hi @maihde,

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 · 2018-02-01T03:12:15Z

homeassistant/components/rpi_gpiozero.py

+    btn = Button(
+        port,
+        pull_up=(pull_mode.upper() == 'UP'),
+        bounce_time=float(bouncetime) / 1e3, 


trailing whitespace

houndci-bot · 2018-02-01T03:12:15Z

homeassistant/components/rpi_gpiozero.py

+        raise ValueError("invalid bouncetime %s", bouncetime)
+
+    pin_factory = get_pinfactory(hostport)
+    if pin_factory == None:


comparison to None should be 'if cond is None:'

houndci-bot · 2018-02-01T03:12:15Z

homeassistant/components/rpi_gpiozero.py

+
+    if pull_mode.upper() not in ('UP', 'DOWN'):
+        raise ValueError("invalid pull_mode %s", pull_mode)
+


blank line contains whitespace

houndci-bot · 2018-02-01T03:12:15Z

homeassistant/components/rpi_gpiozero.py

+    :param hostport: the remote host/port, None for local.
+    """
+    from gpiozero import Button
+


blank line contains whitespace

houndci-bot · 2018-02-01T03:12:15Z

homeassistant/components/rpi_gpiozero.py

+        pin_factory = _LOCAL_FACTORY
+    return pin_factory
+
+def setup_button(port, pull_mode, bouncetime, hostport):


expected 2 blank lines, found 1

houndci-bot · 2018-02-01T03:12:16Z

homeassistant/components/rpi_gpiozero.py

+    hass.bus.listen_once(EVENT_HOMEASSISTANT_START, prepare_gpiozero)
+    return True
+
+def close_remote_pinfactory(hostport):


expected 2 blank lines, found 1

houndci-bot · 2018-02-01T03:12:16Z

homeassistant/components/rpi_gpiozero.py

+    def cleanup_gpiozero(event):
+        """Stuff to do before stopping."""
+        for dev in _DEVICES:
+            try: 


trailing whitespace

houndci-bot · 2018-02-01T03:12:16Z

homeassistant/components/rpi_gpiozero.py

+    # Make the default pin factory 'mock' so that
+    # it other pin factories can be loaded after import
+    os.environ['GPIOZERO_PIN_FACTORY'] = 'mock'
+    import gpiozero


'gpiozero' imported but unused

houndci-bot · 2018-02-01T03:12:16Z

homeassistant/components/rpi_gpiozero.py

+_LOCAL_FACTORY = None
+
+# pylint: disable=no-member
+def setup(hass, config):


expected 2 blank lines, found 1

houndci-bot · 2018-02-01T03:12:17Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+            self._state = False # if would be preferable to use None here
+
+        _LOGGER.info("%s has been updated to state %s",
+                self._name, self._state)


continuation line under-indented for visual indent

homeassistant · 2018-02-01T03:33:15Z

Hi @maihde,

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 · 2018-02-01T03:33:22Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+                _LOGGER.exception("%s has failed to update", self._name)
+                self._reset()
+        else:
+            self._state = False # if would be preferable to use None here


at least two spaces before inline comment

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+
+    @property
+    def available(self):
+        return self.btn != None


comparison to None should be 'if cond is not None:'

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+                        """Read state from GPIO."""
+                        self._state = device.is_pressed
+                        _LOGGER.info("%s has changed to %s",
+                                self._name, self._state)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+
+                if self._btn is None:
+                    _LOGGER.error("failed to create button %s on port %s",
+                            self._name, self._port)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+            if self._btn is None and self._hostport:
+
+                _LOGGER.debug("creating button %s on port %s",
+                        self._name, self._port)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+    """Represent a binary sensor that uses Raspberry Pi GPIO via gpiozero"""
+
+    def __init__(self, name, port, pull_mode, bouncetime, invert_logic,
+            hostport):


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:23Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+                _LOGGER.exception("%s has failed to update", self._name)
+                self._reset()
+        else:
+            self._state = False # if would be preferable to use None here


at least two spaces before inline comment

houndci-bot · 2018-02-01T03:33:24Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+
+    @property
+    def available(self):
+        return self.btn != None


comparison to None should be 'if cond is not None:'

houndci-bot · 2018-02-01T03:33:24Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+                        """Read state from GPIO."""
+                        self._state = device.is_pressed
+                        _LOGGER.info("%s has changed to %s",
+                                self._name, self._state)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:24Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+
+                if self._btn is None:
+                    _LOGGER.error("failed to create button %s on port %s",
+                            self._name, self._port)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:24Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+            if self._btn is None and self._hostport:
+
+                _LOGGER.debug("creating button %s on port %s",
+                        self._name, self._port)


continuation line under-indented for visual indent

houndci-bot · 2018-02-01T03:33:24Z

homeassistant/components/binary_sensor/rpi_gpiozero.py

+    """Represent a binary sensor that uses Raspberry Pi GPIO via gpiozero"""
+
+    def __init__(self, name, port, pull_mode, bouncetime, invert_logic,
+            hostport):


continuation line under-indented for visual indent

homeassistant · 2018-02-01T03:34:35Z

Hi @maihde,

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!

The `gpiozero` library provides a unified interface for both local GPIO pins and remote GPIO pins (via `pigpiod`). This allows it to replace the standard `rpi_gpio` component while also adding new capabilities to easily interact with GPIO pins on networked Raspberry Pis.

balloob · 2018-05-02T18:16:21Z

Component names are based on what they control, not on the name of the lib. So if this is a replacement for rpi_gpio, you should update that component.

balloob · 2018-05-02T18:17:06Z

However, I'm a bit confused. rpi_gpio seems to talk to the pins, this PR just talks to a daemon ?

maihde · 2018-05-02T20:47:31Z

So the standard `rpi_gpio` component talks only to local pins. I wanted to be able to read GPIO pins on a remote Raspberry PI. This requires some form of daemon running on the remote PI and a component within home assistant to talk to that remote daemon. For the daemon, I chose to use `pigpiod` because it is a included with Raspbian and can easily be enabled with `raspi-config`. I implemented the component using `gpiozero` because it provided a high-level API that worked both with local and remote pins; the objective would be that eventually this implementation (once feature complete) could replace `rpi_gpio` so that only one component needed to be maintained. I'm not partial to the name itself and only used that name to disambiguate it from `rpi_gpio`. If you would prefer that I finish the implementation so it is a drop-in replacement to `rpi_gpio` I can work down that path and submit a new pull request.

…

On Wed, May 2, 2018 at 2:17 PM, Paulus Schoutsen ***@***.***> wrote: However, I'm a bit confused. rpi_gpio seems to talk to the pins, this PR just talks to a daemon ? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#12105 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAOCIgiK8lGyL06INygSpaajsI0zKJKcks5tufg0gaJpZM4R0_a5> .

balloob · 2018-05-02T21:18:53Z

Hmm. I wonder if we would want this at all or that we should just wait for #13876 to land so that someone can just connect Home Assistant on the remote Pi too.

I wouldn't want to replace the current implementation because it would mean extra dependencies and usage of resources for no extra gain.

fabaff · 2018-08-07T17:14:35Z

This PR seems to gone stale. Please re-open it when you want to proceed.

maihde requested a review from andrey-git as a code owner February 1, 2018 03:12

homeassistant added cla-needed new-platform platform: binary_sensor.rpi_gpiozero integration: rpi_gpiozero labels Feb 1, 2018

houndci-bot reviewed Feb 1, 2018

View reviewed changes

maihde force-pushed the gpiozero-binary-sensor branch from 606cf59 to d1e6983 Compare February 1, 2018 03:33

homeassistant added the cla-needed label Feb 1, 2018

houndci-bot reviewed Feb 1, 2018

View reviewed changes

maihde force-pushed the gpiozero-binary-sensor branch from d1e6983 to c863b44 Compare February 1, 2018 03:34

homeassistant added the cla-needed label Feb 1, 2018

homeassistant added cla-signed and removed cla-needed labels Feb 1, 2018

maihde force-pushed the gpiozero-binary-sensor branch from c863b44 to db86205 Compare February 1, 2018 03:38

homeassistant added the cla-signed label Feb 1, 2018

This comment has been minimized.

Sign in to view

fabaff closed this Aug 7, 2018

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost removed the platform: binary_sensor.rpi_gpiozero label Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a binary_sensor using the `gpiozero` library #12105

Create a binary_sensor using the `gpiozero` library #12105

maihde commented Feb 1, 2018 •

edited by balloob

Loading

homeassistant commented Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

homeassistant commented Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

houndci-bot Feb 1, 2018

homeassistant commented Feb 1, 2018

This comment has been minimized.

balloob commented May 2, 2018

balloob commented May 2, 2018

maihde commented May 2, 2018 via email

balloob commented May 2, 2018

fabaff commented Aug 7, 2018


		if pull_mode.upper() not in ('UP', 'DOWN'):
		raise ValueError("invalid pull_mode %s", pull_mode)

Create a binary_sensor using the gpiozero library #12105

Create a binary_sensor using the gpiozero library #12105

Conversation

maihde commented Feb 1, 2018 • edited by balloob Loading

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Feb 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

homeassistant commented Feb 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

homeassistant commented Feb 1, 2018

This comment has been minimized.

balloob commented May 2, 2018

balloob commented May 2, 2018

maihde commented May 2, 2018 via email

balloob commented May 2, 2018

fabaff commented Aug 7, 2018

Create a binary_sensor using the `gpiozero` library #12105

Create a binary_sensor using the `gpiozero` library #12105

maihde commented Feb 1, 2018 •

edited by balloob

Loading

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