Pelican Customers
New Site Setup
LOGIN
Flyout Menu
Skip to main content

Categories:

OpenAPI

Demand Response API

Demand Response Attributes

UPDATED

The Pelican OpenAPI allows for the scheduling and management of Demand Response (DR) events, helping optimize energy consumption across Pelican-controlled HVAC systems. Using specific API requests, you can start, modify, and cancel DR events while monitoring thermostat participation.

Scheduling a Demand Response Event

To schedule a DR event, send a request with request=drEvent to the object=Site, including the following attributes:​

drEvent - Request Attributes

Attribute names are not case-sensitive; attribute values are case-sensitive.

Name Value Description
startDateTime Date/Time ISO 8601 formatted date and time specifying when the event should start.
duration isoDuration ISO 8601 formatted duration indicating how long the event will run (e.g., 15 minutes = PT15M, 1 hour = PT1H).
level Integer The level of the event:
- 0 = Normal
- 1 = Moderate
- 2 = High
- 3 = Special

Example drEvent HTTPS Request

The following request schedules a 2-hour high-level setback event for August 1, 2022, at 3:00 PM:

				
					https://sitename.officeclimatecontrol.net/api.cgi?username=myname@gmail.com&password=mypassword&object=Site&request=drEvent&value=startDateTime:2022-08-01T15:00;duration:PT2H;level:2;

Scheduled drEvent

  • Only one Demand Response event can be scheduled at a time.
  • Scheduling a new drEvent will override and delete any existing scheduled event.
  • To cancel an active or scheduled Demand Response event, send a request with request=drEventCancel.
  • If an event is not manually canceled, it will automatically terminate at the specified duration.

Canceling a Demand Response Event

To cancel a scheduled or active DR event, use request=drEventCancel with the object=Site. If an event is not canceled, it will run for the full duration set in the original drEvent request.

Example drEventCancel HTTPS request:

				
					https://sitename.officeclimatecontrol.net/api.cgi?username=myname@gmail.com&password=mypassword&object=Site&request=drEventCancel

Setting Which Thermostats Will Setback

  • Through the Pelican App, site administrators can configure:
    • Which thermostats participate in a Demand Response event.
    • How much setback should be applied to thermostat settings based on the scheduled drEvent level.
  • These settings cannot be modified via the API—they must be configured within the Pelican App.

Important Note: Pelican does not manage Demand Response contracts, relationships, or agreements between customers and their demand response aggregators.

  • It is the responsibility of the Pelican customer and the demand response aggregator to clearly define which thermostats will participate and how they will adjust during a Demand Response event.
  • Ensure that both parties agree on the setback levels and participation rules before scheduling an event.

Monitoring Thermostat Demand Response Participation

  • Check Active Participation: Use the Thermostat object and check the setback attribute to see if a thermostat is actively participating in a DR event.
  • Retrieve Historical DR Participation: Use ThermostatHistory to retrieve past DR events and the duration thermostats were affected.
  • Analyze Pre- and Post-Event Conditions: Retrieve historical thermostat data before, during, and after an event using the ThermostatHistory attributes.
Table of Contents