node-alarm-dot-com 2.1.0-beta.3 → 2.1.0-beta.5

package/README.md

@@ -24,6 +24,10 @@ Supported Features
    * Dimmer switch
  * Locks
    * Lock/Unlock switch
+ * Thermostats
+   * State (Off, Heat, Cool, Auto)
+   * Desired Heat setpoint
+   * Desired Cool setpoint
 
 Usage
 -----
@@ -83,6 +87,9 @@ Documentation
     * [~getLocks(lockIDs, authOpts)](#module_nodeADC..getLocks) ⇒ <code>Promise</code>
     * [~secureLock(lockID, authOpts)](#module_nodeADC..secureLock) ⇒ <code>Promise</code>
     * [~unsecureLock(lockID, authOpts)](#module_nodeADC..unsecureLock) ⇒ <code>Promise</code>
+    * [~setThermostatState(thermostatID, newState, authOpts)](#module_nodeADC..setThermostatState) ⇒ <code>Promise</code>
+    * [~setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts)](#module_nodeADC..setThermostatTargetHeatTemperature) ⇒ <code>Promise</code>
+    * [~setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts)](#module_nodeADC..setThermostatTargetCoolTemperature) ⇒ <code>Promise</code>
     * [~armStay(partitionID, authOpts, opts)](#module_nodeADC..armStay) ⇒ <code>Promise</code>
     * [~armAway(partitionID, authOpts, opts)](#module_nodeADC..armAway) ⇒ <code>Promise</code>
     * [~disarm(partitionID, authOpts)](#module_nodeADC..disarm) ⇒ <code>Promise</code>
@@ -209,6 +216,45 @@ Sets a lock to "unlocked" (UNSECURED).
 | lockID | <code>string</code> | Lock ID string. |
 | authOpts | <code>Object</code> | Authentication object returned from the `login` method. |
 
+<a name="module_nodeADC..setThermostatState"></a>
+
+### nodeADC~setThermostatState(thermostatID, newState, authOpts) ⇒ <code>Promise</code>
+Update Thermostat State (see `THERMOSTAT_STATES`)
+
+**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
+
+| Param        | Type                           | Description                                                 |
+|--------------|--------------------------------|-------------------------------------------------------------|
+| thermostatID | <code>string</code>            | Thermostat ID string.                                       |
+| newState     | <code>THERMOSTAT_STATES</code> | Desired state, `THERMOSTAT_STATES.OFF`/`HEAT`/`COOL`/`AUTO` |
+| authOpts     | <code>Object</code>            | Authentication object returned from the `login` method.     |
+
+<a name="module_nodeADC..setThermostatTargetHeatTemperature"></a>
+
+### nodeADC~setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts) ⇒ <code>Promise</code>
+Set desired Heat setpoint temperature for Thermostat
+
+**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
+
+| Param        | Type                | Description                                             |
+|--------------|---------------------|---------------------------------------------------------|
+| thermostatID | <code>string</code> | Thermostat ID string.                                   |
+| newTemp      | <code>number</code> | Desired temperature                                     |
+| authOpts     | <code>Object</code> | Authentication object returned from the `login` method. |
+
+<a name="module_nodeADC..setThermostatTargetCoolTemperature"></a>
+
+### nodeADC~setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts) ⇒ <code>Promise</code>
+Set desired Cool setpoint temperature for Thermostat
+
+**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
+
+| Param        | Type                | Description                                             |
+|--------------|---------------------|---------------------------------------------------------|
+| thermostatID | <code>string</code> | Thermostat ID string.                                   |
+| newTemp      | <code>number</code> | Desired temperature                                     |
+| authOpts     | <code>Object</code> | Authentication object returned from the `login` method. |
+
 <a name="module_nodeADC..armStay"></a>
 
 ### nodeADC~armStay(partitionID, authOpts, opts) ⇒ <code>Promise</code>

package/dist/_models/SystemState.d.ts

@@ -1,4 +1,4 @@
-import { GarageState, LightState, LockState, PartitionState, SensorState } from './DeviceStates';
+import { GarageState, LightState, LockState, PartitionState, SensorState, ThermostatState } from './DeviceStates';
 /**
  * Response information from
  * api/systems/systems/{id}
@@ -31,6 +31,7 @@ export interface FlattenedSystemState {
     lights: LightState[];
     locks: LockState[];
     garages: GarageState[];
+    thermostats: ThermostatState[];
     relationships: Relationships;
 }
 export interface Relationships {

package/dist/index.d.ts

@@ -5,6 +5,7 @@ import { AuthOpts } from './_models/AuthOpts';
 import { ApiDeviceState } from './_models/DeviceStates';
 import { PartitionActionOptions } from './_models/PartitionActionOptions';
 import { FlattenedSystemState } from './_models/SystemState';
+import { THERMOSTAT_STATES } from "./_models/States";
 export * from './_models/AuthOpts';
 export * from './_models/DeviceStates';
 export * from './_models/IdentityResponse';
@@ -139,5 +140,35 @@ export declare function closeGarage(garageID: string, authOpts: AuthOpts): Promi
  * @returns {Promise}
  */
 export declare function openGarage(garageID: string, authOpts: AuthOpts): Promise<any>;
+/**
+ * Update thermostat state
+ *
+ * @param {string} thermostatID Thermostat ID string.
+ * @param {Object} newState New desired state
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+export declare function setThermostatState(thermostatID: string, newState: THERMOSTAT_STATES, authOpts: AuthOpts): Promise<any>;
+/**
+ * Sets a thermostat target heat temperature.
+ *
+ * @param {string} thermostatID ThermostatID ID string.
+ * @param {number} newTemp New target temperature
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+export declare function setThermostatTargetHeatTemperature(thermostatID: string, newTemp: number, authOpts: AuthOpts): Promise<any>;
+/**
+ * Sets a thermostat target cool temperature.
+ *
+ * @param {string} thermostatID ThermostatID ID string.
+ * @param {number} newTemp New target temperature
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+export declare function setThermostatTargetCoolTemperature(thermostatID: string, newTemp: number, authOpts: AuthOpts): Promise<any>;
 export declare function authenticatedGet(url: string, opts: any): Promise<any>;
 export declare function authenticatedPost(url: string, opts: any): Promise<any>;

package/dist/index.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authenticatedPost = exports.authenticatedGet = exports.openGarage = exports.closeGarage = exports.setLockUnsecure = exports.setLockSecure = exports.setLightOff = exports.setLightOn = exports.disarm = exports.armAway = exports.armStay = exports.getComponents = exports.getCurrentState = exports.login = void 0;
+exports.authenticatedPost = exports.authenticatedGet = exports.setThermostatTargetCoolTemperature = exports.setThermostatTargetHeatTemperature = exports.setThermostatState = exports.openGarage = exports.closeGarage = exports.setLockUnsecure = exports.setLockSecure = exports.setLightOff = exports.setLightOn = exports.disarm = exports.armAway = exports.armStay = exports.getComponents = exports.getCurrentState = exports.login = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 __exportStar(require("./_models/AuthOpts"), exports);
 __exportStar(require("./_models/DeviceStates"), exports);
@@ -38,6 +38,7 @@ const PARTITIONS_URL = 'https://www.alarm.com/web/api/devices/partitions/';
 const SENSORS_URL = 'https://www.alarm.com/web/api/devices/sensors';
 const LIGHTS_URL = 'https://www.alarm.com/web/api/devices/lights/';
 const GARAGE_URL = 'https://www.alarm.com/web/api/devices/garageDoors/';
+const THERMOSTAT_URL = 'https://www.alarm.com/web/api/devices/thermostats/';
 const LOCKS_URL = 'https://www.alarm.com/web/api/devices/locks/';
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const UA = `node-alarm-dot-com/${require('../package.json').version}`;
@@ -170,6 +171,10 @@ async function getCurrentState(systemID, authOpts) {
     if (typeof garageIDs[0] !== 'undefined') {
         components.set('garages', await getComponents(GARAGE_URL, garageIDs, authOpts));
     }
+    const thermostatIDs = rels.thermostats.data.map(thermostat => thermostat.id);
+    if (typeof thermostatIDs[0] !== 'undefined') {
+        components.set('thermostats', await getComponents(THERMOSTAT_URL, thermostatIDs, authOpts));
+    }
     return {
         id: res.data.id,
         attributes: res.data.attributes,
@@ -180,6 +185,7 @@ async function getCurrentState(systemID, authOpts) {
         lights: components.has('lights') ? components.get('lights').data : [],
         locks: components.has('locks') ? components.get('locks').data : [],
         garages: components.has('garages') ? components.get('garages').data : [],
+        thermostats: components.has('thermostats') ? components.get('thermostats').data : [],
         relationships: rels
     };
 }
@@ -481,6 +487,67 @@ function openGarage(garageID, authOpts) {
     return authenticatedPost(url, postOpts);
 }
 exports.openGarage = openGarage;
+// Thermostat methods ////////////////////////////////////////////////////////////////
+/**
+ * Update thermostat state
+ *
+ * @param {string} thermostatID Thermostat ID string.
+ * @param {Object} newState New desired state
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+function setThermostatState(thermostatID, newState, authOpts) {
+    const url = `${THERMOSTAT_URL}${thermostatID}/setState`;
+    const postOpts = Object.assign({}, authOpts, {
+        body: {
+            desiredState: newState,
+            statePollOnly: false
+        }
+    });
+    return authenticatedPost(url, postOpts);
+}
+exports.setThermostatState = setThermostatState;
+/**
+ * Sets a thermostat target heat temperature.
+ *
+ * @param {string} thermostatID ThermostatID ID string.
+ * @param {number} newTemp New target temperature
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+function setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts) {
+    const url = `${THERMOSTAT_URL}${thermostatID}/setState`;
+    const postOpts = Object.assign({}, authOpts, {
+        body: {
+            desiredHeatSetpoint: newTemp,
+            statePollOnly: false
+        }
+    });
+    return authenticatedPost(url, postOpts);
+}
+exports.setThermostatTargetHeatTemperature = setThermostatTargetHeatTemperature;
+/**
+ * Sets a thermostat target cool temperature.
+ *
+ * @param {string} thermostatID ThermostatID ID string.
+ * @param {number} newTemp New target temperature
+ * @param {Object} authOpts Authentication object returned from the `login`
+ *   method.
+ * @returns {Promise}
+ */
+function setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts) {
+    const url = `${THERMOSTAT_URL}${thermostatID}/setState`;
+    const postOpts = Object.assign({}, authOpts, {
+        body: {
+            desiredCoolSetpoint: newTemp,
+            statePollOnly: false
+        }
+    });
+    return authenticatedPost(url, postOpts);
+}
+exports.setThermostatTargetCoolTemperature = setThermostatTargetCoolTemperature;
 // Helper methods //////////////////////////////////////////////////////////////
 function getValue(data, path) {
     if (typeof path === 'string') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-alarm-dot-com",
-  "version": "2.1.0-beta.3",
+  "version": "2.1.0-beta.5",
   "betaVersion": "2.1.0",
   "description": "An interface module written in node.js to arm and disarm Alarm.com security systems.",
   "author": {