:py:mod:`phoenix6.hardware.candle`
==================================

.. py:module:: phoenix6.hardware.candle

Module Contents
---------------


.. py:class:: CANdle(device_id: int, canbus: phoenix6.canbus.CANBus | str = CANBus())


   Bases: :py:obj:`phoenix6.hardware.core.core_candle.CoreCANdle`, :py:obj:`wpiutil.Sendable`

   Constructs a new CANdle object.

   .. versionchanged:: 2026
      Constructing devices with a CAN bus string is deprecated for removal
      in the 2027 season. Construct devices using a CANBus instance instead.

   :param device_id: ID of the device, as configured in Phoenix Tuner
   :type device_id: int
   :param canbus: The CAN bus this device is on. Possible CAN bus strings are:

       - "rio" for the native roboRIO CAN bus
       - CANivore name or serial number
       - SocketCAN interface (non-FRC Linux only)
       - "*" for any CANivore seen by the program
       - empty string (default) to select the default for the system:

           - "rio" on roboRIO
           - "can0" on Linux
           - "*" on Windows

   :type canbus: CANBus | str, optional

   .. py:attribute:: ANIM_SLOT_COUNT
      :type: int
      :value: '8'

      The number of animation slots.


   .. py:method:: close()


   .. py:method:: 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
      :rtype: StatusCode


   .. py:method:: initSendable(builder: wpiutil.SendableBuilder)

      Initializes this Sendable object.

      :param builder: sendable builder