#include <pas-co2-uart.hpp>

Inheritance diagram for pasco2::UART:

Collaboration diagram for pasco2::UART:

Public Member Functions
	UART (UARTPAL *const uartpal, uint32_t baudrateBps=dfltBaudrateBps)
	UART interface constructor. More...

	~UART (void)
	UUART interface desconstructor. More...

Error_t	init (void)
	Initializes the I2C interface. More...

Error_t	deinit (void)
	Deinitializes the serial interface. More...

Error_t	write (const uint8_t regAddr, const uint8_t *data, uint16_t length)
	Writes data to a register or set of consecutive registers. More...

Error_t	read (const uint8_t regAddr, uint8_t *data, uint16_t length)
	Reads data from a register or set of consecutive registers. More...

Proto_t	getProtocol (void)
	Gets the specific serial protocol. More...

Static Public Attributes
static const uint32_t	dfltBaudrateBps = 9600

Protected Member Functions
char	uint4ToHexChar (const uint8_t uint4)
	Converts an unsigned 4 bits integer to its hexadecimal ascii value. More...

virtual void	assembleWriteRequestFrame (const uint8_t regAddr, const uint8_t regVal, char *frame)
	Assembles the register write request frame. More...

virtual void	assembleReadRequestFrame (const uint8_t regAddr, char *frame)
	Assembles the register read request frame. More...

virtual uint8_t	disassembleReadReplyFrame (const char *frame)
	Disassembles the read response frame. More...

virtual bool	isAckFrame (const char *frame, const uint8_t len)
	Checks if a frame is an ack reply frame. More...

virtual bool	isNackFrame (const char *frame, const uint8_t len)
	Checks if a frame is an nack reply frame. More...

Additional Inherited Members
Public Types inherited from pasco2::SBus
enum	Proto_t { BUS_PROTO_I2C = 0, BUS_PROTO_UART = 1 }

Constructor & Destructor Documentation

◆ UART()

UART::UART	(	UARTPAL *const	uartpal,
		uint32_t	baudrateBps = `dfltBaudrateBps`
	)

UART interface constructor.

Parameters

[in]	*uartpal	UART pal interface
[in]	baudrateBps	Baudrate in bit per second. Default 19200 bps. Valid Range [9600, 19200].

Precondition: None

◆ ~UART()

UART::~UART ( void )

UUART interface desconstructor.

Precondition: None

Member Function Documentation

◆ init()

Error_t UART::init ( void )

virtual

Initializes the I2C interface.

Initiliazes the host I2C peripheral and set its clock frequency

Returns: PAS CO2 error code

Return values

OK	if success
INTF_ERROR	if hardware interface error

Precondition: None

Implements pasco2::SBus.

Here is the call graph for this function:

◆ deinit()

Error_t UART::deinit ( void )

virtual

Deinitializes the serial interface.

Returns: PAS CO2 error code

Return values

OK	if success
INTF_ERROR	if error

Implements pasco2::SBus.

Here is the call graph for this function:

◆ write()

Error_t UART::write	(	const uint8_t	memAddr,
		const uint8_t *	data,
		uint16_t	length
	)

virtual

Writes data to a register or set of consecutive registers.

Parameters

[in]	regAddr	Register start write address
[in]	*data	Pointer to the data array to be written
[in]	length	Number of registers to be written in the bus

Returns: PAS CO2 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition: init()

Implements pasco2::SBus.

Here is the call graph for this function:

◆ read()

Error_t UART::read	(	const uint8_t	memAddr,
		uint8_t *	data,
		uint16_t	length
	)

virtual

Reads data from a register or set of consecutive registers.

Parameters

[in]	regAddr	Register start read address
[out]	*data	Pointer to the array that will store the read data
[in]	length	Number of registers to be read from the bus

Returns: PAS CO2 error code

Return values

OK	if success
INTF_ERROR	if error

Precondition: init()

Implements pasco2::SBus.

Here is the call graph for this function:

◆ getProtocol()

Proto_t pasco2::UART::getProtocol ( void )

inlinevirtual

Gets the specific serial protocol.

Returns: PAS CO2 serial protocol

Return values

BUS_PROTO_I2C
BUS_PROTO_UART

Implements pasco2::SBus.

◆ uint4ToHexChar()

char UART::uint4ToHexChar ( const uint8_t uint4 )

protected

Converts an unsigned 4 bits integer to its hexadecimal ascii value.

Parameters

[in] uint4 Unsigned 4 bits integer

Returns: hexadecimal ascii value (char)

◆ assembleWriteRequestFrame()

void UART::assembleWriteRequestFrame	(	const uint8_t	regAddr,
		const uint8_t	regVal,
		char *	frame
	)

protectedvirtual

Assembles the register write request frame.

The UART write request frames have the following structure:

         "w," + <ascii hex 2 char register address> + "," +
           <ascii hex 2 char register value> "\n"

         For example, in order to write 0xE2 in the register 0x0A, the corresponding
         char string will be: "w,0a,e2\n". 
         Also uppercase ascii letters are allowed

Parameters

[in]	regAddr	Register address
[in]	regVal	Register value to be written
[out]	*frame	Pointer to store the assembled write frame

Returns: void

Here is the call graph for this function:

◆ assembleReadRequestFrame()

void UART::assembleReadRequestFrame	(	const uint8_t	regAddr,
		char *	frame
	)

protectedvirtual

Assembles the register read request frame.

The UART read request frames have the following structure:

         "w," + <ascii hex 2 char register address> + "\n"

         For example, in order to read the register 0x0E, the corresponding
         char string will be: "r,0e\n". 
         Also uppercase ascii letters are allowed

Parameters

[in]	regAddr	Register address to be read
[out]	*frame	Pointer to store the assembled read frame

Returns: void

Here is the call graph for this function:

◆ disassembleReadReplyFrame()

uint8_t UART::disassembleReadReplyFrame ( const char * frame )

protectedvirtual

Disassembles the read response frame.

The UART read response frames have the following structure:

         <ascii hex 2 char register value> + "\n"

         For example, a register with value 0xAB will reply the 
         frame: "ab\n". 
         Also uppercase ascii letters are allowed

Parameters

[in] *frame Pointer to read response frame

Returns: register value as unsigned 8 bits integer (uint8_t)

◆ isAckFrame()

bool UART::isAckFrame	(	const char *	frame,
		const uint8_t	len
	)

protectedvirtual

Checks if a frame is an ack reply frame.

The UART ack response frame is formed by the ascii ack value (0x06) followed by a new line character ('
' or 0xA). As hexadecimal, the array {0x06, 0xA}

Parameters

[in]	*frame	Pointer to reply frame
[in]	len	Frame length in number of bytes

Returns: bool

Return values

TRUE	if the frame is an ack frame
FALSE	if the frame is NOT an ack frame

◆ isNackFrame()

bool UART::isNackFrame	(	const char *	frame,
		const uint8_t	len
	)

protectedvirtual

Checks if a frame is an nack reply frame.

The UART nack response frame is formed by the ascii nack value (0x15) followed by a new line character ('
' or 0xA). As hexadecimal, the array {0x15, 0xA}

Parameters

[in]	*frame	Pointer to reply frame
[in]	len	Frame length in number of bytes

Returns: bool

Return values

TRUE	if the frame is an ack frame
FALSE	if the frame is NOT an ack frame

Member Data Documentation

◆ dfltBaudrateBps

const uint32_t pasco2::UART::dfltBaudrateBps = 9600

static

Default baudrate in bps

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ UART()

◆ ~UART()

Member Function Documentation

◆ init()

◆ deinit()

◆ write()

◆ read()

◆ getProtocol()

◆ uint4ToHexChar()

◆ assembleWriteRequestFrame()

◆ assembleReadRequestFrame()

◆ disassembleReadReplyFrame()

◆ isAckFrame()

◆ isNackFrame()

Member Data Documentation

◆ dfltBaudrateBps