XMODEM (checksum variant) classic

File transfer over a serial link. Mixes 128/1024-byte framed data blocks (selected by leading byte, not a length field) with completely bare single-byte control codes -- no envelope at all around ACK/NAK/EOT/CAN.

Servers

Operations

  • PUB omniuart/cmd/DataBlock128

    Send command DataBlock128 (ID: 0x01)

    Leading byte 0x01 (SOH) implies a 128-byte data field; nothing else about the length is transmitted.

    Operation IDpublish

    Available only on servers:

    Accepts the following message:

    DataBlock128 Command
    object

    Leading byte 0x01 (SOH) implies a 128-byte data field; nothing else about the length is transmitted.

    Examples

  • PUB omniuart/cmd/DataBlock1024

    Send command DataBlock1024 (ID: 0x02)

    Leading byte 0x02 (STX) implies a 1024-byte data field.

    Operation IDpublish

    Available only on servers:

    Accepts the following message:

    DataBlock1024 Command
    object

    Leading byte 0x02 (STX) implies a 1024-byte data field.

    Examples

  • PUB omniuart/cmd/EndOfTransmission

    Send command EndOfTransmission (ID: 0x04)

    A single bare byte, 0x04 -- no length field, no checksum, no envelope of any kind.

    Operation IDpublish

    Available only on servers:

    Accepts the following message:

    EndOfTransmission Command
    object

    A single bare byte, 0x04 -- no length field, no checksum, no envelope of any kind.

    Examples

  • PUB omniuart/cmd/Cancel

    Send command Cancel (ID: 0x18)

    Dispatch Cancel frame to microcontroller over serial line

    Operation IDpublish

    Available only on servers:

    Accepts the following message:

    Cancel Command
    object

    Command payload for Cancel

    Examples

  • SUB omniuart/telemetry/Ack

    Unsolicited telemetry message Ack (ID: 0x06)

    Unsolicited telemetry message from device: Ack

    Operation IDsubscribe

    Available only on servers:

    Accepts the following message:

    Ack Telemetry
    object

    Device-initiated telemetry payload for Ack

    Examples

  • SUB omniuart/telemetry/Nak

    Unsolicited telemetry message Nak (ID: 0x15)

    Unsolicited telemetry message from device: Nak

    Operation IDsubscribe

    Available only on servers:

    Accepts the following message:

    Nak Telemetry
    object

    Device-initiated telemetry payload for Nak

    Examples

Schemas

  • object

    Leading byte 0x01 (SOH) implies a 128-byte data field; nothing else about the length is transmitted.

  • object

    Leading byte 0x02 (STX) implies a 1024-byte data field.

  • object

    A single bare byte, 0x04 -- no length field, no checksum, no envelope of any kind.

  • object

    Command payload for Cancel

  • object

    Device-initiated telemetry payload for Ack

  • object

    Device-initiated telemetry payload for Nak