Warning: Can't synchronize with repository "(default)" (No changeset 96d22ec3fa3ef6de3ea8dc0d7d398adc9aa071cf in the repository). Look in the Trac log for more information.

source: Dbus API specifications/html/org.freesmartphone.GSM.Device.html @ 089682b

Revision 089682b, 4.9 KB checked in by Michael 'Mickey' Lauer <mickey@…>, 5 years ago (diff)

otapi: add missing descriptions and mention org.freesmartphone.GSM.AuthFailed?
being possibly raised for org.freesmartphone.GSM.Device.SetAntennaPower?()
  • Property mode set to 100644
Line 
1
2<!-- Warning: This file has been autogenerated by tools/makedoc.py. Manual edits will be overwritten. -->
3<html>
4    <head>
5        <title>freesmartphone.org GSM Device Interface</title>
6        <link rel="stylesheet" type="text/css" href="http://git.freesmartphone.org/?p=specs.git;a=blob_plain;f=html/style.css;hb=HEAD" />
7    </head>
8    <body>
9    <div class="topbox">freesmartphone.org Framework DBus Interface Specification</div>
10
11
12<h1>org.freesmartphone.GSM.Device</h1><h2>Description</h2>
13<p>The Device interface is used to give information about the GSM device  and its capabilities. Use it also to enable or disable the RF  subsystem (which is mandatory for implementing a flight mode).</p>
14<h2>Namespace</h2>
15<p><tt>org.freesmartphone.GSM.Device</tt></p>
16<h2>Methods</h2><ul>
17<li><a href="#GetInfo">GetInfo</a></li>
18<li><a href="#GetAntennaPower">GetAntennaPower</a></li>
19<li><a href="#SetAntennaPower">SetAntennaPower</a></li>
20<li><a href="#GetFeatures">GetFeatures</a></li>
21<li><a href="#GetSimBuffersSms">GetSimBuffersSms</a></li>
22<li><a href="#SetSimBuffersSms">SetSimBuffersSms</a></li>
23</ul>
24<h2>Signals</h2><i>None</i>
25<h2>Errors</h2><ul>
26<li><a href="#NotPresent">NotPresent</a></li>
27<li><a href="#Timeout">Timeout</a></li>
28<li><a href="#Failed">Failed</a></li>
29</ul>
30<h1>Methods</h1><h3><a name="GetInfo">GetInfo</a> ( ) &rarr; a{sv}</h3>
31<p><i>Description:</i> Get information about the GSM device.</p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CGMI (see 3GPP TS 07.07 Chapter 5.1),</li>  <li>+CGMM (see 3GPP TS 07.07 Chapter 5.2),</li>  <li>+CGMR (see 3GPP TS 07.07 Chapter 5.3),</li>  <li>+CGSN (see 3GPP TS 07.07 Chapter 5.4).</li>  </ul></p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about this GSM device. Mandatory tuples are:  <ul>  <li>( "manufacturer", string ),</li>  <li>( "model", string ).</li>  </ul>  Optional tuples are:  <ul>  <li>( "revision", string ),</li>  <li>( "serial", string ).</li>  </ul></p>
32<h3><a name="GetAntennaPower">GetAntennaPower</a> ( ) &rarr; b</h3>
33<p><i>Description:</i> Retrieve antenna power status from the device.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CFUN=?, see 3GPP TS 07.07 Chapter 8.2.</p></div></p><h4>Returns</h4><i>b: antenna_power</i><p>True, when the antenna is powered on. False, otherwise.</p>
34<h3><a name="SetAntennaPower">SetAntennaPower</a> ( b )</h3>
35<p><i>Description:</i> Set antenna power status for this device. Will raise org.freesmartphone.GSM.SIM.AuthFailed, if the SIM is protected with an authentication code.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CFUN=(antenna_power), see 3GPP TS 07.07 Chapter 8.2</p></div></p><h4>Parameters</h4><i>b: antenna_power</i><p>True, for powering on the antenna. False, otherwise.</p>
36<h3><a name="GetFeatures">GetFeatures</a> ( ) &rarr; a{sv}</h3>
37<p><i>Description:</i> Get information about the telephony features supported by this device.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +GCAP, see 3GPP TS 07.07 Chapter 5.8.</p></div></p><h4>Returns</h4><i>a{sv}: features</i><p>The telephony features supported by this device. Expected tuples are:  <ul>  <li>("GSM", string),</li>  <li>("FAX", string),</li>  <li>("WS", string),</li>  <li>("GPRS", string).</li>  </ul></p>
38<h3><a name="GetSimBuffersSms">GetSimBuffersSms</a> ( ) &rarr; b</h3>
39<p><i>Description:</i> Retrieve whether incoming SMS are buffered on the SIM (in which case  org.freesmartphone.GSM.SIM.IncomingStoredMessage is sent) or sent directly via  the org.freesmartphone.GSM.SIM.IncomingMessage signal).</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CNMI?, see 3GPP TS 07.05 Chapter 3.4.1</p></div></p><h4>Returns</h4><i>b: sim_buffers_sms</i><p>True, if incoming SMS are buffered on the SIM. False, otherwise.</p>
40<h3><a name="SetSimBuffersSms">SetSimBuffersSms</a> ( b )</h3>
41<p><i>Description:</i> Set whether incoming SMS should be buffered on the SIM (in which case  org.freesmartphone.GSM.SIM.IncomingStoredMessage is sent) or sent directly via  the org.freesmartphone.GSM.SIM.IncomingMessage signal).</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CNMI=..., see 3GPP TS 07.05 Chapter 3.4.1</p></div></p><h4>Parameters</h4><i>b: sim_buffers_sms</i><p>True, if incoming SMS should be buffered on the SIM. False, otherwise.</p>
42<h1>Errors</h1><h3><a name="NotPresent">NotPresent</a></h3><p><i>Description:</i> Raised, when the device is not present.</p>
43<h3><a name="Timeout">Timeout</a></h3><p><i>Description:</i> Raised, when the device does not answer within the specified time for this operation.</p>
44<h3><a name="Failed">Failed</a></h3><p><i>Description:</i> Raised, when the device reported an unrecoverable error.</p>
45
46    <hr/>
47    <small>
48    | Specified 2008 by the <a href="http://www.freesmartphone.org">Freesmartphone.org</a> team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org
49    </small>
50    <hr/>
51    </body>
52</html>
53
Note: See TracBrowser for help on using the repository browser.