actuator_manager.hpp

Go to the documentation of this file.

 
#ifndef LSHCORE_DEVICE_ACTUATOR_MANAGER_HPP
#define LSHCORE_DEVICE_ACTUATOR_MANAGER_HPP
 
#include <etl/array.h>
#include <etl/map.h>
#include <etl/vector.h>
#include <stdint.h>
 
#include "internal/user_config_bridge.hpp"
class Actuator; 
 
namespace Actuators
{
    extern uint8_t totalActuators;                                                 
    extern etl::array<Actuator *, CONFIG_MAX_ACTUATORS> actuators;                 
    extern etl::map<uint8_t, uint8_t, CONFIG_MAX_ACTUATORS> actuatorsMap;          
    extern etl::vector<uint8_t, CONFIG_MAX_ACTUATORS> actuatorsWithAutoOffIndexes; 
 
    void addActuator(Actuator *actuator);                                                                  // Add one actuator to actuators vector and activate it
    [[nodiscard]] auto getActuator(uint8_t actuatorId) -> Actuator *;                                      // Returns a single actuator
    [[nodiscard]] auto getIndex(uint8_t actuatorId) -> uint8_t;                                            // Returns a single actuator index
    [[nodiscard]] auto actuatorExists(uint8_t actuatorId) -> bool;                                         // Returns true if actuator exists
    [[nodiscard]] auto actuatorsAutoOffTimersCheck() -> bool;                                              // Performs an auto-off timer check for actuators
    [[nodiscard]] auto turnOffAllActuators() -> bool;                                                      // Turns off all actuators
    [[nodiscard]] auto turnOffUnprotectedActuators() -> bool;                                              // Turns off unprotected actuators
    [[nodiscard]] auto setAllActuatorsState(const etl::array<bool, CONFIG_MAX_ACTUATORS> &states) -> bool; // Set the state for all actuators
    void finalizeSetup();                                                                                  // Populates actuatorsWithAutoOffIndexes
} // namespace Actuators
 
#endif // LSHCORE_DEVICE_ACTUATOR_MANAGER_HPP