common/pic24_serial.c File Reference

#include "pic24_all.h"
#include <libpic30.h>

Go to the source code of this file.

Functions
void	outChar (uint8 u8_c)
void	outString (const char *psz_s)
uint16	inString (char *psz_buff, int16 u16_maxCount)
uint16	inStringEcho (char *psz_buff, int16 u16_maxCount)
void	outUint8 (uint8 u8_x)
void	outUint16 (uint16 u16_x)
void	outUint32 (uint32 u32_x)
void	outUint8Decimal (uint8 u8_x)
void	outUint16Decimal (uint16 u16_x)
uint8	inChar (void)
uint8	inCharEcho (void)
uint8	isCharReady (void)
void	configDefaultUART (uint32 u32_baudRate)

---

Detailed Description

Implementation of serial I/O functions prototyped in pic24_serial.h

Definition in file pic24_serial.c.

---

Function Documentation

void configDefaultUART

(

uint32

u32_baudRate

)

Configures a UART based compiler setting of DEFAULT_UART and sets __C30_UART to the default UART. If you want to configure a different UART, then call the configUARTx function explicitly.

Parameters:

u32_baudRate

The baud rate to use.

Definition at line 343 of file pic24_serial.c.

uint8 inChar

(

void

)

Read a character from the serial port. This function blocks until a character is read. The serial port used is selected by the __C30_UART variable, which defaults to 1.

Returns:

Character read from the serial port.

Definition at line 273 of file pic24_serial.c.

uint8 inCharEcho

(

void

)

Same as inChar(), except echo character that is back to console

Definition at line 301 of file pic24_serial.c.

uint16 inString	(	char *	psz_buff,
		int16	u16_maxCount
	)

Reads a string into psz_buff, assumes psz_buff can hold at least u16_maxCount+1 characters. String reading halts when either a newline or carriage return is read, or u16_maxCount characters is read. The return string is always null-terminated. The return count does not includes the null terminator. An input string of just '
' returns a null string.

Parameters:

	psz_buff	pointer to buffer for storing string read from console
	u16_maxCount	maximum number of characters to read from console.

Definition at line 136 of file pic24_serial.c.

uint16 inStringEcho	(	char *	psz_buff,
		int16	u16_maxCount
	)

Same as inString(), except echoes characters to console as they are read.

Definition at line 143 of file pic24_serial.c.

uint8 isCharReady

(

void

)

Determine if a character is ready to be read from the serial port.

Returns:

non-zero value if character is ready, zero otherwise..

Definition at line 312 of file pic24_serial.c.

void outChar

(

uint8

u8_c

)

Write a character to the serial port. This function blocks until a character is written. The UART used is determined by the __C30_UART variable, which defaults to 1.

Parameters:

u8_c

Character to write

Definition at line 54 of file pic24_serial.c.

void outString

(

const char *

psz_s

)

Write a null-terminated string to the serial port. See file documentation for End-of-line behavior when passed a "\n" (newline).

Parameters:

psz_s

Pointer to null-terminated string to print.

Definition at line 86 of file pic24_serial.c.

void outUint16

(

uint16

u16_x

)

Output u16_x as formatted hex value with leading "0x".

Parameters:

u16_x

value to output.

Definition at line 172 of file pic24_serial.c.

void outUint16Decimal

(

uint16

u16_x

)

Output u16_x as decimal value.

Parameters:

u16_x

value to output.

Definition at line 238 of file pic24_serial.c.

void outUint32

(

uint32

u32_x

)

Output u32_x as formatted hex value with leading "0x".

Parameters:

u32_x

value to output.

Definition at line 186 of file pic24_serial.c.

void outUint8

(

uint8

u8_x

)

Output u8_x as formatted hex value with leading "0x".

Parameters:

u8_x

value to output.

Definition at line 163 of file pic24_serial.c.

void outUint8Decimal

(

uint8

u8_x

)

Output u8_x as decimal value.

Parameters:

u8_x

value to output.

Definition at line 203 of file pic24_serial.c.