CANdle.hpp

Go to the documentation of this file.

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once
 
#include "ctre/phoenix6/core/CoreCANdle.hpp"
 
#include <wpi/hal/SimDevice.hpp>
 
namespace ctre {
namespace phoenix6 {
namespace hardware {
 
#if defined(_WIN32) || defined(_WIN64)
#pragma warning(push)
#pragma warning(disable : 4250)
#endif
 
/**
 * Class for CTR Electronics' CANdle® branded device,
 * a device that controls LEDs over the CAN bus.
 */
class CANdle : public core::CoreCANdle {
    /*
     * The StatusSignal getters are copies so that calls
     * to the WPI interface do not update any references
     *
     * These are also mutable so the const getter methods are
     * properly managed.
     */
 
    wpi::hal::SimDevice m_simCANdle;
    wpi::hal::SimDouble m_simSupplyVoltage;
    wpi::hal::SimDouble m_simFiveVRail;
    wpi::hal::SimDouble m_simOutputCurrent;
    wpi::hal::SimDouble m_simTemperature;
    wpi::hal::SimDouble m_simVBatModulation;
 
    int32_t m_simPeriodicUid{-1};
    std::vector<int32_t> m_simValueChangedUids;
 
    static void OnValueChanged(
        const char *name, void *param, HAL_SimValueHandle handle,
        HAL_Bool readonly, const struct HAL_Value *value
    );
    static void OnPeriodic(void *param);
 
public:
    /** The number of animation slots. */
    static constexpr int kAnimSlotCount = 8;
 
    /**
     * Constructs a new CANdle object.
     *
     * \param deviceId    ID of the device, as configured in Phoenix Tuner
     * \param canbus      The CAN bus this device is on
     */
    CANdle(int deviceId, CANBus canbus);
 
    ~CANdle();
 
    /**
     * \brief 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
     */
    static CANdle None()
    {
        return CANdle{-1, CANBus{}};
    }
 
    /**
     * \brief Clears all animations on the CANdle. This is equivalent to applying a
     * controls#EmptyAnimation to all the animation slots on the CANdle.
     *
     * \returns Status code of the first failed control call, or OK if all succeeded
     */
    ctre::phoenix::StatusCode ClearAllAnimations();
};
 
#if defined(_WIN32) || defined(_WIN64)
#pragma warning(pop)
#endif
 
}
}
}