User Attributes
Categories: OpenAPI User API User Attributes UPDATED The User object attributes enable you to access and manage user information within the Pelican App’s User Management section. These attributes facilitate the configuration of notification settings for both registered and non-registered users. Predefined system-managed attributes for User objects, used for essential functions like temperature control, system status, and […]
Notification Attributes
Categories: OpenAPI Notification API Notification Attributes UPDATED The Notification attributes provide access to current notification statuses generated within the Pelican App. Through the Notification API, you can retrieve active notifications and update their statuses as necessary. Notification – Object Attributes Attribute names are not case-sensitive; attribute values are case-sensitive. Name Values Set Description name String […]
PowerUsage Attributes
Categories: OpenAPI PowerLink API PowerUsage Attributes UPDATED The PowerUsage attributes allow you to obtain summarized energy usage data tracked by a Pelican PowerLink. Note: The PowerLink is a special order item primarily used by utilities or utility program managers to monitor energy consumption at meters or dedicated equipment at Pelican customer sites. If your company […]
MySites Attributes
Categories: OpenAPI MySites API MySites Attributes UPDATED The MySites object attributes provide summary information for each Pelican site associated with your account. This includes details such as site domain names, gateway statuses, the number of active devices, and notifications. Additionally, the MySites API facilitates multi-site token requests, enabling authentication across multiple sites. Predefined system-managed attributes […]
DemandResponseHistory Attributes
Categories: OpenAPI Attributes DemandResponseHistory Attributes UPDATED The DemandResponseHistory object attributes allow you to retrieve historical information about past Demand Response (DR) events, including their occurrence and duration. A DemandResponseHistory request must include at least the required selection attributes, specifying a starting (startDateTime) and ending (endDateTime) date/time. If no specific DemandResponseHistory object attributes are provided in […]
Demand Response Attributes
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. Predefined system-managed attributes for Thermostat objects, used for […]
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 […]