c7222-development/api/safe__led_8hpp_source.html

#ifndef ELEC_C7222_DEVICES_SAFE_LED_HPP

#define ELEC_C7222_DEVICES_SAFE_LED_HPP


#include <chrono>

#include <condition_variable>

#include <mutex>


#include "led.hpp"

#include "non_copyable.hpp"

#include "platform.hpp"


namespace c7222 {


class SafeLed : public NonCopyableNonMovable {

  public:

    explicit SafeLed(Led& led);

    explicit SafeLed(PicoWBoard::LedId id) : SafeLed(Platform::GetInstance()->GetLed(id)) {}


    void Acquire();

    bool AcquireFor(uint32_t timeout);

    void Release();

    bool IsHeld() const;


    void Set(bool on);

    void On();

    void Off();

    void Toggle();


 private:

    Led& led_;

    mutable std::mutex mutex_;

    std::condition_variable cv_;

    bool locked_ = false;

};


} // namespace c7222


#endif // ELEC_C7222_DEVICES_SAFE_LED_HPP

c7222::Led
Output-only GPIO wrapper intended for LEDs.
Definition led.hpp:39

c7222::NonCopyableNonMovable
Disable both copy and move operations.
Definition non_copyable.hpp:75

c7222::PicoWBoard::LedId
LedId
Logical LED identifiers mapped to GPIO pins.
Definition c7222_pico_w_board.hpp:52

c7222::Platform
Singleton access to platform-specific devices and initialization.
Definition platform.hpp:118

c7222::SafeLed
LED wrapper that prevents simultaneous control from multiple threads.
Definition safe_led.hpp:44

c7222::SafeLed::AcquireFor
bool AcquireFor(uint32_t timeout)
Acquire exclusive control with a timeout.
Definition safe_led.cpp:16

c7222::SafeLed::Toggle
void Toggle()
Toggle the LED (requires Acquire()).
Definition safe_led.cpp:55

c7222::SafeLed::On
void On()
Turn the LED on (requires Acquire()).
Definition safe_led.cpp:45

c7222::SafeLed::SafeLed
SafeLed(PicoWBoard::LedId id)
Construct a SafeLed wrapper for a board LED by logical ID.
Definition safe_led.hpp:57

c7222::SafeLed::IsHeld
bool IsHeld() const
Return true if this object currently holds the lock.
Definition safe_led.cpp:35

c7222::SafeLed::Set
void Set(bool on)
Set the LED state (requires Acquire()).
Definition safe_led.cpp:40

c7222::SafeLed::Acquire
void Acquire()
Acquire exclusive control of the LED (blocks until available).
Definition safe_led.cpp:10

c7222::SafeLed::Off
void Off()
Turn the LED off (requires Acquire()).
Definition safe_led.cpp:50

c7222::SafeLed::Release
void Release()
Release exclusive control of the LED.
Definition safe_led.cpp:25

led.hpp
Output-only GPIO abstraction for LEDs.

c7222
C7222 course abstractions namespace.
Definition ble.hpp:20

non_copyable.hpp
Base classes to control copy/move semantics.

platform.hpp
Platform encapsulation for board-level devices.