UPnP-Robair-DistanceSensor1

From air
Jump to navigation Jump to search

<!-- UPnP description of DistanceSensor service v1-->

<scpd>
   <serviceStateTable>
      <stateVariable>
         <name>Name</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>string</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>Application</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>string</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>Angle</name> <!-- in radian (SI) -->
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>float</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>AngleStep</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>i4</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>MinDetection</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>float</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>MaxDetection</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>float</dataType>
      </stateVariable>
      <stateVariable>
         <Optional/>
         <name>AbsoluteDeltaDetectionThreshold</name>
         <sendEventsAttribute>no</sendEventsAttribute>
         <dataType>float</dataType>
      </stateVariable>

      <stateVariable>
         <name>CurrentDistanceArray</name>
         <sendEventsAttribute>yes</sendEventsAttribute>
         <dataType>string</dataType> <!-- CSV floats  (unit is meter (SI))-->
      </stateVariable>

      <stateVariable>
         <Optional/>
         <name>CurrentError</name> 
         <sendEventsAttribute>yes</sendEventsAttribute>
         <dataType>float</dataType>  <!-- absolute error : unit is meter (SI) -->
      </stateVariable>
      
   </serviceStateTable>
   <actionList>
      <action>
         <name>GetName</name>
         <argumentList>
            <argument>
               <name>Name</name>
               <direction>out</direction>
               <relatedStateVariable>Name</relatedStateVariable>
               <retval/>
            </argument>
         </argumentList>
      </action>

      <action>
         <name>GetCurrentDistanceArray</name>
         <argumentList>
            <argument>
               <name>CurrentDistanceArray</name>
               <direction>out</direction>
               <relatedStateVariable>CurrentDistanceArray</relatedStateVariable>
            </argument>
            <argument>
               <name>CurrentError</name>
               <direction>out</direction>
               <relatedStateVariable>CurrentError</relatedStateVariable>
            </argument>
         </argumentList>
      </action>
      
      <action>
         <Optional/>
         <name>GetDistanceSensorInfo</name>
         <argumentList>
            <argument>
               <name>Name</name>
               <direction>out</direction>
               <relatedStateVariable>Name</relatedStateVariable>
               <retval/>
            </argument>
            <argument>
               <name>Application</name>
               <direction>out</direction>
               <relatedStateVariable>Application</relatedStateVariable>
               <retval/>
            </argument>
            <argument>
               <name>Angle</name>
               <direction>out</direction>
               <relatedStateVariable>Angle</relatedStateVariable>
               <retval/>
            </argument>
            <argument>
               <name>AngleStep</name>
               <direction>out</direction>
               <relatedStateVariable>AngleStep</relatedStateVariable>
               <retval/>
            </argument>
            <argument>
               <name>MinDetection</name>
               <direction>out</direction>
               <relatedStateVariable>MinDetection</relatedStateVariable>
               <retval/>
            </argument>
            <argument>
               <name>MaxDetection</name>
               <direction>out</direction>
               <relatedStateVariable>MaxDetection</relatedStateVariable>
               <retval/>
            </argument>
         </argumentList>
      </action>

      <action>
         <Optional/>
         <name>GetAbsoluteDeltaDetectionThreshold</name>
         <argumentList>
            <argument>
               <name>CurrentAbsoluteDeltaDetectionThreshold</name>
               <direction>out</direction>
               <relatedStateVariable>AbsoluteDeltaDetectionThreshold</relatedStateVariable>
               <retval/>
            </argument>
         </argumentList>
      </action>
      <action>
         <Optional/>
         <name>SetAbsoluteDeltaDetectionThreshold</name>
         <argumentList>
            <argument>
               <name>NewAbsoluteDeltaDetectionThreshold</name>
               <direction>in</direction>
               <relatedStateVariable>AbsoluteDeltaDetectionThreshold</relatedStateVariable>
            </argument>
         </argumentList>
      </action>

   </actionList>
</scpd>