Open Smart Grid Platform Documentation

  Fix This Page

Contract

Contract for v0.5.1

Messages

These message below are part of OSLP v0.5.1.

  • RegisterDeviceRequest (from device to platform) is a request that notifies the platform a device which wants to register. During the registration the sequence number is reset to a random value, the platform is notified if the device has a light schedule, the type of the device, the device identification, and the device communicates its IP address to the platform.
  • RegisterDeviceResponse (from platform to device) is a response which holds the time of the platform so the device can synchronize the time, contains location information for the device like GPS coordinates and Day Light Saving time information. The device will sent ConfirmRegisterDeviceRequest after receiving the RegisterDeviceResponse.
  • StartSelfTestRequest (from platform to device) is a request that notifies the device to switch all relays on.
  • StartSelfTestResponse (from device to platform) is a response which confirms the StartSelfTestRequest has been executed or rejects the StartSelfTestRequest.
  • StopSelfTestRequest (from platform to device) is a request that notifies the device to switch all relays off.
  • StopSelfTestResponse (from device to platform) is a response which confirms the StopSelfTestResponse has been executed or rejects the StopSelfTestResponse.
  • UpdateFirmwareRequest (from platform to device) is a request which notifies the device to download a new firmware version from a server using a URL.
  • UpdateFirmwareResponse (from device to platform) is a response which confirms the UpdateFirmwareRequest has been executed or rejects the UpdateFirmwareRequest. Please note there are several events which are sent from the device to the platform to inform the platform when the firmware has been downloaded and whether or not the firmware was successfully activated.
  • SetLightRequest (from platform to device) is a request that notifies the device to switch on or off one ore several light relays, optionally with a dim-value per relay.
  • SetLightResponse (from device to platform) is a response which confirms the SetLightRequest has been executed or rejected.
  • GetStatusRequest (from platform to device) is a request that requires the device to send the status of all relays, current network link and preferred network link, the type of configuration (PSLD vs SSLD), and the event notification mask which has been set.
  • GetStatusResponse (from device to platform) is a response which confirms the GetStatusRequest has been executed and returns the current status for all of the relays and other information or rejects the GetStatusRequest.
  • ResumeScheduleRequest (from platform to device) is a request that notifies the device to continue the current schedule after the current schedule was interrupted (for example by switching by hand using SetLightRequest). This request can operate on a single relay or on all relays and the resuming of the schedule can be immediate or at the next schedule-entry.
  • ResumeScheduleResponse (from device to platform) is a response which confirms the ResumeScheduleRequest has been executed or rejected.
  • SetEventNotificationsRequest (from platform to device) is a request that sets the event notification mask.
  • SetEventNotificationsResponse (from device to platform) is a response which confirms the SetEventNotifications request has been executed or rejected.
  • EventNotificationRequest (from device to platform) is a request that pushes an event notification from a device to the platform.
  • EventNotificationResponse (from platform to device) is a response which confirms the EventNotificationRequest has been executed or rejected.
  • GetFirmwareVersionRequest (from platform to device) is a request that requests the device to sent its current firmware version.
  • GetFirmwareVersionResponse (from device to platform) is a response that sends the current firmware version to the platform.
  • SetScheduleRequest (from platform to device) is a request that sends a light or tariff schedule to the device.
  • SetScheduleResponse (from device to platform) is a response which confirms the SetScheduleRequest has been executed or rejected.
  • SetConfigurationRequest (from platform to device) is a request that sends configuration settings to the device.
  • SetConfigurationResponse (from device to platform) is a response which confirms the SetConfigurationRequest has been executed or rejected.
  • GetPowerUsageHistoryRequest (from platform to device) is a request that requests the device to send the content of its power usage registers.
  • GetPowerUsageHistoryResponse (from device to platform) is a response which confirms the GetPowerUsageHistoryRequest has been executed or rejected and contains the power usage data.
  • GetActualPowerUsageRequest (from platform to device) is a request that requests the device to send the content of its power usage registers.
  • GetActualPowerUsageResponse (from device to platform) is a response which confirms the GetActualPowerUsageRequest has been executed or rejected and contains the power usage data.
  • SetRebootRequest (from platform to device) is a request that notifies the device to reboot immediately.
  • SetRebootResponse (from device to platform) is a response which confirms the SetRebootRequest has been executed or rejected.
  • SetTransitionRequest (from platform to device) is a request that notifies the device to switch its light relays according to light measurement schedule-entries.
  • SetTransitionResponse (from device to platform) is a response which confirms the SetTransitionRequest has been executed or rejected.
  • GetConfigurationRequest (from platform to device) is a request that requests the device to send its current configuration settings.
  • GetConfigurationResponse (from device to platform) is a response which confirms the GetConfigurationRequest has been executed or rejected.
  • ConfirmRegisterDeviceRequest (from device to platform) is a request that notifies the platform that a device wants to perform the second step of the registration process.
  • ConfirmRegisterDeviceResponse (from platform to device) is a response which confirms the ConfirmRegisterDeviceRequest has been executed or rejected.