From 4fb371955586692b979a79fd22038fc6a6bec4d6 Mon Sep 17 00:00:00 2001 From: Reid 'arrdem' McKenzie Date: Fri, 5 Nov 2021 13:20:00 -0600 Subject: [PATCH] More docs tweaks --- projects/clusterctrl/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/projects/clusterctrl/README.md b/projects/clusterctrl/README.md index d2008ec..d4f1579 100644 --- a/projects/clusterctrl/README.md +++ b/projects/clusterctrl/README.md @@ -22,6 +22,8 @@ This behavior can be disabled by subclassing the driver and overloading `_post_i This API is built atop a `PiRef(board_id, pi_id)` tuple which is intended to allow for the construction of cluster management APIs which allow for automatic but predictable mapping of requests (eg. `power_on`, `power_status`) to a given device. +If you provide an "unqualified" integer ID directly, the driver will attempt to interpret it as being in `[min_pi, max_pi]` specific to this device. + ``` python hat.fw_version # => (1, 6) hat.min_pi # => @@ -33,10 +35,10 @@ hat.max_adc # => int (ADC support is incomplete) ### Power status -``` -hat.power_on() -hat.power_off() -hat.power_status() +``` python +hat.power_on(Union[int, PiRef]) +hat.power_off(Union[int, PiRef]) +hat.power_status(Union[int, PiRef]) hat.power_all_off() hat.power_all_on() @@ -85,6 +87,10 @@ hat.hub_reset() ### USB booting +**WARNING**: Support for USB booting is specific to the ClusterHAT family of devices, to which I don't have access. +As such no promises can be made for whether this machinery does what it's supposed to do. +The upstream drivers have a lot of oddities around USB booting and ClusterHAT specific use of GPIO pins. + ``` python hat.usbboot_on() hat.usbboot_off()