import { EventEmitter } from "events"; import { WebSocket } from "ws"; import debug from "debug"; import { ICRequest } from "./messages/request.js"; import { ICResponse } from "./messages/response.js"; // needed for jsdoc // eslint-disable-next-line @typescript-eslint/no-unused-vars import { messages } from "./messages/messages.js"; // eslint-disable-next-line @typescript-eslint/no-unused-vars import { SubscribeToUpdates } from "./messages/notify.js"; const debugUnit = debug("ic:unit"); /** * Contains methods to connect to and communicate with an IntelliCenter controller. * * Call `connect` to connect to the unit. * * Available events: * * * `"response-{messageID}"` - fired once per message sent with `send()` where {messageID} is the ID specified in the {@linkcode ICRequest} given to `send()` * * `"notify"` - fired when an update is available to a property previously subscribed to via a {@linkcode SubscribeToUpdates} request * * `"close"` - fired any time the client is closed by any means (timeout, by request, error, etc.) * * `"open"` - fired when the socket connects to the unit successfully * * `"error"` - fired when the socket encounters an unrecoverable error and will close * * `"timeout"` - fired when the socket has not received a ping response within the allowed threshold and will close */ export class Unit extends EventEmitter { private client?: WebSocket; private pingTimeout?: ReturnType; private pingTimer?: ReturnType; private pingInterval = 60000; constructor( public endpoint: string, public port = 6680, ) { super(); this.endpoint = endpoint; this.port = port; } /** * Connects to the specified unit and maintains a connection to it until `close()` is called. */ public async connect() { if (this.client) { throw new Error("can't open a client that is already open"); } debugUnit(`connecting to ws://${this.endpoint}:${this.port.toString()}`); this.client = new WebSocket( `ws://${this.endpoint}:${this.port.toString()}`, ); const { heartbeat, onClientMessage, socketCleanup } = this; this.client.on("error", (evt) => { // todo: emit event so we can reconnect? auto reconnect? debugUnit("error in websocket: $o", evt); this.emit("error"); socketCleanup(); }); this.client.on("open", () => { this.emit("open"); heartbeat(); }); this.client.on("ping", heartbeat); this.client.on("pong", heartbeat); this.client.on("close", socketCleanup); this.client.on("message", onClientMessage); this.pingTimer = setInterval(() => { debugUnit("sending ping"); this.client?.ping(); }, this.pingInterval); await new Promise((resolve, reject) => { this.client?.once("error", reject); this.client?.once("open", resolve); }); debugUnit("connected"); } /** * Closes the connection to the unit. */ public close() { debugUnit("closing connection by request"); this.emit("close"); this.client?.close(); } private socketCleanup = () => { debugUnit("socket cleanup"); this.client?.removeAllListeners(); this.client = undefined; if (this.pingTimeout) { clearTimeout(this.pingTimeout); this.pingTimeout = undefined; } if (this.pingTimer) { clearInterval(this.pingTimer); this.pingTimer = undefined; } }; private heartbeat = () => { debugUnit("received heartbeat"); clearTimeout(this.pingTimeout); this.pingTimeout = setTimeout(() => { debugUnit("terminating connection due to heartbeat timeout"); this.emit("timeout"); this.client?.terminate(); this.socketCleanup(); }, this.pingInterval + 5000); }; private onClientMessage = (msg: Buffer) => { debugUnit("message received, length %d", msg.length); const respObj = JSON.parse(msg.toString()) as ICResponse; if (respObj.command.toLowerCase() === "notifylist") { debugUnit(" it's a subscription confirmation or update"); this.emit(`notify`, respObj); } this.emit(`response-${respObj.messageID}`, respObj); }; /** * Sends a request to the unit. * * @param request an message from {@linkcode messages} to send to the unit. * @returns a promise that resolves into the {@linkcode ICResponse} with information about the request. */ public async send(request: ICRequest): Promise { const payload = JSON.stringify(request); debugUnit( "sending message of length %d with id %s", payload.length, request.messageID, ); this.client?.send(payload); return await new Promise((resolve) => { this.once(`response-${request.messageID}`, (resp: ICResponse) => { debugUnit(" returning response to message %s", request.messageID); resolve(resp); }); }); } }