OLED logging platform module. More...

#include <OLED.h>

Inheritance diagram for Loom_OLED:

Public Types
enum	Version { Version::FEATHERWING, Version::BREAKOUT }
	Different forms of the OLED display. More...

enum	Format { Format::FOUR, Format::EIGHT, Format::SCROLL }
	Different formats to display information in. More...

enum	FreezeType { FreezeType::DISABLE, FreezeType::DATA, FreezeType::SCROLL }
	Differnt freeze behaviors. More...

Public Types inherited from LoomModule
enum	Type { Type::Unknown = 0, Type::Other =1000, Type::Interrupt_Manager, Type::Sleep_Manager, Type::Multiplexer, Type::NTP, Type::TempSync, Type::WarmUp_Manager, Type::Sensor =2000, Type::Analog, Type::Digital, Type::I2C =2100, Type::ADS1115, Type::AS7262, Type::AS7263, Type::AS7265X, Type::FXAS21002, Type::FXOS8700, Type::LIS3DH, Type::MB1232, Type::MMA8451, Type::MPU6050, Type::MS5803, Type::SHT31D, Type::TMP007, Type::TSL2561, Type::TSL2591, Type::ZXGesture, Type::STEMMA, Type::SDI12 =2200, Type::Decagon5TM, Type::DecagonGS3, Type::SPI =2300, Type::MAX31855, Type::MAX31856, Type::L_SERIAL =2400, Type::K30, Type::L_RTC =3000, Type::DS3231, Type::PCF8523, Type::Actuator =4000, Type::Neopixel, Type::Relay, Type::Servo, Type::Stepper, Type::LogPlat =5000, Type::OLED, Type::SDCARD, Type::BATCHSD, Type::CommPlat =6000, Type::LoRa, Type::nRF, Type::Bluetooth, Type::InternetPlat =7000, Type::Ethernet, Type::WiFi, Type::LTE, Type::PublishPlat =8000, Type::GoogleSheets, Type::MaxPub, Type::SpoolPub, Type::SubscribePlats =9000, Type::MaxSub }
	Enum to check against to when finding individual component managed by a LoomManager. More...

enum	Category { Category::Unknown =0, Category::Other =1, Category::Sensor =2, Category::L_RTC =3, Category::Actuator =4, Category::LogPlat =5, Category::CommPlat =6, Category::InternetPlat =7, Category::PublishPlat =8, Category::SubscribePlat =9 }
	Enum to classify modules. More...

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	Loom_OLED (LoomManager *manager, const bool enable_rate_filter=true, const uint16_t min_filter_delay=300, const Version type=Version::FEATHERWING, const byte reset_pin=A2, const Format display_format=Format::SCROLL, const uint16_t scroll_duration=6000, const byte freeze_pin=10, const FreezeType freeze_behavior=FreezeType::SCROLL)
	OLED module constructor. More...

	Loom_OLED (LoomManager *manager, JsonArrayConst p)
	Constructor that takes Json Array, extracts args and delegates to regular constructor. More...

	~Loom_OLED ()=default
	Destructor. More...

OPERATION
bool	log (JsonObject json) override
	Log a Json object. More...

PRINT INFORMATION
void	print_config () const override
	Display the configuration settings of the module. More...

GETTERS
Format	get_display_format () const
	Get the current OLED display organization. More...

uint	get_scroll_duration () const
	Get the current scroll duration. More...

byte	get_freeze_pin () const
	Get the digital pin use to freeze the display. More...

FreezeType	get_freeze_behavior () const
	Get the current freeze behavior. More...

SETTERS
void	set_display_format (const Format format)
	Set the OLED display organization. More...

void	set_scroll_duration (const uint duration)
	Set the duration of a complete scroll. More...

void	set_freeze_pin (const byte pin)
	Set the digital pin to use to freeze the display. More...

void	set_freeze_behavior (const FreezeType behavior)
	Set the freezing behavior of the display. More...

Public Member Functions inherited from LoomLogPlat
	LoomLogPlat (LoomManager manager, const char module_name, const LoomModule::Type module_type, const bool enable_rate_filter=true, const uint16_t min_filter_delay=1000)
	Constructor. More...

virtual	~LoomLogPlat ()=default
	Destructor. More...

virtual void	package (JsonObject json) override
	No package necessary for logging platforms. More...

bool	log ()
	Version of log for use with LoomManager. More...

Public Member Functions inherited from LoomModule
	LoomModule (LoomManager manager, const char module_name="Unknown", const Type module_type=Type::Unknown)
	Constructor. More...

virtual	~LoomModule ()=default
	Destructor. More...

virtual void	second_stage_ctor ()
	Second stage construction. More...

virtual bool	dispatch (JsonObject json)
	Route command to driver. More...

virtual void	power_down ()
	Turn off any hardware. More...

virtual void	power_up ()
	Turn on any hardware. More...

virtual void	add_config (JsonObject json)
	Add configuration information to JsonObject. More...

Type	get_module_type () const
	Get module type. More...

LoomManager *	get_device_manager () const
	Get the device manager class if linked. More...

void	get_module_name (char *buf) const
	Copy module name into buffer. More...

const char *	get_module_name () const
	Get module name. More...

Verbosity	get_print_verbosity () const
	Get print verbosity. More...

Verbosity	get_package_verbosity () const
	Get package verbosity. More...

bool	get_active () const
	Get whether or not the module should be treated as active. More...

Category	category () const
	Get the category of the module. More...

virtual void	link_device_manager (LoomManager *LM)
	Add pointer back to device manager. More...

void	set_print_verbosity (const Verbosity v)
	Set print verbosity Controlls level of detail included in debug prints. More...

void	set_package_verbosity (const Verbosity v)
	Set package verbosity. More...

void	set_active (const bool enable)
	Set whether or not the module should be treated as active. More...

virtual void	print_state () const
	Display current state of the module. More...

Protected Attributes
Adafruit_SSD1306	display
	Underlying OLED controller. More...

Version	version
	What type the OLED is (FeatherWing or breakout) More...

byte	reset_pin
	The reset pin (only applies to breakout version) More...

Format	display_format
	How to display the data on OLED. More...

uint	scroll_duration
	The duration to complete a full cycle through a bundle of data (milliseconds)(non-blocking) More...

byte	freeze_pin
	Which pin to check if display should freeze. More...

FreezeType	freeze_behavior
	What 'freezing' behavior should be followed. More...

Protected Attributes inherited from LoomLogPlat
bool	enable_rate_filter
	Whether or not to enable a minimum delay between logging. More...

uint16_t	min_filter_delay
	Minimum delay between logging (milliseconds) More...

unsigned long	last_log_millis
	Value of millis() at last executed log time. More...

Protected Attributes inherited from LoomModule
const Type	module_type
	Module type. More...

LoomManager *	device_manager
	Pointer to manager. More...

const String	module_name_base
	The name of the module (Should have a DEFAULT but can be overriden if provided to constructor) More...

const char *	module_name

bool	active
	Whether or not the module should be treated as active. More...

Verbosity	print_verbosity
	Print verbosity. More...

Verbosity	package_verbosity
	Package verbosity. More...

MISCELLANEOUS
static const char *	enum_oled_version_string (const Version v)
	Get c-string of name associated with OLED::Version enum. More...

static const char *	enum_oled_format_string (const Format f)
	Get c-string of name associated with OLED:Format enum. More...

static const char *	enum_oled_freeze_string (const FreezeType f)
	Get c-string of name associated with OLED freeze behavior enum. More...

Additional Inherited Members
Static Public Member Functions inherited from LoomModule
static const char *	enum_verbosity_string (const Verbosity v)
	Get string of name associated with verbosity enum. More...

static const char *	enum_category_string (const Category c)
	Get string of the category associated with a Category. More...

Protected Member Functions inherited from LoomLogPlat
bool	check_millis ()
	Check against millis to determine if time since last log exceeds min time. More...

Protected Member Functions inherited from LoomModule
void	print_module_label () const
	Print the module name as a label. More...

Detailed Description

OLED logging platform module.

Resources

Member Enumeration Documentation

enum Loom_OLED::Format

strong

Different formats to display information in.

Enumerator
FOUR	4 Key values
EIGHT	8 Key values
SCROLL	Scrolling.

enum Loom_OLED::FreezeType

strong

Differnt freeze behaviors.

Enumerator
DISABLE	Freeze disabled.
DATA	Screen freezes.
SCROLL	Scroll freezes, data updates.

enum Loom_OLED::Version

strong

Different forms of the OLED display.

Enumerator
FEATHERWING	FeatherWing OLED.
BREAKOUT	Breakout board.

Constructor & Destructor Documentation

Loom_OLED::Loom_OLED	(	LoomManager *	manager,
		const bool	enable_rate_filter = `true`,
		const uint16_t	min_filter_delay = `300`,
		const Version	type = `Version::FEATHERWING`,
		const byte	reset_pin = `A2`,
		const Format	display_format = `Format::SCROLL`,
		const uint16_t	scroll_duration = `6000`,
		const byte	freeze_pin = `10`,
		const FreezeType	freeze_behavior = `FreezeType::SCROLL`
	)

OLED module constructor.

Parameters

[in]	enable_rate_filter	Bool \| <true> \| {true, false} \| Whether or not to impose maximum update rate
[in]	min_filter_delay	Int \| <300> \| [50-5000] \| Minimum update delay, if enable_rate_filter enabled
[in]	type	Set(Version) \| <0> \| {0("Featherwing"), 1("Breakout")} \| Which version of the OLED is being used
[in]	reset_pin	Set(Int) \| <14> \| {5, 6, 9, 10, 11, 12, 13, 14("A0"), 15("A1"), 16("A2"), 17("A3"), 18("A4"), 19("A5")} \| Which pin should be used for reseting. Only applies to breakout version
[in]	display_format	Set(Format) \| <A0> \| {0("4 pairs"), 1("8 pairs"), 2("Scrolling")} \| How to display the key value pairs of a bundle
[in]	scroll_duration	Int \| <6000> \| [500-30000] \| The time (ms) to complete full scroll cycle if display_format is SCROLL
[in]	freeze_pin	Set(Int) \| <10> \| {5, 6, 9, 10, 11, 12, 13, 14("A0"), 15("A1"), 16("A2"), 17("A3"), 18("A4"), 19("A5")} \| Which pin should be used to pause the display
[in]	freeze_behavior	Set(FreezeType) \| <2> \| {O("Disable"), 1("Pause Data"), 2("Pause Data and Scroll")} \| How freezing the display should behave

Loom_OLED::Loom_OLED	(	LoomManager *	manager,
		JsonArrayConst	p
	)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters

[in] p The array of constuctor args to expand

Loom_OLED::~Loom_OLED ( )

default

Destructor.

Member Function Documentation

const char * Loom_OLED::enum_oled_format_string ( const Format f )

static

Get c-string of name associated with OLED:Format enum.

Parameters

[in] f OLED::Format value to get string of

Returns: C-string of OLED format

const char * Loom_OLED::enum_oled_freeze_string ( const FreezeType f )

static

Get c-string of name associated with OLED freeze behavior enum.

Parameters

[in] f FreezeType to get string of

Returns: C-string of OLED freeze behavior

const char * Loom_OLED::enum_oled_version_string ( const Version v )

static

Get c-string of name associated with OLED::Version enum.

Parameters

[in] v OLED::Version value to get string of

Returns: C-string of OLED version

Format Loom_OLED::get_display_format ( ) const

inline

Get the current OLED display organization.

Returns: The current Format being used

FreezeType Loom_OLED::get_freeze_behavior ( ) const

inline

Get the current freeze behavior.

Returns: The current freeze behavior

byte Loom_OLED::get_freeze_pin ( ) const

inline

Get the digital pin use to freeze the display.

Returns: The freeze pin

uint Loom_OLED::get_scroll_duration ( ) const

inline

Get the current scroll duration.

Returns: The current scroll duration

bool Loom_OLED::log ( JsonObject json )

overridevirtual

Log a Json object.

Parameters

[in] json Json Object to log

Implements LoomLogPlat.

void Loom_OLED::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomLogPlat.

void Loom_OLED::set_display_format ( const Format format )

inline

Set the OLED display organization.

Parameters

[in] format The Format to set to

void Loom_OLED::set_freeze_behavior ( const FreezeType behavior )

inline

Set the freezing behavior of the display.

Parameters

[in] behavior Which FreezeType type to use

void Loom_OLED::set_freeze_pin ( const byte pin )

Set the digital pin to use to freeze the display.

Parameters

[in] pin The pin to use

void Loom_OLED::set_scroll_duration ( const uint duration )

inline

Set the duration of a complete scroll.

Parameters

[in] duration The duration to set to

Member Data Documentation

Adafruit_SSD1306 Loom_OLED::display

protected

Underlying OLED controller.

Format Loom_OLED::display_format

protected

How to display the data on OLED.

FreezeType Loom_OLED::freeze_behavior

protected

What 'freezing' behavior should be followed.

byte Loom_OLED::freeze_pin

protected

Which pin to check if display should freeze.

byte Loom_OLED::reset_pin

protected

The reset pin (only applies to breakout version)

uint Loom_OLED::scroll_duration

protected

The duration to complete a full cycle through a bundle of data (milliseconds)(non-blocking)

Version Loom_OLED::version

protected

What type the OLED is (FeatherWing or breakout)

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

src/LogPlats/OLED.h
src/LogPlats/OLED.cpp

Public Types

Public Member Functions

Protected Attributes

MISCELLANEOUS

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation