Loom_OLED Class Reference

#include <Loom_OLED.h>

Inheritance diagram for Loom_OLED:

Collaboration diagram for Loom_OLED:

Public Types
enum class	Version { FEATHERWING , BREAKOUT }
enum class	Format { FOUR , EIGHT , SCROLL }
enum class	FreezeType { DISABLE , DATA , SCROLL }

Public Member Functions
	Loom_OLED (Manager &man, 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)
Public Member Functions inherited from Module
	Module (const char *modName)
void	setModuleName (const char *modName)
virtual const char *	getModuleName ()
virtual void	printModuleName (const char *message)
virtual void	initialize ()=0
virtual void	measure ()=0
virtual void	package ()=0
virtual void	power_up ()=0
virtual void	power_down ()=0
virtual void	display_data ()

Protected Member Functions
void	power_up () override
void	power_down () override
void	measure () override
void	initialize () override
void	package () override
void	display_data () override

Additional Inherited Members
Public Attributes inherited from Module
bool	moduleInitialized = true
int	module_address = -1

Detailed Description

Class for driving the OLED display

Authors

Will Richards, Luke Goertzen

Member Enumeration Documentation

Format

enum class Loom_OLED::Format

strong

Different formats to display information in

FreezeType

enum class Loom_OLED::FreezeType

strong

Different freeze behaviors

Version

enum class Loom_OLED::Version

strong

Different forms of the OLED display

Constructor & Destructor Documentation

Loom_OLED()

Loom_OLED::Loom_OLED	(	Manager &	man,
		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
	)

Construct a new OLED interface

Parameters

man	Reference to the manager instance
enable_rate_filter	Whether or not to impose maximum update rate
min_filter_delay	Minimum update delay, if enable_rate_filter enabled
type	Which version of the OLED is being used (Version::FEATHERWING or Version::BREAKOUT)
reset_pin	Which pin should be used for reseting. Only applies to breakout version
display_format	How to display the key value pairs of a bundle (Format::Scroll, Format::FOUR or Format::EIGHT)
scroll_duration	The time (ms) to complete full scroll cycle if display_format is SCROLL
freeze_pin	Which pin should be used to pause the display
freeze_behavior	How freezing the display should behave (FreezeType::SCROLL, FreezeType::DATA or FreezeType::DISABLE)

Member Function Documentation

display_data()

void Loom_OLED::display_data ( )

overrideprotectedvirtual

Reimplemented from Module.

initialize()

void Loom_OLED::initialize ( )

overrideprotectedvirtual

Implements Module.

measure()

void Loom_OLED::measure ( )

inlineoverrideprotectedvirtual

Implements Module.

package()

void Loom_OLED::package ( )

inlineoverrideprotectedvirtual

Implements Module.

power_down()

void Loom_OLED::power_down ( )

inlineoverrideprotectedvirtual

Implements Module.

power_up()

void Loom_OLED::power_up ( )

inlineoverrideprotectedvirtual

Implements Module.

---

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

• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Hardware/Loom_OLED/Loom_OLED.h
• C:/Users/jwilt/AppData/Local/Arduino15/packages/loom4/hardware/samd/4.5/libraries/Loom/src/Hardware/Loom_OLED/Loom_OLED.cpp