node-alarm-dot-com 2.1.0-beta.4 → 2.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,6 +24,10 @@ Supported Features
|
|
|
24
24
|
* Dimmer switch
|
|
25
25
|
* Locks
|
|
26
26
|
* Lock/Unlock switch
|
|
27
|
+
* Thermostats
|
|
28
|
+
* State (Off, Heat, Cool, Auto)
|
|
29
|
+
* Desired Heat setpoint
|
|
30
|
+
* Desired Cool setpoint
|
|
27
31
|
|
|
28
32
|
Usage
|
|
29
33
|
-----
|
|
@@ -83,6 +87,9 @@ Documentation
|
|
|
83
87
|
* [~getLocks(lockIDs, authOpts)](#module_nodeADC..getLocks) ⇒ <code>Promise</code>
|
|
84
88
|
* [~secureLock(lockID, authOpts)](#module_nodeADC..secureLock) ⇒ <code>Promise</code>
|
|
85
89
|
* [~unsecureLock(lockID, authOpts)](#module_nodeADC..unsecureLock) ⇒ <code>Promise</code>
|
|
90
|
+
* [~setThermostatState(thermostatID, newState, authOpts)](#module_nodeADC..setThermostatState) ⇒ <code>Promise</code>
|
|
91
|
+
* [~setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts)](#module_nodeADC..setThermostatTargetHeatTemperature) ⇒ <code>Promise</code>
|
|
92
|
+
* [~setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts)](#module_nodeADC..setThermostatTargetCoolTemperature) ⇒ <code>Promise</code>
|
|
86
93
|
* [~armStay(partitionID, authOpts, opts)](#module_nodeADC..armStay) ⇒ <code>Promise</code>
|
|
87
94
|
* [~armAway(partitionID, authOpts, opts)](#module_nodeADC..armAway) ⇒ <code>Promise</code>
|
|
88
95
|
* [~disarm(partitionID, authOpts)](#module_nodeADC..disarm) ⇒ <code>Promise</code>
|
|
@@ -209,6 +216,45 @@ Sets a lock to "unlocked" (UNSECURED).
|
|
|
209
216
|
| lockID | <code>string</code> | Lock ID string. |
|
|
210
217
|
| authOpts | <code>Object</code> | Authentication object returned from the `login` method. |
|
|
211
218
|
|
|
219
|
+
<a name="module_nodeADC..setThermostatState"></a>
|
|
220
|
+
|
|
221
|
+
### nodeADC~setThermostatState(thermostatID, newState, authOpts) ⇒ <code>Promise</code>
|
|
222
|
+
Update Thermostat State (see `THERMOSTAT_STATES`)
|
|
223
|
+
|
|
224
|
+
**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
|
|
225
|
+
|
|
226
|
+
| Param | Type | Description |
|
|
227
|
+
|--------------|--------------------------------|-------------------------------------------------------------|
|
|
228
|
+
| thermostatID | <code>string</code> | Thermostat ID string. |
|
|
229
|
+
| newState | <code>THERMOSTAT_STATES</code> | Desired state, `THERMOSTAT_STATES.OFF`/`HEAT`/`COOL`/`AUTO` |
|
|
230
|
+
| authOpts | <code>Object</code> | Authentication object returned from the `login` method. |
|
|
231
|
+
|
|
232
|
+
<a name="module_nodeADC..setThermostatTargetHeatTemperature"></a>
|
|
233
|
+
|
|
234
|
+
### nodeADC~setThermostatTargetHeatTemperature(thermostatID, newTemp, authOpts) ⇒ <code>Promise</code>
|
|
235
|
+
Set desired Heat setpoint temperature for Thermostat
|
|
236
|
+
|
|
237
|
+
**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
|
|
238
|
+
|
|
239
|
+
| Param | Type | Description |
|
|
240
|
+
|--------------|---------------------|---------------------------------------------------------|
|
|
241
|
+
| thermostatID | <code>string</code> | Thermostat ID string. |
|
|
242
|
+
| newTemp | <code>number</code> | Desired temperature |
|
|
243
|
+
| authOpts | <code>Object</code> | Authentication object returned from the `login` method. |
|
|
244
|
+
|
|
245
|
+
<a name="module_nodeADC..setThermostatTargetCoolTemperature"></a>
|
|
246
|
+
|
|
247
|
+
### nodeADC~setThermostatTargetCoolTemperature(thermostatID, newTemp, authOpts) ⇒ <code>Promise</code>
|
|
248
|
+
Set desired Cool setpoint temperature for Thermostat
|
|
249
|
+
|
|
250
|
+
**Kind**: inner method of [<code>nodeADC</code>](#module_nodeADC)
|
|
251
|
+
|
|
252
|
+
| Param | Type | Description |
|
|
253
|
+
|--------------|---------------------|---------------------------------------------------------|
|
|
254
|
+
| thermostatID | <code>string</code> | Thermostat ID string. |
|
|
255
|
+
| newTemp | <code>number</code> | Desired temperature |
|
|
256
|
+
| authOpts | <code>Object</code> | Authentication object returned from the `login` method. |
|
|
257
|
+
|
|
212
258
|
<a name="module_nodeADC..armStay"></a>
|
|
213
259
|
|
|
214
260
|
### nodeADC~armStay(partitionID, authOpts, opts) ⇒ <code>Promise</code>
|