arrdem/source
1
0
Fork 0
Code Issues 11 Pull requests Projects Releases Packages Wiki Activity

More docs tweaks

Browse source
This commit is contained in:
Reid 'arrdem' McKenzie 2021-11-05 13:20:00 -06:00
parent 89610a3568
commit 4fb3719555
1 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
projects/clusterctrl/README.md
View file

@ -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. 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 ``` python
hat.fw_version # => (1, 6) hat.fw_version # => (1, 6)
hat.min_pi # => <PiRef XXX-01> hat.min_pi # => <PiRef XXX-01>
@ -33,10 +35,10 @@ hat.max_adc # => int (ADC support is incomplete)
### Power status ### Power status
``` ``` python
hat.power_on(<int | PiRef>) hat.power_on(Union[int, PiRef])
hat.power_off(<int | PiRef>) hat.power_off(Union[int, PiRef])
hat.power_status(<int | PiRef>) hat.power_status(Union[int, PiRef])
hat.power_all_off() hat.power_all_off()
hat.power_all_on() hat.power_all_on()
@ -85,6 +87,10 @@ hat.hub_reset()
### USB booting ### 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 ``` python
hat.usbboot_on() hat.usbboot_on()
hat.usbboot_off() hat.usbboot_off()