sensorsupport/testsensor/data/ssyreference_config_template.xml
branchRCL_3
changeset 20 c2c61fdca848
parent 19 924385140d98
child 21 9af619316cbf
equal deleted inserted replaced
19:924385140d98 20:c2c61fdca848
     1 <!-- ssyreference_config_template.xml -->
       
     2 <!-- SsyReference configuration file template -->
       
     3 <!-- ************************************************************* -->
       
     4 <!-- * NOTE. DO NOT LEAVE ANY COMMENTS IN THE ACTUAL CONFIG FILE * -->
       
     5 <!-- ************************************************************* -->
       
     6 <SsyReferenceConfig>
       
     7     <SsyGeneralInformation>
       
     8         <!-- General information for SSY itself -->
       
     9         <Properties>
       
    10         <!-- General properties of the sensor -->
       
    11     	  <!-- TSensrvProperty. Each property has its own item defined in here -->
       
    12         	
       
    13         	<!-- Property example 1 -->
       
    14         	<PropertyItem PropertyId="TSensrvPropertyId"
       
    15         	    ItemIndex="Item index in channel data structure"
       
    16         		PropertyValue="Value of the property"
       
    17         		MaxValue="Maximum value of data"
       
    18         		MinValue="Minimum value of data"
       
    19         		ReadOnly="Read only or modifiable"
       
    20         		PropertyType="TSensrvPropertyType">
       
    21             </PropertyItem>
       
    22             <!-- Property example 2 -->
       
    23         	<PropertyItem PropertyId="TSensrvPropertyId"
       
    24         		ItemIndex="Item index in channel data structure"
       
    25         		PropertyValue="Value of the property"
       
    26         		MaxValue="Maximum value of data"
       
    27         		MinValue="Minimum value of data"
       
    28         		ReadOnly="Read only or modifiable"
       
    29         		PropertyType="TSensrvPropertyType">
       
    30             </PropertyItem>
       
    31         </Properties>
       
    32     </SsyGeneralInformation>
       
    33     <ChannelInformationGroup ChannelCount="2">
       
    34     	<!-- Channel definitions. Each channel item contains all information of one channel -->
       
    35     	<!-- Channel example 1 -->
       
    36     	<ChannelItem 
       
    37     		ChannelId="This value is updated runtime when Sensrv has defined channel IDs" 
       
    38     		ContextType="TSensrvContextType" 
       
    39     		Quantity="TSensrvQuantity" 
       
    40     		ChannelType="TSensrvChannelTypeId" 
       
    41     		Location="Location of the sensor" 
       
    42     		Vendor="Vendor ID"
       
    43     		DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h">
       
    44     		  <!-- One channel definition. Each channel has its own item block -->
       
    45         	<!-- TSensrvChannelInfo. Contains information of this channel; Context type, Quantity etc. --> 
       
    46         	
       
    47         	<!-- Contains properties of this channel. -->
       
    48         	<Properties>
       
    49         	  <!-- TSensrvProperty. Each property has its own item defined in here -->
       
    50         		<!-- Property example 3 -->
       
    51     		    <PropertyItem PropertyId="TSensrvPropertyId"
       
    52     		      ItemIndex="Item index in channel data structure"
       
    53     		      PropertyValue="Value of the property"
       
    54     		      MaxValue="Maximum value of data"
       
    55     		      MinValue="Minimum value of data"
       
    56     		      ReadOnly="Read only or modifiable"
       
    57     		      PropertyType="TSensrvPropertyType">
       
    58         		</PropertyItem>
       
    59     		    <!-- Property example 4 -->
       
    60     		    <PropertyItem PropertyId="TSensrvPropertyId"
       
    61     		      ItemIndex="Item index in channel data structure"
       
    62     		      PropertyValue="Value of the property"
       
    63     		      MaxValue="Maximum value of data"
       
    64     		      MinValue="Minimum value of data"
       
    65     		      ReadOnly="Read only or modifiable"
       
    66     		      PropertyType="TSensrvPropertyType">
       
    67         		</PropertyItem>
       
    68         	</Properties>
       
    69 
       
    70             <!-- Channel data. Information of generated data by this channel.  -->
       
    71             <!-- There may be several different (yet same type) data items. Next data item is added to  -->
       
    72             <!-- buffer after the previous data items (all according to count) are added and last Interval is passed -->
       
    73              
       
    74             <ChannelData StartIntervalMs="Time in milliseconds to start filling buffer after StartChannelData()">
       
    75                 <ChannelDataItem DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h" count="Number of this data items to be added into buffer (with the same values)" 
       
    76     			     									 IntervalMs="Time in milliseconds after next data item is added into buffer">
       
    77                     <!-- Content of this channel item is dependent on the type of this channel. It must be one and only one of the following -->
       
    78                     <SsyRefChannelDataAxis XAxis="Integer value of X Axis" YAxis="Integer value of Y Axis" ZAxis="Integer value of Z Axis" ><!-- This type has DataTypeID 0x00010001 --></SsyRefChannelDataAxis>
       
    79                     <SsyRefChannelDataTapping Direction="direction of tapping"><!-- This type has DataTypeID 0x00010002 --></SsyRefChannelDataTapping>
       
    80                 </ChannelDataItem>
       
    81 
       
    82                 <!-- Next channel data item -->
       
    83                 <ChannelDataItem DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h" count="Number of this data items to be added into buffer (with the same values)" 
       
    84     			     									 IntervalMs="Time in milliseconds after next data item is added into buffer">
       
    85                     <!-- Content of this channel item is dependent on the type of this channel. It must be one and only one of the following -->
       
    86                     <SsyRefChannelDataAxis XAxis="Integer value of X Axis" YAxis="Integer value of Y Axis" ZAxis="Integer value of Z Axis" ><!-- This type has DataTypeID 0x00010001 --></SsyRefChannelDataAxis>
       
    87                     <SsyRefChannelDataTapping Direction="direction of tapping"><!-- This type has DataTypeID 0x00010002 --></SsyRefChannelDataTapping>
       
    88                 </ChannelDataItem>
       
    89             </ChannelData>
       
    90     	</ChannelItem>
       
    91     	<!-- Channel example 2 -->
       
    92     	<ChannelItem 
       
    93     		ChannelId="This value is updated runtime when Sensrv has defined channel IDs" 
       
    94     		ContextType="TSensrvContextType" 
       
    95     		Quantity="TSensrvQuantity" 
       
    96     		ChannelType="TSensrvChannelTypeId" 
       
    97     		Location="Location of the sensor" 
       
    98     		Vendor="Vendor ID"
       
    99     		DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h">
       
   100     		<!-- One channel definition. Each channel has its own item block -->
       
   101         	<!-- TSensrvChannelInfo. Contains information of this channel; Context type, Quantity etc. -->
       
   102         	
       
   103             <!-- Contains properties of this channel. -->
       
   104         	<Properties>
       
   105         	  	 <!-- TSensrvProperty. Each property has its own item defined in here -->
       
   106         		 <!-- Property example 5 -->
       
   107     		    <PropertyItem PropertyId="TSensrvPropertyId"
       
   108     		      ItemIndex="Item index in channel data structure"
       
   109     		      PropertyValue="Value of the property"
       
   110     		      MaxValue="Maximum value of data"
       
   111     		      MinValue="Minimum value of data"
       
   112     		      ReadOnly="Read only or modifiable"
       
   113     		      PropertyType="TSensrvPropertyType">
       
   114         		</PropertyItem>
       
   115 
       
   116         		<!-- Property example 6 -->
       
   117     		    <PropertyItem PropertyId="TSensrvPropertyId"
       
   118     		      ItemIndex="Item index in channel data structure"
       
   119     		      PropertyValue="Value of the property"
       
   120     		      MaxValue="Maximum value of data"
       
   121     		      MinValue="Minimum value of data"
       
   122     		      ReadOnly="Read only or modifiable"
       
   123     		      PropertyType="TSensrvPropertyType">
       
   124         	    </PropertyItem>
       
   125         	</Properties>
       
   126 
       
   127             <!-- Channel data. Information of generated data by this channel.  -->
       
   128             <!-- There may be several different (yet same type) data items. Next data item is added to  -->
       
   129             <!-- buffer after the previous data items (all according to count) are added and last Interval is passed -->
       
   130              
       
   131             <ChannelData StartIntervalMs="Time in milliseconds to start filling buffer after StartChannelData()">
       
   132                 <ChannelDataItem DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h" count="Number of this data items to be added into buffer (with the same values)" 
       
   133     			     									 IntervalMs="Time in milliseconds after next data item is added into buffer">
       
   134                     <!-- Content of this channel item is dependent on the type of this channel. It must be one and only one of the following -->
       
   135                     <SsyRefChannelDataAxis XAxis="Integer value of X Axis" YAxis="Integer value of Y Axis" ZAxis="Integer value of Z Axis" ><!-- This type has DataTypeID 0x00010001 --></SsyRefChannelDataAxis>
       
   136                     <SsyRefChannelDataTapping Direction="direction of tapping"><!-- This type has DataTypeID 0x00010002 --></SsyRefChannelDataTapping>
       
   137                     </ChannelDataItem>
       
   138 
       
   139                 <!-- Next channel data item -->
       
   140                 <ChannelDataItem DataTypeId="data type ID identifies data type defined here. See sensrvchanneldatatypes.h" count="Number of this data items to be added into buffer (with the same values)" 
       
   141     			     									 IntervalMs="Time in milliseconds after next data item is added into buffer">
       
   142                     <!-- Content of this channel item is dependent on the type of this channel. It must be one and only one of the following -->
       
   143                     <SsyRefChannelDataAxis XAxis="Integer value of X Axis" YAxis="Integer value of Y Axis" ZAxis="Integer value of Z Axis" ><!-- This type has DataTypeID 0x00010001 --></SsyRefChannelDataAxis>
       
   144                     <SsyRefChannelDataTapping Direction="direction of tapping"><!-- This type has DataTypeID 0x00010002 --></SsyRefChannelDataTapping>
       
   145                 </ChannelDataItem>
       
   146             </ChannelData>
       
   147     	</ChannelItem>
       
   148     </ChannelInformationGroup>
       
   149 </SsyReferenceConfig>