W3C home > Mailing lists > Public > public-dap-commits@w3.org > May 2010

2009/dap/system-info Overview.html,1.113,1.114

From: Max Froumentin via cvs-syncmail <cvsmail@w3.org>
Date: Thu, 27 May 2010 11:53:07 +0000
To: public-dap-commits@w3.org
Message-Id: <E1OHbe7-0006qp-GE@lionel-hutz.w3.org>
Update of /sources/public/2009/dap/system-info
In directory hutz:/tmp/cvs-serv26319

Modified Files:
	Overview.html 
Log Message:
corrections from Suresh's email


Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/system-info/Overview.html,v
retrieving revision 1.113
retrieving revision 1.114
diff -u -d -r1.113 -r1.114
--- Overview.html	26 May 2010 12:52:26 -0000	1.113
+++ Overview.html	27 May 2010 11:53:05 -0000	1.114
@@ -25,16 +25,18 @@
       table { border: 1px solid black }
       th { border: 1px solid black }
       tr.interface { background-color: #ddd }
+      td { border: 1px solid black }
 </style>
 
   </head>
   <body>
     <section id='abstract'>
-      <p>This specification defines an API to provide Web applications
-      with access to various properties of the system on which they are
-      running. Specifically, properties pertaining to the device
-      hardware are exposed. Examples include battery status,
-      current network bandwidth. Additionally, some of those
+      <p>This specification defines an <abbr title="Application Programming Interface">API</abbr>
+      to provide Web applications with access to various properties of
+      the system on which they are running. Specifically, properties
+      pertaining to device information are exposed. Examples of such
+      properties include battery status, current network connection
+      characteristics, and I/O properties. Additionally, some of those
       properties offer access to the environment around the device,
       such as ambient brightness or atmospheric pressure.</p>
     </section>
@@ -50,15 +52,18 @@
     <section class='introduction'>
       <h2>Introduction</h2>
       <p>In order for web applications to gain access to information
-      only available to an operating system's native applications,
-      they must be able to access various data present on the device,
-      either related to the hardware state (e.g. CPU usage), software
-      data (e.g. pictures stored) or environment information
-      (e.g. ambient brightness). The APIs defined by the <em>Device
-      APIs and Policy Working Group</em> address this
-      issue. Specifically, the API defined in this specification
-      provides access to hardware devices, either internal (CPU,
-      Thermometers) or ambient (light, noise or temperature).</p>
+      that is typically available to an operating system's native
+      applications, they must be able to access various system
+      properties present on the device, either related to the hardware
+      state (e.g. CPU usage), software data (e.g. installed codecs) or
+      environment information (e.g. ambient brightness). The APIs
+      defined by the <em>Device APIs and Policy Working Group</em>
+      address this issue. Specifically, the API defined in this
+      specification provides access to System Information and
+      properties from the underlying platform related to Input/Output,
+      AVCodecs, Network, Storage, Sensors, and other Internal device
+      properties. The properties accessed through this API may be
+      static and/or dynamic in nature.</p>
 
     </section>
 
@@ -89,14 +94,15 @@
         <ul>
           <li>A name.</li>
           <li>A URI, which is the concatenation of the string <code>http://www.w3.org/2009/dap/SysInfo/</code> with the name of the property.</li>
-          <li>A webIDL [[!WEBIDL]] interface that contains its attributes.</li>
+          <li>A webIDL [[!WEBIDL]] interface that contains attributes.</li>
         </ul>
 
         <p>The name of a property (or its URI, interchangeably) is
         used in the functions of the <a>SystemInfo</a> interface to
-        identify the accessed property. When a success callback
-        resulting from calling one of those functions is invoked, the
-        API MUST pass an instance of the property's interface.</p>
+        identify the accessed property. In response to calling one of
+        those functions, the resulting property MUST be an instance of
+        the property’s interface i.e. an instance of the webIDL
+        interface that contains its attributes.</p>
 
         <p>Some of the properties below are defined as
         <dfn>enumerable</dfn>, meaning that more than one instance of
@@ -394,7 +400,7 @@
         </section>
 
         <section>
-          <h4>The <a>Power</a> Property</h4>
+          <h4>The <code>Power</code> Property</h4>
           <p>This property reflects the general state of the system's power sources. The information provided when requesting this property is described by the <a>PowerAttributes</a> interface.</p>
 
           <dl title="[NoInterfaceObject] interface PowerAttributes : SystemProperty" class="idl">
@@ -459,7 +465,7 @@
         </section>
         
         <section>
-          <h4>The <a>CPU</a> Property</h4>
+          <h4>The <code>CPU</code> Property</h4>
           <p>This property reflects the state of the CPUs available to this system. The information provided when requesting this property is described by the <a>CPUAttributes</a> interface.</p>
 
           <dl title="[NoInterfaceObject] interface CPUAttributes : SystemProperty" class="idl">
@@ -496,7 +502,7 @@
         </section>
         
         <section>
-          <h4>The <a>Thermal</a> property</h4>
+          <h4>The <code>Thermal</code> property</h4>
           
           <p>This property provides information on the global temperature state of the system. The information provided when requesting this property is described by the <a>ThermalAttributes</a> interface.</p>
 
@@ -540,7 +546,7 @@
         </section>
 
         <section>
-          <h4>The <em>Network</em> Property</h4>
+          <h4>The <code>Network</code> Property</h4>
 
           <p>This property exposes the network connections that are
           available on this system. The information provided when
@@ -560,7 +566,7 @@
         </section>
 
         <section>
-          <h4>The <em>Connection</em> Property</h4>
+          <h4>The <code>Connection</code> Property</h4>
 
           <p>This property exposes a network connection which is
           available on this system. The information provided when
@@ -791,7 +797,7 @@
         <section>
           <h4>Proximity</h4>
           <section>
-            <h5>The <a>Proximity</a> Property</h5>
+            <h5>The <code>Proximity</code> Property</h5>
             <p>This property provides information about the distance of objects around the device.</p>
 
 
@@ -827,7 +833,7 @@
 </pre>
         </section>
         <section>
-          <h4>The <a>AVCodecs</a> property</h4>
+          <h4>The <code>AVCodecs</code> property</h4>
 
           <p>This property exposes information about the audio/video
           codecs available to this system. The information provided
@@ -844,7 +850,7 @@
         </section>
 
         <section>
-          <h4>The <a>AudioCodec</a> Property</h4>
+          <h4>The <code>AudioCodec</code> Property</h4>
 
           <p>This property exposes information on a single audio codec
           available on this system.  The information provided when
@@ -867,7 +873,7 @@
           </dl>
         </section>
         <section>            
-          <h3>The <a>VideoCodec</a> Property</h3>
+          <h3>The <code>VideoCodec</code> Property</h3>
 
           <p>This property exposes information on a single video codec
           available on this system. The information provided when
@@ -915,14 +921,14 @@
           </section>
 
           <section>
-            <h4>The <em>Storage</em> Property</h4> 
+            <h4>The <code>Storage</code> Property</h4> 
             <p>This property exposes the data storage devices
             connected to this system. When requested through API
             functions, this property returns an array of objects of
             type <a>StorageUnitAttributes</a>, corresponding to the
             storage devices available to this unit.</p>
 
-            <h4>The <em>StorageUnit</em> Property</h4>
+            <h4>The <code>StorageUnit</code> Property</h4>
             <p>This property exposes a single data storage device
             connected to this system. When requested through API
             functions, this property returns an object of type
@@ -983,7 +989,7 @@
 
 
           <section>
-            <h4>The <a>OutputDevices</a> Property</h4>
+            <h4>The <code>OutputDevices</code> Property</h4>
               
             <p>This property provides information on the output
             devices (displays or audio) available on this system.  The
@@ -1135,7 +1141,7 @@
 
 
           <section>
-            <h3>The <em>InputDevices</em> Property</h3>
+            <h3>The <code>InputDevices</code> Property</h3>
 
             <p>This property provides information on input
             devices (cameras, mice) available on this system.</p>
@@ -1154,9 +1160,9 @@
               <dd>The list of cameras available on this system.</dd>
               <dt>attribute CameraAttributes activeCameras[]</dt>
               <dd>The list of cameras available on this system that are currently in use.</dd>
-              <dt>attribute Microphone microphones[]</dt>
+              <dt>attribute MicrophoneAttributes microphones[]</dt>
               <dd>The list of microphones available on this system.</dd>
-              <dt>attribute Microphone activeMicrophones[]</dt>
+              <dt>attribute MicrophoneAttributes activeMicrophones[]</dt>
               <dd>The list of microphones available on this system that are currently in use.</dd>
             </dl>
 
@@ -1369,6 +1375,39 @@
         </tbody>
       </table>
     </section>
+
+    <section class="appendix">
+      <h3>Properties And Attributes Table</h3>
+      <p>The table below lists all the properties, the corresponding interface and that interface's attributes</p>
+      <table>
+        <thead><tr><th>Property</th><th>Property Interface</th><th>Attributes</th></tr></thead>
+        <tbody>
+          <tr><td><code>Power</code></td><td><code>PowerAttributes</code></td><td><code>level<br/>timeRemaining<br/>isBattery<br/>isCharging</code></td></tr>
+          <tr><td><code>CPU</code></td><td><code>CPUAttributes</code></td><td><code>usage</code></td></tr>
+          <tr><td><code>Thermal</code></td><td><code>ThermalAttributes</code></td><td><code>state</code></td></tr>
+          <tr><td><code>Network</code></td><td><code>NetworkAttributes</code></td><td><code>connections<br/>activeConnection</code></td></tr>
+          <tr><td><code>Connection</code></td><td><code>ConnectionAttributes</code></td><td><code>type<br/>currentDownloadBandwidth<br/>currentUploadBandwidth<br/>maxDownloadBandwidth<br/>maxUploadBandwidth<br/>macAddress<br/>ipAddress<br/>currentSignalStrength<br/>SSID<br/>apn<br/>operatorName<br/>roaming<br/>mcc<br/>mnc<br/></code></td></tr>
+          <tr><td><code>AmbientLight<br/>AmbientNoise<br/>AmbientTemperature<br/>AmbientAtmosphericPressure<br/>Proximity</code></td><td><code>SensorAttributes</code></td><td><code>value<br/>min<br/>max<br/>normalizedValue</code></td></tr>
+
+          <tr><td><code>AVCodecs</code></td><td><code>AVCodecsAttributes</code></td><td><code>audioCodecs<br/>videoCodecs</code></td></tr>
+          <tr><td><code>AudioCodec</code></td><td><code>AudioCodecAttributes</code></td><td><code>compFormat<br/>encode<br/>decode</code></td></tr>
+          <tr><td><code>VideoCodec</code></td><td><code>VideoCodecAttributes</code></td><td><code>compFormats<br/>containerFormats<br/>hwAccel<br/>profiles<br/>frameTypes<br/>rateTypes</code></td></tr>
+          <tr><td><code>Storage</code></td><td><code>StorageUnitAttributes (array)</code></td><td><code></code></td></tr>
+          <tr><td><code>StorageUnit</code></td><td><code>StorageUnitAttributes</code></td><td><code>type<br/>isReadWrite<br/>capacity<br/>availableCapacity<br/>isRemoveable</code></td></tr>
+          <tr><td rowspan="5"><code>OutputDevices</code></td><td><code>OutputDevicesAttributes</code></td><td><code>displayDevices<br/>activeDisplayDevices<br/>printingDevices<br/>activePrintingDevices<br/>brailleDevices<br/>activeBrailleDevices<br/>audioDevices<br/>activeAudioDevices</code></td></tr>
+          <tr><td><code>DisplayDeviceAttributes</code></td><td><code>orientation<br/>brightness<br/>contrast<br/>blanked<br/>dotsPerInchW<br/>dotsPerInchH<br/>physicalWidth<br/>physicalHeight<br/>info</code></td></tr>
+          <tr><td><code>AudioDeviceAttributes</code></td><td><code>type<br/>freqRangeLow<br/>freqRangeHigh<br/>volumeLevel<br/>info</code></td></tr>
+          <tr><td><code>PrintingDeviceAttributes</code></td><td><code>type<br/>resolution<br/>color<br/>info</code></td></tr>
+          <tr><td><code>BrailleDeviceAttributes</code></td><td><code>nbCells<br/>info</code></td></tr>
+          <tr><td rowspan="5"><code>InputDevices</code></td><td><code>InputDevicesAttributes</code></td><td><code>pointingDevices<br/>activePointingDevices<br/>keyboards<br/>activeKeyboards<br/>cameras<br/>activeCameras<br/>microphones<br/>activeMicrophones</code></td></tr>
+          <tr><td><code>PointerAttributes</code></td><td><code>type<br/>supportsMultiTouch<br/>info</code></td></tr>
+          <tr><td><code>KeyboardAttributes</code></td><td><code>type<br/>isHardware<br/>info</code></td></tr>
+          <tr><td><code>CameraAttributes</code></td><td><code>supportsVideo<br/>hasFlash<br/>sensorPixels<br/>maxZoomFactor</code></td></tr>
+          <tr><td><code>MicrophoneAttributes</code></td><td><code>type<br/>freqRangeLow<br/>freqRangeHigh<br/>info</code></td></tr>
+        </tbody>
+      </table>
+
+    </section>
  
     <!--************************************* Acks ***************************************************-->
     <section class='appendix'>
Received on Thursday, 27 May 2010 11:53:13 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Thursday, 27 May 2010 11:53:14 GMT