lsh-core/lsh__user__macros_8hpp_source.html

#ifndef LSHCORE_LSH_USER_MACROS_HPP

#define LSHCORE_LSH_USER_MACROS_HPP


// This file provides the user-facing macros. It needs the definitions of the

// classes it instantiates and the bridge to the user's configuration.


#include "config/configurator.hpp"

#include "internal/user_config_bridge.hpp"

#include "peripherals/input/clickable.hpp"

#include "peripherals/output/actuator.hpp"

#include "peripherals/output/indicator.hpp"

#include "util/debug/debug.hpp"


#define LSH_ACTUATOR(var_name, pin, id)                                                           \

    static_assert((id) > 0, "Actuator ID must be > 0. Please use positive IDs starting from 1."); \

    Actuator var_name((pin), (id))


#define LSH_BUTTON(var_name, pin, id)                                                           \

    static_assert((id) > 0, "Button ID must be > 0. Please use positive IDs starting from 1."); \

    Clickable var_name((pin), (id))


#define LSH_INDICATOR(var_name, pin) \

    Indicator var_name((pin))


#endif // LSHCORE_LSH_USER_MACROS_HPP

actuator.hpp
Defines the Actuator class, representing a physical relay or digital output.

clickable.hpp
Defines the Clickable class for handling button inputs and click logic.

configurator.hpp
Declares the static Configurator class used for device setup in user code.

debug.hpp
Declares debugging macros (DP, DPL) and helper functions.

indicator.hpp
Defines the Indicator class, representing an LED or status light.

user_config_bridge.hpp
Internal bridge that imports user-defined macros into the library's scope.