Skip to main content
Step-based exports describe levels: at which step each channel changes. The Oryx Signal Format (.osf) describes the same thing as operations: write 3F 0A on TX at step 4, expect 4F 4B 0A on RX, read two bytes from 0x48. A device can run them with its peripherals (hardware UART, SPI and I2C) and validate what it receives without walking every step.

When it shows up

In Export, as the first option and marked Recommended, when every channel going into the file (that has a drawing) belongs to a UART, SPI or I2C bus Oryx can read. If there is any other kind of channel —a PWM, a hand-drawn channel with no protocol, an analog signal— or something that cannot be expressed without losing information (a byte with a deliberate parity error, SPI Dual/Quad/Octal or DDR), it does not show up and the usual formats remain. It is available on every plan. The file downloads as .osf: it is JSON inside, so any JSON reader opens it.

Structure

One document shared by every protocol, versioned: Every operation has an [at, end) interval in steps. Two operations whose intervals overlap run at the same time (two buses talking at once). after points to the request an operation answers.

Operations

I2C operations may carry tenBit (10-bit address) and repeatedStart (they end with a repeated START instead of STOP).

Example: UART with a response

Example: SPI full duplex

role is controller when Oryx drives the clock (the usual case). With the clock set to RX, the bus is exported as peripheral.

Example: I2C write and read

Example: several protocols at once

UART, SPI and I2C in one document. SPI and the I2C read start while the UART write is still going, and the UART response follows its request:

Example: back-to-back transactions

Validating a file

The JSON schema (draft 2020-12) is published at https://oryx.mechatronstudio.com/schemas/oryx-signal-format-1.json and every file names it in $schema. Any JSON Schema validator checks it; on top of that, Oryx checks that every reference exists (channels, buses, devices, after) before downloading the file.
A new version of the format changes version. A version 1 reader should reject a number it does not know instead of guessing.

From steps to time

Everything is in steps, like the rest of Oryx. When running, the step time is set by the device (or by stepUs, if exported): on UART, bitSteps × step time is the length of a bit (9600 baud = 104.17 µs per bit); on SPI and I2C, clockHalfSteps × 2 × step time is the clock period.