Loom_OLED class

Base classes

class LoomLogPlat

Abstract base of logging platforms.

Public types

enum Version { FEATHERWING, BREAKOUT }

Different forms of the OLED display.

enum Format { FOUR, EIGHT, SCROLL }

Different formats to display information in.

enum FreezeType { DISABLE, DATA, SCROLL }

Differnt freeze behaviors.

Protected variables

Adafruit_SSD1306 display

Underlying OLED controller.

Version version

What type the OLED is (FeatherWing or breakout)

byte reset_pin

The reset pin (only applies to breakout version)

Format display_format

How to display the data on OLED.

uint scroll_duration

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

byte freeze_pin

Which pin to check if display should freeze.

FreezeType freeze_behavior

What 'freezing' behavior should be followed.

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.

Loom_OLED(LoomManager* manager, JsonArrayConst p)

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

~Loom_OLED() defaulted

Destructor.

OPERATION

auto log(JsonObject json) -> bool override

Log a Json object.

PRINT INFORMATION

void print_config() const override

Display the configuration settings of the module.

GETTERS

auto get_display_format() const -> Format

Get the current OLED display organization.

auto get_scroll_duration() const -> uint

Get the current scroll duration.

auto get_freeze_pin() const -> byte

Get the digital pin use to freeze the display.

auto get_freeze_behavior() const -> FreezeType

Get the current freeze behavior.

SETTERS

void set_display_format(const Format format)

Set the OLED display organization.

void set_scroll_duration(const uint duration)

Set the duration of a complete scroll.

void set_freeze_pin(const byte pin)

Set the digital pin to use to freeze the display.

void set_freeze_behavior(const FreezeType behavior)

Set the freezing behavior of the display.

MISCELLANEOUS

unsigned long previous_time

Last display update time.

static auto enum_oled_version_string(const Version v) -> const char*

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

static auto enum_oled_format_string(const Format f) -> const char*

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

static auto enum_oled_freeze_string(const FreezeType f) -> const char*

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

Enum documentation

Function documentation

Variable documentation