Class BridgeClient

Manages the real-time WebSocket connection from the tutor to the edge device.

const client = new BridgeClient(config, sessionId);
client.onStrokeReceived((s) => strokeGrouping.addStroke(s));
client.onConnectionStatus((s) => console.log('Bridge:', s));
await client.connect();
await client.sendRenderCommand(command);

Index

Constructors

constructor

Methods

connect disconnect getStatus onCapabilitiesReceived onConnectionStatus onStrokeReceived send sendRenderCommand

Constructors

constructor

new BridgeClient(config: BridgeConfig, sessionId: string): BridgeClient
Creates a new BridgeClient. Does not open the WebSocket — call connect.
Parameters
- config: BridgeConfig
  Endpoint URL, auth token, and retry settings.
- sessionId: string
  The active session ID embedded in every outgoing message.
Returns BridgeClient
- Defined in apps/tutor/src/bridge/BridgeClient.ts:103

Methods

connect

connect(): Promise<void>
Opens the WebSocket connection and starts the heartbeat timer.

Returns Promise<void>
Resolves once the connection is established and the capability report has been received from the edge device.
- Defined in apps/tutor/src/bridge/BridgeClient.ts:113

disconnect

disconnect(): Promise<void>
Gracefully closes the WebSocket and stops the heartbeat timer.

Returns Promise<void>
Resolves when the connection is fully closed.
- Defined in apps/tutor/src/bridge/BridgeClient.ts:122

getStatus

getStatus(): BridgeConnectionStatus
Returns the current connection status.

Returns BridgeConnectionStatus
One of BridgeConnectionStatus.
- Defined in apps/tutor/src/bridge/BridgeClient.ts:142

onCapabilitiesReceived

onCapabilitiesReceived(cb: CapabilitiesReceivedCallback): void
Registers a callback for the capability report sent by the device on connect.
Parameters
- cb: CapabilitiesReceivedCallback
  Called once with the device's BridgeCapabilities.
Returns void
- Defined in apps/tutor/src/bridge/BridgeClient.ts:160

onConnectionStatus

onConnectionStatus(cb: ConnectionStatusCallback): void
Registers a callback that fires on every connection status change.
Parameters
- cb: ConnectionStatusCallback
  Called with the new BridgeConnectionStatus.
Returns void
- Defined in apps/tutor/src/bridge/BridgeClient.ts:169

onStrokeReceived

onStrokeReceived(cb: StrokeReceivedCallback): void
Registers a callback for incoming stroke events from the edge device.
Parameters
- cb: StrokeReceivedCallback
  Called with each Stroke as it arrives.
Returns void
- Defined in apps/tutor/src/bridge/BridgeClient.ts:151

send

send(message: BridgeMessage, awaitAck?: boolean): Promise<void>
Sends an arbitrary typed message and optionally awaits acknowledgement. Prefer sendRenderCommand for the common render case.
Parameters
- message: BridgeMessage
  Any BridgeMessage to send.
- OptionalawaitAck: boolean
  Whether to wait for an ACK before resolving.
Returns Promise<void>
Resolves when the message is sent (and ACK'd if awaitAck is true).
- Defined in apps/tutor/src/bridge/BridgeClient.ts:181

sendRenderCommand

sendRenderCommand(command: PrimitiveRenderCommand): Promise<void>
Sends a render command to the edge device. Waits for an ACK before resolving.
Parameters
- command: PrimitiveRenderCommand
  The PrimitiveRenderCommand to dispatch.
Returns Promise<void>
Resolves when the edge device acknowledges receipt.
- Defined in apps/tutor/src/bridge/BridgeClient.ts:133

Class BridgeClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BridgeClient

Methods

connect

Returns Promise<void>

disconnect

Returns Promise<void>

getStatus

Returns BridgeConnectionStatus

onCapabilitiesReceived

Parameters

Returns void

onConnectionStatus

Parameters

Returns void

onStrokeReceived

Parameters

Returns void

send

Parameters

Returns Promise<void>

sendRenderCommand

Parameters

Returns Promise<void>

Settings

On This Page