W60X_Arduino: Serial

Arduino W60X

W60X_Arduino
Serial

Serial. More...

Functions

 HardwareSerial::HardwareSerial (int serial_no)
 This constructor is used to init hardware serial. More...
 
 HardwareSerial::HardwareSerial (int serial_no, bool mul_flag)
 This constructor is used to init hardware serial. More...
 
 HardwareSerial::HardwareSerial ()
 This constructor is used to init hardware serial. More...
 
void HardwareSerial::begin ()
 Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate. More...
 
void HardwareSerial::begin (unsigned long baud)
 Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate. More...
 
void HardwareSerial::begin (unsigned long baud, int modeChoose)
 Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate. More...
 
virtual int HardwareSerial::read (void)
 Reads incoming serial data. read() inherits from the Stream utility class. More...
 
virtual int HardwareSerial::available (void)
 Get the number of bytes (characters) available for reading from the serial port. This is data that's already arrived and stored in the serial receive buffer (which holds 64 bytes). available() inherits from the Stream utility class. More...
 
virtual int HardwareSerial::peek ()
 Returns the next byte (character) of incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read(). peek() inherits from the Stream utility class. More...
 

Detailed Description

Serial.

Function Documentation

◆ available()

int HardwareSerial::available ( void  )
virtual

Get the number of bytes (characters) available for reading from the serial port. This is data that's already arrived and stored in the serial receive buffer (which holds 64 bytes). available() inherits from the Stream utility class.

Parameters
[in]none
Returns
the number of bytes available to read
Note

Implements Stream.

◆ begin() [1/3]

void HardwareSerial::begin ( void  )

Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate.

An optional second argument configures the data, parity, and stop bits. The default is 8 data bits, no parity, one stop bit.

Parameters
[in]None
Returns
nothing
Note

◆ begin() [2/3]

void HardwareSerial::begin ( unsigned long  baud)

Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate.

An optional second argument configures the data, parity, and stop bits. The default is 8 data bits, no parity, one stop bit.

Parameters
[in]baudspeed: in bits per second (baud) - long
Returns
nothing
Note

◆ begin() [3/3]

void HardwareSerial::begin ( unsigned long  baud,
int  modeChoose 
)

Sets the data rate in bits per second (baud) for serial data transmission. For communicating with the computer, use one of these rates: 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, or 115200. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate.

An optional second argument configures the data, parity, and stop bits. The default is 8 data bits, no parity, one stop bit.

Parameters
[in]baudspeed: in bits per second (baud) - long
[in]modeChooseSpecify the mode.
Returns
nothing
Note

◆ HardwareSerial() [1/3]

HardwareSerial::HardwareSerial ( int  serial_no)

This constructor is used to init hardware serial.

Parameters
[in]serial_noSpecify serial_no
Returns
None
Note

◆ HardwareSerial() [2/3]

HardwareSerial::HardwareSerial ( int  serial_no,
bool  mul_flag 
)

This constructor is used to init hardware serial.

Parameters
[in]serial_noSpecify serial_no
[in]mul_flagSpecify mul_flag
Returns
None
Note

◆ HardwareSerial() [3/3]

HardwareSerial::HardwareSerial ( )
inline

This constructor is used to init hardware serial.

Parameters
[in]none
Returns
None
Note

◆ peek()

int HardwareSerial::peek ( void  )
virtual

Returns the next byte (character) of incoming serial data without removing it from the internal serial buffer. That is, successive calls to peek() will return the same character, as will the next call to read(). peek() inherits from the Stream utility class.

Parameters
[in]None
Returns
the first byte of incoming serial data available (or -1 if no data is available) - int
Note

Implements Stream.

◆ read()

int HardwareSerial::read ( void  )
virtual

Reads incoming serial data. read() inherits from the Stream utility class.

Parameters
[in]None
Returns
the first byte of incoming serial data available (or -1 if no data is available) - int
Note

Implements Stream.

Generated by   doxygen 1.8.14