SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SystemStatusLed Class Reference

Consumes the networking and websocket states and delta counts and updates the device LED accordingly. Inherit this class and override the methods to customize the behavior. More...

#include <sensesp/system/system_status_led.h>

Inheritance diagram for sensesp::SystemStatusLed:
[legend]

Public Member Functions

 SystemStatusLed (int pin)
 
virtual void set_input (SystemStatus new_value, uint8_t input_channel=0) override
 
virtual void set_input (int new_value, uint8_t input_channel=0) override
 
- Public Member Functions inherited from sensesp::ValueConsumer< SystemStatus >
void connect_from (ValueProducer< SystemStatus > *producer, uint8_t input_channel=0)
 
- Public Member Functions inherited from sensesp::ValueConsumer< int >
void connect_from (ValueProducer< int > *producer, uint8_t input_channel=0)
 

Protected Member Functions

virtual void set_wifi_no_ap ()
 
virtual void set_wifi_disconnected ()
 
virtual void set_wifimanager_activated ()
 
virtual void set_ws_disconnected ()
 
virtual void set_ws_authorizing ()
 
virtual void set_ws_connecting ()
 
virtual void set_ws_connected ()
 

Protected Attributes

PatternBlinkerblinker_
 

Detailed Description

Consumes the networking and websocket states and delta counts and updates the device LED accordingly. Inherit this class and override the methods to customize the behavior.

Definition at line 15 of file system_status_led.h.

Constructor & Destructor Documentation

◆ SystemStatusLed()

sensesp::SystemStatusLed::SystemStatusLed ( int  pin)

Definition at line 35 of file system_status_led.cpp.

Member Function Documentation

◆ set_input() [1/2]

void sensesp::SystemStatusLed::set_input ( int  new_value,
uint8_t  input_channel = 0 
)
overridevirtual

Used to set an input of this consumer. It is usually called automatically by a ValueProducer.

Parameters
new_valuethe value of the input
input_channelConsumers can have one or more inputs feeding them. This parameter allows you to specify which input number the producer is connecting to. For single input consumers, leave the index at zero.

Reimplemented from sensesp::ValueConsumer< int >.

Definition at line 85 of file system_status_led.cpp.

Here is the call graph for this function:

◆ set_input() [2/2]

void sensesp::SystemStatusLed::set_input ( SystemStatus  new_value,
uint8_t  input_channel = 0 
)
overridevirtual

Used to set an input of this consumer. It is usually called automatically by a ValueProducer.

Parameters
new_valuethe value of the input
input_channelConsumers can have one or more inputs feeding them. This parameter allows you to specify which input number the producer is connecting to. For single input consumers, leave the index at zero.

Reimplemented from sensesp::ValueConsumer< SystemStatus >.

Definition at line 59 of file system_status_led.cpp.

Here is the call graph for this function:

◆ set_wifi_disconnected()

void sensesp::SystemStatusLed::set_wifi_disconnected ( )
protectedvirtual

Definition at line 40 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_wifi_no_ap()

void sensesp::SystemStatusLed::set_wifi_no_ap ( )
protectedvirtual

Definition at line 39 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_wifimanager_activated()

void sensesp::SystemStatusLed::set_wifimanager_activated ( )
protectedvirtual

Definition at line 43 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_ws_authorizing()

void sensesp::SystemStatusLed::set_ws_authorizing ( )
protectedvirtual

Definition at line 49 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_ws_connected()

void sensesp::SystemStatusLed::set_ws_connected ( )
protectedvirtual

Definition at line 55 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_ws_connecting()

void sensesp::SystemStatusLed::set_ws_connecting ( )
protectedvirtual

Definition at line 52 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_ws_disconnected()

void sensesp::SystemStatusLed::set_ws_disconnected ( )
protectedvirtual

Definition at line 46 of file system_status_led.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ blinker_

PatternBlinker* sensesp::SystemStatusLed::blinker_
protected

Definition at line 18 of file system_status_led.h.


The documentation for this class was generated from the following files: