Interface ConnectionOptions

The IP of the core system to connect to. In a Primary/Secondary configuration, this should be the IP of the primary core.

If this system uses a redundant core, specify the IP of the redundant core here. This will enable automatic failover.

If true, the connection will use wss instead of ws.

The interval in milliseconds at which the system will poll the core for updates. Default is 35ms.

An array of control names to subscribe to. If provided, only controls in this array will be sent to the system. If a function is provided, it will be called with the control name as an argument and should return a boolean indicating whether to subscribe to that control.

interface ConnectionOptions {
    controlFilter?:
        | (componentState: Readonly<IComponentGetComponentsResult>) => boolean
        | string[];
    coreIp: string;
    poleInterval?: number;
    redundantCoreIp?: string;
    secure?: boolean;
}

Properties

controlFilter?:
    | (componentState: Readonly<IComponentGetComponentsResult>) => boolean
    | string[]
coreIp: string
poleInterval?: number
redundantCoreIp?: string
secure?: boolean