This class is a readonly system-details panel. More...

#include <grmcdorman/device/SystemDetailsDisplay.h>

Inheritance diagram for grmcdorman::device::SystemDetailsDisplay:

Public Member Functions
	SystemDetailsDisplay ()
	Construct a new SystemDetailsDisplay Device object.

const __FlashStringHelper *	identifier () const override
	The device identifier, "system_details". More...

void	setup () override
	Setup. More...

void	loop () override
	Loop. More...

DynamicJsonDocument	as_json () const override
	Get the values, as a JSON document. More...

Public Member Functions inherited from grmcdorman::device::Device
	Device (const __FlashStringHelper device_name, const __FlashStringHelper device_identifier)
	Construct a new Device object. More...

virtual	~Device ()
	Destroy the Device object.

const __FlashStringHelper *	name () const
	Get the device name; used for UI names and IDs. More...

virtual void	set_defaults ()
	Set defaults, if necessary. More...

virtual void	set_devices (const std::vector< Device * > &list)
	For devices that support it, add devices to manage. More...

virtual bool	publish (DynamicJsonDocument &json) const
	Publish the value and attributes. More...

const definition_list_t &	get_definitions () const
	Get the definitions list. More...

const ::grmcdorman::SettingInterface::settings_list_t &	get_settings () const
	Get the settings list. More...

bool	is_enabled () const
	Get whether this device is enabled. More...

void	set_enabled (bool state)
	Set whether this device is enabled. More...

void	set (const String &setting, const String &value)
	If possible, set a setting's value. More...

String	get (const String &setting) const
	Get a setting value, as a string. More...

virtual String	get_status () const
	Get a status report. More...

virtual bool	get_is_published () const
	Get whether the device readings have been published. More...

void	set_is_published ()
	Set the device as having published readings. More...

void	clear_is_published ()
	Set the device as not having published readings.

Additional Inherited Members
Public Types inherited from grmcdorman::device::Device
typedef std::vector< const Definition * >	definition_list_t
	The type containing a list of Definition objects.

Static Public Member Functions inherited from grmcdorman::device::Device
static void	set_system_identifiers (const __FlashStringHelper *firmware_name_value, const String &system_identifier_value=String())
	Set the system identifier values. More...

static const __FlashStringHelper *	get_firmware_name ()
	Get the firmware prefix. More...

static const String &	get_system_identifier ()
	Get the system identifier. More...

Static Public Attributes inherited from grmcdorman::device::Device
static constexpr int	D0 = 16
	D0 is GPIO16, HIGH at boot, not suitable for most usages.

static constexpr int	D1 = 5
	D1 is GPIO5; often used as SCL.

static constexpr int	D2 = 4
	D2 is GPIO4; often used as SDA.

static constexpr int	D3 = 0
	D3 is GPIO0; pulled up; connected to FLASH button; not for input.

static constexpr int	D4 = 2
	D4 is GPIO2; pulled up; HIGH at boot; on-board LED; not for input.

static constexpr int	D5 = 14
	D5 is GPIO14; SPI (SCLK)

static constexpr int	D6 = 12
	D6 is GPIO12; SPI (MISO)

static constexpr int	D7 = 13
	D7 is GPIO13; SPI (MOSI)

static constexpr int	D8 = 15
	D8 is GPIO15; pulled to GND; SPI (CS); not recommended.

static const ExclusiveOptionSetting::names_list_t	data_line_names { FPSTR("D1"), FPSTR("D2"), FPSTR("D3"), FPSTR("D5"), FPSTR("D6"), FPSTR("D7")}
	Names for each configurable data line; see `settingsMap`.

Protected Member Functions inherited from grmcdorman::device::Device
void	initialize (definition_list_t &&definition_list, ::grmcdorman::SettingInterface::settings_list_t &&setting_list)
	Initialize the definition and setting lists. More...

Static Protected Member Functions inherited from grmcdorman::device::Device
static int	index_to_dataline (int index)
	Convert a data line index to a ESP data line. More...

static int	dataline_to_index (int dataLine)
	Convert a data line to an index. More...

Protected Attributes inherited from grmcdorman::device::Device
ToggleSetting	enabled
	Whether this device is enabled.

Static Protected Attributes inherited from grmcdorman::device::Device
static const int	settingsMap [6]
	The set of data lines usable for communication. More...

Detailed Description

This class is a readonly system-details panel.

It does not publish data and has no configuration.

This panel contains only static non-updating data.

Member Function Documentation

◆ as_json()

DynamicJsonDocument grmcdorman::device::SystemDetailsDisplay::as_json ( ) const

overridevirtual

Get the values, as a JSON document.

The structure is identical to the document created inside publish.

Returns: DynamicJsonDocument

Reimplemented from grmcdorman::device::Device.

◆ identifier()

const __FlashStringHelper * grmcdorman::device::SystemDetailsDisplay::identifier ( ) const

inlineoverridevirtual

The device identifier, "system_details".

Returns: Device identifier.

Reimplemented from grmcdorman::device::Device.

◆ loop()

void grmcdorman::device::SystemDetailsDisplay::loop ( )

inlineoverridevirtual

Loop.

This class has no loop operations.

Implements grmcdorman::device::Device.

◆ setup()

void grmcdorman::device::SystemDetailsDisplay::setup ( )

inlineoverridevirtual

Setup.

Set the firmware identifier.

Implements grmcdorman::device::Device.

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

grmcdorman/device/SystemDetailsDisplay.h
SystemDetailsDisplay.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ as_json()

◆ identifier()

◆ loop()

◆ setup()