Add GetCircuitStatus message

dist/messages/circuit-status.d.ts

@@ -0,0 +1,9 @@
+import { ICRequest } from "./request.js";
+/**
+ * Requests the list of circuits known to this controller.
+ *
+ * The response contains an `objectList` populated with circuit information.
+ *
+ * @returns the object used to issue this request
+ */
+export declare function GetCircuitStatus(): ICRequest;

dist/messages/messages.d.ts

@@ -1,5 +1,6 @@
 import { GetBodyStatus } from "./body-status.js";
 import { GetChemicalStatus } from "./chem-status.js";
+import { GetCircuitStatus } from "./circuit-status.js";
 import { GetSystemConfiguration } from "./configuration.js";
 import { GetHeaters } from "./get-heater.js";
 import { SubscribeToUpdates } from "./notify.js";
@@ -11,6 +12,7 @@ import { GetSystemInformation } from "./system-info.js";
 export declare const messages: {
     GetBodyStatus: typeof GetBodyStatus;
     GetChemicalStatus: typeof GetChemicalStatus;
+    GetCircuitStatus: typeof GetCircuitStatus;
     GetHeaters: typeof GetHeaters;
     GetSchedule: typeof GetSchedule;
     GetSystemConfiguration: typeof GetSystemConfiguration;

example.ts

@@ -4,7 +4,7 @@ import { FindUnits, Unit } from "./index.js";
 import { messages } from "./messages/messages.js";
 
 console.log("searching...");
-const f = new FindUnits("10.0.0.3");
+const f = new FindUnits();
 const units = await f.searchAsync(1000);
 f.close();
 console.log("Discovered units:", units);
@@ -62,6 +62,10 @@ console.log("sending Get Schedule request...");
 resp = await unit.send(messages.GetSchedule());
 console.log("got response:", JSON.stringify(resp, null, 2));
 
+console.log("sending Get Circuit Status request...");
+resp = await unit.send(messages.GetCircuitStatus());
+console.log("got response:", JSON.stringify(resp, null, 2));
+
 // console.log("sending Set Setpoint request...");
 // resp = await unit.send(messages.SetSetpoint("B1202", 97));
 // console.log("got response:", JSON.stringify(resp, null, 2));

messages/circuit-status.ts

@@ -0,0 +1,39 @@
+import { GetRequest, ICRequest, ICRequestObj } from "./request.js";
+
+/**
+ * Requests the list of circuits known to this controller.
+ *
+ * The response contains an `objectList` populated with circuit information.
+ *
+ * @returns the object used to issue this request
+ */
+export function GetCircuitStatus(): ICRequest {
+  const req = GetRequest();
+  req.command = "GetParamList";
+  req.condition = "OBJTYP = CIRCUIT";
+  req.objectList = [];
+
+  const reqObj = new ICRequestObj();
+  reqObj.objnam = "ALL";
+  reqObj.keys = [
+    "OBJNAM",
+    "OBJTYP",
+    "SUBTYP",
+    "STATUS",
+    "BODY",
+    "SNAME",
+    "HNAME",
+    "FREEZE",
+    "DNTSTP",
+    "HNAME",
+    "TIME",
+    "FEATR",
+    "USAGE",
+    "LIMIT",
+    "USE",
+    "SHOMNU",
+  ];
+  req.objectList.push(reqObj);
+
+  return req;
+}

messages/messages.ts

@@ -1,5 +1,6 @@
 import { GetBodyStatus } from "./body-status.js";
 import { GetChemicalStatus } from "./chem-status.js";
+import { GetCircuitStatus } from "./circuit-status.js";
 import { GetSystemConfiguration } from "./configuration.js";
 import { GetHeaters } from "./get-heater.js";
 import { SubscribeToUpdates } from "./notify.js";
@@ -12,6 +13,7 @@ import { GetSystemInformation } from "./system-info.js";
 export const messages = {
   GetBodyStatus,
   GetChemicalStatus,
+  GetCircuitStatus,
   GetHeaters,
   GetSchedule,
   GetSystemConfiguration,