diff --git a/docs/api_boards.rst b/docs/api_boards.rst index cec9e7e..49919fb 100644 --- a/docs/api_boards.rst +++ b/docs/api_boards.rst @@ -127,6 +127,20 @@ Energenie :inherited-members: :members: +StatusZero +========== + +.. autoclass:: StatusZero + :inherited-members: + :members: + +StatusBoard +=========== + +.. autoclass:: StatusBoard + :inherited-members: + :members: + SnowPi ====== @@ -168,4 +182,3 @@ CompositeDevice .. autoclass:: CompositeDevice(\*args, _order=None, \*\*kwargs) :members: - diff --git a/docs/images/device_hierarchy.dot b/docs/images/device_hierarchy.dot index a794678..c3b6717 100644 --- a/docs/images/device_hierarchy.dot +++ b/docs/images/device_hierarchy.dot @@ -90,11 +90,13 @@ digraph classes { ButtonBoard->HoldMixin; PiLiter->LEDBoard; PiLiterBarGraph->LEDBarGraph; + StatusZero->LEDBoard; TrafficLights->LEDBoard; SnowPi->LEDBoard; PiTraffic->TrafficLights; PiStop->TrafficLights; TrafficLightsBuzzer->CompositeOutputDevice; + StatusBoard->CompositeOutputDevice; FishDish->TrafficLightsBuzzer; TrafficHat->TrafficLightsBuzzer; Robot->CompositeDevice; @@ -115,4 +117,3 @@ digraph classes { PingServer->InternalDevice; CPUTemperature->InternalDevice; } - diff --git a/docs/images/device_hierarchy.pdf b/docs/images/device_hierarchy.pdf index 5aecea9..c61e943 100644 Binary files a/docs/images/device_hierarchy.pdf and b/docs/images/device_hierarchy.pdf differ diff --git a/docs/images/device_hierarchy.png b/docs/images/device_hierarchy.png index 42e1073..28e47f3 100644 Binary files a/docs/images/device_hierarchy.png and b/docs/images/device_hierarchy.png differ diff --git a/docs/images/device_hierarchy.svg b/docs/images/device_hierarchy.svg index d5d5b09..35097c4 100644 --- a/docs/images/device_hierarchy.svg +++ b/docs/images/device_hierarchy.svg @@ -4,235 +4,235 @@ - - + + classes - + ValuesMixin - -ValuesMixin + +ValuesMixin SourceMixin - -SourceMixin + +SourceMixin SharedMixin - -SharedMixin + +SharedMixin EventsMixin - -EventsMixin + +EventsMixin HoldMixin - -HoldMixin + +HoldMixin Device - -Device + +Device Device->ValuesMixin - - + + GPIODevice - -GPIODevice + +GPIODevice GPIODevice->Device - - + + SmoothedInputDevice - -SmoothedInputDevice + +SmoothedInputDevice SmoothedInputDevice->EventsMixin - - + + InputDevice - -InputDevice + +InputDevice SmoothedInputDevice->InputDevice - - + + AnalogInputDevice - -AnalogInputDevice + +AnalogInputDevice SPIDevice - -SPIDevice + +SPIDevice AnalogInputDevice->SPIDevice - - + + MCP3xxx - -MCP3xxx + +MCP3xxx MCP3xxx->AnalogInputDevice - - + + MCP33xx - -MCP33xx + +MCP33xx MCP33xx->MCP3xxx - - + + CompositeDevice - -CompositeDevice + +CompositeDevice CompositeDevice->Device - - + + CompositeOutputDevice - -CompositeOutputDevice + +CompositeOutputDevice CompositeOutputDevice->SourceMixin - - + + CompositeOutputDevice->CompositeDevice - - + + LEDCollection - -LEDCollection + +LEDCollection LEDCollection->CompositeOutputDevice - - + + InternalDevice - -InternalDevice + +InternalDevice -InternalDevice->EventsMixin - - +InternalDevice->EventsMixin + + -InternalDevice->Device - - +InternalDevice->Device + + InputDevice->GPIODevice - - + + DigitalInputDevice - -DigitalInputDevice + +DigitalInputDevice DigitalInputDevice->EventsMixin - - + + DigitalInputDevice->InputDevice - - + + Button - -Button + +Button Button->HoldMixin - - + + Button->DigitalInputDevice - - + + MotionSensor - -MotionSensor + +MotionSensor MotionSensor->SmoothedInputDevice - - + + LightSensor - -LightSensor + +LightSensor LightSensor->SmoothedInputDevice - - + + LineSensor - -LineSensor + +LineSensor LineSensor->SmoothedInputDevice - - + + DistanceSensor - -DistanceSensor + +DistanceSensor DistanceSensor->SmoothedInputDevice - - + + OutputDevice @@ -241,488 +241,508 @@ OutputDevice->SourceMixin - - + + OutputDevice->GPIODevice - - + + DigitalOutputDevice - -DigitalOutputDevice + +DigitalOutputDevice DigitalOutputDevice->OutputDevice - - + + LED - -LED + +LED LED->DigitalOutputDevice - - + + Buzzer - -Buzzer + +Buzzer Buzzer->DigitalOutputDevice - - + + PWMOutputDevice - -PWMOutputDevice + +PWMOutputDevice PWMOutputDevice->OutputDevice - - + + PWMLED - -PWMLED + +PWMLED PWMLED->PWMOutputDevice - - + + RGBLED - -RGBLED + +RGBLED RGBLED->SourceMixin - - + + RGBLED->Device - - + + SPIDevice->Device - - + + MCP30xx - -MCP30xx + +MCP30xx MCP30xx->MCP3xxx - - + + MCP32xx - -MCP32xx + +MCP32xx MCP32xx->MCP3xxx - - + + MCP3xx2 - -MCP3xx2 + +MCP3xx2 MCP3xx2->MCP3xxx - - + + MCP3001 - -MCP3001 + +MCP3001 MCP3001->MCP30xx - - + + MCP3002 - -MCP3002 + +MCP3002 MCP3002->MCP30xx - - + + MCP3002->MCP3xx2 - - + + MCP3004 - -MCP3004 + +MCP3004 MCP3004->MCP30xx - - + + MCP3008 - -MCP3008 + +MCP3008 MCP3008->MCP30xx - - + + MCP3201 - -MCP3201 + +MCP3201 MCP3201->MCP32xx - - + + MCP3202 - -MCP3202 + +MCP3202 MCP3202->MCP32xx - - + + MCP3202->MCP3xx2 - - + + MCP3204 - -MCP3204 + +MCP3204 MCP3204->MCP32xx - - + + MCP3208 - -MCP3208 + +MCP3208 MCP3208->MCP32xx - - + + MCP3301 - -MCP3301 + +MCP3301 MCP3301->MCP33xx - - + + MCP3302 - -MCP3302 + +MCP3302 MCP3302->MCP33xx - - + + MCP3304 - -MCP3304 + +MCP3304 MCP3304->MCP33xx - - + + LEDBoard - -LEDBoard + +LEDBoard LEDBoard->LEDCollection - - + + LEDBarGraph - -LEDBarGraph + +LEDBarGraph LEDBarGraph->LEDCollection - - + + LedBorg - -LedBorg + +LedBorg LedBorg->RGBLED - - + + ButtonBoard - -ButtonBoard + +ButtonBoard ButtonBoard->HoldMixin - - + + ButtonBoard->CompositeDevice - - + + PiLiter - -PiLiter + +PiLiter PiLiter->LEDBoard - - + + PiLiterBarGraph - -PiLiterBarGraph + +PiLiterBarGraph PiLiterBarGraph->LEDBarGraph - - + + + + +StatusZero + +StatusZero + + +StatusZero->LEDBoard + + -TrafficLights - -TrafficLights +TrafficLights + +TrafficLights -TrafficLights->LEDBoard - - +TrafficLights->LEDBoard + + -SnowPi - -SnowPi +SnowPi + +SnowPi -SnowPi->LEDBoard - - +SnowPi->LEDBoard + + -PiTraffic - -PiTraffic +PiTraffic + +PiTraffic -PiTraffic->TrafficLights - - +PiTraffic->TrafficLights + + -PiStop - -PiStop +PiStop + +PiStop -PiStop->TrafficLights - - +PiStop->TrafficLights + + -TrafficLightsBuzzer - -TrafficLightsBuzzer +TrafficLightsBuzzer + +TrafficLightsBuzzer -TrafficLightsBuzzer->CompositeOutputDevice - - +TrafficLightsBuzzer->CompositeOutputDevice + + + + +StatusBoard + +StatusBoard + + +StatusBoard->CompositeOutputDevice + + -FishDish - -FishDish +FishDish + +FishDish -FishDish->TrafficLightsBuzzer - - +FishDish->TrafficLightsBuzzer + + -TrafficHat - -TrafficHat +TrafficHat + +TrafficHat -TrafficHat->TrafficLightsBuzzer - - +TrafficHat->TrafficLightsBuzzer + + -Robot - -Robot +Robot + +Robot -Robot->SourceMixin - - +Robot->SourceMixin + + -Robot->CompositeDevice - - +Robot->CompositeDevice + + -Energenie - -Energenie +Energenie + +Energenie -Energenie->SourceMixin - - +Energenie->SourceMixin + + -Energenie->Device - - +Energenie->Device + + -RyanteckRobot - -RyanteckRobot +RyanteckRobot + +RyanteckRobot -RyanteckRobot->Robot - - +RyanteckRobot->Robot + + -CamJamKitRobot - -CamJamKitRobot +CamJamKitRobot + +CamJamKitRobot -CamJamKitRobot->Robot - - +CamJamKitRobot->Robot + + -Motor - -Motor +Motor + +Motor -Motor->SourceMixin - - +Motor->SourceMixin + + -Motor->CompositeDevice - - +Motor->CompositeDevice + + -Servo - -Servo +Servo + +Servo -Servo->SourceMixin - - +Servo->SourceMixin + + -Servo->CompositeDevice - - +Servo->CompositeDevice + + -AngularServo - -AngularServo +AngularServo + +AngularServo -AngularServo->Servo - - +AngularServo->Servo + + -TimeOfDay - -TimeOfDay +TimeOfDay + +TimeOfDay -TimeOfDay->InternalDevice - - +TimeOfDay->InternalDevice + + -PingServer - -PingServer +PingServer + +PingServer -PingServer->InternalDevice - - +PingServer->InternalDevice + + -CPUTemperature - -CPUTemperature +CPUTemperature + +CPUTemperature -CPUTemperature->InternalDevice - - +CPUTemperature->InternalDevice + +