Wim Huiskamp / PT6318
Embed: (wiki syntax)

« Back to documentation index

PT6318 Class Reference

PT6318 Class Reference

A class for driving Princeton PT6318 VFD controller. More...

#include <PT6318.h>

Inherited by PT6318_KUH8300.

Public Types

enum  Mode {
  Grid8_Seg20 = PT6318_GR8_SEG20, Grid9_Seg19 = PT6318_GR9_SEG19, Grid10_Seg18 = PT6318_GR10_SEG18, Grid11_Seg17 = PT6318_GR11_SEG17,
  Grid12_Seg16 = PT6318_GR12_SEG16, Grid13_Seg15 = PT6318_GR13_SEG15, Grid14_Seg14 = PT6318_GR14_SEG14, Grid15_Seg13 = PT6318_GR15_SEG13,
  Grid16_Seg12 = PT6318_GR16_SEG12
}
 

Enums for display mode.

More...
typedef char DisplayData_t [PT6318_DISPLAY_MEM]
 Datatypes for display and keymatrix data.

Public Member Functions

 PT6318 (PinName mosi, PinName miso, PinName sclk, PinName cs, Mode mode=Grid16_Seg12)
 Constructor for class for driving Princeton PT6318 VFD controller.
void cls ()
 Clear the screen and locate to 0.
void writeData (char data, int address)
 Write databyte to PT6318.
void writeData (DisplayData_t data, int length=PT6318_DISPLAY_MEM, int address=0)
 Write Display datablock to PT6318.
bool getKeys (KeyData_t *keydata)
 Read keydata block from PT6318.
char getSwitches ()
 Read switches from PT6318.
void setLED (char leds=0)
 Set LEDs.
void setBrightness (char brightness=PT6318_BRT_DEF)
 Set Brightness.
void setDisplay (bool on)
 Set the Display mode On/off.

Detailed Description

A class for driving Princeton PT6318 VFD controller.

Supports 8 Grids of 20 Segments upto 16 Grids of 12 Segments. Also supports a scanned keyboard of upto 48 keys, 4 switches and 5 LEDs. SPI bus interface device.

Definition at line 154 of file PT6318.h.


Member Typedef Documentation

typedef char DisplayData_t[PT6318_DISPLAY_MEM]

Datatypes for display and keymatrix data.

Definition at line 171 of file PT6318.h.


Member Enumeration Documentation

enum Mode

Enums for display mode.

Enumerator:
Grid8_Seg20 

8 Grids, 20 Segments

Grid9_Seg19 

9 Grids, 19 Segments

Grid10_Seg18 

10 Grids, 18 Segments

Grid11_Seg17 

11 Grids, 17 Segments

Grid12_Seg16 

12 Grids, 16 Segments

Grid13_Seg15 

13 Grids, 15 Segments

Grid14_Seg14 

14 Grids, 14 Segments

Grid15_Seg13 

15 Grids, 13 Segments

Grid16_Seg12 

16 Grids, 12 Segments

Definition at line 158 of file PT6318.h.


Constructor & Destructor Documentation

PT6318 ( PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  cs,
Mode  mode = Grid16_Seg12 
)

Constructor for class for driving Princeton PT6318 VFD controller.

Supports 8 Grids of 20 Segments upto 16 Grids of 12 Segments. Also supports a scanned keyboard of upto 32 keys, 4 switches and 5 LEDs. SPI bus interface device.

Parameters:
PinNamemosi, miso, sclk, cs SPI bus pins
Modeselects either number of Grids and Segments (default 16 Grids, 12 Segments)

Supports 8 Grids of 20 Segments upto 16 Grids of 12 Segments. Also supports a scanned keyboard of upto 48 keys, 4 switches and 5 LEDs. SPI bus interface device.

Parameters:
PinNamemosi, miso, sclk, cs SPI bus pins
Modeselects either number of Digits and Segments

Definition at line 33 of file PT6318.cpp.


Member Function Documentation

void cls (  )

Clear the screen and locate to 0.

Definition at line 63 of file PT6318.cpp.

bool getKeys ( KeyData_t *  keydata )

Read keydata block from PT6318.

Parameters:
*keydataPtr to Array of PT6318_KEY_MEM (=6) bytes for keydata
Returns:
bool keypress True when at least one key was pressed

Note: Due to the hardware configuration the PT6318 key matrix scanner will detect multiple keys pressed at same time, but this may result in some spurious keys also being set in keypress data array. It may be best to ignore all keys in those situations. That option is implemented in this method depending on define setting.

Parameters:
*keydataPtr to Array of PT6318_KEY_MEM (=6) bytes for keydata
Returns:
bool keypress True when at least one key was pressed

Note: Due to the hardware configuration the PT6318 key matrix scanner will detect multiple keys pressed at same time, but this may also result in some spurious keys being set in keypress data array. It may be best to ignore all keys in those situations. That option is implemented in this method depending on define setting.

Definition at line 161 of file PT6318.cpp.

char getSwitches (  )

Read switches from PT6318.

Parameters:
none
Returns:
char for switch data (4 least significant bits)

Definition at line 206 of file PT6318.cpp.

void setBrightness ( char  brightness = PT6318_BRT_DEF )

Set Brightness.

Parameters:
charbrightness (3 significant bits, valid range 0..7 (1/16 .. 14/16 dutycycle)
Returns:
none

Definition at line 83 of file PT6318.cpp.

void setDisplay ( bool  on )

Set the Display mode On/off.

Parameters:
booldisplay mode

Definition at line 95 of file PT6318.cpp.

void setLED ( char  leds = 0 )

Set LEDs.

Parameters:
charleds (5 least significant bits)
Returns:
none
Parameters:
charleds (4 least significant bits)
Returns:
none

Definition at line 233 of file PT6318.cpp.

void writeData ( DisplayData_t  data,
int  length = PT6318_DISPLAY_MEM,
int  address = 0 
)

Write Display datablock to PT6318.

Parameters:
DisplayData_tdata Array of PT6318_DISPLAY_MEM (=48) bytes for displaydata (starting at address)
lengthnumber bytes to write (valid range 0..PT6318_DISPLAY_MEM (=48), starting at address)
intaddress display memory location to write byte (default = 0)
Returns:
none
Parameters:
DisplayData_tdata Array of PT6318_DISPLAY_MEM (=48) bytes for displaydata (starting at address)
lengthnumber bytes to write (valid range 0..PT6318_DISPLAY_MEM (=48), starting at address)
intaddress display memory location to write byte
Returns:
none

Reimplemented in PT6318_KUH8300.

Definition at line 130 of file PT6318.cpp.

void writeData ( char  data,
int  address 
)

Write databyte to PT6318.

Parameters:
chardata byte written at given address
intaddress display memory location to write byte
Returns:
none

Definition at line 112 of file PT6318.cpp.