otapi: document additional property in org.freesmartphone.GSM.Network.{Get}Status()
authorMichael 'Mickey' Lauer <mickey@vanille-media.de>
Tue, 25 Nov 2008 18:07:41 +0000 (19:07 +0100)
committerMichael 'Mickey' Lauer <mickey@vanille-media.de>
Tue, 25 Nov 2008 18:07:41 +0000 (19:07 +0100)
html/org.freesmartphone.GSM.Network.html
otapi/org.freesmartphone.GSM.Network.xml.in

index ba77ecf..112a0f1 100644 (file)
@@ -43,7 +43,7 @@
 <h1>Methods</h1><h3><a name="Register">Register</a> ( )</h3><p><i>Description:</i> Register with any available service provider. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=0, see 3GPP TS 07.07 Chapter 7.3.</p></div></p>
 <h3><a name="Unregister">Unregister</a> ( )</h3><p><i>Description:</i> Unregister from service provider. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=2, see 3GPP TS 07.07 Chapter 7.3.</p></div></p>
 <h3><a name="GetStatus">GetStatus</a> ( ) &rarr; a{sv}</h3>
-<p><i>Description:</i> Get Network Status. </p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CREG? (see 3GPP TS 07.07 Chapter 7.3),</li>  <li>+COPS? (see 3GPP TS 07.07 Chapter 7.4),</li>  <li>+CSQ (see 3GPP TS 07.07 Chapter 8.5).</li>  </ul></p></div></p><h4>Returns</h4><i>a{sv}: status</i><p>Network status information. Mandatory tuples are:  <ul>  <li>( "registration", string ):  <ul> The registration status. Expected values are:  <li>"unregistered" = not registered, not trying,</li>  <li>"home" = registered to home network,</li>  <li>"busy" = not registered, but currently trying,</li>  <li>"denied" = no permitted network available,</li>  <li>"unknown" = no idea,</li>  <li>"roaming" = registered to foreign network.</li>  </ul></li>  <li>( "mode", string ):  <ul>  The registration mode. Expected values are:  <li>"automatic" = automatic selection,</li>  <li>"manual" = manual selection,</li>  <li>"manual;automatic" = manual first, then automatic,</li>  <li>"unknown" = unknown.</li>  </ul></li>  </ul>  Optional tuples are:  <ul>  <li>( "provider", string ): The network provider (if registered or roaming).</li>  <li>( "strength", int ): The signal strength in percentage (0-100).</li>  <li>( "lac", string ): The location area code string (if available).</li>  <li>( "cid", string ): The cell id string (if available).</li>  </ul></p>
+<p><i>Description:</i> Get Network Status. </p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CREG? (see 3GPP TS 07.07 Chapter 7.3),</li>  <li>+COPS? (see 3GPP TS 07.07 Chapter 7.4),</li>  <li>+CSQ (see 3GPP TS 07.07 Chapter 8.5).</li>  </ul></p></div></p><h4>Returns</h4><i>a{sv}: status</i><p>Network status information. Mandatory tuples are:  <ul>  <li>( "registration", string ):  <ul> The registration status. Expected values are:  <li>"unregistered" = not registered, not trying,</li>  <li>"home" = registered to home network,</li>  <li>"busy" = not registered, but currently trying,</li>  <li>"denied" = no permitted network available,</li>  <li>"unknown" = no idea,</li>  <li>"roaming" = registered to foreign network.</li>  </ul></li>  <li>( "mode", string ):  <ul>  The registration mode. Expected values are:  <li>"automatic" = automatic selection,</li>  <li>"manual" = manual selection,</li>  <li>"manual;automatic" = manual first, then automatic,</li>  <li>"unknown" = unknown.</li>  </ul></li>  </ul>  Optional tuples are:  <ul>  <li>( "provider", string ): The network provider (if registered or roaming).</li>  <li>( "code", int ): MCC and MNC of the network provider (if registered or roaming).</li>  <li>( "strength", int ): The signal strength in percentage (0-100).</li>  <li>( "lac", string ): The location area code string (if available).</li>  <li>( "cid", string ): The cell id string (if available).</li>  </ul></p>
 <h3><a name="GetSignalStrength">GetSignalStrength</a> ( ) &rarr; i</h3>
 <p><i>Description:</i> Query the current signal strength, if registered with a service provider. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSQ, see 3GPP TS 07.07 Chapter 8.5.</p></div></p><h4>Returns</h4><i>i: signal_strength</i><p>The signal strength in percent (0-100).</p>
 <h3><a name="ListProviders">ListProviders</a> ( ) &rarr; a(isss)</h3>
index 176e699..1b79c98 100644 (file)
@@ -3,7 +3,7 @@
 
 <doc:doc>
   <doc:summary>freesmartphone.org GSM Network Interface</doc:summary>
-  <doc:version>0.8.9</doc:version>
+  <doc:version>0.8.9.1</doc:version>
 </doc:doc>
 
 <interface name="org.freesmartphone.GSM.Network">
           Optional tuples are:
           [ul]
             [li]( "provider", string ): The network provider (if registered or roaming).[/li]
+            [li]( "code", int ): MCC and MNC of the network provider (if registered or roaming).[/li]
             [li]( "strength", int ): The signal strength in percentage (0-100).[/li]
             [li]( "lac", string ): The location area code string (if available).[/li]
             [li]( "cid", string ): The cell id string (if available).[/li]