actuator_manager.hpp

Go to the documentation of this file.

 
#ifndef LSH_CORE_DEVICE_ACTUATOR_MANAGER_HPP
#define LSH_CORE_DEVICE_ACTUATOR_MANAGER_HPP
 
#include <stdint.h>
 
#include "internal/etl_array.hpp"
#include "internal/user_config_bridge.hpp"
class Actuator;
 
namespace Actuators
{
using PackedActuatorStateBytes = etl::array<uint8_t, CONFIG_PACKED_ACTUATOR_STATE_STORAGE_CAPACITY>;
 
#if defined(LSH_DEBUG) || defined(LSH_STATIC_CONFIG_RUNTIME_CHECKS)
extern etl::array<Actuator *, CONFIG_MAX_ACTUATORS> actuators;
#endif
extern PackedActuatorStateBytes packedActuatorStates;
 
[[nodiscard]] auto getId(uint8_t actuatorIndex) -> uint8_t;        // Returns the static actuator ID for one dense runtime index
[[nodiscard]] auto getActuator(uint8_t actuatorId) -> Actuator *;  // Returns a single actuator, or nullptr if the ID is unknown
[[nodiscard]] auto getIndex(uint8_t actuatorId) -> uint8_t;        // Returns a single actuator index, or UINT8_MAX if the ID is unknown
[[nodiscard]] auto tryGetIndex(uint8_t actuatorId, uint8_t &actuatorIndex)
    -> bool;                                                    // Returns true and writes the actuator index when the ID exists
[[nodiscard]] auto actuatorExists(uint8_t actuatorId) -> bool;  // Returns true if actuator exists
void recordSwitchTime(uint8_t actuatorIndex, uint32_t now_ms);  // Records a state-change time for compact actuator timer storage.
#if CONFIG_USE_COMPACT_ACTUATOR_SWITCH_TIMES && LSH_STATIC_CONFIG_AUTO_OFF_ACTUATORS > 0
[[nodiscard]] auto checkCompactAutoOffTimer(uint8_t autoOffIndex,
                                            uint8_t actuatorIndex,
                                            Actuator &actuator,
                                            uint32_t now_ms,
                                            uint32_t timer_ms) -> bool;  // Checks one generated compact auto-off entry.
#endif
 
void updatePackedState(uint8_t actuatorIndex, bool state);
 
template <uint8_t ActuatorIndex> __attribute__((always_inline)) inline void updatePackedStateStatic(bool state)
{
    static_assert(ActuatorIndex < CONFIG_MAX_ACTUATORS, "ActuatorIndex is outside the generated static profile.");
    constexpr uint8_t byteIndex = static_cast<uint8_t>(ActuatorIndex >> 3U);
    constexpr uint8_t bitMask = static_cast<uint8_t>(1U << (ActuatorIndex & 0x07U));
    if (state)
    {
        packedActuatorStates[byteIndex] |= bitMask;
    }
    else
    {
        packedActuatorStates[byteIndex] &= static_cast<uint8_t>(~bitMask);
    }
}
 
[[nodiscard]] auto getPackedStateByteCount() -> uint8_t;
 
[[nodiscard]] auto getPackedStateByte(uint8_t byteIndex) -> uint8_t;
 
void finalizeSetup();  // Final validation pass after configuration registration.
}  // namespace Actuators
 
#endif  // LSH_CORE_DEVICE_ACTUATOR_MANAGER_HPP