Wim Huiskamp / TM1637

Dependents:   mbed_TM1637 TM1637_test

Embed: (wiki syntax)

« Back to documentation index

TM1637_CATALEX Class Reference

Constructor for class for driving TM1637 controller as used in CATALEX. More...

#include <TM1637.h>

Inherits TM1637.

Public Types

enum  Icon {
  DP1 = ( 1<<24) | S7_DP1, DP2 = ( 2<<24) | S7_DP2, DP3 = ( 3<<24) | S7_DP3, DP4 = ( 4<<24) | S7_DP4,
  COL2 = ( 2<<24) | S7_DP2
}
 

Enums for Icons.

More...
typedef char DisplayData_t [TM1637_DISPLAY_MEM]
 Datatype for displaydata.
typedef char KeyData_t
 Datatypes for keymatrix data.

Public Member Functions

 TM1637_CATALEX (PinName mosi_nc, PinName miso_dio, PinName sclk_clk)
 Constructor for class for driving TM1637 LED controller as used in CATALEX.
 TM1637_CATALEX (PinName dio, PinName clk)
 Constructor for class for driving TM1637 LED controller.
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 (char data, int address)
 Write databyte to TM1637.
void writeData (DisplayData_t data, int length=(CATALEX_NR_GRIDS *TM1637_BYTES_PER_GRID), int address=0)
 Write Display datablock to TM1637.
void cls ()
 Clear the screen and locate to 0.
bool getKeys (KeyData_t *keydata)
 Read keydata block from TM1637.
void setBrightness (char brightness=TM1637_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 TM1637 controller as used in CATALEX.

Supports 4 Digits of 7 Segments + DP (or Colon for Digit2 on some models). Also Supports up to 16 Keys. Serial bus interface device.

Parameters:
PinNamemosi Serial bus MOSI pin
PinNamemiso Serial bus MISO pin
PinNamesclk Serial bus SCLK pin

Definition at line 298 of file TM1637.h.


Member Typedef Documentation

typedef char DisplayData_t[TM1637_DISPLAY_MEM] [inherited]

Datatype for displaydata.

Definition at line 161 of file TM1637.h.

typedef char KeyData_t [inherited]

Datatypes for keymatrix data.

Definition at line 164 of file TM1637.h.


Member Enumeration Documentation

enum Icon

Enums for Icons.

Enumerator:
DP1 

Digit 1.

DP2 

Digit 2.

DP3 

Digit 3.

DP4 

Digit 4.

COL2 

Column 2.

Definition at line 303 of file TM1637.h.


Constructor & Destructor Documentation

TM1637_CATALEX ( PinName  mosi_nc,
PinName  miso_dio,
PinName  sclk_clk 
)

Constructor for class for driving TM1637 LED controller as used in CATALEX.

Supports 4 Digits of 7 Segments + DP (or Colon for Digit2 on some models). Also Supports up to 16 Keys. Serial bus interface device. DEPRECATED version

Parameters:
PinNamemosi_nc Serial bus NC pin
PinNamemiso_dio Serial bus DIO pin
PinNamesclk_clk Serial bus CLK pin

Supports 4 Digits of 7 Segments + DP (or Colon for Digit2 on some models). DEPRECATED version

Parameters:
PinNamemosi_nc Serial bus NC pin
PinNamemiso_dio Serial bus DIO pin
PinNamesclk_clk Serial bus CLK pin

Definition at line 345 of file TM1637.cpp.

TM1637_CATALEX ( PinName  dio,
PinName  clk 
)

Constructor for class for driving TM1637 LED controller.

Supports 4 Digits of 7 Segments + DP (or Colon for Digit2 on some models). Also Supports up to 16 Keys. Serial bus interface device.

Parameters:
PinNamedio Serial bus DIO pin
PinNamesck Serial bus CLK pin

Supports 4 Digits of 7 Segments + DP (or Colon for Digit2 on some models). Serial bus interface device.

Parameters:
PinNamedio Serial bus DIO pin
PinNamesck Serial bus CLK pin

Definition at line 359 of file TM1637.cpp.


Member Function Documentation

int _putc ( int  value ) [protected, virtual]

Write a single character (Stream implementation)

Definition at line 483 of file TM1637.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 450 of file TM1637.cpp.

void cls ( bool  clrAll = false )

Clear the screen and locate to 0.

Parameters:
boolclrAll Clear Icons also (default = false)

Definition at line 407 of file TM1637.cpp.

void cls (  ) [inherited]

Clear the screen and locate to 0.

Definition at line 96 of file TM1637.cpp.

int columns (  )

Number of screen columns.

Parameters:
none
Returns:
columns

Definition at line 399 of file TM1637.cpp.

bool getKeys ( KeyData_t keydata ) [inherited]

Read keydata block from TM1637.

Parameters:
*keydataPtr to bytes for keydata
Returns:
bool keypress True when at least one key was pressed

Definition at line 181 of file TM1637.cpp.

void locate ( int  column )

Locate cursor to a screen column.

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

Definition at line 385 of file TM1637.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 = TM1637_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 113 of file TM1637.cpp.

void setDisplay ( bool  on ) [inherited]

Set the Display mode On/off.

Parameters:
booldisplay mode

Definition at line 124 of file TM1637.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 432 of file TM1637.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)
unsignedchar udc_idx The Index of the UDC (0..7)
intudc_data The bitpattern for the UDC (8 bits)

Definition at line 469 of file TM1637.cpp.

void writeData ( DisplayData_t  data,
int  length = (CATALEX_NR_GRIDS * TM1637_BYTES_PER_GRID),
int  address = 0 
)

Write Display datablock to TM1637.

Parameters:
DisplayData_tdata Array of TM1637_DISPLAY_MEM (=4) bytes for displaydata
lengthnumber bytes to write (valid range 0..(CATALEX_NR_GRIDS * TM1637_BYTES_PER_GRID) (=4), when starting at address 0)
intaddress display memory location to write bytes (default = 0)
Returns:
none

Reimplemented from TM1637.

Definition at line 409 of file TM1637.h.

void writeData ( char  data,
int  address 
)

Write databyte to TM1637.

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

Reimplemented from TM1637.

Definition at line 399 of file TM1637.h.