Add support for USB hub power control via uhubctl #525
Conversation
| stdout=subprocess.PIPE, | ||
| stderr=subprocess.PIPE, | ||
| text=True | ||
| ) |
There was a problem hiding this comment.
Popen cannot be used in Moonraker's code as calls to communicate() block the asyncio event loop. Moonraker has a shell_command component that wraps an async implementation of subprocess that can be used for this purpose:
shell_cmd: SCMDComp = self.server.lookup_component("shell_command")
try:
response = await shell_cmd.exec_cmd("uhubctrl", timeout=5.)
except shell_cmd.error as e:
if e.stderr:
logging.exception(f"uhubctl returned error: {err.decode(errors='ignore')}")
raise| return [] | ||
|
|
||
| async def init_state(self) -> None: | ||
| await self.set_power("on" if self.initial_state else "off") |
There was a problem hiding this comment.
Is it wise to have an initial state for this? The GPIO implementation is unique in that GPIOs are exclusively controlled by Moonraker, when the service is restarted their state always gets reset, thus an initial state is always required.
The ubhubctrl state exists outside of Moonraker's control. It may not be desirable to force a particular state each time Moonraker starts.
There was a problem hiding this comment.
This was added because I always want my printer to be off unless explicitly commanded to be on, but maybe there are other ways to toggle power devices automatically at startup? Or would you accept the option if it was optional, and state was only changed on init if it was specified in the config?
There was a problem hiding this comment.
I recently made initial_state a global option for power devices (I just haven't updated the docs yet). It functions as you suggest, the initial_state defaults to None if not configured, in which case we do not change the state of the device on init. The change to your code should be relatively simple, remove line 1332 as the base class has already fetched the option, and change init_state() to:
async def init_state(self) -> None:
if self.initial_state is not None:
await self.set_power("on" if self.initial_state else "off")|
|
||
| async def set_power(self, state: str) -> None: | ||
| await self.refresh_status(self._port_status(state)) | ||
| return |
There was a problem hiding this comment.
set_power and refresh_status should handle exceptions similar to how it the gpio implementation handles them. That way we can catch any error, reset the state to error, then re-raise he exception so the front end gets an error.
|
Thanks. I took an initial look and found a few things that should be addressed. |
| return [] | ||
|
|
||
| async def init_state(self) -> None: | ||
| await self.set_power("on" if self.initial_state else "off") |
There was a problem hiding this comment.
This was added because I always want my printer to be off unless explicitly commanded to be on, but maybe there are other ways to toggle power devices automatically at startup? Or would you accept the option if it was optional, and state was only changed on init if it was specified in the config?
|
The |
This adds support for toggling power to certain USB hubs/ports on or off via the command line tool uhubctl (available via apt on Raspbian). This is useful to completely shut down MCUs, LCDs, and other peripherals that are powered over USB.
On my RPi 3 + RAMPS 1.4 printer setup, the following config lets me turn off the entire printer plus its webcam (port 2 controls power to all 4 ports on the RPi):
[power USB] type: uhubctl port: 1-1.2 bound_service: klipperDisclaimer: I am not a Python developer, and the entire Klipper ecosystem is new to me as of a few days ago, but I've done my best 😅 Feedback welcome 🙂
Signed-off-by: Jim C K Flaten [email protected]