PowerSchedule Attributes
Categories: OpenAPI Power Control Module API PowerSchedule Attributes UPDATED The PowerSchedule attributes enable you to add, modify, delete, and retrieve one-time or recurring run-time schedules for Pelican’s Power Control Modules (PM5 Series). This functionality allows for precise control over connected electrical equipment, optimizing energy usage and operational efficiency. Key Features: Advanced Scheduling: Supports both one-time […]
PowerOutput Attributes
Categories: OpenAPI Power Control Module API PowerOutput Attributes UPDATED The PowerOutput attributes enable you to control and monitor the active statuses of the relays in Pelican’s Power Control Modules (PM5 Series). Each module is equipped with five (5) output relays, allowing for versatile management of connected electrical devices. Predefined system-managed attributes for PowerOutput objects, used […]
Power Control Module API Overview
Categories: OpenAPI Power Control Module API Power Control Module API Overview UPDATED The Pelican OpenAPI provides two primary API categories for managing Power Control Modules (PM5 Series), enabling you to control active statuses and schedules of connected electrical equipment. Power Control Module API Categories PowerOutput Attributes Manage and retrieve the active statuses of the Power […]
ThermostatUsage Attributes
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 […]
ThermostatHistory Attributes
Categories: OpenAPI Thermostat API ThermostatHistory Attributes UPDATED The ThermostatHistory attributes enable retrieval of historical readings and setpoint information from Pelican thermostats. To perform a ThermostatHistory request, you must specify at least the required selection attributes, including a starting date/time (startDateTime) and an ending date/time (endDateTime). If no specific object attributes are requested, the API will […]
SharedSchedule Attributes
Categories: OpenAPI Thermostat API SharedSchedule Attributes UPDATED SharedSchedule attributes allow you to set shared schedules for thermostats. Attribute names are not case-sensitive, while attribute values are case-sensitive. Predefined system-managed attributes for SharedSchedule objects, used for essential functions like temperature control, system status, and scheduling. They follow a fixed structure and cannot be renamed or redefined […]
ThermostatEvent Attributes
Categories: OpenAPI Thermostat API ThermostatEvent Attributes UPDATED The ThermostatEvent attributes allow you to schedule one-time events that override a thermostat’s standard recurring schedule. This interface enables adding, modifying, or deleting events, as well as retrieving existing pending events. Events added through the API are tracked as “External” events. There are no restrictions on the number […]
ThermostatSchedule Attributes
Categories: OpenAPI Thermostat API ThermostatSchedule Attributes UPDATED ThermostatSchedule attributes allow you to list and set a thermostat’s recurring schedules. Attribute names are not case-sensitive, while attribute values are case-sensitive. Predefined system-managed attributes for ThermostatSchedule objects, used for essential functions like temperature settings, system settings, and scheduling times. They follow a fixed structure and cannot be […]
Thermostat API Overview
Categories: OpenAPI Thermostat API Thermostat API Overview UPDATED The Pelican OpenAPI provides a comprehensive set of thermostat-related API categories, allowing developers to retrieve and modify configurations, monitor active statuses, manage schedules, and access historical data. These APIs support interactions with individual thermostats, all thermostats at a site, or specific subsets based on defined attributes. Thermostat […]
Thermostat Attributes
Categories: OpenAPI Thermostat API Thermostat Attributes UPDATED Thermostat attributes enable setting and retrieving configuration settings and real-time status information. Predefined system-managed attributes for Thermostat 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 […]