HardwareSerial.h
Go to the documentation of this file.
46 using StreamDataReceivedDelegate = Delegate<void(Stream& source, char arrivedChar, uint16_t availableCharsCount)>;
55 XX(5N1) XX(6N1) XX(7N1) XX(8N1) XX(5N2) XX(6N2) XX(7N2) XX(8N2) XX(5E1) XX(6E1) XX(7E1) XX(8E1) \
175 bool begin(uint32_t baud, SerialFormat format, SerialMode mode, uint8_t txPin, uint8_t rxPin = SERIAL_PIN_DEFAULT);
bool begin(uint32_t baud, SerialFormat format)
Initialise and set its configuration.
Definition: HardwareSerial.h:146
int peek() override
Read a character from serial port without removing from input buffer.
Definition: HardwareSerial.h:295
void systemDebugOutput(bool enabled)
Configure serial port for system debug output and redirect output from debugf.
bool onDataReceived(StreamDataReceivedDelegate dataReceivedDelegate)
Set handler for received data.
Definition: HardwareSerial.h:350
void clear(SerialMode mode=SERIAL_FULL)
Clear the serial port transmit/receive buffers.
Definition: HardwareSerial.h:304
bool isTxEnabled()
Checks if the current UART can transmit(print) information.
Definition: HardwareSerial.h:381
int available() override
Get quantity characters available from serial input.
Definition: HardwareSerial.h:255
void commandProcessing(bool reqEnable)
Configure serial port for command processing.
Definition: HardwareSerial.h:342
bool isFinished() override
Check if all data has been read.
Definition: HardwareSerial.h:286
bool begin(uint32_t baud, SerialFormat format, SerialMode mode, uint8_t txPin, uint8_t rxPin=SERIAL_PIN_DEFAULT)
Initialise, set its configuration and mode.
smg_uart_t * getUart()
Returns a pointer to the internal uart object. Use with care.
Definition: HardwareSerial.h:436
void setTx(uint8_t tx_pin)
Toggle between use of GPIO1 and GPIO2 as TX on UART 0.
Definition: HardwareSerial.h:235
HardwareSerial(int uartPort)
Create instance of a hardware serial port object.
Definition: HardwareSerial.h:113
void swap(uint8_t tx_pin)
Toggle between use of GPIO13/GPIO15 or GPIO3/GPIO(1/2) as RX and TX.
Definition: HardwareSerial.h:222
uint32_t setBaudRate(uint32_t baudrate)
Attempt to set the requested baud rate.
Definition: HardwareSerial.h:409
void swap()
Toggle between use of GPIO13/GPIO15 or GPIO3/GPIO(1/2) as RX and TX.
Definition: HardwareSerial.h:213
int read() override
Read a character from serial port.
Definition: HardwareSerial.h:264
int indexOf(char c) override
Returns the location of the searched character.
Definition: HardwareSerial.h:427
bool isRxEnabled()
Checks if the current UART can receive information.
Definition: HardwareSerial.h:390
uint16_t readMemoryBlock(char *buf, int max_len) override
Read a block of characters from serial port.
Definition: HardwareSerial.h:276
bool begin(uint32_t baud=9600)
Initialise the serial port.
Definition: HardwareSerial.h:132
bool begin(uint32_t baud, SerialFormat format, SerialMode mode)
Initialise, set its configuration and mode.
Definition: HardwareSerial.h:161
void setTxWait(bool wait)
Governs write behaviour when UART transmit buffers are full.
Definition: HardwareSerial.h:202
bool onTransmitComplete(TransmitCompleteDelegate transmitCompleteDelegate)
Set handler for received data.
Definition: HardwareSerial.h:360
void setUartCallback(smg_uart_callback_t callback, void *param=nullptr)
Set callback ISR for received data.
Definition: HardwareSerial.h:372
void flush() override
Flush all pending data to the serial port.
Definition: HardwareSerial.h:312
size_t write(const uint8_t *buffer, size_t size) override
write multiple characters to serial port
Definition: HardwareSerial.h:324
uint32_t baudRate()
Get the current baud rate.
Definition: HardwareSerial.h:399
void pins(uint8_t tx, uint8_t rx)
Sets the transmission and receiving PINS.
Definition: HardwareSerial.h:247
XX(x)
XX(tag, comment)
@ TxOnly
@ RxOnly
@ Full