Experiment: Using `gpiod` for driving pins #271

RobinTail · 2024-05-19T08:56:32Z

Probably closes #270 and maybe will help with #255

setup.py

octoprint_octorelay/driver.py

mypy.ini

This reverts commit b9a0e30.

mypy.ini

RobinTail · 2024-05-19T11:35:09Z

setup.py

@@ -35,7 +35,7 @@ def get_version_and_cmdclass(pkg_path):

 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module
-plugin_description = """A plugin that adds buttons to the navbar for toggling GPIO on the RPi. It can be used for turning relays on and off."""
+plugin_description = """A plugin that adds buttons to the navbar for toggling GPIO on Raspberry Pi. It can be used for turning relays on and off."""


not only Raspberry Pi now

RobinTail · 2024-05-19T11:35:36Z

octoprint_octorelay/driver.py


 def xor(left: bool, right: bool) -> bool:
    return left is not right

 class Relay():
    def __init__(self, pin: int, inverted: bool):
+        self.request = request_lines(
+            "/dev/gpiochip0",


⚠️ this should be configurable

tests/test_driver.py

RobinTail · 2024-05-19T12:03:06Z

🚀 5.0.0a1

🆗 It does some relay switching on startup.

❌ Revealed issues:

Relays marked as inverted are switched to the wrong position on startup (something is messed up with it)
Some relay seems to be exclusively locked and which causes a system error while handling event

2024-05-19 13:52:34,482 - octoprint.plugins.octorelay - DEBUG - Received the ClientOpened event having payload: {'remoteAddress': ''}
2024-05-19 13:52:34,483 - octoprint.plugins.octorelay - DEBUG - Updating the UI
2024-05-19 13:52:34,508 - octoprint.plugins.octorelay - DEBUG - Finding the upcoming tasks
2024-05-19 13:52:34,511 - octoprint.plugin - ERROR - Error while calling plugin octorelay
Traceback (most recent call last):
  File "/home/pi/oprint/lib/python3.9/site-packages/octoprint/plugin/__init__.py", line 275, in call_plugin
    result = getattr(plugin, method)(*args, **kwargs)
  File "/home/pi/oprint/lib/python3.9/site-packages/octoprint/util/__init__.py", line 1686, in wrapper
    return f(*args, **kwargs)
  File "/home/pi/oprint/lib/python3.9/site-packages/octoprint_octorelay/__init__.py", line 181, in on_event
    self.update_ui()
  File "/home/pi/oprint/lib/python3.9/site-packages/octoprint_octorelay/__init__.py", line 316, in update_ui
    relay = Relay(
  File "/home/pi/oprint/lib/python3.9/site-packages/octoprint_octorelay/driver.py", line 11, in __init__
    self.request = request_lines(
  File "/home/pi/oprint/lib/python3.9/site-packages/gpiod/__init__.py", line 54, in request_lines
    return chip.request_lines(*args, **kwargs)
  File "/home/pi/oprint/lib/python3.9/site-packages/gpiod/chip.py", line 315, in request_lines
    req_internal = self._chip.request_lines(line_cfg, consumer, event_buffer_size)
OSError: [Errno 16] Device or resource busy

… relays." This reverts commit 544df8a.

RobinTail · 2024-05-19T15:06:28Z

🚀 5.0.0a2

❌ not fixed (initial state)
❌ switching happens twice (on/off) immediately

request_lines seems to be always pushing some initial value, it should not be used for reading the state

RobinTail · 2024-05-19T19:26:55Z

It seems that this library won't work with existing code implementation treating each switch as a standalone operation.
Instead, the driver should either be a singleton, or the code should be refactored to create Relay instances once and then operate them as needed. It could be places in Model entry.
https://www.tomshardware.com/how-to/control-raspberry-pi-5-gpio-with-python-3

RobinTail · 2024-05-19T19:28:22Z

I also found out, that there is a mode Direction.AS_IS that does not set the initial value.
Moreover, it's possible to set value on demand from that mode.
However, I'm not sure how'd it work if the pin is initially in Input mode.

RobinTail · 2024-05-19T19:50:11Z

Alternatively, there is a much better documented library
https://gpiozero.readthedocs.io/en/latest/index.html
That is confirmed to work on Raspberry 5 (applicable to #255 )
But not sure if it's applicable for #270
UPD: no, it does not

And more gpiod examples: https://github.com/hhk7734/python3-gpiod/tree/main/py_src/gpiod/test

RobinTail · 2024-05-20T06:58:13Z

🚀 5.0.0a3

🆗 Fixed initial state
🆗 No conflicts this time
🆗 Switching works
❌ Polling thread does not seems to monitor changes correctly

RobinTail · 2024-05-20T11:24:20Z

Won't work without much greater refactoring

gpiod driver implementation draft.

a78bd98

RobinTail added enhancement New feature or request refactoring Better implementation of the same thing breaking Breaking changes labels May 19, 2024

RobinTail changed the base branch from master to develop May 19, 2024 08:56

RobinTail added 6 commits May 19, 2024 11:15

Removing initial output and update first two tests.

790bd23

Add missing comma.

66ba130

Change mocking approach.

b4e7de3

Fix mock name.

6a05047

Fix expectations.

4be16fa

Updating the test for is_closed().

440a5d2

RobinTail removed refactoring Better implementation of the same thing breaking Breaking changes labels May 19, 2024

Updating the test for toggle() with no args.

fbaef94

RobinTail force-pushed the use-gpiod branch from cc840cf to fbaef94 Compare May 19, 2024 09:35

RobinTail added 2 commits May 19, 2024 11:40

Ref: shortening imports.

431a91f

Adjusting test.

352b818

RobinTail force-pushed the use-gpiod branch from 337d9a4 to 352b818 Compare May 19, 2024 09:43

RobinTail changed the title ~~Using gpiod for driving pins~~ Experiment: Using gpiod for driving pins May 19, 2024

RobinTail force-pushed the use-gpiod branch 2 times, most recently from e2fc545 to b5f8192 Compare May 19, 2024 10:34

Fix mypi.

59fca6f

RobinTail force-pushed the use-gpiod branch from b5f8192 to 59fca6f Compare May 19, 2024 10:41

Fix pylint on driver.

b7d7cb5

RobinTail added the breaking Breaking changes label May 19, 2024

RobinTail commented May 19, 2024

View reviewed changes

setup.py Show resolved Hide resolved

Shortening lines.

a0d81db

RobinTail commented May 19, 2024

View reviewed changes

octoprint_octorelay/driver.py Outdated Show resolved Hide resolved

RobinTail commented May 19, 2024

View reviewed changes

octoprint_octorelay/driver.py Outdated Show resolved Hide resolved

RobinTail commented May 19, 2024

View reviewed changes

mypy.ini Outdated Show resolved Hide resolved

RobinTail added 2 commits May 19, 2024 11:11

REF: DNRY: keeping the request prop for all actions in Relay.

b35ef4a

Revert "Rev: removing mypy config on gpiod."

a505e13

This reverts commit b9a0e30.

RobinTail commented May 19, 2024

View reviewed changes

mypy.ini Outdated Show resolved Hide resolved

RobinTail added 3 commits May 19, 2024 13:13

Update mypy.ini

52856c8

Readme: python 3.9.

b5e8e61

Removing python 3.7 and 3.8 from release workflow.

ab71719

RobinTail mentioned this pull request May 19, 2024

BIGTREETECH BTT Pi V1.2 The plugin is installed but it is not in the plugin manager. #270

Closed

RobinTail commented May 19, 2024

View reviewed changes

tests/test_driver.py Outdated Show resolved Hide resolved

Ref: driver test: dedicated var for gpiod.line mock.

8f839ee

RobinTail added the help wanted Extra attention is needed label May 19, 2024

RobinTail added 3 commits May 19, 2024 14:48

Using active_low prop of LineSettings for addressing inverted relays.

544df8a

Revert "Using active_low prop of LineSettings for addressing inverted…

ada3ff4

… relays." This reverts commit 544df8a.

Forcing active_low to operate inverted relays within the driver.

154524e

RobinTail force-pushed the use-gpiod branch from b8555c1 to 154524e Compare May 19, 2024 14:49

RobinTail force-pushed the use-gpiod branch 4 times, most recently from 7a555a3 to 5a0ca35 Compare May 20, 2024 06:40

Using AS_IS mode.

5470c6c

RobinTail force-pushed the use-gpiod branch from 5a0ca35 to 5470c6c Compare May 20, 2024 06:41

RobinTail closed this May 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experiment: Using `gpiod` for driving pins #271

Experiment: Using `gpiod` for driving pins #271

RobinTail commented May 19, 2024

RobinTail May 19, 2024

RobinTail May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 20, 2024

RobinTail commented May 20, 2024

Experiment: Using gpiod for driving pins #271

Experiment: Using gpiod for driving pins #271

Conversation

RobinTail commented May 19, 2024

RobinTail May 19, 2024

Choose a reason for hiding this comment

RobinTail May 19, 2024 • edited Loading

Choose a reason for hiding this comment

RobinTail commented May 19, 2024 • edited Loading

RobinTail commented May 19, 2024 • edited Loading

RobinTail commented May 19, 2024 • edited Loading

RobinTail commented May 19, 2024

RobinTail commented May 19, 2024 • edited Loading

RobinTail commented May 20, 2024

RobinTail commented May 20, 2024

Experiment: Using `gpiod` for driving pins #271

Experiment: Using `gpiod` for driving pins #271

RobinTail May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading

RobinTail commented May 19, 2024 •

edited

Loading