Grid eXchange Fabric Documentation

  Fix This Page

SetLight

Description

Request that notifies the device to switch on or off one or several light relays, optionally with a dim-value per relay. If optional value 'index' is omitted, all relays configured as light are switched. In that case, all light relays will switch using only 1 LightValue instance for 'values'. In case the value 'index' is included, multiple instances of LightValue can be used (up to 6), each indicating a particular relay. If optional value 'dimValue' is omitted, then default values of 0 and 100 will be assumed for either 'on = false' or 'on = true'.

Response communicates status.

Message definitions

message SetLightRequest {
    repeated LightValue values = 1; // [(nanopb).max_count = 6];
}

message SetLightResponse {
    required Status status = 1;
}

Data types

message LightValue {
    optional bytes index = 1; // [(nanopb).max_size = 1]; // index number of connected light (DALI), none means all connected ligts.
    required bool on = 2;
    optional bytes dimValue = 3; // [(nanopb).max_size = 1]; // 1 - 100 %
}

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

Example

Soap requests and responses sent to and from platform:


   
      LianderNetManagement
      WEB_OWNER
      liander gebruiker
   
   
      
         device-01
         
            true
         
      
   



   
   
      
         
            LianderNetManagement|||device-01|||20160105121022551
            device-01
         
      
   



   
      LianderNetManagement
      WEB_OWNER
      liander gebruiker
   
   
      
         
            LianderNetManagement|||device-01|||20160105121022551
            device-01
         
      
   



   
   
      
         OK
      
   

OSLP SetLightRequest sent to 'device-01':

setLightRequest {
  values {
    on: true
  }
}

OSLP SetLightResponse sent to platform:

setLightResponse {
  status: OK
}