Serial console (VT100-style CLI), software flow control illustrative

Many console/CLI serial ports are wired with only TX/RX/GND -- no RTS/CTS lines exist to carry hardware flow control, so XON/XOFF (software, in-band) is the only option when the far end needs to pace output.

Servers

Operations

  • PUB omniuart/cmd/CommandLine

    Send command CommandLine (ID: 0x00)

    Dispatch CommandLine frame to microcontroller over serial line

    Operation IDpublish

    Available only on servers:

    Accepts the following message:

    CommandLine Command
    object

    Command payload for CommandLine

    Examples

  • SUB omniuart/telemetry/OutputLine

    Unsolicited telemetry message OutputLine (ID: OutputLine)

    Unsolicited telemetry message from device: OutputLine

    Operation IDsubscribe

    Available only on servers:

    Accepts the following message:

    OutputLine Telemetry
    object

    Device-initiated telemetry payload for OutputLine

    Examples

Schemas

  • object

    Command payload for CommandLine

  • object

    Device-initiated telemetry payload for OutputLine