| 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 MUX 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.MUX</h1><h2>Description</h2> |
|---|
| 13 | <p>The MUX interface is used to request virtual serial channels (implemented through pseudo TTYs) which are multiplexed to one serial line as described in 3GPP TS 07.10. It also allows to control modem power and reset handling.</p> |
|---|
| 14 | <h2>Namespace</h2> |
|---|
| 15 | <p><tt>org.freesmartphone.GSM.MUX</tt></p> |
|---|
| 16 | <h2>Methods</h2><ul> |
|---|
| 17 | <li><a href="#SetPower">SetPower</a></li> |
|---|
| 18 | <li><a href="#GetPower">GetPower</a></li> |
|---|
| 19 | <li><a href="#Reset">Reset</a></li> |
|---|
| 20 | <li><a href="#AllocChannel">AllocChannel</a></li> |
|---|
| 21 | </ul> |
|---|
| 22 | <h2>Signals</h2><i>None</i> |
|---|
| 23 | <h2>Errors</h2><i>None</i> |
|---|
| 24 | <h1>Methods</h1><h3><a name="SetPower">SetPower</a> ( sb )</h3> |
|---|
| 25 | <p><i>Description:</i> Set modem power.</p><h4>Parameters</h4><i>s: origin</i><p></p><i>b: on</i><p>True, to turn power on. False, otherwise.</p> |
|---|
| 26 | <h3><a name="GetPower">GetPower</a> ( s ) → b</h3> |
|---|
| 27 | <p><i>Description:</i> Retrieve modem power status.</p><h4>Parameters</h4><i>s: origin</i><p></p><h4>Returns</h4><i>b: on</i><p>True, if the modem is powered on. False, otherwise.</p> |
|---|
| 28 | <h3><a name="Reset">Reset</a> ( s )</h3> |
|---|
| 29 | <p><i>Description:</i> Reset the modem.</p><h4>Parameters</h4><i>s: origin</i><p></p> |
|---|
| 30 | <h3><a name="AllocChannel">AllocChannel</a> ( s ) → s</h3> |
|---|
| 31 | <p><i>Description:</i> Allocate a new virtual channel.</p><h4>Parameters</h4><i>s: origin</i><p>For now, the origin will be used for logging only. you will see which channels are closed not only by number but with an explaining name like 'ppp'. future use may be to allocate a special channel because some modems allow some operations on specific channels only.</p><h4>Returns</h4><i>s: channel</i><p>UNIX path to the pseudo serial device.</p> |
|---|
| 32 | |
|---|
| 33 | <hr/> |
|---|
| 34 | <small> |
|---|
| 35 | | 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 |
|---|
| 36 | </small> |
|---|
| 37 | <hr/> |
|---|
| 38 | </body> |
|---|
| 39 | </html> |
|---|
| 40 | |
|---|
