Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.

Configure the SonoMarc module

Settings are edited in HEAT Capture’s module settings UI, under Sonomarc Module.

Connection and session

SettingTypeDefaultWhat it controls
HoststringlocalhostHostname or IP of the SonoMarc Core server.
Portinteger80HTTP port of the SonoMarc REST API.
SessionNamestringemptyThe SonoMarc session to capture. Left empty, this module picks the first session it finds in the Running state - not necessarily a predictable one if more than one is running.
SessionPollRetryMsinteger (ms)5000How often this module checks for a matching running session. It keeps checking indefinitely - there is no give-up point, so a capture session that starts before SonoMarc does waits.

Capture mode

SettingTypeDefaultWhat it controls
CaptureModeWholeSession | PerSeatWholeSessionWholeSession: capture every seat on every platform - intended for one centralized capture node. PerSeat: capture only the seat bound to this workstation - intended for a per-operator HEAT Capture deployment.
SeatBindingstringempty (local hostname)Only used in PerSeat mode. The seat binding this workstation should match. A seat matches if its own binding string contains this value, not only on an exact match - see Troubleshooting for why that can pick up more than one seat.

SSE

SettingTypeDefaultWhat it controls
SseReconnectDelayMsinteger (ms)3000Delay before reconnecting a dropped event stream. Retries indefinitely.

This module also exposes the generic settings every HEAT Capture module has (Enabled, Interval, OverrideNodeId/NodeId, Timeout) - see Manage capture modules. Interval matters more than its name suggests here: seat and asset state (including malfunction detection) is only re-polled, and fault-transition events only computed, when this module’s own capture call runs - left at the SDK default of 1000 ms, a fault that clears within that window can be missed entirely, the same risk documented for the game controller input module. Activity events (transmit, receive, push-to-talk) are not affected - those arrive over the separate SSE stream in real time, independent of Interval.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.