#include <GPIO_NXP.h>

Inheritance diagram for PCA9554:

Public Types
enum	reg_num { Input_Port , Output_Port , Polarity_Inversion , Configuration }
enum	board { NONE , ARDUINO_SHIELD }
Public Types inherited from GPIO_base
enum	board { NONE , ARDUINO_SHIELD }

Public Member Functions
	PCA9554 (uint8_t i2c_address=(0x40 > > 1)+0)
	PCA9554 (TwoWire &wire, uint8_t i2c_address=(0x40 > > 1)+0)
virtual	~PCA9554 ()
void	begin (board env=NONE)
void	output (int port, uint8_t value, uint8_t mask=0)
void	output (const uint8_t *vp)
uint8_t	input (int port)
uint8_t *	input (uint8_t *vp)
void	config (int port, uint8_t config, uint8_t mask=0)
void	config (const uint8_t *vp)
void	write_port (access_word w, const uint8_t *vp)
void	write_port16 (access_word w, const uint16_t *vp)
uint8_t *	read_port (access_word w, uint8_t *vp)
uint16_t *	read_port16 (access_word w, uint16_t *vp)
void	write_port (access_word w, uint8_t value, int port_num=0)
void	write_port16 (access_word w, uint16_t value, int port_num=0)
uint8_t	read_port (access_word w, int port_num=0)
uint16_t	read_port16 (access_word w, int port_num=0)
bool	ping (void)
int	reg_w (uint8_t reg_adr, const uint8_t *data, uint16_t size)
int	reg_w (uint8_t reg_adr, uint8_t data)
int	reg_r (uint8_t reg_adr, uint8_t *data, uint16_t size)
uint8_t	reg_r (uint8_t reg_adr)
void	write_r8 (uint8_t reg, uint8_t val)
void	write_r16 (uint8_t reg, uint16_t val)
uint8_t	read_r8 (uint8_t reg)
uint16_t	read_r16 (uint8_t reg)
void	bit_op8 (uint8_t reg, uint8_t mask, uint8_t value)
void	bit_op16 (uint8_t reg, uint16_t mask, uint16_t value)
Public Member Functions inherited from GPIO_base
	GPIO_base (uint8_t i2c_address, int nbits, const uint8_t *arp, uint8_t ai)
	GPIO_base (TwoWire &wire, uint8_t i2c_address, int nbits, const uint8_t *arp, uint8_t ai)
virtual	~GPIO_base ()
virtual void	begin (board env=NONE)

Public Attributes
const int	n_bits
const int	n_ports
Public Attributes inherited from GPIO_base
const int	n_bits
const int	n_ports

Static Public Attributes
static constexpr uint8_t	access_ref [NUM_access_word]

Additional Inherited Members
Static Public Member Functions inherited from GPIO_base
static void	print_bin (uint8_t v)
Protected Attributes inherited from GPIO_base
const uint8_t	auto_increment

Detailed Description

PCA9554 class

Definition at line 246 of file GPIO_NXP.h.

Member Enumeration Documentation

◆ board

enum PCA9554::board

Constants for begin() method

Definition at line 289 of file GPIO_NXP.h.

◆ reg_num

enum PCA9554::reg_num

Name of the PCA9554 registers

Definition at line 250 of file GPIO_NXP.h.

Constructor & Destructor Documentation

◆ PCA9554() [1/2]

PCA9554::PCA9554 ( uint8_t i2c_address = (0x40 >> 1) + 0 )

Constructor

Parameters

i2c_address I2C target address

Definition at line 198 of file GPIO_NXP.cpp.

◆ PCA9554() [2/2]

PCA9554::PCA9554	(	TwoWire &	wire,
		uint8_t	i2c_address = (0x40 >> 1) + 0 )

Constructor

Parameters

wire	TwoWire instance
i2c_address	I2C target address

Definition at line 203 of file GPIO_NXP.cpp.

◆ ~PCA9554()

PCA9554::~PCA9554 ( )

virtual

Destructor

Definition at line 208 of file GPIO_NXP.cpp.

Member Function Documentation

◆ begin()

void PCA9554::begin ( board env = NONE )

Device/board initialization

This method is needed to initialize Arduino-shield type evaluation boards from NXP. This method takes one argument of "PCA9554::ARDUINO_SHIELD" to set RESET and ADDRESS pins.

If the device is used as it self, this method doesn't need to be called.

Parameters

env	This argument can be given as "PCA9554::NONE" or "PCA9554::ARDUINO_SHIELD"

◆ bit_op8()

void PCA9554::bit_op8	(	uint8_t	reg,
		uint8_t	mask,
		uint8_t	value )

Register overwriting with bit-mask

Register can be updated by bit level

Parameters

reg	register index/address/pointer
mask	bit-mask to protect overwriting
value	value to overwrite

◆ config() [1/2]

void PCA9554::config ( const uint8_t * vp )

virtual

Config, all ports

Basic GPIO port access function for all port configuration

Parameters

vp	Pointer to array of configuration values. The array should have 'n_ports' length

Reimplemented from GPIO_base.

◆ config() [2/2]

void PCA9554::config	(	int	port,
		uint8_t	config,
		uint8_t	mask = 0 )

virtual

Config, single port

Basic GPIO port access function for single port configuration

Parameters

port	Port number
value	Value to be written into configuration register
mask	Bit mask. Value will not be changed in bit positions '1' in mask

Reimplemented from GPIO_base.

Referenced by config().

◆ input() [1/2]

uint8_t PCA9554::input ( int port )

virtual

Input, single port

Basic GPIO port access function for single port input

Parameters

port	Port number

Returns: Port read value

Reimplemented from GPIO_base.

◆ input() [2/2]

uint8_t * PCA9554::input ( uint8_t * vp )

virtual

Input, all ports

Basic GPIO port access function for all ports input

Parameters

vp	Pointer to an array of values. The array should have 'n_ports' length

Returns: Pointer to vp

Reimplemented from GPIO_base.

◆ output() [1/2]

void PCA9554::output ( const uint8_t * vp )

virtual

Output, all ports

Basic GPIO port access function for all ports output

Parameters

vp	Pointer to an array of values. The array should have 'n_ports' length

Reimplemented from GPIO_base.

◆ output() [2/2]

void PCA9554::output	(	int	port,
		uint8_t	value,
		uint8_t	mask = 0 )

virtual

Output, single port

Basic GPIO port access function for single port output

Parameters

port	Port number
value	Value to be output
mask	Bit mask. Value will not be changed in bit positions '1' in mask

Reimplemented from GPIO_base.

◆ ping()

bool PCA9554::ping ( void )

Ping the device

Returns: true when ACK

◆ read_port() [1/2]

uint8_t PCA9554::read_port	(	access_word	w,
		int	port_num = 0 )

virtual

Read single port method

Single port register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
port_num	Option, to specify port number

Returns: Register read value

Reimplemented from GPIO_base.

◆ read_port() [2/2]

uint8_t * PCA9554::read_port	(	access_word	w,
		uint8_t *	vp )

virtual

Read all port method

All port register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
vp	Pointer to an array of values. The array should have 'n_ports' length

Returns: Pointer to vp

Reimplemented from GPIO_base.

◆ read_port16() [1/2]

uint16_t PCA9554::read_port16	(	access_word	w,
		int	port_num = 0 )

virtual

Read single port method

Single port 16 bit register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
port_num	Option, to specify port number

Returns: Register read value

Reimplemented from GPIO_base.

◆ read_port16() [2/2]

uint16_t * PCA9554::read_port16	(	access_word	w,
		uint16_t *	vp )

virtual

Read all port method

All port 16 bit register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
vp	Pointer to an array of values. The array should have 'n_ports' length

Returns: Pointer to vp

Reimplemented from GPIO_base.

◆ read_r16()

uint16_t PCA9554::read_r16 ( uint8_t reg )

Register read, 16 bit

This 16 bit access may not be common but it's useful for sensor devices

Parameters

reg	register index/address/pointer

Returns: data value

◆ read_r8()

uint8_t PCA9554::read_r8 ( uint8_t reg )

Register read, 8 bit

Parameters

reg	register index/address/pointer

Returns: data value

◆ reg_r() [1/2]

uint8_t PCA9554::reg_r ( uint8_t reg_adr )

Single register read

Parameters

reg	register index/address/pointer

Returns: read data

◆ reg_r() [2/2]

int PCA9554::reg_r	(	uint8_t	reg_adr,
		uint8_t *	data,
		uint16_t	size )

Multiple register read

Parameters

reg	register index/address/pointer
data	pointer to data buffer
size	data size

Returns: transferred data size

◆ reg_w() [1/2]

int PCA9554::reg_w	(	uint8_t	reg_adr,
		const uint8_t *	data,
		uint16_t	size )

Multiple register write

Parameters

reg	register index/address/pointer
data	pointer to data buffer
size	data size

Returns: transferred data size

◆ reg_w() [2/2]

int PCA9554::reg_w	(	uint8_t	reg_adr,
		uint8_t	data )

Single register write

Parameters

reg_adr	register index/address/pointer
data	data byte to write

Returns: transferred data size

◆ write_port() [1/2]

void PCA9554::write_port	(	access_word	w,
		const uint8_t *	vp )

virtual

Write all port method

All port register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
vp	Pointer to an array of values. The array should have 'n_ports' length

Reimplemented from GPIO_base.

◆ write_port() [2/2]

void PCA9554::write_port	(	access_word	w,
		uint8_t	value,
		int	port_num = 0 )

virtual

Write single port method

Single port register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
value	Value to be written into a register
port_num	Option, to specify port number

Reimplemented from GPIO_base.

◆ write_port16() [1/2]

void PCA9554::write_port16	(	access_word	w,
		const uint16_t *	vp )

virtual

Write all port method

All port 16 bit register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
vp	Pointer to an array of values. The array should have 'n_ports' length

Reimplemented from GPIO_base.

◆ write_port16() [2/2]

void PCA9554::write_port16	(	access_word	w,
		uint16_t	value,
		int	port_num = 0 )

virtual

Write single port method

Single port 16 bit register access function using word of 'access_word'

Parameters

w	Access word. This should be chosen from 'access_word'
value	Value to be written into a register
port_num	Option, to specify port number

Reimplemented from GPIO_base.

◆ write_r16()

void PCA9554::write_r16	(	uint8_t	reg,
		uint16_t	val )

Register write, 16 bit

This 16 bit access may not be common but it's useful for sensor devices

Parameters

reg	register index/address/pointer
val	data value

◆ write_r8()

void PCA9554::write_r8	(	uint8_t	reg,
		uint8_t	val )

Register write, 8 bit

Parameters

reg	register index/address/pointer
val	data value

Member Data Documentation

◆ access_ref

uint8_t PCA9554::access_ref

staticconstexpr

Initial value:

                              = {
    Input_Port,         
    Output_Port,        
    Polarity_Inversion, 
    Configuration,      
    0xFF,   
    0xFF,   
    0xFF,   
    0xFF,   
    0xFF,   
    0xFF,   
    0xFF,   
}

Definition at line 273 of file GPIO_NXP.h.

◆ n_bits

const int PCA9554::n_bits

Number of IO bits

Definition at line 295 of file GPIO_NXP.h.

◆ n_ports

const int PCA9554::n_ports

Number of IO ports

Definition at line 298 of file GPIO_NXP.h.

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ board

◆ reg_num

Constructor & Destructor Documentation

◆ PCA9554() [1/2]

◆ PCA9554() [2/2]

◆ ~PCA9554()

Member Function Documentation

◆ begin()

◆ bit_op8()

◆ config() [1/2]

◆ config() [2/2]

◆ input() [1/2]

◆ input() [2/2]

◆ output() [1/2]

◆ output() [2/2]

◆ ping()

◆ read_port() [1/2]

◆ read_port() [2/2]

◆ read_port16() [1/2]

◆ read_port16() [2/2]

◆ read_r16()

◆ read_r8()

◆ reg_r() [1/2]

◆ reg_r() [2/2]

◆ reg_w() [1/2]

◆ reg_w() [2/2]

◆ write_port() [1/2]

◆ write_port() [2/2]

◆ write_port16() [1/2]

◆ write_port16() [2/2]

◆ write_r16()

◆ write_r8()

Member Data Documentation

◆ access_ref

◆ n_bits

◆ n_ports