org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-FEB5D463-F6A1-44D9-9456-D95DE4BAED77.html
changeset 229 716254ccbcc0
equal deleted inserted replaced
228:913c9751c067 229:716254ccbcc0
       
     1 
       
     2 <!DOCTYPE html
       
     3   PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Sensor channel information"/><meta name="DC.Relation" scheme="URI" content="GUID-46FAFCDA-BCF3-41CB-B154-C17BBF7CD755"/><meta name="DC.Relation" scheme="URI" content="GUID-C2731B38-6294-419C-B7E2-AFB918F508D4"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-B77C2006-879F-4AC6-B7BF-04B25B563A29"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-FEB5D463-F6A1-44D9-9456-D95DE4BAED77"/><title>Sensor
       
     5 channel information </title><script type="text/javascript">
       
     6       function initPage() {}
       
     7     </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-FEB5D463-F6A1-44D9-9456-D95DE4BAED77">Sensor
       
     8 channel information</h1><div>
       
     9 <p>The Sensor Service API uses objects to represent sensor channels. One
       
    10 object contains the information for one sensor channel (see the following
       
    11 table). The Sensor Service API methods use these sensor channel objects as
       
    12 follows:</p>
       
    13 <ul>
       
    14 <li><p><a href="GUID-46DB749E-A388-46B2-BB13-A274385CA97C.html#GUID-46DB749E-A388-46B2-BB13-A274385CA97C"><code>FindSensorChannel</code></a></p>
       
    15 
       
    16 <p>The <code>ReturnValue</code> property of the result object is
       
    17 an <span>iterator</span> containing
       
    18 the requested sensor channel information. Each item (object) in the <span>iterator</span> corresponds
       
    19 to one sensor channel matching the <a href="GUID-A4538B4D-0D90-43F8-B1FA-72F616937760.html#GUID-A4538B4D-0D90-43F8-B1FA-72F616937760">search
       
    20 criteria</a> specified for the <code>FindSensorChannel</code> call.</p>
       
    21 
       
    22 </li>
       
    23 <li><p><a href="GUID-B4897257-F7BC-4C32-9C6C-A577FDAC5D09.html#GUID-B4897257-F7BC-4C32-9C6C-A577FDAC5D09"><code>RegisterForNotification</code></a></p>
       
    24 
       
    25 <p>The <code>criteria.ChannelInfoMap</code> property used
       
    26 for input is a sensor channel object. It specifies the channel from which
       
    27 the <code>RegisterForNotification</code> call registers to receive
       
    28 data.</p>
       
    29 
       
    30 </li>
       
    31 <li><p><a href="GUID-C2731B38-6294-419C-B7E2-AFB918F508D4.html#GUID-C2731B38-6294-419C-B7E2-AFB918F508D4"><code>GetChannelProperty</code></a></p>
       
    32 
       
    33 <p>The <code>criteria.ChannelInfoMap</code> property used
       
    34 for input is a sensor channel object. It specifies the channel of the property
       
    35 about which the <code>GetChannelProperty</code> call retrieves information.</p>
       
    36 
       
    37 </li>
       
    38 </ul>
       
    39 <div class="tablenoborder"><a name="GUID-80590C17-FB93-41B5-9A88-EFA9B29B6253"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-80590C17-FB93-41B5-9A88-EFA9B29B6253" frame="border" border="1" rules="all"><caption><strong>Table: </strong>Sensor channel
       
    40 object properties</caption>
       
    41 
       
    42 <thead align="left">
       
    43 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e65982">
       
    44 <p>Property</p>
       
    45 </th><th class="cellrowborder" valign="top" width="25%" id="d0e65987">
       
    46 <p>Description</p>
       
    47 </th><th class="cellrowborder" valign="top" width="25%" id="d0e65992">
       
    48 <p>Type</p>
       
    49 </th><th class="cellrowborder" valign="top" width="25%" id="d0e65997">
       
    50 <p>Value</p>
       
    51 </th></tr>
       
    52 </thead>
       
    53 <tbody>
       
    54 <tr class="">
       
    55 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
    56 <p><code>ChannelId</code></p>
       
    57 </td>
       
    58 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
    59 <p>Specifies the inique identifier of the channel.</p>
       
    60 </td>
       
    61 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
    62 <p>number</p>
       
    63 </td>
       
    64 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
    65 </tr>
       
    66 <tr class="bg ">
       
    67 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
    68 <p><code>ContextType</code></p>
       
    69 </td>
       
    70 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
    71 <p>Specifies the context in which the channel is available.</p>
       
    72 </td>
       
    73 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
    74 <p>number</p>
       
    75 </td>
       
    76 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">
       
    77 <p>Possible values:</p>
       
    78 <ul>
       
    79 <li><p><code>0</code> - Not defined</p></li>
       
    80 <li><p><code>1</code> - Ambient sensor, for example to measure
       
    81 pressure</p></li>
       
    82 <li><p><code>2</code> - Provides information on the device</p>
       
    83 </li>
       
    84 <li><p><code>3</code> - Measures user-initiated stimulus</p>
       
    85 </li>
       
    86 </ul>
       
    87 </td>
       
    88 </tr>
       
    89 <tr class="">
       
    90 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
    91 <p><code>Quantity</code></p>
       
    92 </td>
       
    93 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
    94 <p>Specifies the quantity being sensed.</p>
       
    95 </td>
       
    96 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
    97 <p>number</p>
       
    98 </td>
       
    99 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">
       
   100 <p>Possible values:</p>
       
   101 <ul>
       
   102 <li><p><code>0</code> - Not defined</p></li>
       
   103 <li><p><code>10</code> - Acceleration</p></li>
       
   104 <li><p><code>11</code> - Tapping</p></li>
       
   105 <li><p><code>12</code> - Orientation</p></li>
       
   106 <li><p><code>13</code> - Rotation</p></li>
       
   107 <li><p><code>14</code> - Magnetic</p></li>
       
   108 <li><p><code>15</code> - Tilt</p></li>
       
   109 </ul>
       
   110 </td>
       
   111 </tr>
       
   112 <tr class="bg ">
       
   113 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
   114 <p><code>ChannelType</code></p>
       
   115 </td>
       
   116 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
   117 <p>Specifies the type of the channel. This is the unique identifier of
       
   118 the Sensor Subsystem (SSY) that provides data for this channel.</p>
       
   119 <p>Each physical sensor registers to the S60 sensor framework as a Sensor
       
   120 Subsystem that provides specific sensor data. If the physical sensor provides
       
   121 multiple types of data, it can register a separate SSY for each type. For
       
   122 example, a sensor that provides both orientation and rotation data can register
       
   123 one SSY for orientation data and another for rotation data. <code>ChannelType</code> thus
       
   124 identifies a particular SSY representing the channel.</p>
       
   125 </td>
       
   126 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
   127 <p>number</p>
       
   128 </td>
       
   129 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
   130 </tr>
       
   131 <tr class="">
       
   132 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
   133 <p><code>Location</code></p>
       
   134 </td>
       
   135 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
   136 <p>Specifies the location of the sensor related to the channel.</p>
       
   137 </td>
       
   138 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
   139 <p>string</p>
       
   140 </td>
       
   141 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
   142 </tr>
       
   143 <tr class="bg ">
       
   144 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
   145 <p><code>VendorId</code></p>
       
   146 </td>
       
   147 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
   148 <p>Specifies the vendor ID of the sensor related to the channel.</p>
       
   149 </td>
       
   150 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
   151 <p>string</p>
       
   152 </td>
       
   153 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
   154 </tr>
       
   155 <tr class="">
       
   156 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
   157 <p><code>DataItemSize</code></p>
       
   158 </td>
       
   159 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
   160 <p>Specifies the data item size delivered in the channel.</p>
       
   161 </td>
       
   162 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
   163 <p>number</p>
       
   164 </td>
       
   165 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
   166 </tr>
       
   167 <tr class="bg ">
       
   168 <td class="cellrowborder" valign="top" width="25%" headers="d0e65982 ">
       
   169 <p><code>ChannelDataTypeId</code></p>
       
   170 </td>
       
   171 <td class="cellrowborder" valign="top" width="25%" headers="d0e65987 ">
       
   172 <p>Specifies the unique data type identifier for the data being sensed.</p>
       
   173 </td>
       
   174 <td class="cellrowborder" valign="top" width="25%" headers="d0e65992 ">
       
   175 <p>number</p>
       
   176 </td>
       
   177 <td class="cellrowborder" valign="top" width="25%" headers="d0e65997 ">&nbsp;</td>
       
   178 </tr>
       
   179 </tbody>
       
   180 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html>