Wim Huiskamp / PT6311

Dependents:   mbed_PT6311

Embed: (wiki syntax)

« Back to documentation index

PT6311_VFDEM2 Class Reference

Constructor for class for driving Princeton PT6311 VFD controller as used in VFDEM2. More...

#include <PT6311.h>

Inherits PT6311.

Public Types

enum  Icon
 

Enums for Icons.

More...
enum  Mode
 

Enums for display mode.

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

Public Member Functions

 PT6311_VFDEM2 (PinName mosi, PinName miso, PinName sclk, PinName cs)
 Constructor for class for driving Princeton PT6311 VFD controller as used in VFDEM2.
int putc (int c)
 Write a character to the Display.
int printf (const char *format,...)
 Write a formatted string to the Display.
void locate (int column)
 Locate cursor to a screen column.
void cls (bool clrAll=false)
 Clear the screen and locate to 0.
void setIcon (Icon icon)
 Set Icon.
void clrIcon (Icon icon)
 Clr Icon.
void setUDC (unsigned char udc_idx, int udc_data)
 Set User Defined Characters (UDC)
int columns ()
 Number of screen columns.
void writeData (int address, char data)
 Write databyte to PT6311.
void writeData (DisplayData_t data, int length=(VFDEM2_NR_GRIDS *PT6311_BYTES_PER_GRID))
 Write Display datablock to PT6311.
void cls ()
 Clear the screen and locate to 0.
bool getKeys (KeyData_t *keydata)
 Read keydata block from PT6311.
char getSwitches ()
 Read switches from PT6311.
void setLED (char leds=0)
 Set LEDs.
void setBrightness (char brightness=PT6311_BRT_DEF)
 Set Brightness.
void setDisplay (bool on)
 Set the Display mode On/off.

Protected Member Functions

virtual int _putc (int value)
 Write a single character (Stream implementation)

Detailed Description

Constructor for class for driving Princeton PT6311 VFD controller as used in VFDEM2.

Supports 12 Grids of 16 Segments and Icons (10 digits of 14 segments plus some icons and another 2 Icon grids). Also supports a scanned keyboard of 7 keys and 1 LED.

Parameters:
PinNamemosi, miso, sclk, cs SPI bus pins

Definition at line 294 of file PT6311.h.


Member Typedef Documentation

typedef char DisplayData_t[PT6311_DISPLAY_MEM] [inherited]

Datatypes for display and keymatrix data.

Definition at line 171 of file PT6311.h.


Member Enumeration Documentation

enum Icon

Enums for Icons.

Definition at line 299 of file PT6311.h.

enum Mode [inherited]

Enums for display mode.

Definition at line 158 of file PT6311.h.


Constructor & Destructor Documentation

PT6311_VFDEM2 ( PinName  mosi,
PinName  miso,
PinName  sclk,
PinName  cs 
)

Constructor for class for driving Princeton PT6311 VFD controller as used in VFDEM2.

Supports 12 Grids of 16 Segments and Icons (10 digits of 14 Segments plus some icons and another 2 Icon grids). Also supports a scanned keyboard of 7 keys and 1 LED.

Parameters:
PinNamemosi, miso, sclk, cs SPI bus pins

Definition at line 296 of file PT6311.cpp.


Member Function Documentation

int _putc ( int  value ) [protected, virtual]

Write a single character (Stream implementation)

Definition at line 425 of file PT6311.cpp.

void clrIcon ( Icon  icon )

Clr Icon.

Parameters:
Iconicon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 16 LSBs
Returns:
none

Definition at line 392 of file PT6311.cpp.

void cls ( bool  clrAll = false )

Clear the screen and locate to 0.

Parameters:
boolclrAll Clear Icons also (default = false)

Definition at line 344 of file PT6311.cpp.

void cls (  ) [inherited]

Clear the screen and locate to 0.

Definition at line 63 of file PT6311.cpp.

int columns (  )

Number of screen columns.

Parameters:
none
Returns:
columns

Definition at line 336 of file PT6311.cpp.

bool getKeys ( KeyData_t *  keydata ) [inherited]

Read keydata block from PT6311.

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

Note: Due to the hardware configuration the PT6311 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 PT6311_KEY_MEM (=6) bytes for keydata
Returns:
bool keypress True when at least one key was pressed

Note: Due to the hardware configuration the PT6311 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 156 of file PT6311.cpp.

char getSwitches (  ) [inherited]

Read switches from PT6311.

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

Definition at line 202 of file PT6311.cpp.

void locate ( int  column )

Locate cursor to a screen column.

Parameters:
columnThe horizontal position from the left, indexed from 0

Definition at line 322 of file PT6311.cpp.

int printf ( const char *  format,
  ... 
)

Write a formatted string to the Display.

Parameters:
formatA printf-style format string, followed by the variables to use in formatting the string.
int putc ( int  c )

Write a character to the Display.

Parameters:
cThe character to write to the display
void setBrightness ( char  brightness = PT6311_BRT_DEF ) [inherited]

Set Brightness.

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

Definition at line 83 of file PT6311.cpp.

void setDisplay ( bool  on ) [inherited]

Set the Display mode On/off.

Parameters:
booldisplay mode

Definition at line 95 of file PT6311.cpp.

void setIcon ( Icon  icon )

Set Icon.

Parameters:
Iconicon Enums Icon has Grid position encoded in 8 MSBs, Icon pattern encoded in 16 LSBs
Returns:
none

Definition at line 373 of file PT6311.cpp.

void setLED ( char  leds = 0 ) [inherited]

Set LEDs.

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

Definition at line 229 of file PT6311.cpp.

void setUDC ( unsigned char  udc_idx,
int  udc_data 
)

Set User Defined Characters (UDC)

Parameters:
unsignedchar udc_idx The Index of the UDC (0..7)
intudc_data The bitpattern for the UDC (16 bits)

Definition at line 412 of file PT6311.cpp.

void writeData ( int  address,
char  data 
)

Write databyte to PT6311.

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

Reimplemented from PT6311.

Definition at line 414 of file PT6311.h.

void writeData ( DisplayData_t  data,
int  length = (VFDEM2_NR_GRIDS * PT6311_BYTES_PER_GRID) 
)

Write Display datablock to PT6311.

Parameters:
DisplayData_tdata Array of PT6311_DISPLAY_MEM (=48) bytes for displaydata (starting at address 0)
lengthnumber bytes to write (valid range 0..(VFDEM2_NR_GRIDS * PT6311_BYTES_PER_GRID) == 36, starting at address 0)
Returns:
none

Reimplemented from PT6311.

Definition at line 423 of file PT6311.h.