Class StarCommsLocalClient

Standalone WebSocket client for the StarComm desktop application.

Connects to the StarComm desktop app's Mobile Remote WebSocket endpoint (ws://<host>:<port>/control?token=<pairing_token>).

This client is completely independent from StarCommsClient (the shard Owner API client). It requires only the pairing token from StarComm's settings (Settings → Mobile Remote).

PTT Modes

pttStart(netId) — Momentary mode. Mimics holding a physical PTT button. Releases automatically if not sustained (used by the phone app's press-and-hold gesture).
pttHold(netId) — Toggle/latch mode. Tap once to lock transmission on, call pttStop(netId) to release. Use this for programmatic PTT.
pttStop(netId) — Release transmission on a net.

Example

import { StarCommsLocalClient } from "@30k/starcomm-client";

const local = new StarCommsLocalClient({
  token: "your_pairing_token",
  // host: "127.0.0.1",  // default
  // port: 8798,          // default
});

local.on("snapshot", (snapshot) => {
  console.log(`Connected as ${snapshot.displayName}`);
  console.log(`Active net: ${snapshot.ptt.channel}`);
});

local.onLifecycle("disconnected", ({ reason }) => {
  console.warn("Lost connection to StarComm:", reason);
});

await local.connect();

// PTT control (use pttHold for sustained transmission)
local.pttHold(255);   // latch on
local.pttStop(255);   // release

// Admin commands (only work if user has admin access)
local.adminAssign("user123", 2);
local.adminAcars("Fleet depart in 5 minutes");

// Disconnect when done
local.disconnect();

Index

Constructors

constructor

new StarCommsLocalClient(
config: StarCommsLocalClientConfig,
): StarCommsLocalClient
Parameters
- config: StarCommsLocalClientConfig
Returns StarCommsLocalClient
- Defined in src/local-client.ts:145

Properties

snapshot

snapshot: null | LocalSnapshot = null

The most recent snapshot received from the local client.

Accessors

connected

get connected(): boolean
Whether the WebSocket is currently open.

Returns boolean
- Defined in src/local-client.ts:164

Methods

adminAcars

adminAcars(text: string): void
Admin: send an ACARS alert to all users.
Parameters
- text: string
Returns void
- Defined in src/local-client.ts:302

adminAssign

adminAssign(userId: string, netId: number): void
Admin: assign a user to a net.
Parameters
- userId: string
- netId: number
Returns void
- Defined in src/local-client.ts:287

adminDisconnect

adminDisconnect(userId: string): void
Admin: disconnect a user.
Parameters
- userId: string
Returns void
- Defined in src/local-client.ts:297

adminUnassign

adminUnassign(userId: string, netId: number): void
Admin: unassign a user from a net.
Parameters
- userId: string
- netId: number
Returns void
- Defined in src/local-client.ts:292

connect

connect(): Promise<void>
Open the WebSocket connection to the local StarComm app. Resolves when the connection is open and the hello handshake has been sent. Rejects if the initial connection fails.

Returns Promise<void>
- Defined in src/local-client.ts:173

disconnect

disconnect(): void
Close the connection. Will not trigger automatic reconnection.

Returns void
- Defined in src/local-client.ts:188

off

off<K extends keyof LocalEventMap>(
event: K,
handler: (data: LocalEventMap[K]) => void,
): this
Remove a previously registered handler.
Type Parameters
- K extends keyof LocalEventMap
Parameters
- event: K
- handler: (data: LocalEventMap[K]) => void
Returns this
- Defined in src/local-client.ts:219
off(event: "*", handler: (type: string, data: LocalMessage) => void): this
Remove a previously registered handler.
Parameters
- event: "*"
- handler: (type: string, data: LocalMessage) => void
Returns this
- Defined in src/local-client.ts:220

offLifecycle

offLifecycle(
event: LocalLifecycleEventType,
handler: LocalLifecycleHandler,
): this
Remove a lifecycle handler.
Parameters
- event: LocalLifecycleEventType
- handler: LocalLifecycleHandler
Returns this
- Defined in src/local-client.ts:242

on

on<K extends keyof LocalEventMap>(
event: K,
handler: (data: LocalEventMap[K]) => void,
): this
Register a typed handler for a specific message type.
Type Parameters
- K extends keyof LocalEventMap
Parameters
- event: K
- handler: (data: LocalEventMap[K]) => void
Returns this
- Defined in src/local-client.ts:201
on(event: "*", handler: (type: string, data: LocalMessage) => void): this
Register a wildcard handler for all messages.
Parameters
- event: "*"
- handler: (type: string, data: LocalMessage) => void
Returns this
- Defined in src/local-client.ts:203

onLifecycle

onLifecycle(
event: LocalLifecycleEventType,
handler: LocalLifecycleHandler,
): this
Register a handler for connection lifecycle events.
Parameters
- event: LocalLifecycleEventType
- handler: LocalLifecycleHandler
Returns this
- Defined in src/local-client.ts:231

pttHold

pttHold(netId: number): void
Toggle/latch PTT on a net. Locks transmission on until pttStop is called. Use this for programmatic or sustained PTT.
Parameters
- netId: number
Returns void
- Defined in src/local-client.ts:277

pttStart

pttStart(netId: number): void
Start momentary push-to-talk on a net. This mimics holding a physical PTT button — releases automatically if not sustained. For programmatic PTT, use pttHold instead.
Parameters
- netId: number
Returns void
- Defined in src/local-client.ts:268

pttStop

pttStop(netId: number): void
Release push-to-talk on a net.
Parameters
- netId: number
Returns void
- Defined in src/local-client.ts:282

requestSnapshot

requestSnapshot(): void
Request a fresh snapshot from the local client.

Returns void
- Defined in src/local-client.ts:259

send

send(command: LocalCommand): void
Send a raw command object to the local StarComm app.
Parameters
- command: LocalCommand
Returns void
- Defined in src/local-client.ts:250

Class StarCommsLocalClient

PTT Modes

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StarCommsLocalClient

Properties

snapshot

Accessors

connected

Returns boolean

Methods

adminAcars

Parameters

Returns void

adminAssign

Parameters

Returns void

adminDisconnect

Parameters

Returns void

adminUnassign

Parameters

Returns void

connect

Returns Promise<void>

disconnect

Returns void

off

Type Parameters

Parameters

Returns this

Parameters

Returns this

offLifecycle

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Parameters

Returns this

onLifecycle

Parameters

Returns this

pttHold

Parameters

Returns void

pttStart

Parameters

Returns void

pttStop

Parameters

Returns void

requestSnapshot

Returns void

send

Parameters

Returns void

Settings

On This Page