NumericPad Class Reference

This class interfaces with NumericPad attached to NXShield. More...

#include <NumericPad.h>

Inheritance diagram for NumericPad:

Public Member Functions
	NumericPad (uint8_t i2c_address=0xB4)
void	InitializeKeypad ()
bool	GetKeyPress (int waitPeriod, byte &keyHolder)
int	GetKeysPressed ()
Public Member Functions inherited from NXShieldI2C
	NXShieldI2C (uint8_t i2c_address)
void	init (void *shield, SH_BankPort bp)
uint8_t	readByte (uint8_t location)
uint16_t	readInteger (uint8_t location)
uint32_t	readLong (uint8_t location)
uint8_t *	readRegisters (uint8_t start_register, uint8_t bytes, uint8_t *buf)
char *	readString (uint8_t location, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0)
bool	writeRegisters (uint8_t start_register, uint8_t bytes_to_write, uint8_t *buffer=0)
bool	writeByte (uint8_t location, uint8_t data)
bool	writeInteger (uint8_t location, uint16_t data)
bool	writeLong (uint8_t location, uint32_t data)
char *	getFirmwareVersion ()
char *	getVendorID ()
char *	getDeviceID ()
char *	getFeatureSet ()
uint8_t	getErrorCode ()
bool	checkAddress ()
bool	setAddress (uint8_t address)
Public Member Functions inherited from BaseI2CDevice
	BaseI2CDevice (uint8_t i2c_address)
void	initProtocol ()
uint8_t *	readRegisters (uint8_t start_register, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0, bool clear_buffer=false)
uint8_t	readByte (uint8_t location)
int16_t	readInteger (uint8_t location)
uint32_t	readLong (uint8_t location)
char *	readString (uint8_t location, uint8_t bytes_to_read, uint8_t *buffer=0, uint8_t buffer_length=0)
bool	writeRegisters (uint8_t start_register, uint8_t bytes_to_write, uint8_t *buffer=0)
bool	writeByte (uint8_t location, uint8_t data)
bool	writeInteger (uint8_t location, uint16_t data)
bool	writeLong (uint8_t location, uint32_t data)
bool	checkAddress ()
bool	setAddress (uint8_t i2c_address)
uint8_t	getAddress ()
uint8_t	getWriteErrorCode ()
char *	getFirmwareVersion ()
char *	getVendorID ()
char *	getDeviceID ()
char *	getFeatureSet ()
Public Member Functions inherited from SoftI2cMaster
uint8_t	start (uint8_t addressRW)
void	stop (void)
uint8_t	restart (uint8_t addressRW)
uint8_t	write (uint8_t b)
uint8_t	read (uint8_t last)
	SoftI2cMaster (uint8_t devAddr)
void	initProtocol (uint8_t sclPin=NULL, uint8_t sdaPin=NULL)
uint8_t *	readRegisters (uint8_t startRegister, uint8_t bytes, uint8_t *buf=NULL)
bool	writeRegistersWithLocation (int bytes, uint8_t *buf)
bool	writeRegisters (uint8_t location, uint8_t bytes_to_write, uint8_t *buffer=0)
bool	writeByte (uint8_t location, uint8_t data)
bool	writeInteger (uint8_t location, uint16_t data)
bool	writeLong (uint8_t location, uint32_t data)
char *	readString (uint8_t startRegister, uint8_t bytes, uint8_t *buf=NULL, uint8_t len=0)
uint8_t	readByte (uint8_t location)
int16_t	readInteger (uint8_t location)
uint32_t	readLong (uint8_t location)
char *	getFirmwareVersion ()
char *	getVendorID ()
char *	getDeviceID ()
uint8_t	getWriteErrorCode ()
bool	checkAddress ()
bool	setAddress (uint8_t address)

Additional Inherited Members
Public Attributes inherited from NXShieldI2C
void *	mp_shield
uint8_t *	_i2c_buffer
uint8_t	m_protocol
Public Attributes inherited from SoftI2cMaster
uint8_t *	_so_buffer
Static Public Attributes inherited from BaseI2CDevice
static uint8_t *	_buffer = 0
static bool	b_initialized = false
Protected Member Functions inherited from BaseI2CDevice
void	setWriteErrorCode (uint8_t code)

Detailed Description

This class interfaces with NumericPad attached to NXShield.

Constructor & Destructor Documentation

NumericPad::NumericPad

(

uint8_t

i2c_address = 0xB4

)

class constructor for the NumericPad with an optional custom i2c address parameter

Member Function Documentation

bool NumericPad::GetKeyPress	(	int	waitPeriod,
		byte &	keyHolder
	)

Get the key pressed on the keypad.

Parameters

waitPeriod	how long to wait for user to press key (seconds).
keyHolder	return value of the key user pressed in that time.

Returns

true if there was a key pressed in specified time.

false if no key pressed in the specified time.

int NumericPad::GetKeysPressed

(

)

Get all the keys pressed by the user at the present moment

function returns: integer value of all keys, each bit that is set to 1 represents a key that is pressed. the bits are set as per keyMap. Only 12 bits can be 1.

void NumericPad::InitializeKeypad

(

)

Initialize the keypad for communication with host. This function also sets up the capacitance values for the keypad with appropriate sensitiviy

---

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

• NumericPad.h
• NumericPad.cpp