udp

A worked example for one device: the bytes it sends and the ACKs it gets (any member)

Everything needed to write sender firmware for THIS device: a sample payload, a sample nonce of its own width, the resulting datagram in hex, the ACK for each status, and a field-by-field byte-offset table for both directions. The nonce and payload are samples and are labeled as such — nonce_note says what the device must send instead, which for every keyed suite is a value that NEVER repeats under its key. Everything else is the device's real row, so the datagram is byte for byte what it would put on the wire. The key is used to compute this and is never returned: it existed once, in the create response.

get/v1/projects/{project_id}/udp/devices/{device_id}/example

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/projects/{project_id}/udp/devices/{device_id}/example
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

project_idstring required
device_idstring required

the device's 16-hex-character id

Response

OK

addressesstring[] required

the canonical static endpoint: anycast addresses, IPv4 and IPv6, that never change — hard-code one

content_encodingstring
content_typestring required
datagram_hexstring required
datagram_leninteger required

bytes on the wire; keep a real datagram under about 1200 so it is never fragmented

device_idstring required
encoding_notestring

present only when the device compresses: the sample payload stands in for compressed bytes

hostnamestring

an optional DNS name for this deployment, when configured; addresses are the endpoint, not a fallback

nonce_hexstring required
nonce_leninteger required
nonce_notestring required

what the sample nonce is, and what the device must send in its place

payload_hexstring required
payload_textstring required

the sample payload as text — one NDJSON line, one JSON object, or one CSV row

portinteger required
provisionedboolean required

false when this deployment has no UDP listener; the example is still exact

sealedboolean required

the payload is encrypted, so the datagram carries ciphertext where the payload would be

suitestring required
tablestring required
tag_leninteger required

Changes

No recorded changes to this operation across all 1 revision of this API.