OledTelemetry128x64 Class Reference

Telemetry display via 128x64 monochrome OLED. More...

#include <SimWheelUI.hpp>

Public Member Functions
	OledTelemetry128x64 (const OLEDParameters &params, I2CBus bus=I2CBus::SECONDARY, bool enableFlashing=true, OledDashboard initialDashboard=OledDashboard::_DEFAULT, InputNumber nextDash=UNSPECIFIED::VALUE)
	Create an Oled Telemetry display (128x64)
	OledTelemetry128x64 (const OLEDParameters &params, uint8_t address7bits, I2CBus bus=I2CBus::SECONDARY, bool enableFlashing=true, OledDashboard initialDashboard=OledDashboard::_DEFAULT, InputNumber nextDash=UNSPECIFIED::VALUE)
	Create an Oled Telemetry display (128x64)
virtual void	onStart () override
	Called just once after initialization.
virtual void	onConnected () override
	Notify device is connected.
virtual void	onBLEdiscovering () override
	Notify device is in discovery mode.
virtual void	onTelemetryData (const TelemetryData *pTelemetryData) override
	Notify new telemetry data.
virtual void	serveSingleFrame (uint32_t elapsedMs) override
	Draw a single frame.
virtual void	onBitePoint (uint8_t bitePoint) override
	Notify a change in the current bite point.
virtual void	onLowBattery () override
	Notify low battery.
virtual void	onSaveSettings () override
	Notify that user settings have been saved to flash memory.
virtual void	onUserInput (uint8_t inputNumber) override
	Notify user input.
virtual void	shutdown () override
	Cut power to the UI hardware.
virtual uint8_t	getMaxFPS () override
	Get the maximum FPS supported by the underlying hardware.
virtual uint16_t	getStackSize () override
	Get the stack size required by this user interface.
Public Member Functions inherited from AbstractUserInterface
	AbstractUserInterface (const AbstractUserInterface &)=delete
AbstractUserInterface &	operator= (const AbstractUserInterface &)=delete

Additional Inherited Members
Public Attributes inherited from AbstractUserInterface
bool	requiresPowertrainTelemetry = false
	Set to true to receive and use powertrain telemetry data.
bool	requiresECUTelemetry = false
	Set to true to receive and use ECU telemetry data.
bool	requiresRaceControlTelemetry = false
	Set to true to receive and use race control telemetry data.
bool	requiresGaugeTelemetry = false
	Set to true to receive and use telemetry data for gauges.
bool	requiresWheelTelemetry = false
	Set to true to receive and use wheel telemetry data.
Protected Member Functions inherited from AbstractUserInterface
uint32_t	frameTimer (uint32_t &timerVariable, uint32_t elapsedTimeMs, uint32_t timeLimitMs)
	Simple timer.

Detailed Description

Telemetry display via 128x64 monochrome OLED.

Definition at line 153 of file SimWheelUI.hpp.

Constructor & Destructor Documentation

OledTelemetry128x64() [1/2]

OledTelemetry128x64::OledTelemetry128x64	(	const OLEDParameters &	params,
		I2CBus	bus = I2CBus::SECONDARY,
		bool	enableFlashing = true,
		OledDashboard	initialDashboard = OledDashboard::_DEFAULT,
		InputNumber	nextDash = UNSPECIFIED::VALUE )

Create an Oled Telemetry display (128x64)

Parameters

params	OLED hardware parameters
bus	I2C bus
enableFlashing	Whether to allow screen flashing or not
initialDashboard	Dashboard to show at first
nextDash	Input number to cycle to the next dashboard. Set to UNSPECIFIED::VALUE to disable. The input number must be routed by inputHub::route_to_ui::add()

OledTelemetry128x64() [2/2]

OledTelemetry128x64::OledTelemetry128x64	(	const OLEDParameters &	params,
		uint8_t	address7bits,
		I2CBus	bus = I2CBus::SECONDARY,
		bool	enableFlashing = true,
		OledDashboard	initialDashboard = OledDashboard::_DEFAULT,
		InputNumber	nextDash = UNSPECIFIED::VALUE )

Create an Oled Telemetry display (128x64)

Parameters

params	OLED hardware parameters
address7bits	Full I2C address in 7 bit format
bus	I2C bus
enableFlashing	Whether to allow screen flashing or not
initialDashboard	Dashboard to show at first
nextDash	Input number to cycle to the next dashboard. Set to UNSPECIFIED::VALUE to disable. The input number must be routed by inputHub::route_to_ui::add()

Member Function Documentation

getMaxFPS()

virtual uint8_t OledTelemetry128x64::getMaxFPS ( )

inlineoverridevirtual

Get the maximum FPS supported by the underlying hardware.

Note

You must override this method to receive telemetry data

Returns

uint8_t Frames per second.

Reimplemented from AbstractUserInterface.

Definition at line 248 of file SimWheelUI.hpp.

getStackSize()

virtual uint16_t OledTelemetry128x64::getStackSize ( )

inlineoverridevirtual

Get the stack size required by this user interface.

Warning

You should override this method if you get "stack canary" or "dual exception" errors.

Returns

uin16_t Stack size in bytes for the notification/frameserver daemon. Return zero to use a default value. Increase the stack size if you get "stack canary" or "dual exception" errors and reboots.

Reimplemented from AbstractUserInterface.

Definition at line 249 of file SimWheelUI.hpp.

onBitePoint()

virtual void OledTelemetry128x64::onBitePoint ( uint8_t bitePoint )

overridevirtual

Notify a change in the current bite point.

Parameters

bitePoint

Last known bite point.

Reimplemented from AbstractUserInterface.

onBLEdiscovering()

virtual void OledTelemetry128x64::onBLEdiscovering ( )

overridevirtual

Notify device is in discovery mode.

Reimplemented from AbstractUserInterface.

onConnected()

virtual void OledTelemetry128x64::onConnected ( )

overridevirtual

Notify device is connected.

Reimplemented from AbstractUserInterface.

onLowBattery()

virtual void OledTelemetry128x64::onLowBattery ( )

overridevirtual

Notify low battery.

Note

Called at timed intervals while the low battery condition persists.

Reimplemented from AbstractUserInterface.

onSaveSettings()

virtual void OledTelemetry128x64::onSaveSettings ( )

overridevirtual

Notify that user settings have been saved to flash memory.

Reimplemented from AbstractUserInterface.

onStart()

virtual void OledTelemetry128x64::onStart ( )

overridevirtual

Called just once after initialization.

Reimplemented from AbstractUserInterface.

onTelemetryData()

virtual void OledTelemetry128x64::onTelemetryData ( const TelemetryData * pTelemetryData )

overridevirtual

Notify new telemetry data.

Parameters

pTelemetryData

Pointer to telemetry data. Can be null. Safe to store for later use.

Note

For this method to get called, user code must meet the following requirements:

• getMaxFPS must return non-zero.
• At instance creation, one of the requiresXXXTelemetry attributes must be set to true.

Always called just before serveSingleFrame(). This method may draw a display frame into a buffer, while serveSingleFrame() just displays that frame buffer.

pTelemetryData is null when no telemetry data has been received in the previous two seconds. May be used to turn the display off.

Must not enter an infinite loop. Must return as soon as possible.

Reimplemented from AbstractUserInterface.

onUserInput()

virtual void OledTelemetry128x64::onUserInput ( uint8_t inputNumber )

overridevirtual

Notify user input.

Parameters

inputNumber

Input number that was pressed

Reimplemented from AbstractUserInterface.

serveSingleFrame()

virtual void OledTelemetry128x64::serveSingleFrame ( uint32_t elapsedMs )

overridevirtual

Draw a single frame.

Parameters

elapsedMs

Elapsed milliseconds since last call.

Note

Called at timed intervals when no notifications are pending. Do not assume perfect timing.

Must not enter an infinite loop. Must return as soon as possible.

Reimplemented from AbstractUserInterface.

shutdown()

virtual void OledTelemetry128x64::shutdown ( )

overridevirtual

Cut power to the UI hardware.

Note

This is a command, not a notification. Not reversible.

Reimplemented from AbstractUserInterface.

---

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

• /github/workspace/src/include/SimWheelUI.hpp