Interface MotionMasterConnectionConfig

Configuration options for establishing connections to the Motion Master when creating a client object using createMotionMasterClient.

Hierarchy

  • MotionMasterConnectionConfig

Properties

clientId: string

Unique identifier assigned by the client to the Motion Master. The default value is generated using the v4() function.

hostname: string

The IP address or domain name of the machine running the Motion Master process. The default value is 'localhost'.

pingSystemInterval: number

Time interval (in milliseconds) for sending Ping messages from the client to the Motion Master. The default value is 250 ms.

pubSubPort: number

Port number for the Publish/Subscribe WebSocket connection. The default value is 63525.

remember?: boolean

UI-only flag indicating whether the entered connection configuration should be stored and used in the future.

reqResPort: number

Port number for the Request/Response WebSocket connection. The default value is 63524.

secure?: boolean

Indicates whether the client should connect using WebSocket (ws://) or WebSocket Secure (wss://). Note: Currently, only the ws:// protocol is supported.

systemAliveTimeout: number

Specifies the duration the client will wait for a response from Motion Master before considering it unresponsive, such as when there is no reply to a Ping message. The default value should be a multiple of pingSystemInterval, such as 1000 ms.

Generated using TypeDoc