Skip to main content

Serial Nodes

These nodes could be used to interface with peripherals using the UART protocol and also for debugging purposes.

Config Nodes

serial port

Handles serial connection and its settings for serial communication.

Inputs

  • Port no. : Select the UART port
  • Speed (bits/s) : Specify the baud rate
  • TX pin : Specify the TX pin
  • RX pin : Specify the RX pin
  • Sclk Freq : Select the clock source
  • Max receive size : Specify the maximum rx buffer size
  • Word size : Select the word size/length
  • Parity : Select parity
  • Stop Bits : Select stop bits
  • Flow control : Select flow control mode

Proc Nodes

serial write

Sends text/buffer data over a serial(UART) connection.

Inputs

  • Serial port : Select the serial port config
  • Text : Specify text to write

display

Prints text on the serial display window.

Inputs

  • Text : Specify text to display

serial read

Waits for data to arrive on a serial(UART) connection. When all the data is received, it is passed over to the next nodes.

Inputs

  • Serial port : Select the serial port config
  • Mode : Select read mode
  • Data length : Specify the data length to be recieved
  • Line ending char : Specify the line ending character
  • Clip ending : Whether to clip pattern
  • Set timeout : Whether to set timeout
  • Timeout (s) : Specify timeout

Outputs

  • data : data received

serial set word length

Set UART data bits.

Inputs

  • Config : Select the serial port config
  • Word size : Select the word size/length

serial get word length

Get UART data bits.

Inputs

  • Config : Select the serial port config

Outputs

  • Word length : Word length

serial set stop bits

Set UART stop bits.

Inputs

  • Config : Select the serial port config
  • Stop Bits : Select stop bits

serial get stop bits

Get UART stop bits.

Inputs

  • Config : Select the serial port config

Outputs

  • Stop bits : Stop bits

serial set parity bits

Set UART parity bits.

Inputs

  • Config : Select the serial port config
  • Parity : Select parity

serial get parity bits

Get UART parity bits.

Inputs

  • Config : Select the serial port config

Outputs

  • Parity bits : Parity Bits

serial set baudrate

Set UART baudrate.

Inputs

  • Config : Select the serial port config
  • Baud rate : Specify Baudrate

serial get baudrate

Get UART baudrate.

Inputs

  • Config : Select the serial port config

Outputs

  • Baud rate : Baud rate

serial set line inverse

Set UART line inverse.

Inputs

  • Config : Select the serial port config
  • Inverse mask : Provide an inverse mask

serial set sw flow control

Set UART set sw flow control.

Inputs

  • Config : Select the serial port config
  • Enable : Select status
  • Rx threshold xon : Specify xon threshold for rx
  • Rx threshold xoff : Specify xoff threshold for rx

serial set hw flow control

Set hw flow control.

Inputs

  • Config : Select the serial port config
  • Rx threshold : Specify rx threshold

serial get hw flow control

Get hw flow control.

Inputs

  • Config : Select the serial port config

Outputs

  • Flow ctrl mode : Flow Control Mode

change serial intr mask status

Set UART interrupt enable/disable.

Inputs

  • Config : Select the serial port config
  • Mask : Provide a bitmap to set/reset the interrupts
  • Status : Select status

serial clear intr mask

Clear UART interrupt status.

Inputs

  • Config : Select the serial port config
  • Clear mask : Provide bitmap to clear the interrupts

change serial rx intr status

Set UART rx interrupt enable/disable.

Inputs

  • Config : Select the serial port config
  • Status : Select status

change serial tx intr status

Set UART tx interrupt enable/disable.

Inputs

  • Config : Select the serial port config
  • Status : Select status
  • Threshold : Specify the threshold value

serial set pin

Assign signals of a UART peripheral to GPIO pins.

Inputs

  • Config : Select the serial port config
  • RX pin : Specify the RX pin
  • TX pin : Specify the TX pin
  • Rts Pin : Specify the RTS pin
  • Cts Pin : Specify the CTS pin

serial get pin

Get UART pins.

Inputs

  • Config : Select the serial port config

Outputs

  • Rx pin : RX pin
  • Tx pin : TX pin
  • Rts io num : RTS IO num
  • Cts io num : CTS IO num

set dtr rts pin level

Set dtr rts pin level.

Inputs

  • Config : Select the serial port config
  • Set rts : Set RTS
  • Rts level : Specify RTS value
  • Set dtr : Set DTR
  • Dtr level : Specify the DTR level

set tx idle number

Set UART idle interval after tx FIFO is empty.

Inputs

  • Config : Select the serial port config
  • Idle num : Specify Idle interval for tx

serial wait for tramsmit done

Wait until UART TX FIFO is empty.

Inputs

  • Config : Select the serial port config
  • Ticks to wait : Specify number of ticks to wait after transmission

serial write bytes

Write the data and size.

Inputs

  • Config : Select the serial port config
  • Data Source : Specify the data source
  • Size : Specify size
  • Break length : Select type of line break

Outputs

  • Bytes written : Bytes Written

serial get buffered data length

UART gets RX ring buffer cached data length.

Inputs

  • Config : Select the serial port config

Outputs

  • Buffered data length : Buffered data length

serial get tx buffer free size

UART gets TX ring buffer free space size.

Inputs

  • Config : Select the serial port config

Outputs

  • Free size : Free Size

serial pattern pop get position

Return the nearest detected pattern position in the buffer.

Inputs

  • Config : Select the serial port config
  • Select : Select type of operation

Outputs

  • Pattern pos : Pattern Position
  • Current pattern pos : Current Pattern Position

serial flush

UART ring buffer flush. This will discard all data in the UART RX buffer.

Inputs

  • Config : Select the serial port config

serial set mode

UART sets communication mode.

Inputs

  • Config : Select the serial port config
  • Mode : Select the mode

change pattern detect status

UART pattern detect function.

Inputs

  • Config : Select the serial port config
  • Select : Select status
  • Pattern char : Provide character pattern
  • Char num : Specify num of characters in a pattern
  • Char tout : Specify characters for TOUT feature
  • Post idle : Specify post idle
  • Pre idle : Specify pre idle

pattern queue reset

Allocate a new memory with the given length to save and record the detected pattern position in the rx buffer.

Inputs

  • Config : Select the serial port config
  • Queue length : Specify the queue length

set receiver timeout

UART set a threshold timeout for the TOUT feature.

Inputs

  • Config : Select the serial port config
  • Tout threshold : Specify the TOUT threshold timeout

set wakeup threshold

Set the number of RX pin signal edges for light sleep wakeup.

Inputs

  • Config : Select the serial port config
  • Wakeup threshold : Specify the wake up threshold

get wakeup threshold

Get the number of RX pin signal edges for light sleep wakeup.

Inputs

  • Config : Select the serial port config

Outputs

  • Wakeup threshold : wakeup threshold

get clock source frequency

Get the frequency of a clock source for the HP UART port.

Inputs

  • Config : Select the serial port config

Outputs

  • Freq in hz : Clock frequency

get collision flag

The return collision detection flag for RS485 mode.

Inputs

  • Config : Select mode for receiving data

Outputs

  • Collision flag : Collision Detection Flag

wait transmit idle polling

Wait until UART tx memory is empty and the last char sends ok (polling mode).

Inputs

  • Config : Select the serial port config

set transmit empty threshold

Set uart threshold values for TX fifo empty.

Inputs

  • Config : Select the serial port config
  • Threshold : Specify the threshold value for transmitter

set receiver full threshold

Set uart threshold value for RX fifo full.

Inputs

  • Config : Select the serial port config
  • Threshold : Specify the threshold value for receiver

set always receiver timeout

Configure behavior of UART RX timeout interrupt.

Inputs

  • Config : Select the serial port config
  • Rx timeout : Enable the receiver timeout

Event Nodes

on receive

An Event Producer Node. Waits for data to arrive on a serial(UART) connection. When all data is received, the next nodes are triggered and the data is passed to them.

Inputs

  • Serial port : Select the serial port config
  • Mode : Select mode for receiving data
  • Length (Bytes) : Specify the length in bytes for received data
  • Line ending char : Specify the line ending character
  • Clip ending : Whether to clip ending

Outputs

  • data : Received Data Buffer