OSGP / Documentation

This repository contains documentation for the Open Smart Grid Platform project. This repository is built as a GitBook, therefore all content has to be written using markdown syntax. See the latest GitBook:
https://documentation.gxf.lfenergy.org/
Apache License 2.0
24 stars 15 forks source link

ConfigurationManagement.GetConfiguration response is incomplete #245

Open ThE-MaRaC opened 3 years ago

ThE-MaRaC commented 3 years ago

Boolean values (isTestButtonEnabled and isDhcpEnabled) from OSLP GetConfigurationResponse are not correctly mapped. OSLP GetConfigurationResponse

Received OSLP Response (before callback): getConfigurationResponse {
  status: OK
  lightType: LT_NOT_SET
  relayConfiguration {
    addressMap {
      index: "\001"
      address: "\001"
      relayType: TARIFF
    }
    addressMap {
      index: "\002"
      address: "\002"
      relayType: LIGHT
    }
    addressMap {
      index: "\003"
      address: "\003"
      relayType: LIGHT
    }
  }
  shortTermHistoryIntervalMinutes: 15
  preferredLinkType: LINK_NOT_SET
  meterType: MT_NOT_SET
  longTermHistoryInterval: 1
  longTermHistoryIntervalType: DAYS
  timeSyncFrequency: 86400
  deviceFixIpValue: "\300\250\000d"
  netMask: "\377\377\377\000"
  gateWay: "\300\250\000\001"
  isDhcpEnabled: true
  communicationTimeout: 30
  communicationNumberOfRetries: 5
  communicationPauseTimeBetweenConnectionTrials: 120
  ospgIpAddress: "\250?aA"
  osgpPortNumber: 12122
  isTestButtonEnabled: true
  isAutomaticSummerTimingEnabled: false
  astroGateSunRiseOffset: -900
  astroGateSunSetOffset: 600
  switchingDelay: 1
  switchingDelay: 2
  switchingDelay: 3
  switchingDelay: 4
  relayLinking {
    masterRelayIndex: "\002"
    masterRelayOn: false
    indicesOfControlledRelaysOn: "\003\004"
    indicesOfControlledRelaysOff: "\003\004"
  }
  relayRefreshing: false
  summerTimeDetails: "0360100"
  winterTimeDetails: "1060200"
}

SOAP GetConfigurationResponse

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ns2:GetConfigurationResponse xmlns:ns2="http://www.opensmartgridplatform.org/schemas/configurationmanagement/2014/10" xmlns:ns3="http://www.opensmartgridplatform.org/schemas/common/2014/10" xmlns:ns4="http://www.opensmartgridplatform.org/schemas/devicemanagement/2014/10">
         <ns2:Result>OK</ns2:Result>
         <ns2:Configuration>
            <ns2:RelayConfiguration>
               <ns2:RelayMap>
                  <ns2:Index>1</ns2:Index>
                  <ns2:Address>1</ns2:Address>
                  <ns2:RelayType>TARIFF</ns2:RelayType>
               </ns2:RelayMap>
               <ns2:RelayMap>
                  <ns2:Index>2</ns2:Index>
                  <ns2:Address>2</ns2:Address>
                  <ns2:RelayType>LIGHT</ns2:RelayType>
               </ns2:RelayMap>
               <ns2:RelayMap>
                  <ns2:Index>3</ns2:Index>
                  <ns2:Address>3</ns2:Address>
                  <ns2:RelayType>LIGHT</ns2:RelayType>
               </ns2:RelayMap>
            </ns2:RelayConfiguration>
            <ns2:TimeSyncFrequency>86400</ns2:TimeSyncFrequency>
            <ns2:DeviceFixedIp>
               <ns2:IpAddress>192.168.0.100</ns2:IpAddress>
               <ns2:NetMask>255.255.255.0</ns2:NetMask>
               <ns2:GateWay>192.168.0.1</ns2:GateWay>
            </ns2:DeviceFixedIp>
            <ns2:CommunicationTimeout>30</ns2:CommunicationTimeout>
            <ns2:CommunicationNumberOfRetries>5</ns2:CommunicationNumberOfRetries>
            <ns2:CommunicationPauseTimeBetweenConnectionTrials>120</ns2:CommunicationPauseTimeBetweenConnectionTrials>
            <ns2:OsgpIpAddress>168.63.97.65</ns2:OsgpIpAddress>
            <ns2:OsgpPortNumber>12122</ns2:OsgpPortNumber>
            <ns2:AstroGateSunRiseOffset>-15</ns2:AstroGateSunRiseOffset>
            <ns2:AstroGateSunSetOffset>10</ns2:AstroGateSunSetOffset>
            <ns2:SwitchingDelays>1</ns2:SwitchingDelays>
            <ns2:SwitchingDelays>2</ns2:SwitchingDelays>
            <ns2:SwitchingDelays>3</ns2:SwitchingDelays>
            <ns2:SwitchingDelays>4</ns2:SwitchingDelays>
            <ns2:RelayLinking>
               <ns2:MasterRelayIndex>2</ns2:MasterRelayIndex>
               <ns2:MasterRelayOn>false</ns2:MasterRelayOn>
               <ns2:IndicesOfControlledRelaysOn>3</ns2:IndicesOfControlledRelaysOn>
               <ns2:IndicesOfControlledRelaysOn>4</ns2:IndicesOfControlledRelaysOn>
               <ns2:IndicesOfControlledRelaysOff>3</ns2:IndicesOfControlledRelaysOff>
               <ns2:IndicesOfControlledRelaysOff>4</ns2:IndicesOfControlledRelaysOff>
            </ns2:RelayLinking>
            <ns2:SummerTimeDetails>2021-03-28T01:00:00.000Z</ns2:SummerTimeDetails>
            <ns2:WinterTimeDetails>2021-10-31T02:00:00.000Z</ns2:WinterTimeDetails>
         </ns2:Configuration>
      </ns2:GetConfigurationResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

TestButtonEnabled and DhcpEnabled booleans are present in the XSD (configurationmanagement.xsd), but they were not sent in the response.

kevinsmeets commented 3 years ago

Those fields are indeed missing from the XML response. Thank you for reporting this issue, @ThE-MaRaC :) I created a JIRA ticket: https://smartsocietyservices.atlassian.net/browse/OC-731

ThE-MaRaC commented 3 years ago

I can provide a pull request with the correction.

ThE-MaRaC commented 3 years ago

cucumber-tests-platform-common

420 Scenarios (420 passed)
1394 Steps (1394 passed)
4m23.349s

cucumber-tests-platform-publiclighting

442 Scenarios (442 passed)
2158 Steps (2158 passed)
12m30.403s
ThE-MaRaC commented 3 years ago

Is there any specific reason why this correction is still not merged? Do you need anything else from my side?