beffroi-tools/docs/interfaces/midra-device-send.md

15 KiB
Raw Blame History

Midra reviewed layer exchange

This is a transient device protocol, not a project/save schema. Reference collections in project v10 do not change device layer mapping. Compatibility exercised: Eikos 4K firmware 3.3.10, installed WebRCS app.e42fce4879f318b28cde.js. Other firmware needs verification.

Addressing and fields

HTTP GET /api/tpp/v1/system and /api/stores/device supply identity and snapshots. A WebSocket at ws://DEVICE_IP/ accepts JSON text:

{"channel":"DEVICE","data":{"path":["device","screenList","items","2","presetList","items","UP","liveLayerList","items","1","position","pp","posH"],"value":162}}

Normal geometry fields under the mapped live layer are:

  • size.pp.sizeH, size.pp.sizeV: integer container pixels, 1–65535.
  • position.pp.posH, position.pp.posV: integer center coordinates, −67268–67268.
  • crop.pp.left, right, top, bottom: normalized integers, 0–65535.
  • crop.pp.aspectOverride: CENTERED.

At AT_DOWN, Preview is UP and Program DOWN; AT_UP reverses those roles. The selected configuration captures one physical bank. Send writes directly without a preflight read or stale-snapshot refusal. Commands do not retarget halfway through. No TAKE or source routing, mask, effect, opacity or output setting is sent. Shared input aspect/crop fields are omitted unless explicitly opted into and edited as described below.

Conversion

When the destination reports positive content dimensions, the editor native source dimensions must equal status.pp.contentWidth/contentHeight. Missing or zero dimensions (for example, an unassigned input) use the editor's native dimensions for crop conversion and do not block sending. Reported dimensions describe the incoming content used for this layer, not an instruction to change input hardware configuration.

Combine each local input crop edge with its advanced layer crop edge, in native source pixels. Quantize each combined edge to round(edge / native_axis * 65535). Reject exhausted retained regions, invalid geometry, masked destinations and source-resolution mismatch. Input correction is folded into the layer crop, so it affects only the mapped destination.

For Output-sized, round the requested visible width/height to container pixels. For Source aspect, compute k = max(visible_width/native_width, visible_height/native_height) and round native * k as the container size. The post-crop retained source fits inside this container with Centered aspect. Both modes center the container at the rounded requested visible center.

Reconstruct the retained size from quantized crop fractions, then use min(container_width/retained_width, container_height/retained_height) to derive visible bounds. Reject size errors above one output pixel. Center rounding has at most half a pixel of error. Stored editor coordinates retain full precision; review values use one decimal and transmitted geometry uses whole pixels.

Import and round trip

Centered layers with zero masks and valid content dimensions reconstruct their visible geometry with the same fit calculation. Imported sources are independent local sources with the device content dimensions, zero input correction, and all combined cropping stored in advanced crop. Thus the visual framing survives; the original separation into input correction and layer crop cannot be recovered. Imports are atomic and undoable, including creation of new layers/sources.

Other aspect modes retain container-only import and reject nonzero crop/mask. The Python snapshot-to-SVG bridge remains container-only under its existing contract.

Execution and failure semantics

Only an explicit Send click creates a worker. Read/refresh, editing, project load, import, undo and redo never write. Requests run off the UI thread with bounded socket operations. After preflight, changed fields are written sequentially once. Crop decreases precede increases to avoid temporarily exhausting the retained area while moving a crop. Readback checks every changed field. Valid plans remain sendable even when stored geometry matches: sending still applies staged values. Failure reports partial/uncertain outcomes without blind retries or automatic rollback.

Program selection is explicit. The application defaults to Preview and hides Program unless the persisted allow_sending_to_program preference is enabled. Turning it off resets the exporter to Preview, including quick Apply. Layer screen/destination links are saved in project version 5. Plans and raw snapshots are not saved in projects or preferences. The device address is saved in application settings, never in projects. Refresh and screen changes preserve saved links. Physical display validation remains separate from the successful device-field and import round trips.

The status-bar and Export-menu Midra mapping & transfer… actions only open export configuration, even when current layers have valid saved links. They never start a write. The user chooses a transfer scope, mappings, target and sizing, then explicitly clicks Send mapped layers for the displayed screen. Empty/unlinked rows are skipped. The load button uses all saved links in the scope, including links to other screens. Busy/offline actions are disabled. Send all linked layers remains a separate direct-send action using saved links. No persistent schema changes are involved.

Snapshot layer lists include only allocated live-layer entries, independently of input assignment (NONE, empty or absent) and OFF state. The active allocation comes from device/preconfig/status/stateList/items/CURRENT/screenList/items/{screen}/pp/layerCount. Only numeric live-layer IDs 1 through that count are listed or accepted as send destinations, even though the firmware stores eight slots. The staged NEW configuration, physical input count, background and foreground planes do not determine this list. Missing/invalid allocation metadata produces a connection error rather than exposing all slots. Missing layer IDs are not synthesized. Input routing is informational and is never changed by geometry transfers. A Centered layer without usable content dimensions and with zero crop/ mask imports its container geometry without inferred source framing; nonzero crops still require valid dimensions for visible-bound reconstruction. This changes device discovery/transfer behavior only; project and export schemas are unchanged.

The direct send button uses the shared transfer scope. Its default All layers includes all linked document layers, even unselected, hidden or locked ones. Only selected layers uses exactly the current selection (an empty selection does not mean All); Folder: … uses all members of the named folder, independently of selection/visibility/locks. Unlinked layers are skipped. Plans are grouped by saved screen ID and all groups are validated before starting. Screen groups send sequentially with readback; on failure later groups are not sent, and the result reports the failed screen and completed-group count. Links never auto-send and are not tied to an IP address.

Preset apply pulse

After the geometry writes, send two DEVICE WebSocket messages at device/preset/control/pp/xUpdate: false, then true, matching WebRCS's DEVICE_PRESET_CONTROL_SET_ONE action sequence. This commits staged preset edits when enableAutoUpdate is false. Do not change enableAutoUpdate or issue TAKE. The pulse is global and may apply other pending preset edits; it is not scoped to an individual screen/layer. Each screen send currently ends with this pulse. Always pulse on an explicit valid send, even if the staged geometry already matches and the change list is empty. A pulse-write failure is reported separately from geometry-write failure. Geometry readback follows the pulse; a readable store alone does not prove the physical video output updated. The trigger itself is not included in geometry comparisons, because it is a command rather than geometry.

Send all linked layers sends immediately using saved links and the current target and sizing settings, without opening the export window. The button shows progress and its tooltip reports completion. Invalid links or send failures open the export window with the error.

Load linked layers, beside the connection status and in Export, reads fresh Midra Preview geometry and crop framing into linked editor layers in the shared transfer scope. The default All layers ignores canvas selection; Only selected layers and Folder: … explicitly restrict the operation. The load button inside Midra mapping & transfer… uses that same scope and the saved links. Both actions are read-only on the device and always load Preview (independent of the send target). They do not recall device memories or presets. Loading is one atomic Undo step; links remain saved. Missing screens/layers, mismatched output resolutions, unsupported geometry, and hidden or locked editor destinations reject the complete import without changing the document. Unlock/show destinations before loading. Results appear in the transfer window or the load button's status tooltip. No project or settings schema changes are involved.

Closing a device import review with chosen destinations offers Apply/Discard. Apply imports into the local editor atomically; it never writes to the device. Closing send configuration does not send. Local property edits that apply immediately still require an explicit device Send action.

Shared transfer scopes and folder layouts

The desktop keeps a session-only scope: All (default), Selected, or one folder name. Scope controls both direct linked send/load and the destination candidates in manual Midra import/export review. All does not depend on selection; Selected with no selection and Folder with no members are empty scopes, never implicit All. Scope changes do not edit viewport selection or saved links. In Folder mode, clicking a folder name changes the scope. Folder rename follows the renamed scope; a missing folder requires choosing another scope. The scope is omitted from project/settings/export representations.

Direct send/load captures stable layer IDs and their saved (screen, layer) links when clicked. Switching scope while a read is pending cannot redirect that import. Direct sends validate destination uniqueness within the chosen scope, across each screen. Duplicate destinations across different folders are valid persistent links, but those folders cannot be sent together. Loading the same device layer into multiple local linked copies is allowed; destination editor IDs must still be unique, visible, and unlocked. Existing geometry validation and atomic import guarantees are unchanged.

The send review lists all scoped editor layers on the currently browsed screen. Saved links on that screen populate editable destinations; empty rows are skipped. Browsing another screen does not rewrite existing links. An explicit destination change saves the new link; a scope change never removes out-of-scope links. Manual device import suggests unique saved links within scope, while retaining manual row remapping until scope/screen changes or refresh. Ambiguous/unlinked rows start skipped. Creating layers is explicit and available only in All/Folder scopes; new layers inherit the scope's folder (root in All). A successful manual import saves reviewed device links, geometry, source/crop data and new-layer membership in one undoable transaction. Invalid mapping, link or geometry rejects the entire transaction. This uses existing layer fields (unchanged in project v10); there is no schema/version change. Source routing and device memories are not imported.

Layer properties → Mapping edits the existing per-layer midra_link.screen and midra_link.layer fields locally. Unmap saves midra_link: null, so linked sends and loads skip the layer. These edits are undoable and never issue device commands. Connected selectors use discovered screens/layers; offline editing accepts positive numeric IDs. Project schema and version are unchanged.

Opt-in advanced input edits (transient)

The Source tab's device controls map one-for-one to the installed WebRCS Advanced Input settings. They are separate from the editor's local source model and its existing combined layer-crop conversion above. Field names, enum values, ranges and input-crop update pulse were checked against the connected Eikos snapshot and app.e42fce4879f318b28cde.js; this change did not write to hardware.

Read the linked Preview layer's source.pp.input, then the input's status.pp.plug. The write root is device/inputList/items/INPUT_N/plugList/items/P/settings/:

Suffix Encoding / units
aspect/pp/signal NATIVE, 5_4, 4_3, 16_10, 15_9, 16_9, 21_9, 256_135, 64_27
aspect/pp/transformTo SIGNAL, 5_4, 4_3, 16_10, 15_9, 16_9, 21_9, CUSTOM
aspect/pp/customRatio Integer ratio × 1000, 250–10000; UI displays 0.250–10.000
aspect/pp/layerFill LAYER_SETTING, 1_1, CENTERED, FULLSCREEN, CROPPED
cropping/control/pp/predefined NONE, LETTERBOX_1_78, LETTERBOX_1_85, LETTERBOX_2_35, PILLARBOX_1_33
cropping/control/pp/left, right, top, bottom Whole input pixels, 0–8191

Input crop is processed before layer crop/zoom and does not set layer-container resolution. These settings are shared across consumers of the physical input; they are not bank-local. A Preview geometry send with opted-in input edits can therefore affect a Program layer using the same input. Layer exports continue to use their own Centered aspect override; input layer-fill edits may affect other layers configured to inherit input settings.

The checkbox defaults off; merely enabling it or opening the tab stages nothing. Only edited fields are retained; reverting to the captured value removes the edit. Plans include a staged field only when an explicitly mapped destination in the chosen physical bank currently uses that input and plug. A Program layer with different routing does not receive the Preview input's edits. Duplicate mappings to one input add each field once per screen plan. Raw input edits are listed in Exact device changes and apply to both reviewed and direct linked sends. They never route sources or write unrelated input defaults.

Input field writes precede layer writes. After writes, each changed input crop gets its own cropping/control/pp/xUpdate false→true pulse, then the normal preset update pulse runs. Readback checks edited values, excluding intermediate pulse values. Existing partial-failure reporting applies; no automatic rollback or resend. Refresh/load reads resulting device content geometry; the input controls do not predict device resampling or update the local source model.

This is session-only state, not part of project JSON, SVG, preferences or recovery. Uncheck, disconnect, address change and project load discard staged input edits and reset opt-in. Existing files migrate without changes and never opt into shared input writes. No persistent format/version change is introduced.