How can we help?
Categories:
OpenAPI
Thermostat API
ThermostatUsage Attributes
UPDATED
The ThermostatUsage attributes enable retrieval of thermostat run-time and consumption-related historical information. A ThermostatUsage request must include at least the required selection attributes, specifying a starting date/time (startDateTime), an ending date/time (endDateTime), and the desired data aggregation interval (duration). If no specific object attributes are requested, the API will return all usage information for every thermostat within the specified date range.
Predefined system-managed attributes for ThermostatUsage objects, used for essential functions like temperature control, system status, and scheduling. They follow a fixed structure and cannot be renamed or redefined by users.
Reserved Attributes
User Defined Attributes
Custom attributes that users can create, set, and retrieve for ThermostatUsage objects. Any attribute name that is not reserved is treated as user-defined. These attributes are created by assigning a value via a SET request and can be accessed using GET requests. There is no restriction on the number of user-defined attributes, allowing flexibility for custom data storage and retrieval.
User-defined attributes can also be used as selection criteria. For example, if a user wants to manage a specific group of thermostats via the API, they could define an attribute named “managed” and SET its value to “yes” for the thermostats in that group. Then, by including “managed:yes;” in their selection criteria, they can filter and control only those thermostats within the designated group.
Selection Attributes
Attribute names are not case-sensitive; attribute values are case-sensitive.
| Name | Values | Required | Description |
|---|---|---|---|
| startDateTime | Date/Time | Yes | ISO 8601 Formatted Date Time. Used for selecting the history date range to retrieve. |
| endDateTime | Date/Time | Yes | ISO 8601 Formatted Date Time. Used for selecting the history date range to retrieve. A maximum of 30 days of history can be retrieved in a single request. |
| duration | One of: month, day, 15minute | Yes |
How the data is to be returned. month: results are for the entire month. A maximum of 12 months of usage can be retrieved in a single request. day: results are for each day. A maximum of 31 days of usage can be retrieved in a single request. 15minute: results are for 15-minute increments. A maximum of 24 hours of usage can be retrieved in a single request. |
| name | String | No | The configured name of the thermostat. |
| groupName | String | No | The configured group name for that thermostat. |
| serialNo | String | No | The thermostat's serial number. Unique factory set identifier. |
Object Attributes
Since this pertains to historical information, all requests are GET only.
| Value | Type | Description |
|---|---|---|
| name | String | The configured name of the thermostat. |
| groupName | String | The configured group name for that thermostat. |
| serialNo | String | The thermostat's serial number. Unique factory set identifier. |
| heatMinutes | Integer | The number of minutes heating was active. |
| coolMinutes | Integer | The number of minutes cooling was active. |
| fanMinutes | Integer | The number of minutes only the fan was acive. |
| heatStage2Minutes | Integer | The number of minutes second stage heating was active. |
| CoolStage2Minutes | Integer | The number of minutes second stage cooling was active. |
| totalkWh | Decimal | The calculated kilowatt-hours for heating and cooling consumers. |
| totalTherms | Decimal | The calculated therms for heating consumers. |
| timestamp | Date/Time | ISO 8601 Formatted Date Time. |
Code Examples
GET
Get the current Temperature, Humidity, and CO2 Level for a thermostat named "Lobby"
curl -Ls "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
#!/usr/bin/perl -w
use strict;
use ClimateControl;
# You can request a copy of the ClimateControl Perl
# Module from Pelican Tech Support.
# Send an email to support@pelicanwireless.com
# Create a new ClimateControl object
my $cc = ClimateControl->new(
'pelicandemosite@gmail.com', # username
'pelican', # password
'demo.officeclimatecontrol.net' # website
);
# Define the selection and attributes to retrieve
my $selection = { 'name' => 'Lobby' };
my $attrlist = ['temperature', 'humidity', 'co2Level'];
# Call getAttributes to retrieve the Thermostat data
my $result = $cc->getAttributes('Thermostat', $selection, $attrlist);
# Check and display the result
if ($result->{'success'}) {
print "Success: $result->{'message'}\n";
} else {
print "Error: $result->{'message'}\n";
}
import requests
url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level"
response = requests.get(url, verify=False)
if response.status_code == 200:
print("Success:", response.text)
else:
print("Error:", response.status_code)
const https = require('https');
const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=get&object=Thermostat&selection=name:Lobby;&value=temperature;humidity;co2Level';
https.get(url, { rejectUnauthorized: false }, (resp) => {
let data = '';
// Collect data chunks
resp.on('data', (chunk) => {
data += chunk;
});
// Handle the complete response
resp.on('end', () => {
if (resp.statusCode === 200) {
console.log('Success:', data);
} else {
console.log('Error: HTTP', resp.statusCode);
}
});
}).on('error', (err) => {
console.error('Error:', err.message);
});
Response
<result>
<Thermostat>
<temperature>71.5</temperature>
<humidity>40</humidity>
<co2Level>1049</co2Level>
...
</Thermostat>
<success>1</success>
<message>Retrieved attributes for 1 thermostats.</message>
...
</result>
SET
Set the Heating and Cooling Ranges for the thermostat named "Lobby"
curl -Ls "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=set&object=Thermostat&selection=name:Lobby;&value=heatMin:50;heatMax:68;coolMin:72;coolMax:85"
#!/usr/bin/perl -w
use strict;
use ClimateControl;
# You can request a copy of the ClimateControl Perl
# Module from Pelican Tech Support.
# Send an email to support@pelicanwireless.com
# Create a new ClimateControl object
my $cc = ClimateControl->new(
'pelicandemosite@gmail.com', # username
'pelican', # password
'demo.officeclimatecontrol.net' # website
);
# Define the selection and values as hashes
my $selection = { 'name' => 'Lobby' };
my $values = {
'heatMin' => '50',
'heatMax' => '68',
'coolMin' => '72',
'coolMax' => '85'
};
# Call setAttributes to update the Thermostat
my $result = $cc->setAttributes('Thermostat', $selection, $values);
# Check and display the result
if ($result->{'success'}) {
print "Success: $result->{'message'}\n";
} else {
print "Error: $result->{'message'}\n";
}
import requests
url = "https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=set&object=Thermostat&selection=name:Lobby;&value=heatMin:50;heatMax:68;coolMin:72;coolMax:85"
response = requests.get(url, verify=False)
if response.status_code == 200:
print("Success:", response.text)
else:
print("Error:", response.status_code)
const https = require('https');
const url = 'https://demo.officeclimatecontrol.net/api.cgi?username=pelicandemosite@gmail.com&password=pelican&request=set&object=Thermostat&selection=name:Lobby;&value=heatMin:50;heatMax:68;coolMin:72;coolMax:85';
https.get(url, { rejectUnauthorized: false }, (resp) => {
let data = '';
// Collect data chunks
resp.on('data', (chunk) => {
data += chunk;
});
// Handle the complete response
resp.on('end', () => {
if (resp.statusCode === 200) {
console.log('Success:', data);
} else {
console.log('Error: HTTP', resp.statusCode);
}
});
}).on('error', (err) => {
console.error('Error:', err.message);
});
Response
<result>
<success>1</success>
<message>Updated 1 thermostats.</message>
...
</result>