8.8 KiB
Device adapters and Aquilon exchange
Canvas Pilot's device-neutral snapshot contains a profile, screens with native IDs, output pixel resolutions, explicit Preview/Program banks, and allocated layers with source identity, visible/container geometry, optional source/crop framing, optional explicit crop-first fit, and unsupported-mode explanations. It is transient, never a save format. The small profile registry selects family implementations; UI, scopes, history, transport and editor geometry do not contain native path substitutions.
Persistent destinations use project version 15: family + screen + layer. Midra links migrate explicitly from versions 1–12. Neither bank roles nor credentials nor raw device state are persisted. Current standalone profiles do not support linked-unit identity; linked Aquilon devices are refused.
Midra represents its four explicit modes using the shared LayerFit enum and
container geometry; fit math stays in the geometry model and wire conversion in
the adapter. A null fit retains the normal visible-box zoom/crop workflow. Aquilon
currently imports that normal workflow and rejects explicit-fit sends; future
adapters must explicitly implement or reject each mode.
Aquilon profile and reads
Supported profile: standalone AQL Cmax, firmware 6.2.x, exercised on the
6.2.79 emulator. This is a first-class adapter; physical-output acceptance
remains outstanding.
Other firmware/models are rejected before reading geometry. /api/tpp/v1/system
on the configured HTTP port supplies identity. Aquilon geometry uses AWJ TCP
10606 on the same IP, independently of the HTTP/WebSocket port. AWJ model and
firmware are checked against the HTTP identity. A blocked/disabled AWJ port is an
explicit connection error; there is no full-store HTTP fallback. Midra retains
its existing HTTP reader. The emulator has authentication disabled; HTTP auth
failures remain explicit and credentials are not saved.
The manufacturer's AWJ guide V6.2
documents property reads over TCP. Requests are {"op":"get","path":"..."},
terminated by byte 0x04. Canonical paths start with DeviceObject; list,
item and property segments use $screen, @items and @props. Responses are
matched by exact canonical path, including out-of-order replies. Error, missing,
unexpected, duplicate, truncated and oversized responses fail the read.
Reads discover itemKeys, then screen modes and available inputs. Only enabled
screens, their allocated numbered layers in the two current role banks, active
input plugs, framing settings and snapshot availability are requested. No memory
banks, inactive layer slots, hardware inventories or other large subtrees are read.
These targeted values populate the same normalized adapter state as before.
Requests are pipelined in batches of 64; parent-object reads are avoided because
the emulator returns empty objects for them. A second pass compares all selected
values, including topology and bank roles; a changing snapshot is rejected instead
of being used for a send. No cache, persistent subscription or AWJ writes are used.
Bounds: 256 entries per discovered collection, 65536 selected fields, 16 KiB per response, and 16 MiB aggregate response bytes across both passes. TCP connect/write timeout is 3 seconds, collection deadline 30 seconds, and read waits check cancellation at 250 ms intervals. HTTP identity retains its 5-second connect / 45-second request limits. All work stays on the worker.
On the 6.2.79 emulator, a complete two-pass read received 197180 bytes over AWJ plus 124 bytes of HTTP identity, versus the previous 124077157-byte store download: 99.84% less downloaded payload. AWJ requests totalled 184978 bytes. Three direct debug-build reads took 0.314, 0.302 and 0.297 seconds; a counting proxy took 1.601 seconds. These are local emulator measurements, excluding TCP/HTTP header overhead, not guarantees for every device configuration.
Enabled screenList and auxiliaryList entries supply status.pp.layerCount
(0–128) and status.size.pp.sizeH/sizeV. Canvas dimensions also obey editor
limits (1–16384 integer pixels per side). status.pp.mode: DISABLED excludes an
entry even if it retains nonzero stored dimensions. Layer IDs are numbered slots,
not inputs; native/background layers are omitted.
Each screen's status.pp.transitionGroup identifies a screenAuxGroupList item.
At AT_UP, its control.pp.presetUp is Program and presetDown Preview;
AT_DOWN reverses roles. Distinct A/B/C bank identities are validated. Other
transition states block import/send planning. Roles are not assumed from bank names.
Geometry, crop and writes
Layer path: device/{screenList|auxiliaryList}/items/{S1|A1}/presetList/items/{bank}/layerList/items/{layer}.
Position and size share position.pp: posH, posV are centers; sizeH, sizeV
are pixel sizes. Editor geometry is top-left based. Firmware accepts/stores f32
values, but WebRCS 6.2.79 throws oldAnchorRect are not integers when rendering
fractional position/size fields. Therefore sends round sizes and centers to whole
pixels (sizes 1–1000000). Saved/editor geometry retains double precision; imported
half-pixel/top-left geometry is not rounded. Conversion rejects a rounded visible
size error above one pixel. Center rounding contributes at most half a pixel.
Strict readback checks the quantized values rather than silently accepting clamps.
Only MIDDLE_CENTER anchors are currently accepted. Source routing is
source.pp.inputNum (LIVE_n, NONE, etc.); production geometry sends omit it.
cropping.classic.pp.{left,right,top,bottom} are integer fractions 0–65535.
Layer crop combines the editor input crop and dynamic crop in native source pixels,
then rounds edge/native_axis*65535. Exhausted axes are rejected. Sends set
cropping.classic.pp.aspectOverride to CENTERED. Masked destinations are rejected;
mask fields are never cleared implicitly. Crop decreases precede increases.
Live input LIVE_n resolves inputList.items.IN_n and its active plug. The
plug's status.signal.pp.imageWidth/imageHeight supply native dimensions.
Shared input cropping and aspect transforms are explicitly unsupported for
visible-bound conversion in this initial profile; their controls remain in
WebRCS and are never sent by the adapter. Unrouted/color layers with zero crop
can still import container geometry. Unknown source dimensions with nonzero
crop do not silently produce a visible-box estimate.
Both Output-sized and Source aspect use the existing editor sizing contract. The retained cropped source fits inside the chosen container with a uniform minimum-axis scale. Quantized crop must reproduce the requested visible size within one output pixel. Import reverses this conversion for centered framing; unsupported fit/mask modes are reported on each layer and block its import.
Explicit sends refresh state first and reject stale banks, source/framing values
or changed destinations before writing. They use the shared root WebSocket
DEVICE framing documented in Midra exchange, then pulse
device/screenAuxGroupList/control/pp/xUpdate false → true. No TAKE, routing,
shared input, mask or effect writes occur. Changed fields are read back; partial
writes, failed applies and mismatches report uncertain outcomes without automatic
retry writes or rollback. The emulator diagnostic explicitly restores its baseline.
Input previews and acceptance limits
Discovery uses available IN_n entries, current-plug signal validity and
snapshot.pp.enable. The adapter resource limit is 256 inputs; unavailable inputs
remain excluded. GET /api/device/snapshots/inputs/n returns PNG data. Inputs 1
and 17 on the emulator returned 256 × 144 PNGs. The existing 16 MiB image
limit, decoder bounds, serialized five-second minimum and pooling apply unchanged.
No polling setting or snapshot size is written to the device.
Sanitized native fields are recorded in tests/fixtures/aquilon-6.2.json;
no raw emulator dump, labels, network settings or credentials are committed.
Synthetic variations cover auxiliaries, multiple banks, malformed states and
unsupported modes. Emulator readback and WebRCS rendering are separate acceptance
checks from physical output. Older firmware, other models, linked units and
physical-output behavior remain unverified.
Mask appearance
Device-neutral layer appearance pairs optional fit with an independent normalized
container mask (LayerAppearance). Imports apply geometry, source/crop, fit and
mask atomically. New/legacy unmasked layers use four zero edges. Midra maps this
mask to its own integer attributes; Aquilon rejects nonzero editor masks before
planning writes. Adding adapter support must preserve blanking rather than
discard it or convert it into source crop.