Class SoftwareSerial

SoftwareSerial Class

Description

A class for software serial implementation for Ameba.

Syntax

class SoftwareSerial

Members

Public Constructors
SoftwareSerial::SoftwareSerial	Constructs a SoftwareSerial object
Public Methods
SoftwareSerial::begin	Initialize and Sets the speed (baud rate) for the serial communication
SoftwareSerial::listen	Enables the selected software serial port to listen
SoftwareSerial::end	Deinitialize the serial communication
SoftwareSerial::stopListening	Check if requested software serial port is actively listening
SoftwareSerial::peek	Get a character that was received on the RX pin of the software serial port
SoftwareSerial::write	Send a single byte to the transmit pin of the software serial port as raw bytes
SoftwareSerial::read	Read data that was received from RX pin of the software serial port
SoftwareSerial::available	Get the number of bytes (characters) available for reading from a software serial port
SoftwareSerial::flush	Clear the received buffer
SoftwareSerial::setBufferSize	Set receive buffer size
Soft wareSerial::setAvailableCallback	Set available callback functions
SoftwareSerial::handle_interrupt	Private methods handles interrupt

SoftwareSerial::SoftwareSerial

Description

Constructs a SoftwareSerial object and sets RX and TX pin, and inverse logic.

Syntax

SoftwareSerial(uint8_t receivePin, uint8_t transmitPin, bool inverse_logic);

Parameters

receivePin: the pin on which to receive serial data

transmitPin: the pin on which to transmit serial data

inverse_logic: used to invert the sense of incoming bits (the default is normal logic). If set, SoftwareSerial treats a LOW (0v on the pin, normally) on the RX pin as a 1-bit (the idle state) and a HIGH (5V on the pin, normally) as a 0-bit. It also affects the way that it writes to the TX pin. (Default: False)

Returns

NA

Example Code

Example: SoftwareSerial_Basic

Caution

Software Serial is using hardware serial thus DO NOT change the default pins.

Note

“SoftwareSerial.h” must be included to use the class function.

SoftwareSerial::begin

Description

Initialize and set the speed (baud rate) for the serial communication.

Syntax

void begin (long speed);

void begin (long speed, int data_bits, int parity, int stop_bits);

void begin (long speed, int data_bits, int parity, int stop_bits, int flowctrl, int rtsPin, int ctsPin);

Parameters

speed: the desired baud rate (long). Supported baud rates are: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 31250, 38400, 57600, and 115200 bauds.

data_bits: number of data bits, 8 bits(default) or 7 bits

stop_bits: number of stop bits, 1 bit(default), 1.5 bits or 2 bits

flowctrl: flow control pin

rtsPin: request to send pin

ctsPin: clear to send pin

Returns

NA

Example Code

Example: SoftwareSerial_Basic

Note

“SoftwareSerial.h” must be included to use the class function.

SoftwareSerial::listen

Description

Enables the selected software serial port to listen. Only one SoftwareSerial object can listen at a time; data that arrives for other ports will be discarded. Any data already received is discarded during the call to listen() function (unless the given instance is already listening).

Syntax

bool listen(void);

“SoftwareSerial.h” must be included to use the class function.

void end(void);

“SoftwareSerial.h” must be included to use the class function.

bool isListening(void);

“SoftwareSerial.h” must be included to use the class function.

bool stopListening(void);

“SoftwareSerial.h” must be included to use the class function.

int peek(void);

“SoftwareSerial.h” must be included to use the class function.

virtual size_t write(uint8_t byte);

“SoftwareSerial.h” must be included to use the class function.

virtual int read(void);

“SoftwareSerial.h” must be included to use the class function.

virtual int available(void);

“SoftwareSerial.h” must be included to use the class function.

virtual void flush(void);

“SoftwareSerial.h” must be included to use the class function.

void setBufferSize(uint32_t buffer_size)

“SoftwareSerial.h” must be included to use the class function.

void setAvailableCallback(void (*callback)(char c))

“SoftwareSerial.h” must be included to use the class function.