Wire Examples¶

Every public payload is rendered from the schema-valid JSON files in the repository. Use the source link beside an example to download that payload verbatim.

Only the hello request and successful hello response carry protocol_version: "1.0". Later requests and responses omit it. Events use event_type and omit daemon-local sequence/uptime metadata. Protocol-level error_response payloads intentionally carry neither type, event_type, nor protocol_version.

Requests¶

Frames sent by the driver.

Hello¶

examples/requests/hello.jsonDownload JSON

Authenticate and negotiate protocol version 1.0.

examples/requests/hello.json

{
  "type": "hello",
  "protocol_version": "1.0",
  "auth": {
    "token": "integration-secret"
  }
}

Query State¶

examples/requests/query_state.jsonDownload JSON

Request the authoritative installation baseline.

examples/requests/query_state.json

{
  "type": "query_state",
  "scope": "all"
}

examples/requests/subscribe.jsonDownload JSON

Request state and registry delta events.

examples/requests/subscribe.json

{
  "type": "subscribe"
}

Ping¶

examples/requests/ping.jsonDownload JSON

Check liveness after a successful hello.

examples/requests/ping.json

{
  "type": "ping"
}

Command Move Target Percent¶

examples/requests/command_move_target_percent.jsonDownload JSON

Move one motor to a fractional percentage target.

examples/requests/command_move_target_percent.json

{
  "type": "command",
  "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
  "op": "move",
  "target_percent": 67.45
}

Command Cycle Motion¶

examples/requests/command_cycle_motion.jsonDownload JSON

Advance the calibrated motor-managed open/stop/close cycle.

examples/requests/command_cycle_motion.json

{
  "type": "command",
  "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
  "op": "cycle_motion"
}

Group Command Move¶

examples/requests/group_command_move.jsonDownload JSON

Move a group using processor-synchronized fan-out.

examples/requests/group_command_move.json

{
  "type": "group_command",
  "group_id": "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001",
  "op": "move",
  "target_percent": 70.25
}

Group Command Stop¶

examples/requests/group_command_stop.jsonDownload JSON

Stop every applicable member of a group.

examples/requests/group_command_stop.json

{
  "type": "group_command",
  "group_id": "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001",
  "op": "stop"
}

Multi Motor Move¶

examples/requests/multi_motor_move.jsonDownload JSON

Send synchronized independent percentage targets to multiple motors.

examples/requests/multi_motor_move.json

{
  "type": "multi_motor_move",
  "request_id": "scene-living-room-1",
  "targets": [
    {
      "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
      "target_percent": 67.45
    },
    {
      "motor_id": "5b8ffb9e-0c71-7f00-9dbf-032216914507",
      "target_percent": 71.2
    }
  ]
}

Command Move Retry Key¶

examples/requests/command_move_retry_key.jsonDownload JSON

Move one motor with a retry-safe request identifier.

examples/requests/command_move_retry_key.json

{
  "type": "command",
  "request_id": "scene-living-left-6745",
  "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
  "op": "move",
  "target_percent": 67.45
}

Responses¶

Direct acknowledgements and baseline data returned by the processor.

Hello OK¶

examples/responses/hello_ok.jsonDownload JSON

Successful hello acknowledgement.

examples/responses/hello_ok.json

{
  "type": "hello",
  "protocol_version": "1.0"
}

Query State¶

examples/responses/query_state.jsonDownload JSON

Authoritative compact motor and group baseline.

examples/responses/query_state.json

{
  "type": "query_state",
  "state": {
    "motors": {
      "5b8ffb9d-dfce-7cf4-8a72-4349274a9011": {
        "display_name": "Living Room Left",
        "online": true,
        "state": "stopped",
        "percent": 45.18,
        "travel_time_10ms": 1200
      },
      "5b8ffb9e-0c71-7f00-9dbf-032216914507": {
        "display_name": "Living Room Right",
        "online": true,
        "state": "stopped",
        "percent": 45.18
      }
    },
    "groups": {
      "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001": {
        "display_name": "Living Room Shades",
        "group_state": "uniform",
        "percent": 45.18
      }
    }
  }
}

Query State Scope Motors¶

examples/responses/query_state_scope_motors.jsonDownload JSON

Motor-only baseline response used during scoped recovery.

examples/responses/query_state_scope_motors.json

{
  "type": "query_state",
  "state": {
    "motors": {
      "5b8ffb9d-dfce-7cf4-8a72-4349274a9011": {
        "display_name": "Living Room Left",
        "online": true,
        "state": "stopped",
        "percent": 45.18,
        "travel_time_10ms": 1200
      }
    }
  }
}

Query State Scope Groups¶

examples/responses/query_state_scope_groups.jsonDownload JSON

Compact group-only baseline response used during scoped recovery.

examples/responses/query_state_scope_groups.json

{
  "type": "query_state",
  "state": {
    "groups": {
      "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001": {
        "display_name": "Living Room Shades",
        "group_state": "uniform",
        "percent": 45.18
      }
    }
  }
}

examples/responses/subscribe_ok.jsonDownload JSON

Successful subscription acknowledgement.

examples/responses/subscribe_ok.json

{
  "type": "subscribe"
}

Pong¶

examples/responses/pong.jsonDownload JSON

Direct response to ping.

examples/responses/pong.json

{
  "type": "pong"
}

Command Response Accepted¶

examples/responses/command_response_accepted.jsonDownload JSON

Terminal acknowledgement for an accepted command.

examples/responses/command_response_accepted.json

{
  "type": "command_response",
  "status": "accepted"
}

Multi Motor Move Response¶

examples/responses/multi_motor_move_response.jsonDownload JSON

Ordered per-motor outcomes for a stateless multi-motor move.

examples/responses/multi_motor_move_response.json

{
  "type": "command_response",
  "request_id": "scene-living-room-1",
  "status": "accepted",
  "results": [
    {
      "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
      "status": "accepted"
    },
    {
      "motor_id": "5b8ffb9e-0c71-7f00-9dbf-032216914507",
      "status": "rejected",
      "error_code": "conflict",
      "retryable": true
    }
  ]
}

Command Response Rejected Conflict¶

examples/responses/command_response_rejected_conflict.jsonDownload JSON

Retryable conflict while the identical original command is in flight.

examples/responses/command_response_rejected_conflict.json

{
  "type": "command_response",
  "request_id": "scene-living-left-6745",
  "status": "rejected",
  "error_code": "conflict",
  "retryable": true
}

Events¶

Subscribed state and registry deltas emitted by the processor.

Motor State¶

examples/events/motor_state.jsonDownload JSON

Motor availability, motion, and percentage delta.

examples/events/motor_state.json

{
  "event_type": "motor_state",
  "motor_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
  "state": "opening",
  "online": true,
  "percent": 45.18,
  "target_percent": 67.45,
  "travel_time_10ms": 1200
}

Group State¶

examples/events/group_state.jsonDownload JSON

Processor-derived group state delta.

examples/events/group_state.json

{
  "event_type": "group_state",
  "group_id": "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001",
  "group_state": "moving",
  "target_percent": 70.25
}

Registry Event Motor Updated¶

examples/events/registry_event_motor_updated.jsonDownload JSON

Registry update for an externally visible motor record.

examples/events/registry_event_motor_updated.json

{
  "event_type": "registry_event",
  "change_type": "updated",
  "entity_type": "motor",
  "entity_id": "5b8ffb9d-dfce-7cf4-8a72-4349274a9011",
  "entity": {
    "display_name": "Living Room Left",
    "online": true,
    "state": "stopped",
    "percent": 70.25
  }
}

Registry Event Group Updated¶

examples/events/registry_event_group_updated.jsonDownload JSON

Compact group-name update without membership topology.

examples/events/registry_event_group_updated.json

{
  "event_type": "registry_event",
  "change_type": "updated",
  "entity_type": "group",
  "entity_id": "018f0f61-5b7d-7cc2-9f4a-6f7db0b2d001",
  "entity": {
    "display_name": "Living Room Shades"
  }
}

Errors¶

Protocol-level error payloads.

Unauthorized Error Response¶

examples/errors/unauthorized_error_response.jsonDownload JSON

Uncorrelated authentication failure; the connection then closes.

examples/errors/unauthorized_error_response.json

{
  "error_code": "unauthorized",
  "error_message": "invalid integration token",
  "retryable": false
}

Query State Response Too Large¶

examples/errors/query_state_response_too_large.jsonDownload JSON

Non-retryable size response that permits scoped baseline recovery on the same connection.

examples/errors/query_state_response_too_large.json

{
  "request_id": "baseline-1",
  "error_code": "response_too_large",
  "error_message": "query_state response exceeds the external frame limit; retry with a narrower scope",
  "retryable": false
}

Uncorrelated Invalid Message Error Response¶

examples/errors/uncorrelated_invalid_message_error_response.jsonDownload JSON

Protocol error for malformed, uncorrelatable JSON.

examples/errors/uncorrelated_invalid_message_error_response.json

{
  "error_code": "invalid_message",
  "error_message": "Malformed JSON request.",
  "retryable": false
}

Wire Examples¶

Requests¶

Hello¶

Query State¶

Subscribe¶

Ping¶

Command Move Target Percent¶

Command Cycle Motion¶

Group Command Move¶

Group Command Stop¶

Multi Motor Move¶

Command Move Retry Key¶

Responses¶

Hello OK¶

Query State¶

Query State Scope Motors¶

Query State Scope Groups¶

Subscribe Ok¶

Pong¶

Command Response Accepted¶

Multi Motor Move Response¶

Command Response Rejected Conflict¶

Events¶

Motor State¶

Group State¶

Registry Event Motor Updated¶

Registry Event Group Updated¶

Errors¶

Unauthorized Error Response¶

Query State Response Too Large¶

Uncorrelated Invalid Message Error Response¶