From abe9ba7d954af8c47d07f08fb4556201ecc25023 Mon Sep 17 00:00:00 2001 From: Parnic Date: Sun, 5 Jan 2025 11:56:53 -0600 Subject: [PATCH] Rename Item to Object The API all calls these objects so best to go with the flow. This is a breaking change. --- dist/example.js | 4 ++-- dist/example.js.map | 2 +- dist/messages/configuration.d.ts | 10 +++++----- dist/messages/configuration.js | 10 +++++----- dist/messages/messages.d.ts | 4 ++-- dist/messages/messages.js | 4 ++-- dist/messages/messages.js.map | 2 +- dist/messages/set-object-status.d.ts | 9 +++++++++ .../{set-status.js => set-object-status.js} | 18 +++++++++--------- dist/messages/set-object-status.js.map | 1 + dist/messages/set-status.d.ts | 9 --------- dist/messages/set-status.js.map | 1 - example.ts | 4 ++-- messages/configuration.ts | 10 +++++----- messages/messages.ts | 4 ++-- .../{set-status.ts => set-object-status.ts} | 18 +++++++++--------- 16 files changed, 55 insertions(+), 55 deletions(-) create mode 100644 dist/messages/set-object-status.d.ts rename dist/messages/{set-status.js => set-object-status.js} (56%) create mode 100644 dist/messages/set-object-status.js.map delete mode 100644 dist/messages/set-status.d.ts delete mode 100644 dist/messages/set-status.js.map rename messages/{set-status.ts => set-object-status.ts} (59%) diff --git a/dist/example.js b/dist/example.js index 753ad4c..935b534 100644 --- a/dist/example.js +++ b/dist/example.js @@ -48,10 +48,10 @@ console.log("got response:", JSON.stringify(resp, null, 2)); // resp = await unit.send(messages.SetSetpoint("B1202", 97)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("turning off pool..."); -// resp = await unit.send(messages.SetItemStatus("B1101", false)); +// resp = await unit.send(messages.SetObjectStatus("B1101", false)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("turning off water feature..."); -// resp = await unit.send(messages.SetItemStatus("C0003", false)); +// resp = await unit.send(messages.SetObjectStatus("C0003", false)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("sending Set Heatmode request..."); // resp = await unit.send(messages.SetHeatMode("B1202", true)); diff --git a/dist/example.js.map b/dist/example.js.map index e3210fb..e33f0ae 100644 --- a/dist/example.js.map +++ b/dist/example.js.map @@ -1 +1 @@ -{"version":3,"file":"example.js","sourceRoot":"","sources":["../example.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AAC5B,MAAM,CAAC,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;AACpC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC,CAAC,KAAK,EAAE,CAAC;AACV,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAExC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACrB,MAAM,IAAI,KAAK,CACb,oEAAoE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAC5F,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;AACrC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3B,gCAAgC;AAChC,qBAAqB;AAErB,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAC7E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACtC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;AACrB,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAEzB,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;IACxB,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AAC1C,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1E,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAClD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;AACpD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,CAAC;AAC1D,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAClD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;AACjD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACtD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC,CAAC;AACrD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;AAC9C,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;AAC9C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;AAC/C,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,kDAAkD;AAClD,6DAA6D;AAC7D,+DAA+D;AAE/D,sCAAsC;AACtC,kEAAkE;AAClE,+DAA+D;AAE/D,+CAA+C;AAC/C,kEAAkE;AAClE,+DAA+D;AAE/D,kDAAkD;AAClD,+DAA+D;AAC/D,+DAA+D;AAE/D,IAAI,CAAC,KAAK,EAAE,CAAC"} \ No newline at end of file +{"version":3,"file":"example.js","sourceRoot":"","sources":["../example.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;AAC5B,MAAM,CAAC,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;AACpC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC,CAAC,KAAK,EAAE,CAAC;AACV,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAExC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACrB,MAAM,IAAI,KAAK,CACb,oEAAoE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAC5F,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;AACrC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAE3B,gCAAgC;AAChC,qBAAqB;AAErB,OAAO,CAAC,GAAG,CAAC,uCAAuC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AAC7E,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACtC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;AACrB,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAEzB,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,EAAE;IACxB,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;AACvC,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AAC1C,IAAI,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC1E,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAClD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;AACpD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC,CAAC;AAC1D,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;AAClD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC;AACjD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AACtD,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC,CAAC;AACrD,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;AAC9C,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;AAC9C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;AAC/C,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;AAC/C,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5D,kDAAkD;AAClD,6DAA6D;AAC7D,+DAA+D;AAE/D,sCAAsC;AACtC,oEAAoE;AACpE,+DAA+D;AAE/D,+CAA+C;AAC/C,oEAAoE;AACpE,+DAA+D;AAE/D,kDAAkD;AAClD,+DAA+D;AAC/D,+DAA+D;AAE/D,IAAI,CAAC,KAAK,EAAE,CAAC"} \ No newline at end of file diff --git a/dist/messages/configuration.d.ts b/dist/messages/configuration.d.ts index 6184aa1..b023465 100644 --- a/dist/messages/configuration.d.ts +++ b/dist/messages/configuration.d.ts @@ -3,12 +3,12 @@ import { ICRequest } from "./request.js"; * Requests the configuration of bodies and circuits available to this controller. * * The response contains the list of bodies and circuits under the `answer` field. - * Each item has an `objnam` that should be used to reference that item for future requests, - * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the item. - * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the item it's describing. + * Each object has an `objnam` that should be used to reference that object for future requests, + * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the object. + * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the object it's describing. * - * Some items, such as the Pool body, will have the `params`.`OBJLIST` array populated with - * a series of attached items such as a chlorinator device. + * Some objects, such as the Pool body, will have the `params`.`OBJLIST` array populated with + * a series of attached objects such as a chlorinator device. * * @returns the object used to issue this request */ diff --git a/dist/messages/configuration.js b/dist/messages/configuration.js index af08f9f..926d703 100644 --- a/dist/messages/configuration.js +++ b/dist/messages/configuration.js @@ -3,12 +3,12 @@ import { GetRequest } from "./request.js"; * Requests the configuration of bodies and circuits available to this controller. * * The response contains the list of bodies and circuits under the `answer` field. - * Each item has an `objnam` that should be used to reference that item for future requests, - * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the item. - * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the item it's describing. + * Each object has an `objnam` that should be used to reference that object for future requests, + * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the object. + * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the object it's describing. * - * Some items, such as the Pool body, will have the `params`.`OBJLIST` array populated with - * a series of attached items such as a chlorinator device. + * Some objects, such as the Pool body, will have the `params`.`OBJLIST` array populated with + * a series of attached objects such as a chlorinator device. * * @returns the object used to issue this request */ diff --git a/dist/messages/messages.d.ts b/dist/messages/messages.d.ts index 2976380..367c2c0 100644 --- a/dist/messages/messages.d.ts +++ b/dist/messages/messages.d.ts @@ -5,7 +5,7 @@ import { GetHeaters } from "./get-heater.js"; import { SubscribeToUpdates } from "./notify.js"; import { GetSchedule } from "./schedule.js"; import { SetHeatMode } from "./set-heater.js"; -import { SetItemStatus } from "./set-status.js"; +import { SetObjectStatus } from "./set-object-status.js"; import { SetSetpoint } from "./setpoint.js"; import { GetSystemInformation } from "./system-info.js"; export declare const messages: { @@ -16,7 +16,7 @@ export declare const messages: { GetSystemConfiguration: typeof GetSystemConfiguration; GetSystemInformation: typeof GetSystemInformation; SetHeatMode: typeof SetHeatMode; - SetItemStatus: typeof SetItemStatus; + SetObjectStatus: typeof SetObjectStatus; SetSetpoint: typeof SetSetpoint; SubscribeToUpdates: typeof SubscribeToUpdates; }; diff --git a/dist/messages/messages.js b/dist/messages/messages.js index 0d0eb22..3394941 100644 --- a/dist/messages/messages.js +++ b/dist/messages/messages.js @@ -5,7 +5,7 @@ import { GetHeaters } from "./get-heater.js"; import { SubscribeToUpdates } from "./notify.js"; import { GetSchedule } from "./schedule.js"; import { SetHeatMode } from "./set-heater.js"; -import { SetItemStatus } from "./set-status.js"; +import { SetObjectStatus } from "./set-object-status.js"; import { SetSetpoint } from "./setpoint.js"; import { GetSystemInformation } from "./system-info.js"; export const messages = { @@ -16,7 +16,7 @@ export const messages = { GetSystemConfiguration, GetSystemInformation, SetHeatMode, - SetItemStatus, + SetObjectStatus, SetSetpoint, SubscribeToUpdates, }; diff --git a/dist/messages/messages.js.map b/dist/messages/messages.js.map index 1567a1a..f082d04 100644 --- a/dist/messages/messages.js.map +++ b/dist/messages/messages.js.map @@ -1 +1 @@ -{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../messages/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,aAAa;IACb,iBAAiB;IACjB,UAAU;IACV,WAAW;IACX,sBAAsB;IACtB,oBAAoB;IACpB,WAAW;IACX,aAAa;IACb,WAAW;IACX,kBAAkB;CACnB,CAAC"} \ No newline at end of file +{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../messages/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,aAAa;IACb,iBAAiB;IACjB,UAAU;IACV,WAAW;IACX,sBAAsB;IACtB,oBAAoB;IACpB,WAAW;IACX,eAAe;IACf,WAAW;IACX,kBAAkB;CACnB,CAAC"} \ No newline at end of file diff --git a/dist/messages/set-object-status.d.ts b/dist/messages/set-object-status.d.ts new file mode 100644 index 0000000..73932eb --- /dev/null +++ b/dist/messages/set-object-status.d.ts @@ -0,0 +1,9 @@ +import { ICRequest } from "./request.js"; +/** + * Requests to change the status of objects known to this controller. + * + * Turns one or more objects on or off. Use the `objnam` of the circuit to be set. + * + * @returns the object used to issue this request + */ +export declare function SetObjectStatus(object: string | string[], status: boolean): ICRequest; diff --git a/dist/messages/set-status.js b/dist/messages/set-object-status.js similarity index 56% rename from dist/messages/set-status.js rename to dist/messages/set-object-status.js index 4b96886..50a8920 100644 --- a/dist/messages/set-status.js +++ b/dist/messages/set-object-status.js @@ -1,24 +1,24 @@ import { ICParam } from "./param.js"; import { GetRequest, ICRequestObj } from "./request.js"; /** - * Requests to change the status of items known to this controller. + * Requests to change the status of objects known to this controller. * - * Turns one or more items on or off. Use the `objnam` of the circuit to be set. + * Turns one or more objects on or off. Use the `objnam` of the circuit to be set. * * @returns the object used to issue this request */ -export function SetItemStatus(item, status) { +export function SetObjectStatus(object, status) { const req = GetRequest(); req.command = "SetParamList"; req.objectList = []; - let items; - if (Array.isArray(item)) { - items = item; + let objects; + if (Array.isArray(object)) { + objects = object; } else { - items = [item]; + objects = [object]; } - for (const i of items) { + for (const i of objects) { const reqObj = new ICRequestObj(); reqObj.objnam = i; reqObj.params = new ICParam(); @@ -27,4 +27,4 @@ export function SetItemStatus(item, status) { } return req; } -//# sourceMappingURL=set-status.js.map \ No newline at end of file +//# sourceMappingURL=set-object-status.js.map \ No newline at end of file diff --git a/dist/messages/set-object-status.js.map b/dist/messages/set-object-status.js.map new file mode 100644 index 0000000..575dc78 --- /dev/null +++ b/dist/messages/set-object-status.js.map @@ -0,0 +1 @@ +{"version":3,"file":"set-object-status.js","sourceRoot":"","sources":["../../messages/set-object-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,UAAU,EAAa,YAAY,EAAE,MAAM,cAAc,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAyB,EACzB,MAAe;IAEf,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;IACzB,GAAG,CAAC,OAAO,GAAG,cAAc,CAAC;IAC7B,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC;IAEpB,IAAI,OAAiB,CAAC;IACtB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAClB,MAAM,CAAC,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7C,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"} \ No newline at end of file diff --git a/dist/messages/set-status.d.ts b/dist/messages/set-status.d.ts deleted file mode 100644 index e6cf5de..0000000 --- a/dist/messages/set-status.d.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { ICRequest } from "./request.js"; -/** - * Requests to change the status of items known to this controller. - * - * Turns one or more items on or off. Use the `objnam` of the circuit to be set. - * - * @returns the object used to issue this request - */ -export declare function SetItemStatus(item: string | string[], status: boolean): ICRequest; diff --git a/dist/messages/set-status.js.map b/dist/messages/set-status.js.map deleted file mode 100644 index 12cbed8..0000000 --- a/dist/messages/set-status.js.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"set-status.js","sourceRoot":"","sources":["../../messages/set-status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,UAAU,EAAa,YAAY,EAAE,MAAM,cAAc,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAuB,EACvB,MAAe;IAEf,MAAM,GAAG,GAAG,UAAU,EAAE,CAAC;IACzB,GAAG,CAAC,OAAO,GAAG,cAAc,CAAC;IAC7B,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC;IAEpB,IAAI,KAAe,CAAC;IACpB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,KAAK,GAAG,IAAI,CAAC;IACf,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;QAClC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAClB,MAAM,CAAC,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAC7C,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"} \ No newline at end of file diff --git a/example.ts b/example.ts index 68be7ed..16d3ee3 100644 --- a/example.ts +++ b/example.ts @@ -67,11 +67,11 @@ console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("turning off pool..."); -// resp = await unit.send(messages.SetItemStatus("B1101", false)); +// resp = await unit.send(messages.SetObjectStatus("B1101", false)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("turning off water feature..."); -// resp = await unit.send(messages.SetItemStatus("C0003", false)); +// resp = await unit.send(messages.SetObjectStatus("C0003", false)); // console.log("got response:", JSON.stringify(resp, null, 2)); // console.log("sending Set Heatmode request..."); diff --git a/messages/configuration.ts b/messages/configuration.ts index 2e9e9e5..9bd009c 100644 --- a/messages/configuration.ts +++ b/messages/configuration.ts @@ -4,12 +4,12 @@ import { GetRequest, ICRequest } from "./request.js"; * Requests the configuration of bodies and circuits available to this controller. * * The response contains the list of bodies and circuits under the `answer` field. - * Each item has an `objnam` that should be used to reference that item for future requests, - * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the item. - * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the item it's describing. + * Each object has an `objnam` that should be used to reference that object for future requests, + * and `params`.`SNAME` is the user-entered friendly name that can be displayed for the object. + * `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the object it's describing. * - * Some items, such as the Pool body, will have the `params`.`OBJLIST` array populated with - * a series of attached items such as a chlorinator device. + * Some objects, such as the Pool body, will have the `params`.`OBJLIST` array populated with + * a series of attached objects such as a chlorinator device. * * @returns the object used to issue this request */ diff --git a/messages/messages.ts b/messages/messages.ts index 1050554..70c6cfa 100644 --- a/messages/messages.ts +++ b/messages/messages.ts @@ -5,7 +5,7 @@ import { GetHeaters } from "./get-heater.js"; import { SubscribeToUpdates } from "./notify.js"; import { GetSchedule } from "./schedule.js"; import { SetHeatMode } from "./set-heater.js"; -import { SetItemStatus } from "./set-status.js"; +import { SetObjectStatus } from "./set-object-status.js"; import { SetSetpoint } from "./setpoint.js"; import { GetSystemInformation } from "./system-info.js"; @@ -17,7 +17,7 @@ export const messages = { GetSystemConfiguration, GetSystemInformation, SetHeatMode, - SetItemStatus, + SetObjectStatus, SetSetpoint, SubscribeToUpdates, }; diff --git a/messages/set-status.ts b/messages/set-object-status.ts similarity index 59% rename from messages/set-status.ts rename to messages/set-object-status.ts index 28d335e..9a7d946 100644 --- a/messages/set-status.ts +++ b/messages/set-object-status.ts @@ -2,28 +2,28 @@ import { ICParam } from "./param.js"; import { GetRequest, ICRequest, ICRequestObj } from "./request.js"; /** - * Requests to change the status of items known to this controller. + * Requests to change the status of objects known to this controller. * - * Turns one or more items on or off. Use the `objnam` of the circuit to be set. + * Turns one or more objects on or off. Use the `objnam` of the circuit to be set. * * @returns the object used to issue this request */ -export function SetItemStatus( - item: string | string[], +export function SetObjectStatus( + object: string | string[], status: boolean, ): ICRequest { const req = GetRequest(); req.command = "SetParamList"; req.objectList = []; - let items: string[]; - if (Array.isArray(item)) { - items = item; + let objects: string[]; + if (Array.isArray(object)) { + objects = object; } else { - items = [item]; + objects = [object]; } - for (const i of items) { + for (const i of objects) { const reqObj = new ICRequestObj(); reqObj.objnam = i; reqObj.params = new ICParam();