13.1.33. SerialCommHub

Hub to communicate with attached serial devices

13.1.33.1. Provides

Implementation of serial communication hub
config:
serial_port:
description:Serial port the hardware is connected to
type:string
default:/dev/ttyUSB0
baudrate:
description:Baudrate
type:integer
parity:
description:Parity bit: 0: None, 1: Odd, 2: Even
type:integer
rtscts:
description:Use RTS/CTS hardware flow control
type:boolean
ignore_echo:
description:On some hardware every message that is sent is read back, this setting filters the sent message in the reply.
type:boolean
rxtx_gpio_chip:
description:GPIO chip to use to switch between RX/TX. An empty string disables GPIO usage.
type:string
default:
rxtx_gpio_line:
description:GPIO line to use to switch between RX/TX
type:integer
rxtx_gpio_tx_high:
description:GPIO direction, false means low for TX, true means high for TX
type:boolean
max_packet_size:
description:Maximum size of a packet to read/write in bytes. Payload exceeding the size will be chunked. The APU size according to [wikipedia](https://en.wikipedia.org/wiki/Modbus) is 256 bytes, which is used as default here.
type:integer
initial_timeout_ms:
description:Timeout in ms for the first packet.
type:integer
within_message_timeout_ms:
description:Timeout in ms for subsequent packets.
type:integer
retries:
description:Count of retries in case of error in Modbus query.
type:integer
config:
serial_port:string <optional>
default: “/dev/ttyUSB0”
Serial port the hardware is connected to
baudrate:integer <optional>
default: 9600
Baudrate
parity:integer <optional>
default: 0
Parity bit: 0: None, 1: Odd, 2: Even
rtscts:boolean <optional>
default: False
Use RTS/CTS hardware flow control
ignore_echo:boolean <optional>
default: False
On some hardware every message that is sent is read back, this setting filters the sent message in the reply.
rxtx_gpio_chip:string <optional>
default: “”
GPIO chip to use to switch between RX/TX. An empty string disables GPIO usage.
rxtx_gpio_line:integer <optional>
default: 0
GPIO line to use to switch between RX/TX
rxtx_gpio_tx_high:boolean <optional>
default: False
GPIO direction, false means low for TX, true means high for TX
max_packet_size:integer <optional>
default: 256
Maximum size of a packet to read/write in bytes. Payload exceeding the size will be chunked. The APU size according to [wikipedia](https://en.wikipedia.org/wiki/Modbus) is 256 bytes, which is used as default here.
initial_timeout_ms:integer <optional>
default: 500
Timeout in ms for the first packet.
within_message_timeout_ms:integer <optional>
default: 100
Timeout in ms for subsequent packets.
retries:integer <optional>
default: 2
Count of retries in case of error in Modbus query.

13.1.33.2. Metadata

13.1.33.2.1. Authors

Lars Dieckmann
Cornelius Claussen

13.1.33.2.2. License