Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
BLINKER_Pin Struct Reference

GPIO-abstraction implementation for the blinker bit. More...

#include <BlinkerGPIO.hxx>

Static Public Member Functions

static void hw_init ()
 Initialize the hardware (noop).
 
static void hw_set_to_safe ()
 Set the hardware to safe setting (noop).
 
static void set (bool value)
 Set the pin to a specific value.
 
static void toggle ()
 Toggle the pin (set to opposite value than previously).
 
static bool get ()
 
static bool is_output ()
 
static constexpr const Gpioinstance ()
 

Detailed Description

GPIO-abstraction implementation for the blinker bit.

This allows a GPIO-style usage of the LED that is controlled by the blinker code in the FreeRTOS-compatible hardware implementations.

Definition at line 45 of file BlinkerGPIO.hxx.

Member Function Documentation

◆ get()

static bool BLINKER_Pin::get ( )
inlinestatic
Returns
zero if the pin is OFF, non-zero otherwise.

Definition at line 66 of file BlinkerGPIO.hxx.

◆ hw_init()

static void BLINKER_Pin::hw_init ( )
inlinestatic

Initialize the hardware (noop).

Definition at line 48 of file BlinkerGPIO.hxx.

◆ hw_set_to_safe()

static void BLINKER_Pin::hw_set_to_safe ( )
inlinestatic

Set the hardware to safe setting (noop).

Definition at line 52 of file BlinkerGPIO.hxx.

◆ instance()

static constexpr const Gpio * BLINKER_Pin::instance ( )
inlinestaticconstexpr
Returns
static virtual Gpio instance.

Definition at line 76 of file BlinkerGPIO.hxx.

◆ is_output()

static bool BLINKER_Pin::is_output ( )
inlinestatic
Returns
true, as the BLINKER_Pin cannot be set to an input.

Definition at line 71 of file BlinkerGPIO.hxx.

◆ set()

static void BLINKER_Pin::set ( bool  value)
inlinestatic

Set the pin to a specific value.

Parameters
valuewhat to set the pin to.

Definition at line 56 of file BlinkerGPIO.hxx.

◆ toggle()

static void BLINKER_Pin::toggle ( )
inlinestatic

Toggle the pin (set to opposite value than previously).

Definition at line 61 of file BlinkerGPIO.hxx.


The documentation for this struct was generated from the following file: