eventnotification.md

EventNotification

Description

Request sent from device to platform containing information about 1 to 6 events.

Response sent from platform to 'device-01' communicates status.

Message definitions

message EventNotificationRequest {
    repeated EventNotification notifications = 1; // [(nanopb).max_count = 6];
}

message EventNotificationResponse {
    required Status status = 1;
}

Datatypes

message EventNotification {
    required Event event = 1;
    optional bytes index = 2; // [(nanopb).max_size=1];
    optional string description = 3; // [(nanopb).max_size = 81];
    optional string timestamp = 4; // [(nanopb).max_size = 15]; // - Format YYYYMMDDhhmmss UTC, indicates the date and time of the event.
}

enum Status {
    OK = 0;
    FAILURE = 1; // general failure
    REJECTED = 2; // request received in wrong state
}

Example

OSLP request sent from 'device-01' to platform:

eventNotificationRequest {
  notifications {
    event: TARIFF_EVENTS_TARIFF_OFF
    index: "\001"
    description: "Tariff Off Example Event"
    timestamp: "20170404093500"
  }
}

OSLP response sent to 'device-01':

eventNotificationResponse {
  status: OK
}