How Can We Help?
The Pelican Power Control Modules (PM5) support advanced scheduling options which include one-time or recurring run times. This interface allows schedules to be added, modified, or deleted. When retrieving schedules with a “get” request only existing or pending schedules will be returned, historical schedules are not retrievable through the API. If a schedule is added through the API it is tracked as an “External” schedule. There is no restriction on the number of schedules that can be added.
Any overlapping schedules are automatically merged.
Schedules cannot cross day boundaries. For schedules that need to cross day boundaries multiple schedules should be created.
The “editable” attribute can be set to “Yes” or “No” for an External schedule (default=No). When set to “Yes” the schedule can be edited by users of the Pelican App. When set to “No” the schedule can only be viewed through the App, but not edited or deleted.
PowerSchedule - Object Attributes
Attribute names are not case sensitive. Attribute values are case sensitive.
|name||String||No||The configured name of the power module output.|
|serialNo||String||No||The power control module serial number.|
|scheduleId||String||Yes||The unique ID of this schedule (See Note 1).|
|title||String||Yes||descriptive label for the schedule.|
|startDate||String||Yes||The first date the schedule will run in ISO 8601 format.|
|endDate||String||Yes||The last date the schedule will run 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.|
|repeat||String||Yes||The frequency the schedule will run (See Note 2).|
|editable||Yes, No||Yes||Whether users can edit the schedule through the Schedule Dashboard.|
|origin||Internal, External, All||No||How the schedule was created (See Note 3)|
|delete||Yes||Yes||Delete the specified schedule entry.|