ThermostatEvent Attributes - Pelican Wireless Systems

ThermostatEvent

ThermostatEvent allow you to set scheduled one-time events that override a thermostat's standard recurring schedule. This interface allows events to be added, modified, or deleted. In addition, existing pending events can be retrieved. If an event is added through the API it is tracked as an “External” event. There are no restrictions on the number of events that can be added. When retrieving events with a “get” request only current or pending events will be returned. Historical events are not retrievable through the API.

Avoid

Avoid adding overlapping events since this may produce unexpected results.

Day boundaries

Events cannot cross day boundaries. For events that need to cross day boundaries multiple events should be created.

The "editable" attribute

The “editable” attribute below can be set to “Yes” or “No” for an External event (default=No). When set to “Yes” the event can be viewed and edited by users through the Pelican App. When set to “No” the event can be viewed through the Pelican App, but not edited or deleted.

ThermostatEvent - Object Attributes

Attribute names are not case sensitive. Attribute values are case sensitive.

Name	Values	Settable	Description
name	String	Yes	The configured name of the thermostat.
serialNo	String	No	The thermostat's serial number.
eventId	String	Yes	The unique ID of this event (See Note 1 below).
title	String	Yes	A descriptive label for the event.
startDate	String	Yes	The date of the event in ISO 8601 format.
startTime	String	Yes	The time of day ISO 8601 extended local time format.
endTime	String	Yes	The time of day ISO 8601 extended local time format.
system	Auto, Heat, Cool, Off	Yes	The thermostat's system mode during the event.
heatSetting	Integer	Yes	The thermostat's heat setpoint during the event..
coolSetting	Integer	Yes	The thermostat's cool setpoint during the event.
fan	Auto, On	Yes	The thermostat's fan setting during the event.
keypad	On, Off	Yes	Thermostat keypad during the event, active or locked. On = Unlocked, Off = Locked.
outsideVentilation	On, Off	Yes	Whether the thermostat is allowed to use Outside Ventilation
editable	Yes, No	Yes	Whether a users can the edit the event through the Pelican App's Schedule Dashboard.
origin	Internal, External, All	No	How the event was created (See Note 2 below)
delete	Yes	Yes	Delete the specified event entry.

Note 1 (eventId)

The eventId is a unique identifier for the event. The eventId can either be system generated or user provided. When a new event is added, if this attribute is not provided, the system will generate a unique eventId and return it's value in the reply. Existing events can be modified or deleted by including the eventId in the request. To delete an existing event, the eventId must be specified in the select item and the value must be set to “delete=Yes”. When an eventId is provided and it matches an existing eventId, the attributes provided in the request will be changed to the newly specified values.

Note 2 (origin)

The origin attribute identifies if the event was created through the API or the Schedule Dashboard in the Pelican App. When used during a get request as a select attribute this will filter which events are returned. The default is “External”. This can also be requested in the value list to determine the origin of the event. Only “External” events can be created from the API, but both Internal and External events can be modified or deleted through the API.