phoenix6.hardware.candle

Module Contents

class phoenix6.hardware.candle.CANdle(device_id: int, canbus: phoenix6.canbus.CANBus)

Bases: phoenix6.hardware.core.core_candle.CoreCANdle

Class for CTR Electronics’ CANdle® branded device, a device that controls LEDs over the CAN bus.

Constructs a new CANdle object.

Parameters:

  • device_id (int) – ID of the device, as configured in Phoenix Tuner

  • canbus (CANBus) – The CAN bus this device is on

ANIM_SLOT_COUNT: int = '8'

The number of animation slots.

classmethod none() → Self

Constructs a stubbed-out CANdle, where all status signals, controls, configs, etc. perform no action and immediately return OK. This can be used to silence error messages for devices that have been completely removed from the robot.

Returns:

Stubbed-out CANdle

Return type:

CANdle

close()
clear_all_animations() → phoenix6.status_code.StatusCode

Clears all animations on the CANdle. This is equivalent to applying an EmptyAnimation to all the animation slots on the CANdle.

Returns:

Status code of the first failed control call, or OK if all succeeded

Return type:

StatusCode