History

Reid 'arrdem' McKenzie ed633c9ab0 Documenting for publication		2021-11-05 12:18:45 -06:00
..
src/python/clusterctrl	Documenting for publication	2021-11-05 12:18:45 -06:00
test/python	Finishing and testing the driver	2021-11-05 11:47:17 -06:00
BUILD	Tapping on the revamped clusterctrl	2021-11-02 01:12:06 -06:00
README.md	Documenting for publication	2021-11-05 12:18:45 -06:00

README.md

clusterctrl

This project is a clean-sheet rewrite of the clusterctrl tool and underlying device driver provided by the 8086 consultancy for interacting with their ClusterCTRL and ClusterHAT line of Raspberry Pi backplane products.

Usage & driver API

from clusterctrl.driver import ClusterCTRLv2Driver as Driver
from smbus2 import SMBus

hat = Driver(SMBus(3))  # Note that 3 here is the number of the i2c device the HAT is on

A quick API overview -

The CTRL/HAT products "order" themselves (identify boards) using an EEPROM stored value called 'order'. The official clients use "order" to enable for somewhat stable sequential addressing of "pi6" as being board 2 pi 1. However it's far more general purpose and predictable to directly expose and model the device tree.

Note that the firmware default for "order" is 20 and this driver will automatically assign random IDs to boards with orders of 20. This behavior can be disabled by subclassing the driver and overloading _post_init().

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.

hat.fw_version  # => (1, 6)
hat.min_pi      # => <PiRef XXX-01>
hat.max_pi      # => <PiRef XXX-05>
hat.pis()       # => Iterable[PiRef] (iterate over all Pis on this device in order)
hat.type        # => BoardType
hat.max_adc     # => int (ADC support is incomplete)

Power status

hat.power_on(<int | PiRef>)
hat.power_off(<int | PiRef>)
hat.power_status(<int | PiRef>)

hat.power_all_off()
hat.power_all_on()

hat.eeprom_save_powerstate()

Board identification

hat.get_order()
hat.set_order(<order: uint8>)

hat.eeprom_save_order()

Alert lights

hat.alert_on()
hat.alert_off()

hat.led_on()
hat.led_off()

hat.eeprom_save_leds()

Fan control

hat.fan_on()
hat.fan_off()
hat.fan_status()

hat.read_temp()  # Temp in integer kelvin

USB hub control

hat.hub_on()
hat.hub_off()
hat.hub_reset()

USB booting

hat.usbboot_on()
hat.usbboot_off()
hat.usbboot_status()
hat.eeprom_save_usbboot()

Driver.eeprom_reset

Reset all EEPROM stored settings to their 'factory' firmware defaults.

Driver.eeprom_save_all

Save all values back to EEPROM. Note that this does not update the defaults restored by Driver.eeprom_reset.

license

This software is published under the terms of the MIT License