Allows for a 90 frame animated gauge to be display on the uLCD

Dependents:   uLCDgaugeTest

Embed: (wiki syntax)

« Back to documentation index

uLCD_gauges Class Reference

uLCD_gauges Class Reference

Header file for uLCD gauges library. More...

#include <uLCD_gauges.h>

Public Member Functions

 uLCD_gauges (uLCD_4DGL &screen, float min, float max)
 Constructor for the uLCD_gauges class.
 uLCD_gauges (uLCD_4DGL &screen, float min, float max, int lowF, int highF, long memoryAddressHigh, long memoryAddressLow)
 Constructor for the uLCD_gauges class.
void start ()
 This method repares the uLCD for displaying the gauge.
void update (float value)
 This method updates the gauge based on the new input value.

Detailed Description

Header file for uLCD gauges library.

Definition at line 10 of file uLCD_gauges.h.


Constructor & Destructor Documentation

uLCD_gauges ( uLCD_4DGL &  screen,
float  min,
float  max 
)

Constructor for the uLCD_gauges class.

Sets up the value mapping assuming the default gauge is used.

Parameters:
screenThe uLCD instance that is going to be used for the gauge
minThe minimum value the gauge wil be updated with. Used for mapping.
maxThe maximum value the gauge wil be updated with. Used for mapping.

Definition at line 11 of file uLCD_gauges.cpp.

uLCD_gauges ( uLCD_4DGL &  screen,
float  min,
float  max,
int  lowF,
int  highF,
long  memoryAddressHigh,
long  memoryAddressLow 
)

Constructor for the uLCD_gauges class.

Sets up the value mapping for custom gauges.

Parameters:
screenThe uLCD instance that is going to be used for the gauge
minThe minimum value the gauge wil be updated with. Used for mapping.
maxThe maximum value the gauge wil be updated with. Used for mapping.
memoryAddressHighThe ending memory address of the animation that will be displayed as a gauge.
memoryAddressLowThe starting memory address of the animation that will be displayed as a gauge.

Definition at line 22 of file uLCD_gauges.cpp.


Member Function Documentation

void start (  )

This method repares the uLCD for displaying the gauge.

Must be called once after object instancing

Definition at line 33 of file uLCD_gauges.cpp.

void update ( float  value )

This method updates the gauge based on the new input value.

Parameters:
valueThe value to be mapped onto the display

Definition at line 40 of file uLCD_gauges.cpp.