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

Changeset 41a0c40 in Dbus API specifications


Ignore:
Timestamp:
11/14/08 01:41:20 (5 years ago)
Author:
Michael 'Mickey' Lauer <mickey@…>
Branches:
820cacfd324a623a04b3e22f319e9220819d6ec4, 0.11, 675acad2f1510526a93c9777d03664766c823aab, morphis/pending, morphis/sms-rework
Children:
8c2342b
Parents:
39476e4
git-author:
Michael 'Mickey' Lauer <mickey@…> (11/14/08 01:41:20)
git-committer:
Michael 'Mickey' Lauer <mickey@…> (11/14/08 01:41:20)
Message:

regenerate everything as per tools update

Location:
html
Files:
24 edited

Legend:

Unmodified
Added
Removed

  • html/org.freesmartphone.Device.Audio.html

    rbd52e25 r41a0c40  
    3131<h2>Errors</h2><i>None</i> 
    3232<h1>Methods</h1><h3><a name="GetInfo">GetInfo</a> ( ) &rarr; a{sv}</h3> 
    33 <p><i>Description:</i> Returns information about the audio hardware.</p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the audio hardware. Expected tuples:  <ul>  <li>...to be defined...</li>  </ul></p> 
     33<p><i>Description:</i> Returns information about the audio hardware. </p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the audio hardware. Expected tuples:  <ul>  <li>...to be defined...</li>  </ul></p> 
    3434<h3><a name="GetSupportedFormats">GetSupportedFormats</a> ( ) &rarr; as</h3> 
    35 <p><i>Description:</i> Returns a list of supported audio formats given by extension.</p><h4>Returns</h4><i>as: formats</i><p>The supported audio formats.</p> 
     35<p><i>Description:</i> Returns a list of supported audio formats given by extension. </p><h4>Returns</h4><i>as: formats</i><p>The supported audio formats.</p> 
    3636<h3><a name="GetAvailableScenarios">GetAvailableScenarios</a> ( ) &rarr; as</h3> 
    37 <p><i>Description:</i> Returns a list of supported audio scenarios.</p><h4>Returns</h4><i>as: scenarios</i><p>The supported audio scenarios.</p> 
     37<p><i>Description:</i> Returns a list of supported audio scenarios. </p><h4>Returns</h4><i>as: scenarios</i><p>The supported audio scenarios.</p> 
    3838<h3><a name="PlaySound">PlaySound</a> ( s )</h3> 
    39 <p><i>Description:</i> Play a sound resource.</p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> 
     39<p><i>Description:</i> Play a sound resource. </p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> 
    4040<h3><a name="StopSound">StopSound</a> ( s )</h3> 
    41 <p><i>Description:</i> Stop playing a sound resource.</p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> 
    42 <h3><a name="StopAllSounds">StopAllSounds</a> ( )</h3><p><i>Description:</i> Stop all currently played sound resources.</p> 
     41<p><i>Description:</i> Stop playing a sound resource. </p><h4>Parameters</h4><i>s: id</i><p>The identification of the sound resource. Will be treated as filename, if no schema is given.</p> 
     42<h3><a name="StopAllSounds">StopAllSounds</a> ( )</h3><p><i>Description:</i> Stop all currently played sound resources. </p> 
    4343<h3><a name="GetScenario">GetScenario</a> ( ) &rarr; s</h3> 
    44 <p><i>Description:</i> Get the current audio scenario.</p><h4>Returns</h4><i>s: scenario</i><p>The name of the scenario.</p> 
     44<p><i>Description:</i> Get the current audio scenario. </p><h4>Returns</h4><i>s: scenario</i><p>The name of the scenario.</p> 
    4545<h3><a name="SetScenario">SetScenario</a> ( s )</h3> 
    46 <p><i>Description:</i> Set a new audio scenario.</p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> 
     46<p><i>Description:</i> Set a new audio scenario. </p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> 
    4747<h3><a name="PushScenario">PushScenario</a> ( s )</h3> 
    48 <p><i>Description:</i> Set a new audio scenario and push the previous one on the stack.</p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> 
     48<p><i>Description:</i> Set a new audio scenario and push the previous one on the stack. </p><h4>Parameters</h4><i>s: scenario</i><p>The name of the scenario.</p> 
    4949<h3><a name="PullScenario">PullScenario</a> ( ) &rarr; s</h3> 
    50 <p><i>Description:</i> Set the previously active audio scenario.</p><h4>Returns</h4><i>s: scenario</i><p>The current scenario.</p> 
    51 <h1>Signals</h1><h3><h3><a name="SoundStatus">SoundStatus</a> ( ssa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system,  no matter whether this is an incoming, active, held, or released call.</p><h4>Parameters</h4><i>s: id</i><p>The identification of sound resource that changed its status.</p><i>s: status</i><p>The new status for the sound resource.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional. Expected tuples are:  <ul>  <li>...to be defined...</li>  </ul></p></h3> 
     50<p><i>Description:</i> Set the previously active audio scenario. </p><h4>Returns</h4><i>s: scenario</i><p>The current scenario.</p> 
     51<h1>Signals</h1><h3><h3><a name="SoundStatus">SoundStatus</a> ( ssa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system,  no matter whether this is an incoming, active, held, or released call. </p><h4>Parameters</h4><i>s: id</i><p>The identification of sound resource that changed its status.</p><i>s: status</i><p>The new status for the sound resource.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional. Expected tuples are:  <ul>  <li>...to be defined...</li>  </ul></p></h3> 
    5252 
    5353    <hr/> 

  • html/org.freesmartphone.Device.Display.html

    rc46e113 r41a0c40  
    2424<h2>Errors</h2><i>None</i> 
    2525<h1>Methods</h1><h3><a name="GetInfo">GetInfo</a> ( ) &rarr; a{sv}</h3> 
    26 <p><i>Description:</i> Retrieve information about the display.</p><h4>Returns</h4><i>a{sv}: properties</i><p>The properties of the display. Expected values are:  <ul>  <li>... to be defined ...</li>  </ul></p> 
     26<p><i>Description:</i> Retrieve information about the display. </p><h4>Returns</h4><i>a{sv}: properties</i><p>The properties of the display. Expected values are:  <ul>  <li>... to be defined ...</li>  </ul></p> 
    2727<h3><a name="GetBrightness">GetBrightness</a> ( ) &rarr; i</h3> 
    28 <p><i>Description:</i> Get the current brightness level.</p><h4>Returns</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
     28<p><i>Description:</i> Get the current brightness level. </p><h4>Returns</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
    2929<h3><a name="SetBrightness">SetBrightness</a> ( i )</h3> 
    30 <p><i>Description:</i> Set the brightness level.</p><p><div class="rationale"><p>A brightness level of 0 does not necessarily mean that the backlight power is off.</p></div></p><h4>Parameters</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
     30<p><i>Description:</i> Set the brightness level. </p><p><div class="rationale"><p>A brightness level of 0 does not necessarily mean that the backlight power is off.</p></div></p><h4>Parameters</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
    3131<h3><a name="GetBacklightPower">GetBacklightPower</a> ( ) &rarr; b</h3> 
    32 <p><i>Description:</i> Get whether the backlight is powered or not.</p><h4>Returns</h4><i>b: power</i><p>True, if the backlight is powered. False, otherwise.</p> 
     32<p><i>Description:</i> Get whether the backlight is powered or not. </p><h4>Returns</h4><i>b: power</i><p>True, if the backlight is powered. False, otherwise.</p> 
    3333<h3><a name="SetBacklightPower">SetBacklightPower</a> ( b )</h3> 
    34 <p><i>Description:</i> Set whether the backlight should be powered or not.</p><h4>Parameters</h4><i>b: power</i><p>True, if the backlight should be powered. False, otherwise.</p> 
     34<p><i>Description:</i> Set whether the backlight should be powered or not. </p><h4>Parameters</h4><i>b: power</i><p>True, if the backlight should be powered. False, otherwise.</p> 
    3535 
    3636    <hr/> 

  • html/org.freesmartphone.Device.IdleNotifier.html

    rb3f4728 r41a0c40  
    2525<h2>Errors</h2><i>None</i> 
    2626<h1>Methods</h1><h3><a name="GetState">GetState</a> ( ) &rarr; s</h3> 
    27 <p><i>Description:</i> Get the current idleness status.</p><h4>Returns</h4><i>s: status</i><p>The idleness status. Expected values are:  <ul>  <li>"busy"</li>  <li>"idle"</li>  <li>"idle_dim"</li>  <li>"idle_prelock"</li>  <li>"lock"</li>  <li>"suspend"</li>  <li>"awake"</li>  </ul></p> 
     27<p><i>Description:</i> Get the current idleness status. </p><h4>Returns</h4><i>s: status</i><p>The idleness status. Expected values are:  <ul>  <li>"busy"</li>  <li>"idle"</li>  <li>"idle_dim"</li>  <li>"idle_prelock"</li>  <li>"lock"</li>  <li>"suspend"</li>  <li>"awake"</li>  </ul></p> 
    2828<h3><a name="GetTimeouts">GetTimeouts</a> ( ) &rarr; a{si}</h3> 
    29 <p><i>Description:</i> Gets a list of all the idle states and their correspondent timeouts.</p><h4>Returns</h4><i>a{si}: status</i><p>The list of the idle states, and their correspondent timeouts.</p> 
     29<p><i>Description:</i> Gets a list of all the idle states and their correspondent timeouts. </p><h4>Returns</h4><i>a{si}: status</i><p>The list of the idle states, and their correspondent timeouts.</p> 
    3030<h3><a name="SetTimeout">SetTimeout</a> ( si )</h3> 
    31 <p><i>Description:</i> Sets a timeout value for a given state.</p><h4>Parameters</h4><i>s: state</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for valid values.</p><i>i: timeout</i><p>The timeout value. Set it to -1 to disable the state.</p> 
     31<p><i>Description:</i> Sets a timeout value for a given state. </p><h4>Parameters</h4><i>s: state</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for valid values.</p><i>i: timeout</i><p>The timeout value. Set it to -1 to disable the state.</p> 
    3232<h3><a name="SetState">SetState</a> ( s )</h3> 
    33 <p><i>Description:</i> Forces a new idleness status.</p><h4>Parameters</h4><i>s: status</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for valid values.</p> 
    34 <h1>Signals</h1><h3><h3><a name="State">State</a> ( s )</h3><p><i>Description:</i> Sent, when the idleness status has changed.</p><h4>Parameters</h4><i>s: status</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for expected values.</p></h3> 
     33<p><i>Description:</i> Forces a new idleness status. </p><h4>Parameters</h4><i>s: status</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for valid values.</p> 
     34<h1>Signals</h1><h3><h3><a name="State">State</a> ( s )</h3><p><i>Description:</i> Sent, when the idleness status has changed. </p><h4>Parameters</h4><i>s: status</i><p>The idle status. See org.freesmartphone.Device.IdleNotifier.GetState for expected values.</p></h3> 
    3535 
    3636    <hr/> 

  • html/org.freesmartphone.Device.Input.html

    r17446dc r41a0c40  
    1919</ul> 
    2020<h2>Errors</h2><i>None</i> 
    21 <h1>Signals</h1><h3><h3><a name="Event">Event</a> ( ssi )</h3><p><i>Description:</i> Sent, when an input event occurs.</p><h4>Parameters</h4><i>s: name</i><p>The name of the event source.</p><i>s: action</i><p>The action that triggered the event. Expected values are:  <ul>  <li>"pressed"</li>  <li>"held" (only for selected event sources)</li>  <li>"released"</li>  </ul></p><i>i: seconds</i><p>The duration for the event. Only valid for the "held" and the "released" action.</p></h3> 
     21<h1>Signals</h1><h3><h3><a name="Event">Event</a> ( ssi )</h3><p><i>Description:</i> Sent, when an input event occurs. </p><h4>Parameters</h4><i>s: name</i><p>The name of the event source.</p><i>s: action</i><p>The action that triggered the event. Expected values are:  <ul>  <li>"pressed"</li>  <li>"held" (only for selected event sources)</li>  <li>"released"</li>  </ul></p><i>i: seconds</i><p>The duration for the event. Only valid for the "held" and the "released" action.</p></h3> 
    2222 
    2323    <hr/> 

  • html/org.freesmartphone.Device.LED.html

    rc46e113 r41a0c40  
    2121<h2>Errors</h2><i>None</i> 
    2222<h1>Methods</h1><h3><a name="SetBrightness">SetBrightness</a> ( i )</h3> 
    23 <p><i>Description:</i> Set the brightness level.</p><h4>Parameters</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
     23<p><i>Description:</i> Set the brightness level. </p><h4>Parameters</h4><i>i: brightness</i><p>The brightness level in percent (0-100).</p> 
    2424<h3><a name="SetBlinking">SetBlinking</a> ( ii )</h3> 
    25 <p><i>Description:</i> Start blinking.</p><h4>Parameters</h4><i>i: on_duration</i><p>Duration of being lit in milliseconds.</p><i>i: off_duration</i><p>Duration of being unlit in milliseconds.</p> 
     25<p><i>Description:</i> Start blinking. </p><h4>Parameters</h4><i>i: on_duration</i><p>Duration of being lit in milliseconds.</p><i>i: off_duration</i><p>Duration of being unlit in milliseconds.</p> 
    2626 
    2727    <hr/> 

  • html/org.freesmartphone.Device.PowerControl.html

    rc46e113 r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<h1>Methods</h1><h3><a name="GetPower">GetPower</a> ( ) &rarr; b</h3> 
    25 <p><i>Description:</i> Get the power status.</p><h4>Returns</h4><i>b: on</i><p>True, if the device is powered on. False, otherwise.</p> 
     25<p><i>Description:</i> Get the power status. </p><h4>Returns</h4><i>b: on</i><p>True, if the device is powered on. False, otherwise.</p> 
    2626<h3><a name="SetPower">SetPower</a> ( b )</h3> 
    27 <p><i>Description:</i> Power the device on or turn the device off.</p><h4>Parameters</h4><i>b: on</i><p>True, if the device should be turned on. False, otherwise.</p> 
    28 <h1>Signals</h1><h3><h3><a name="Power">Power</a> ( b )</h3><p><i>Description:</i> Sent, when the device has changed power status.</p><h4>Parameters</h4><i>b: on</i><p>True, if the device is now powered on. False, otherwise.</p></h3> 
     27<p><i>Description:</i> Power the device on or turn the device off. </p><h4>Parameters</h4><i>b: on</i><p>True, if the device should be turned on. False, otherwise.</p> 
     28<h1>Signals</h1><h3><h3><a name="Power">Power</a> ( b )</h3><p><i>Description:</i> Sent, when the device has changed power status. </p><h4>Parameters</h4><i>b: on</i><p>True, if the device is now powered on. False, otherwise.</p></h3> 
    2929 
    3030    <hr/> 

  • html/org.freesmartphone.Device.PowerSupply.html

    rc33ac41 r41a0c40  
    2525<h2>Errors</h2><i>None</i> 
    2626<h1>Methods</h1><h3><a name="GetInfo">GetInfo</a> ( ) &rarr; a{sv}</h3> 
    27 <p><i>Description:</i> Retrieve information about the power supply.</p><h4>Returns</h4><i>a{sv}: properties</i><p>The properties of the power supply. Expected tuples are:  <ul>  <li>...to be defined ...</li>  </ul></p> 
     27<p><i>Description:</i> Retrieve information about the power supply. </p><h4>Returns</h4><i>a{sv}: properties</i><p>The properties of the power supply. Expected tuples are:  <ul>  <li>...to be defined ...</li>  </ul></p> 
    2828<h3><a name="GetCapacity">GetCapacity</a> ( ) &rarr; i</h3> 
    29 <p><i>Description:</i> Retrieve the capacity of this power supply.</p><p><div class="rationale"><p>A wall power supply will always return 100.</p></div></p><h4>Returns</h4><i>i: energy</i><p>The capacity in percent (0-100).</p> 
     29<p><i>Description:</i> Retrieve the capacity of this power supply. </p><p><div class="rationale"><p>A wall power supply will always return 100.</p></div></p><h4>Returns</h4><i>i: energy</i><p>The capacity in percent (0-100).</p> 
    3030<h3><a name="GetPowerStatus">GetPowerStatus</a> ( ) &rarr; s</h3> 
    31 <p><i>Description:</i> Retrieve the power status for this power supply.</p><p><div class="rationale"><p>A wall power supply will always return "full".</p></div></p><h4>Returns</h4><i>s: status</i><p>The power status. Expected values are:  <ul>  <li>"charging"</li>  <li>"discharging"</li>  <li>"full"</li>  <li>"empty"</li>  <li>"critical"</li>  </ul></p> 
    32 <h1>Signals</h1><h3><h3><a name="PowerStatus">PowerStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the power status changes significantly.</p><h4>Parameters</h4><i>s: status</i><p>The power status. See 'GetPowerStatus' for expected values.</p></h3> 
    33 <h3><h3><a name="Capacity">Capacity</a> ( s )</h3><p><i>Description:</i> Sent, when the capacity changes.</p><h4>Parameters</h4><i>s: status</i><p>The capacity in percent (0-100).</p></h3> 
     31<p><i>Description:</i> Retrieve the power status for this power supply. </p><p><div class="rationale"><p>A wall power supply will always return "full".</p></div></p><h4>Returns</h4><i>s: status</i><p>The power status. Expected values are:  <ul>  <li>"charging"</li>  <li>"discharging"</li>  <li>"full"</li>  <li>"empty"</li>  <li>"critical"</li>  </ul></p> 
     32<h1>Signals</h1><h3><h3><a name="PowerStatus">PowerStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the power status changes significantly. </p><h4>Parameters</h4><i>s: status</i><p>The power status. See 'GetPowerStatus' for expected values.</p></h3> 
     33<h3><h3><a name="Capacity">Capacity</a> ( s )</h3><p><i>Description:</i> Sent, when the capacity changes. </p><h4>Parameters</h4><i>s: status</i><p>The capacity in percent (0-100).</p></h3> 
    3434 
    3535    <hr/> 

  • html/org.freesmartphone.Device.RealtimeClock.html

    rc46e113 r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<h1>Methods</h1><h3><a name="GetCurrentTime">GetCurrentTime</a> ( ) &rarr; i</h3> 
    25 <p><i>Description:</i> Retrieve the current time from the RTC.</p><h4>Returns</h4><i>i: time</i><p>The current time in seconds since epoch.</p> 
     25<p><i>Description:</i> Retrieve the current time from the RTC. </p><h4>Returns</h4><i>i: time</i><p>The current time in seconds since epoch.</p> 
    2626<h3><a name="SetCurrentTime">SetCurrentTime</a> ( i )</h3> 
    27 <p><i>Description:</i> Set the current time in the RTC.</p><h4>Parameters</h4><i>i: time</i><p>The current time in seconds since epoch.</p> 
     27<p><i>Description:</i> Set the current time in the RTC. </p><h4>Parameters</h4><i>i: time</i><p>The current time in seconds since epoch.</p> 
    2828<h3><a name="GetWakeupTime">GetWakeupTime</a> ( ) &rarr; i</h3> 
    29 <p><i>Description:</i> Retrieve the currently programmed wakeup time from the RTC..</p><h4>Returns</h4><i>i: time</i><p>The wakeup time in seconds since epoch, if programmed. 0, otherwise.</p> 
     29<p><i>Description:</i> Retrieve the currently programmed wakeup time from the RTC.. </p><h4>Returns</h4><i>i: time</i><p>The wakeup time in seconds since epoch, if programmed. 0, otherwise.</p> 
    3030<h3><a name="SetWakeupTime">SetWakeupTime</a> ( b )</h3> 
    31 <p><i>Description:</i> Program a wakeup time in the RTC.</p><h4>Parameters</h4><i>b: time</i><p>The wakeuptime in seconds since epoch. Set to 0, if you want to disable wakeup.</p> 
     31<p><i>Description:</i> Program a wakeup time in the RTC. </p><h4>Parameters</h4><i>b: time</i><p>The wakeuptime in seconds since epoch. Set to 0, if you want to disable wakeup.</p> 
    3232 
    3333    <hr/> 

  • html/org.freesmartphone.Events.html

    r467ed33 r41a0c40  
    2222<h2>Errors</h2><i>None</i> 
    2323<h1>Methods</h1><h3><a name="AddRule">AddRule</a> ( s )</h3> 
    24 <p><i>Description:</i> Parse a rule string and add it into the rule list.</p><h4>Parameters</h4><i>s: rule</i><p>The rule in the same format used by the rules file.</p> 
     24<p><i>Description:</i> Parse a rule string and add it into the rule list. </p><h4>Parameters</h4><i>s: rule</i><p>The rule in the same format used by the rules file.</p> 
    2525<h3><a name="RemoveRule">RemoveRule</a> ( s )</h3> 
    26 <p><i>Description:</i> Remove a rule by name.</p><h4>Parameters</h4><i>s: name</i><p>The name of the rule, as specified by the 'name' attribute of the rule.</p> 
     26<p><i>Description:</i> Remove a rule by name. </p><h4>Parameters</h4><i>s: name</i><p>The name of the rule, as specified by the 'name' attribute of the rule.</p> 
    2727<h3><a name="TriggerTest">TriggerTest</a> ( sb )</h3> 
    28 <p><i>Description:</i> Trigger or untrigger all the 'Test' triggers with matching names.</p><h4>Parameters</h4><i>s: name</i><p>the name of the Test triggers to trigger/untrigger.</p><i>b: value</i><p>True to trigger, False to untrigger.</p> 
     28<p><i>Description:</i> Trigger or untrigger all the 'Test' triggers with matching names. </p><h4>Parameters</h4><i>s: name</i><p>the name of the Test triggers to trigger/untrigger.</p><i>b: value</i><p>True to trigger, False to untrigger.</p> 
    2929 
    3030    <hr/> 

  • html/org.freesmartphone.GSM.CB.html

    rc46e113 r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<h1>Methods</h1><h3><a name="GetCellBroadcastSubscriptions">GetCellBroadcastSubscriptions</a> ( ) &rarr; s</h3> 
    25 <p><i>Description:</i> Get current cell broadcast subscription channels.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSCB=?, see 3GPP TS 07.05 Chapter 3.3.4.</p></div></p><h4>Returns</h4><i>s: channels</i><p>The channels you are subscribed to. Simple strings to expect are  "none" and "all". Also valid are compound descriptions of channel lists like  "1,2,3-5,7,234,10-5".</p> 
     25<p><i>Description:</i> Get current cell broadcast subscription channels. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSCB=?, see 3GPP TS 07.05 Chapter 3.3.4.</p></div></p><h4>Returns</h4><i>s: channels</i><p>The channels you are subscribed to. Simple strings to expect are  "none" and "all". Also valid are compound descriptions of channel lists like  "1,2,3-5,7,234,10-5".</p> 
    2626<h3><a name="SetCellBroadcastSubscriptions">SetCellBroadcastSubscriptions</a> ( s )</h3> 
    27 <p><i>Description:</i> Set cell broadcast subscription channels.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSCB=(...), see 3GPP TS 07.05 Chapter 3.3.4.</p></div></p><h4>Parameters</h4><i>s: channels</i><p>The channels you want to subscribe. Valid simple strings are  "none" and "all". Also valid are compound descriptions of channels lists like  "1,2,3-5,7,234,10-5".</p> 
    28 <h1>Signals</h1><h3><h3><a name="IncomingCellBroadcast">IncomingCellBroadcast</a> ( iiiis )</h3><p><i>Description:</i> Sent, when a cell broadcast message has been received.</p><h4>Parameters</h4><i>i: serial</i><p></p><i>i: channel</i><p></p><i>i: encoding</i><p></p><i>i: page</i><p></p><i>s: data</i><p></p></h3> 
     27<p><i>Description:</i> Set cell broadcast subscription channels. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSCB=(...), see 3GPP TS 07.05 Chapter 3.3.4.</p></div></p><h4>Parameters</h4><i>s: channels</i><p>The channels you want to subscribe. Valid simple strings are  "none" and "all". Also valid are compound descriptions of channels lists like  "1,2,3-5,7,234,10-5".</p> 
     28<h1>Signals</h1><h3><h3><a name="IncomingCellBroadcast">IncomingCellBroadcast</a> ( iiiis )</h3><p><i>Description:</i> Sent, when a cell broadcast message has been received. </p><h4>Parameters</h4><i>i: serial</i><p></p><i>i: channel</i><p></p><i>i: encoding</i><p></p><i>i: page</i><p></p><i>s: data</i><p></p></h3> 
    2929 
    3030    <hr/> 

  • html/org.freesmartphone.GSM.Call.html

    r9e6994a r41a0c40  
    3636</ul> 
    3737<h1>Methods</h1><h3><a name="Emergency">Emergency</a> ( s )</h3> 
    38 <p><i>Description:</i> Initiate an emergency call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The emergency number to dial. National and world-wide restrictions apply.</p> 
     38<p><i>Description:</i> Initiate an emergency call. </p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The emergency number to dial. National and world-wide restrictions apply.</p> 
    3939<h3><a name="Activate">Activate</a> ( i )</h3> 
    40 <p><i>Description:</i> Activate a call as single active call. All previously active calls are  put on hold. No difference is made whether this is an incoming  call or a call that has been put on hold.</p><p><div class="rationale"><p>This can map to ATA, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
     40<p><i>Description:</i> Activate a call as single active call. All previously active calls are  put on hold. No difference is made whether this is an incoming  call or a call that has been put on hold. </p><p><div class="rationale"><p>This can map to ATA, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
    4141<h3><a name="ActivateConference">ActivateConference</a> ( i )</h3> 
    42 <p><i>Description:</i> Activate a call in addition to all previously active calls.  No difference is made whether this is an incoming  call or a call that has been put on hold.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
     42<p><i>Description:</i> Activate a call in addition to all previously active calls.  No difference is made whether this is an incoming  call or a call that has been put on hold. </p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
    4343<h3><a name="Release">Release</a> ( i )</h3> 
    44 <p><i>Description:</i> Release a call.</p><p><div class="rationale"><p>This can map to ATH, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12. Some implementations might map it to GSM 07.07 +CHUP=, see 3GPP TS 07.07 Chapter 6.5.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
    45 <h3><a name="HoldActive">HoldActive</a> ( )</h3><p><i>Description:</i> Hold the active call.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=2, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
    46 <h3><a name="Join">Join</a> ( )</h3><p><i>Description:</i> Join all active and held calls and release yourself from the conversation.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=4, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
     44<p><i>Description:</i> Release a call. </p><p><div class="rationale"><p>This can map to ATH, see v.250. It might also map to GSM 07.07 +CHLD=..., see 3GPP TS 07.07 Chapter 7.12. Some implementations might map it to GSM 07.07 +CHUP=, see 3GPP TS 07.07 Chapter 6.5.</p></div></p><h4>Parameters</h4><i>i: id</i><p></p> 
     45<h3><a name="HoldActive">HoldActive</a> ( )</h3><p><i>Description:</i> Hold the active call. </p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=2, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
     46<h3><a name="Join">Join</a> ( )</h3><p><i>Description:</i> Join all active and held calls and release yourself from the conversation. </p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=4, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
    4747<h3><a name="Transfer">Transfer</a> ( s )</h3> 
    48 <p><i>Description:</i> Transfer an incoming or active call to another number.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CCFC=..., see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to transfer the call to.</p> 
    49 <h3><a name="ReleaseHeld">ReleaseHeld</a> ( )</h3><p><i>Description:</i> Release all held calls.</p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
    50 <h3><a name="ReleaseAll">ReleaseAll</a> ( )</h3><p><i>Description:</i> Release all calls, no matter whether active or put on hold.</p><p><div class="rationale"><p>This maps to ATH, see v.250.</p></div></p> 
     48<p><i>Description:</i> Transfer an incoming or active call to another number. </p><p><div class="rationale"><p>This maps to GSM 07.07 +CCFC=..., see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to transfer the call to.</p> 
     49<h3><a name="ReleaseHeld">ReleaseHeld</a> ( )</h3><p><i>Description:</i> Release all held calls. </p><p><div class="rationale"><p>This maps to GSM 07.07 +CHLD=, see 3GPP TS 07.07 Chapter 7.12.</p></div></p> 
     50<h3><a name="ReleaseAll">ReleaseAll</a> ( )</h3><p><i>Description:</i> Release all calls, no matter whether active or put on hold. </p><p><div class="rationale"><p>This maps to ATH, see v.250.</p></div></p> 
    5151<h3><a name="Initiate">Initiate</a> ( ss ) &rarr; i</h3> 
    52 <p><i>Description:</i> Initiate an outgoing call.</p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to call.</p><i>s: type</i><p>The type of call to made. Valid values are:  <ul>  <li>"voice" - a GSM voice call,</li>  <li>"data" - a GSM data call,</li>  <li>"fax" - a FAX call.</li>  </ul></p><h4>Returns</h4><i>i: id</i><p>The reference id for this call. It will get assigned by the system.</p> 
     52<p><i>Description:</i> Initiate an outgoing call. </p><p><div class="rationale"><p>This maps to ATD(number);, see v.250.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The number to call.</p><i>s: type</i><p>The type of call to made. Valid values are:  <ul>  <li>"voice" - a GSM voice call,</li>  <li>"data" - a GSM data call,</li>  <li>"fax" - a FAX call.</li>  </ul></p><h4>Returns</h4><i>i: id</i><p>The reference id for this call. It will get assigned by the system.</p> 
    5353<h3><a name="ListCalls">ListCalls</a> ( ) &rarr; a(isa{sv})</h3> 
    54 <p><i>Description:</i> Retrieve the status for all calls in the system.</p><h4>Returns</h4><i>a(isa{sv}): call_status</i><p>The call status. This is an array containing a call status record for every single call.  For the format description, please see the CallStatus signal.</p> 
     54<p><i>Description:</i> Retrieve the status for all calls in the system. </p><h4>Returns</h4><i>a(isa{sv}): call_status</i><p>The call status. This is an array containing a call status record for every single call.  For the format description, please see the CallStatus signal.</p> 
    5555<h3><a name="SendDtmf">SendDtmf</a> ( s )</h3> 
    56 <p><i>Description:</i> Send one or more Dual Tone Multiple Frequency (DTMF) signals during an active call.</p><p><div class="rationale"><p>This maps to the TIA IS 101 command +VTS=(value), see 3GPP TS 07.07 Chapter C.2.11.  Note: DTMF signals are always sent to all active calls, this is a limitation of the underlying protocols.</p></div></p><h4>Parameters</h4><i>s: tones</i><p>The tones to send. Allowed values are: (0-9,#,*,A-D)</p> 
    57 <h1>Signals</h1><h3><h3><a name="CallStatus">CallStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system,  no matter whether this is an incoming, active, held, or released call.</p><h4>Parameters</h4><i>i: id</i><p>The index of the call that changed its status or properties.</p><i>s: status</i><p>The new status of the call. Expected values are:  <ul>  <li>"incoming" = The call is incoming (but not yet accepted),</li>  <li>"outgoing" = The call is outgoing (but not yet established),</li>  <li>"active" = The call is the active call (you can talk),</li>  <li>"held" = The call is being held,</li>  <li>"release" = The call has been released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that some properties are optional. Mandatory tuples are:  <ul>  <li>( "direction", string ) = "incoming" or "outgoing",</li>  <li>( "peer", string ) = The number of the peer (on incoming calls only if we received a CLIP).</li>  </ul>  Optional tuples include:  <ul>  <li>( "reason", string ) = The reason for the status change (on outgoing calls e.g. 'BUSY' or 'NO CARRIER'),</li>  <li>( "auxstatus", string ) = An auxillary connection status (if your modem supports that),</li>  <li>( "line", string ) = The GSM line (0 or 1) this call is taking place (on modems that support multiple lines).</li>  <ul></p></h3> 
    58 <h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified call is not present.</p> 
    59 <h3><a name="NotAnEmergencyNumber">NotAnEmergencyNumber</a></h3><p><i>Description:</i> Raised, if the number is not allowed to dial as emergency call.</p> 
     56<p><i>Description:</i> Send one or more Dual Tone Multiple Frequency (DTMF) signals during an active call. </p><p><div class="rationale"><p>This maps to the TIA IS 101 command +VTS=(value), see 3GPP TS 07.07 Chapter C.2.11.  Note: DTMF signals are always sent to all active calls, this is a limitation of the underlying protocols.</p></div></p><h4>Parameters</h4><i>s: tones</i><p>The tones to send. Allowed values are: (0-9,#,*,A-D)</p> 
     57<h1>Signals</h1><h3><h3><a name="CallStatus">CallStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a call in the system,  no matter whether this is an incoming, active, held, or released call. </p><h4>Parameters</h4><i>i: id</i><p>The index of the call that changed its status or properties.</p><i>s: status</i><p>The new status of the call. Expected values are:  <ul>  <li>"incoming" = The call is incoming (but not yet accepted),</li>  <li>"outgoing" = The call is outgoing (but not yet established),</li>  <li>"active" = The call is the active call (you can talk),</li>  <li>"held" = The call is being held,</li>  <li>"release" = The call has been released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that some properties are optional. Mandatory tuples are:  <ul>  <li>( "direction", string ) = "incoming" or "outgoing",</li>  <li>( "peer", string ) = The number of the peer (on incoming calls only if we received a CLIP).</li>  </ul>  Optional tuples include:  <ul>  <li>( "reason", string ) = The reason for the status change (on outgoing calls e.g. 'BUSY' or 'NO CARRIER'),</li>  <li>( "auxstatus", string ) = An auxillary connection status (if your modem supports that),</li>  <li>( "line", string ) = The GSM line (0 or 1) this call is taking place (on modems that support multiple lines).</li>  <ul></p></h3> 
     58<h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified call is not present. </p> 
     59<h3><a name="NotAnEmergencyNumber">NotAnEmergencyNumber</a></h3><p><i>Description:</i> Raised, if the number is not allowed to dial as emergency call. </p> 
    6060 
    6161    <hr/> 

  • html/org.freesmartphone.GSM.Device.html

    r089682b r41a0c40  
    2929</ul> 
    3030<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> 
     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> 
    3232<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> 
     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> 
    3434<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> 
     35<p><i>Description:</i> Set antenna power status for this device. Will raise <a href="org.freesmartphone.GSM.SIM.html#AuthFailed">AuthFailed</a> 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> 
    3636<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> 
     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> 
    3838<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> 
     39<p><i>Description:</i> Retrieve whether incoming SMS are buffered on the SIM (in which case  <a href="org.freesmartphone.GSM.SIM.html#IncomingStoredMessage">IncomingStoredMessage</a> is sent) or sent directly via  the <a href="org.freesmartphone.GSM.SIM.html#IncomingMessage">IncomingMessage</a> 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> 
    4040<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> 
     41<p><i>Description:</i> Set whether incoming SMS should be buffered on the SIM (in which case  <a href="org.freesmartphone.GSM.SIM.html#IncomingStoredMessage">IncomingStoredMessage</a> is sent) or sent directly via  the <a href="org.freesmartphone.GSM.SIM.html#IncomingMessage">IncomingMessage</a> 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> 
    4545 
    4646    <hr/> 

  • html/org.freesmartphone.GSM.HZ.html

    rc46e113 r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<h1>Methods</h1><h3><a name="GetKnownHomeZones">GetKnownHomeZones</a> ( ) &rarr; as</h3> 
    25 <p><i>Description:</i> Get the names of known home zones as stored on your SIM card.</p><h4>Returns</h4><i>as: zones</i><p>The home zone names.</p> 
     25<p><i>Description:</i> Get the names of known home zones as stored on your SIM card. </p><h4>Returns</h4><i>as: zones</i><p>The home zone names.</p> 
    2626<h3><a name="GetHomeZoneStatus">GetHomeZoneStatus</a> ( ) &rarr; s</h3> 
    27 <p><i>Description:</i> Get current zone name.</p><h4>Returns</h4><i>s: zone</i><p>The home zone you are currently on. An empty string denotes  that you are out of all home zones. "unknown" indicates that the system  has not processed the necessary data to compute this information.</p> 
    28 <h1>Signals</h1><h3><h3><a name="HomeZoneStatus">HomeZoneStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the home zone status has changed.</p><h4>Parameters</h4><i>s: name</i><p>The home zone you are currently on. See 'GetHomeZoneStatus'.</p></h3> 
     27<p><i>Description:</i> Get current zone name. </p><h4>Returns</h4><i>s: zone</i><p>The home zone you are currently on. An empty string denotes  that you are out of all home zones. "unknown" indicates that the system  has not processed the necessary data to compute this information.</p> 
     28<h1>Signals</h1><h3><h3><a name="HomeZoneStatus">HomeZoneStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the home zone status has changed. </p><h4>Parameters</h4><i>s: name</i><p>The home zone you are currently on. See 'GetHomeZoneStatus'.</p></h3> 
    2929 
    3030    <hr/> 

  • html/org.freesmartphone.GSM.MUX.html

    r9e6994a r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<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> 
     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> 
    2626<h3><a name="GetPower">GetPower</a> ( s ) &rarr; 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> 
     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> 
    2828<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> 
     29<p><i>Description:</i> Reset the modem. </p><h4>Parameters</h4><i>s: origin</i><p></p> 
    3030<h3><a name="AllocChannel">AllocChannel</a> ( s ) &rarr; 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> 
     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> 
    3232 
    3333    <hr/> 

  • html/org.freesmartphone.GSM.Network.html

    rc46e113 r41a0c40  
    4040<li><a href="#NotFound">NotFound</a></li> 
    4141</ul> 
    42 <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> 
    43 <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> 
     42<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> 
     43<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> 
    4444<h3><a name="GetStatus">GetStatus</a> ( ) &rarr; a{sv}</h3> 
    45 <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> 
     45<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> 
    4646<h3><a name="GetSignalStrength">GetSignalStrength</a> ( ) &rarr; i</h3> 
    47 <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> 
     47<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> 
    4848<h3><a name="ListProviders">ListProviders</a> ( ) &rarr; a(isss)</h3> 
    49 <p><i>Description:</i> List available service providers.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=?, see 3GPP TS 07.07 Chapter 7.3.</p></div></p><h4>Returns</h4><i>a(isss): providers</i><p>An array of four-tuples with the following structure:  <ul>  <li>Unique numerical operator code,</li>  <li>Status ("unknown", "available", "current", "forbidden"),</li>  <li>Long Name,</li>  <li>Short Name (optional, may be empty).</li>  </ul></p> 
     49<p><i>Description:</i> List available service providers. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=?, see 3GPP TS 07.07 Chapter 7.3.</p></div></p><h4>Returns</h4><i>a(isss): providers</i><p>An array of four-tuples with the following structure:  <ul>  <li>Unique numerical operator code,</li>  <li>Status ("unknown", "available", "current", "forbidden"),</li>  <li>Long Name,</li>  <li>Short Name (optional, may be empty).</li>  </ul></p> 
    5050<h3><a name="RegisterWithProvider">RegisterWithProvider</a> ( i )</h3> 
    51 <p><i>Description:</i> Register to a dedicated service provider.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=1..., see 3GPP TS 07.07 Chapter 7.3.</p></div></p><h4>Parameters</h4><i>i: operator_code</i><p>The operator code.</p> 
     51<p><i>Description:</i> Register to a dedicated service provider. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS=1..., see 3GPP TS 07.07 Chapter 7.3.</p></div></p><h4>Parameters</h4><i>i: operator_code</i><p>The operator code.</p> 
    5252<h3><a name="GetCountryCode">GetCountryCode</a> ( ) &rarr; s</h3> 
    53 <p><i>Description:</i> Compute the country code of the current service provider.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS?, see 3GPP TS 07.07 Chapter 5.6.  Get the dial code by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>s: dial_code</i><p>The country dial code (including the +).</p> 
     53<p><i>Description:</i> Compute the country code of the current service provider. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +COPS?, see 3GPP TS 07.07 Chapter 5.6.  Get the dial code by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>s: dial_code</i><p>The country dial code (including the +).</p> 
    5454<h3><a name="GetCallForwarding">GetCallForwarding</a> ( ) &rarr; a{sv}</h3> 
    55 <p><i>Description:</i> Get the network call forwarding status.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(reason),2, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Returns</h4><i>a{sv}: status</i><p>A dictionary containing entries for call classes. Expected keywords are:  <ul>  <li>"voice",</li>  <li>"data",</li>  <li>"voice+data",</li>  <li>"fax",</li>  <li>"voice+data+fax".</li>  </ul>  Rarely you might also encounter:  <ul>  <li>"sms",</li>  <li>"dcs",</li>  <li>"dca",</li>  <li>"dpa",</li>  <li>"pad".</li>  </ul>  The value is a three-tuple with the following structure:  <ul>  <li>boolean: Whether the feature is enabled or not,</li>  <li>string: Call forwarding number,</li>  <li>int: Number of seconds after which the call forwarding gets active.</li>  </ul></p> 
     55<p><i>Description:</i> Get the network call forwarding status. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(reason),2, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Returns</h4><i>a{sv}: status</i><p>A dictionary containing entries for call classes. Expected keywords are:  <ul>  <li>"voice",</li>  <li>"data",</li>  <li>"voice+data",</li>  <li>"fax",</li>  <li>"voice+data+fax".</li>  </ul>  Rarely you might also encounter:  <ul>  <li>"sms",</li>  <li>"dcs",</li>  <li>"dca",</li>  <li>"dpa",</li>  <li>"pad".</li>  </ul>  The value is a three-tuple with the following structure:  <ul>  <li>boolean: Whether the feature is enabled or not,</li>  <li>string: Call forwarding number,</li>  <li>int: Number of seconds after which the call forwarding gets active.</li>  </ul></p> 
    5656<h3><a name="EnableCallForwarding">EnableCallForwarding</a> ( sssi )</h3> 
    57 <p><i>Description:</i> Enable network call forwarding.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(...),3, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: reason</i><p>Reason for which you want to enable network call forwarding. Valid reasons are:  <ul>  <li>"unconditional",</li>  <li>"mobile busy",</li>  <li>"no reply",</li>  <li>"not reachable",</li>  <li>"all",</li>  <li>"all conditional".</li>  </ul></p><i>s: class</i><p>Call class for which you want to enable network call forwarding. See GetCallForwarding for valid classes.</p><i>s: number</i><p>Phone number to which the network call will be forwarded.</p><i>i: timeout</i><p>Number of seconds, after which network call forwarding launches (only for reason "no reply").</p> 
     57<p><i>Description:</i> Enable network call forwarding. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(...),3, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: reason</i><p>Reason for which you want to enable network call forwarding. Valid reasons are:  <ul>  <li>"unconditional",</li>  <li>"mobile busy",</li>  <li>"no reply",</li>  <li>"not reachable",</li>  <li>"all",</li>  <li>"all conditional".</li>  </ul></p><i>s: class</i><p>Call class for which you want to enable network call forwarding. See GetCallForwarding for valid classes.</p><i>s: number</i><p>Phone number to which the network call will be forwarded.</p><i>i: timeout</i><p>Number of seconds, after which network call forwarding launches (only for reason "no reply").</p> 
    5858<h3><a name="DisableCallForwarding">DisableCallForwarding</a> ( ss )</h3> 
    59 <p><i>Description:</i> Disable network call forwarding.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(...),4, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: reason</i><p>Reason for which you want to disable network call forwarding. Valid reasons are:  <ul>  <li>"unconditional",</li>  <li>"mobile busy",</li>  <li>"no reply",</li>  <li>"not reachable",</li>  <li>"all",</li>  <li>"all conditional".</li>  </ul></p><i>s: class</i><p>Call class for which the network call gets forwarded. See GetCallForwarding for valid classes.</p> 
     59<p><i>Description:</i> Disable network call forwarding. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CCFC=(...),4, see 3GPP TS 07.07 Chapter 7.10.</p></div></p><h4>Parameters</h4><i>s: reason</i><p>Reason for which you want to disable network call forwarding. Valid reasons are:  <ul>  <li>"unconditional",</li>  <li>"mobile busy",</li>  <li>"no reply",</li>  <li>"not reachable",</li>  <li>"all",</li>  <li>"all conditional".</li>  </ul></p><i>s: class</i><p>Call class for which the network call gets forwarded. See GetCallForwarding for valid classes.</p> 
    6060<h3><a name="SetCallingIdentification">SetCallingIdentification</a> ( s )</h3> 
    61 <p><i>Description:</i> Set whether your subscriber number is visible during a call.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLIR=(value), see 3GPP TS 07.07 Chapter 7.7.</p></div></p><h4>Parameters</h4><i>s: visible</i><p>One of the following values:  <ul>  <li>"on", if your subscriber number should always be visible to other parties.</li>  <li>"off", if your subscriber number should never be visible to other parties.</li>  <li>"network", if you want to use the network default.</li>  </ul></p> 
     61<p><i>Description:</i> Set whether your subscriber number is visible during a call. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLIR=(value), see 3GPP TS 07.07 Chapter 7.7.</p></div></p><h4>Parameters</h4><i>s: visible</i><p>One of the following values:  <ul>  <li>"on", if your subscriber number should always be visible to other parties.</li>  <li>"off", if your subscriber number should never be visible to other parties.</li>  <li>"network", if you want to use the network default.</li>  </ul></p> 
    6262<h3><a name="GetCallingIdentification">GetCallingIdentification</a> ( ) &rarr; s</h3> 
    63 <p><i>Description:</i> Get whether your subscriber number is visible during a call.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLIR?, see 3GPP TS 07.07 Chapter 7.7.</p></div></p><h4>Returns</h4><i>s: visible</i><p>One of the following values:  <ul>  <li>"on", if your subscriber number is always visible to other parties.</li>  <li>"off", if your subscriber number is never visible to other parties.</li>  <li>"network", if visibility depends on the network settings.</li>  </ul></p> 
     63<p><i>Description:</i> Get whether your subscriber number is visible during a call. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLIR?, see 3GPP TS 07.07 Chapter 7.7.</p></div></p><h4>Returns</h4><i>s: visible</i><p>One of the following values:  <ul>  <li>"on", if your subscriber number is always visible to other parties.</li>  <li>"off", if your subscriber number is never visible to other parties.</li>  <li>"network", if visibility depends on the network settings.</li>  </ul></p> 
    6464<h3><a name="SendUssdRequest">SendUssdRequest</a> ( s )</h3> 
    65 <p><i>Description:</i> Send an Unstructured Supplementary Service Data (USSD) request to the network.</p><p><div class="rationale"><p>This can map to the GSM 07.07 command +CUSD=1,"(request)",(code), see 3GPP TS 07.07 Chapter 7.14.</p></div></p><h4>Parameters</h4><i>s: request</i><p>The request to be sent to the network.</p> 
    66 <h1>Signals</h1><h3><h3><a name="Status">Status</a> ( a{sv} )</h3><p><i>Description:</i> Sent, when the network registration status changes.</p><h4>Parameters</h4><i>a{sv}: status</i><p>The registration status. See method GetStatus for expected values.</p></h3> 
    67 <h3><h3><a name="SignalStrength">SignalStrength</a> ( i )</h3><p><i>Description:</i> (OPTIONAL) Sent, when registered with a service provider and the network signal strength changes.</p><h4>Parameters</h4><i>i: signal_strength</i><p>The signal strength in percent (0-100).</p></h3> 
    68 <h3><h3><a name="IncomingUssd">IncomingUssd</a> ( ss )</h3><p><i>Description:</i> Sent, when an USSD result or a network initiated request arrives.</p><h4>Parameters</h4><i>s: mode</i><p>The message mode. Valid values are:  <ul>  <li>"completed", if the last user-initiated request has been successfully completed,</li>  <li>"useraction", if this is a network-initiated request and further user action is necessary,</li>  <li>"terminated", if the network terminated the request,</li>  <li>"localclient", if another local client on the network has responded,</li>  <li>"unsupported", if the last user-inititated request is unsupported,</li>  <li>"timeout", if the network has not answered in time.</li>  </ul></p><i>s: message</i><p>The message. Only set if mode is "completed" or "useraction". "", otherwise.</p></h3> 
    69 <h1>Errors</h1><h3><a name="NotPresent">NotPresent</a></h3><p><i>Description:</i> Raised, if no network service is available.</p> 
    70 <h3><a name="Unauthorized">Unauthorized</a></h3><p><i>Description:</i> Raised, if registering with the specified network is not possible.</p> 
    71 <h3><a name="NotSupported">NotSupported</a></h3><p><i>Description:</i> Raised, if the requested network operation is not supported.</p> 
    72 <h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the requested network provider is not present.</p> 
     65<p><i>Description:</i> Send an Unstructured Supplementary Service Data (USSD) request to the network. </p><p><div class="rationale"><p>This can map to the GSM 07.07 command +CUSD=1,"(request)",(code), see 3GPP TS 07.07 Chapter 7.14.</p></div></p><h4>Parameters</h4><i>s: request</i><p>The request to be sent to the network.</p> 
     66<h1>Signals</h1><h3><h3><a name="Status">Status</a> ( a{sv} )</h3><p><i>Description:</i> Sent, when the network registration status changes. </p><h4>Parameters</h4><i>a{sv}: status</i><p>The registration status. See method GetStatus for expected values.</p></h3> 
     67<h3><h3><a name="SignalStrength">SignalStrength</a> ( i )</h3><p><i>Description:</i> (OPTIONAL) Sent, when registered with a service provider and the network signal strength changes. </p><h4>Parameters</h4><i>i: signal_strength</i><p>The signal strength in percent (0-100).</p></h3> 
     68<h3><h3><a name="IncomingUssd">IncomingUssd</a> ( ss )</h3><p><i>Description:</i> Sent, when an USSD result or a network initiated request arrives. </p><h4>Parameters</h4><i>s: mode</i><p>The message mode. Valid values are:  <ul>  <li>"completed", if the last user-initiated request has been successfully completed,</li>  <li>"useraction", if this is a network-initiated request and further user action is necessary,</li>  <li>"terminated", if the network terminated the request,</li>  <li>"localclient", if another local client on the network has responded,</li>  <li>"unsupported", if the last user-inititated request is unsupported,</li>  <li>"timeout", if the network has not answered in time.</li>  </ul></p><i>s: message</i><p>The message. Only set if mode is "completed" or "useraction". "", otherwise.</p></h3> 
     69<h1>Errors</h1><h3><a name="NotPresent">NotPresent</a></h3><p><i>Description:</i> Raised, if no network service is available. </p> 
     70<h3><a name="Unauthorized">Unauthorized</a></h3><p><i>Description:</i> Raised, if registering with the specified network is not possible. </p> 
     71<h3><a name="NotSupported">NotSupported</a></h3><p><i>Description:</i> Raised, if the requested network operation is not supported. </p> 
     72<h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the requested network provider is not present. </p> 
    7373 
    7474    <hr/> 

  • html/org.freesmartphone.GSM.PDP.html

    rc46e113 r41a0c40  
    2929</ul> 
    3030<h1>Methods</h1><h3><a name="ListGprsClasses">ListGprsClasses</a> ( ) &rarr; as</h3> 
    31 <p><i>Description:</i> List available GPRS device classes.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>as: classes</i><p>The available GPRS device classes.</p> 
     31<p><i>Description:</i> List available GPRS device classes. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>as: classes</i><p>The available GPRS device classes.</p> 
    3232<h3><a name="GetCurrentGprsClass">GetCurrentGprsClass</a> ( ) &rarr; s</h3> 
    33 <p><i>Description:</i> Retrieves the current GPRS device class mode.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>s: device_class</i><p>The GPRS device class mode.</p> 
     33<p><i>Description:</i> Retrieves the current GPRS device class mode. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS?, see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Returns</h4><i>s: device_class</i><p>The GPRS device class mode.</p> 
    3434<h3><a name="SetCurrentGprsClass">SetCurrentGprsClass</a> ( s )</h3> 
    35 <p><i>Description:</i> Sets the current GPRS device class mode.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=(device_class), see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Parameters</h4><i>s: device_class</i><p>The GPRS device class mode.</p> 
     35<p><i>Description:</i> Sets the current GPRS device class mode. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CGCLASS=(device_class), see 3GPP TS 07.07 Chapter 10.1.11.</p></div></p><h4>Parameters</h4><i>s: device_class</i><p>The GPRS device class mode.</p> 
    3636<h3><a name="ActivateContext">ActivateContext</a> ( sss ) &rarr; i</h3> 
    37 <p><i>Description:</i> Request a PDP context activation to an IP-based network service provider and launch a ppp session.</p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>s: apn</i><p>The access point name to connect to.</p><i>s: username</i><p>The user name to authenticate with.</p><i>s: password</i><p>The password to authenticate with.</p><h4>Returns</h4><i>i: index</i><p>An index to identify context status changes.</p> 
     37<p><i>Description:</i> Request a PDP context activation to an IP-based network service provider and launch a ppp session. </p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>s: apn</i><p>The access point name to connect to.</p><i>s: username</i><p>The user name to authenticate with.</p><i>s: password</i><p>The password to authenticate with.</p><h4>Returns</h4><i>i: index</i><p>An index to identify context status changes.</p> 
    3838<h3><a name="DeactivateContext">DeactivateContext</a> ( i )</h3> 
    39 <p><i>Description:</i> Cancel an ongoing ppp session and request a PDP context deactivation.</p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The context to deactivate.</p> 
     39<p><i>Description:</i> Cancel an ongoing ppp session and request a PDP context deactivation. </p><p><div class="rationale"><p>This command might change your network default route.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The context to deactivate.</p> 
    4040<h3><a name="GetContextStatus">GetContextStatus</a> ( i ) &rarr; s</h3> 
    41 <p><i>Description:</i> Retrieve the current PDP context status.</p><h4>Parameters</h4><i>i: index</i><p>The context to inquire.</p><h4>Returns</h4><i>s: status</i><p>The context status. See 'ContextStatus' for valid values.</p> 
    42 <h1>Signals</h1><h3><h3><a name="ContextStatus">ContextStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a pdp context in the system.</p><h4>Parameters</h4><i>i: id</i><p>The index of the context that changed its status or properties.</p><i>s: status</i><p>The new status of the context. Expected values are:  <ul>  <li>"incoming" = The context is incoming (but not yet accepted),</li>  <li>"outgoing" = The context is outgoing (but not yet established),</li>  <li>"active" = The context is active (you have a new default route),</li>  <li>"held" = The context is being held (interrupted by a voice call) [OPTIONAL],</li>  <li>"released" = The context is being released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional.  Expected tuples are:  <ul>  <li>( "reason", string ) = The reason for the status change,</li>  [li( "apn", string ) = The number of the access point.</li>  </ul></p></h3> 
    43 <h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified PDP context is not present.</p> 
     41<p><i>Description:</i> Retrieve the current PDP context status. </p><h4>Parameters</h4><i>i: index</i><p>The context to inquire.</p><h4>Returns</h4><i>s: status</i><p>The context status. See 'ContextStatus' for valid values.</p> 
     42<h1>Signals</h1><h3><h3><a name="ContextStatus">ContextStatus</a> ( isa{sv} )</h3><p><i>Description:</i> Sent whenever there is any status or property change on a pdp context in the system. </p><h4>Parameters</h4><i>i: id</i><p>The index of the context that changed its status or properties.</p><i>s: status</i><p>The new status of the context. Expected values are:  <ul>  <li>"incoming" = The context is incoming (but not yet accepted),</li>  <li>"outgoing" = The context is outgoing (but not yet established),</li>  <li>"active" = The context is active (you have a new default route),</li>  <li>"held" = The context is being held (interrupted by a voice call) [OPTIONAL],</li>  <li>"released" = The context is being released.</li>  </ul>  Further information can be part of the properties.</p><i>a{sv}: properties</i><p>An array of property values. Note that properties are optional.  Expected tuples are:  <ul>  <li>( "reason", string ) = The reason for the status change,</li>  [li( "apn", string ) = The number of the access point.</li>  </ul></p></h3> 
     43<h1>Errors</h1><h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if the specified PDP context is not present. </p> 
    4444 
    4545    <hr/> 

  • html/org.freesmartphone.GSM.SIM.html

    r688f1daa r41a0c40  
    5353</ul> 
    5454<h1>Methods</h1><h3><a name="GetAuthStatus">GetAuthStatus</a> ( ) &rarr; s</h3> 
    55 <p><i>Description:</i> Retrieve the authentication status for the SIM card.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN=?, see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Returns</h4><i>s: status</i><p>The authentication status for the SIM card. Values to expect:  <ul>  <li>"READY" = not waiting for any PIN or PUK,</li>  <li>"SIM PIN" = waiting for SIM PIN to be given,</li>  <li>"SIM PUK" = waiting for SIM PUK to be given,</li>  <li>"SIM PIN2" = waiting for SIM PIN 2 to be given,</li>  <li>"SIM PUK2" = waiting for SIM PUK 2 to be given.</li>  </ul></p> 
     55<p><i>Description:</i> Retrieve the authentication status for the SIM card. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN=?, see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Returns</h4><i>s: status</i><p>The authentication status for the SIM card. Values to expect:  <ul>  <li>"READY" = not waiting for any PIN or PUK,</li>  <li>"SIM PIN" = waiting for SIM PIN to be given,</li>  <li>"SIM PUK" = waiting for SIM PUK to be given,</li>  <li>"SIM PIN2" = waiting for SIM PIN 2 to be given,</li>  <li>"SIM PUK2" = waiting for SIM PUK 2 to be given.</li>  </ul></p> 
    5656<h3><a name="SendAuthCode">SendAuthCode</a> ( s )</h3> 
    57 <p><i>Description:</i> Send authentication code (PIN) for the SIM card.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN="(pin)", see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Parameters</h4><i>s: pin</i><p>The authentication code.</p> 
     57<p><i>Description:</i> Send authentication code (PIN) for the SIM card. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN="(pin)", see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Parameters</h4><i>s: pin</i><p>The authentication code.</p> 
    5858<h3><a name="Unlock">Unlock</a> ( ss )</h3> 
    59 <p><i>Description:</i> Send unlock code (PUK) and new authentication code (PIN).</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN="(puk)","(new_pin)", see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Parameters</h4><i>s: puk</i><p>The unlock code.</p><i>s: new_pin</i><p>The new authentication code.</p> 
     59<p><i>Description:</i> Send unlock code (PUK) and new authentication code (PIN). </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPIN="(puk)","(new_pin)", see 3GPP TS 07.07 Chapter 8.3.</p></div></p><h4>Parameters</h4><i>s: puk</i><p>The unlock code.</p><i>s: new_pin</i><p>The new authentication code.</p> 
    6060<h3><a name="ChangeAuthCode">ChangeAuthCode</a> ( ss )</h3> 
    61 <p><i>Description:</i> Change the authentication code.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPWD="SC","(old_pin)","(new_pin)", see 3GPP TS 07.07 Chapter 7.5.</p></div></p><h4>Parameters</h4><i>s: old_pin</i><p>The old authentication code.</p><i>s: new_pin</i><p>The new authentication code.</p> 
     61<p><i>Description:</i> Change the authentication code. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPWD="SC","(old_pin)","(new_pin)", see 3GPP TS 07.07 Chapter 7.5.</p></div></p><h4>Parameters</h4><i>s: old_pin</i><p>The old authentication code.</p><i>s: new_pin</i><p>The new authentication code.</p> 
    6262<h3><a name="SetAuthCodeRequired">SetAuthCodeRequired</a> ( bs )</h3> 
    63 <p><i>Description:</i> Enable or disable checking for the SIM card authentification on startup.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLCK,"SC",(check),"(pin)", see 3GPP TS 07.07 Chapter 7.4.</p></div></p><h4>Parameters</h4><i>b: check</i><p>True, to turn SIM card authentification on. False, to turn it off.</p><i>s: pin</i><p>A valid authentication code.</p> 
     63<p><i>Description:</i> Enable or disable checking for the SIM card authentification on startup. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLCK,"SC",(check),"(pin)", see 3GPP TS 07.07 Chapter 7.4.</p></div></p><h4>Parameters</h4><i>b: check</i><p>True, to turn SIM card authentification on. False, to turn it off.</p><i>s: pin</i><p>A valid authentication code.</p> 
    6464<h3><a name="GetAuthCodeRequired">GetAuthCodeRequired</a> ( ) &rarr; b</h3> 
    65 <p><i>Description:</i> Retrieve whether the SIM card checks for authentification on startup.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLCK,"SC",2, see 3GPP TS 07.07 Chapter 7.4.</p></div></p><h4>Returns</h4><i>b: check</i><p>True, if SIM card authentification is turned on. False, otherwise.</p> 
     65<p><i>Description:</i> Retrieve whether the SIM card checks for authentification on startup. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CLCK,"SC",2, see 3GPP TS 07.07 Chapter 7.4.</p></div></p><h4>Returns</h4><i>b: check</i><p>True, if SIM card authentification is turned on. False, otherwise.</p> 
    6666<h3><a name="GetSimInfo">GetSimInfo</a> ( ) &rarr; a{sv}</h3> 
    67 <p><i>Description:</i> Get information about the IMSI, the subscriber numbers,  and the country code of the SIM card.</p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CIMI (see 3GPP TS 07.07 Chapter 5.6),</li>  <li>+CNUM (see 3GPP TS 07.07 Chapter 7.1).</li>  </ul>  The dial code is computed by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM card. Required tuples are:  <ul>  <li>("imsi", string) = The unique subscriber identification stored on your SIM.</li>  </ul>  Optional tuples are:  <ul>  <li>("subscriber_numbers", array),</li>  <li>("dial_prefix", string),</li>  <li>("country", string).</li>  </ul>  The subscriber_numbers array contains two-tuples formatted as (string:line-name, string:line-number).</p> 
     67<p><i>Description:</i> Get information about the IMSI, the subscriber numbers,  and the country code of the SIM card. </p><p><div class="rationale"><p>This can map to the following GSM 07.07 commands:  <ul>  <li>+CIMI (see 3GPP TS 07.07 Chapter 5.6),</li>  <li>+CNUM (see 3GPP TS 07.07 Chapter 7.1).</li>  </ul>  The dial code is computed by cross-referencing ITU E.212 (Land Mobile Numbering Plan).</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM card. Required tuples are:  <ul>  <li>("imsi", string) = The unique subscriber identification stored on your SIM.</li>  </ul>  Optional tuples are:  <ul>  <li>("subscriber_numbers", array),</li>  <li>("dial_prefix", string),</li>  <li>("country", string).</li>  </ul>  The subscriber_numbers array contains two-tuples formatted as (string:line-name, string:line-number).</p> 
    6868<h3><a name="SendGenericSimCommand">SendGenericSimCommand</a> ( s ) &rarr; s</h3> 
    69 <p><i>Description:</i> Send a generic SIM command to the SIM card.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSIM=(command), see 3GPP TS 07.07 Chapter 8.17.</p></div></p><h4>Parameters</h4><i>s: command</i><p>The command to send, encoded as described in GSM 11.11.</p><h4>Returns</h4><i>s: result</i><p>The result of the command, encoded as described in GSM 11.11.</p> 
     69<p><i>Description:</i> Send a generic SIM command to the SIM card. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CSIM=(command), see 3GPP TS 07.07 Chapter 8.17.</p></div></p><h4>Parameters</h4><i>s: command</i><p>The command to send, encoded as described in GSM 11.11.</p><h4>Returns</h4><i>s: result</i><p>The result of the command, encoded as described in GSM 11.11.</p> 
    7070<h3><a name="SendRestrictedSimCommand">SendRestrictedSimCommand</a> ( iiiiis ) &rarr; s</h3> 
    71 <p><i>Description:</i> Send a restricted SIM command to the SIM card.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CRSM=(command),(fileid),(p1),(p2),(p3),(data), see 3GPP TS 07.07 Chapter 8.18.</p></div></p><h4>Parameters</h4><i>i: command</i><p>The command to send. Valid values are:  <ul>  <li>176 = READ BINARY,</li>  <li>178 = READ RECORD,</li>  <li>192 = GET RESPONSE,</li>  <li>214 = UPDATE BINARY,</li>  <li>220 = UPDATE RECORD,</li>  <li>242 = STATUS.</li>  </ul></p><i>i: fileid</i><p>The identifier of an elementary datafile on SIM. Mandatory for every command except STATUS.</p><i>i: p1</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>i: p2</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>i: p3</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>s: data</i><p>The command data to the SIM, encoded as described in GSM 11.11.</p><h4>Returns</h4><i>s: result</i><p>The result of the command, encoded as described in GSM 11.11.</p> 
     71<p><i>Description:</i> Send a restricted SIM command to the SIM card. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CRSM=(command),(fileid),(p1),(p2),(p3),(data), see 3GPP TS 07.07 Chapter 8.18.</p></div></p><h4>Parameters</h4><i>i: command</i><p>The command to send. Valid values are:  <ul>  <li>176 = READ BINARY,</li>  <li>178 = READ RECORD,</li>  <li>192 = GET RESPONSE,</li>  <li>214 = UPDATE BINARY,</li>  <li>220 = UPDATE RECORD,</li>  <li>242 = STATUS.</li>  </ul></p><i>i: fileid</i><p>The identifier of an elementary datafile on SIM. Mandatory for every command except STATUS.</p><i>i: p1</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>i: p2</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>i: p3</i><p>Parameter 1 passed to the SIM. Mandatory for every command except STATUS and GET RESPONSE.</p><i>s: data</i><p>The command data to the SIM, encoded as described in GSM 11.11.</p><h4>Returns</h4><i>s: result</i><p>The result of the command, encoded as described in GSM 11.11.</p> 
    7272<h3><a name="GetHomeZones">GetHomeZones</a> ( ) &rarr; a(siii)</h3> 
    73 <p><i>Description:</i> Retrieve the homezones coordinates, if stored on SIM.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CRSM=176,28512,0,0,123, see 3GPP TS 07.07 Chapter 8.17.</p></div></p><h4>Returns</h4><i>a(siii): homezones</i><p>An array containing up to four homezones in Gauss-Krueger coordinates. The array contains of four-tuples with the following format:  <ol>  <li>(name:string), the name of the zone,</li>  <li>(x:int), the X value of the zone center in Gauss-Krueger format,</li>  <li>(y:int), the Y value of the zone center in Gauss-Krueger format,</li>  <li>(r:radious), the R*R value of the zone dimension in meters.</li>  </ol></p> 
     73<p><i>Description:</i> Retrieve the homezones coordinates, if stored on SIM. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CRSM=176,28512,0,0,123, see 3GPP TS 07.07 Chapter 8.17.</p></div></p><h4>Returns</h4><i>a(siii): homezones</i><p>An array containing up to four homezones in Gauss-Krueger coordinates. The array contains of four-tuples with the following format:  <ol>  <li>(name:string), the name of the zone,</li>  <li>(x:int), the X value of the zone center in Gauss-Krueger format,</li>  <li>(y:int), the Y value of the zone center in Gauss-Krueger format,</li>  <li>(r:radious), the R*R value of the zone dimension in meters.</li>  </ol></p> 
    7474<h3><a name="ListPhonebooks">ListPhonebooks</a> ( ) &rarr; as</h3> 
    75 <p><i>Description:</i> Retrieve the list of available phonebooks on the SIM.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBS=?, see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Returns</h4><i>as: categories</i><p>The available phonebooks.</p> 
     75<p><i>Description:</i> Retrieve the list of available phonebooks on the SIM. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBS=?, see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Returns</h4><i>as: categories</i><p>The available phonebooks.</p> 
    7676<h3><a name="GetPhonebookInfo">GetPhonebookInfo</a> ( s ) &rarr; a{sv}</h3> 
    77 <p><i>Description:</i> Request information about the SIM phonebook.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBR=?, see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM phonebook storage. Tuples to expect:  <ul>  <li>("min_index", int:value) = lowest entry index for given phonebook on the SIM,</li>  <li>("max_index", int:value) = highest entry index for given phonebook on the SIM,</li>  <li>("number_length", int:value) = maximum length for the number,</li>  <li>("name_length", int:value) = maximum length for the name.</li>  </ul></p> 
     77<p><i>Description:</i> Request information about the SIM phonebook. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBR=?, see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM phonebook storage. Tuples to expect:  <ul>  <li>("min_index", int:value) = lowest entry index for given phonebook on the SIM,</li>  <li>("max_index", int:value) = highest entry index for given phonebook on the SIM,</li>  <li>("number_length", int:value) = maximum length for the number,</li>  <li>("name_length", int:value) = maximum length for the name.</li>  </ul></p> 
    7878<h3><a name="RetrievePhonebook">RetrievePhonebook</a> ( s ) &rarr; a(iss)</h3> 
    79 <p><i>Description:</i> Retrieve all entries from the SIM phonebook.</p><p><div class="rationale"><p>This vaguely maps to the GSM 07.05 command +CPBR=(index1),(index2), see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><h4>Returns</h4><i>a(iss): entries</i><p>The phonebook entries. This is an array of three-tuples. Every entry has the following structure:  <ul>  <li>(int:index) = storage index,</li>  <li>(string:name) = name,</li>  <li>(string:number) = number.</li>  </ul></p> 
     79<p><i>Description:</i> Retrieve all entries from the SIM phonebook. </p><p><div class="rationale"><p>This vaguely maps to the GSM 07.05 command +CPBR=(index1),(index2), see 3GPP TS 07.07 Chapter 8.12.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><h4>Returns</h4><i>a(iss): entries</i><p>The phonebook entries. This is an array of three-tuples. Every entry has the following structure:  <ul>  <li>(int:index) = storage index,</li>  <li>(string:name) = name,</li>  <li>(string:number) = number.</li>  </ul></p> 
    8080<h3><a name="DeleteEntry">DeleteEntry</a> ( si )</h3> 
    81 <p><i>Description:</i> Delete an entry in the SIM phonebook.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><i>i: index</i><p>Index of entry to delete.</p> 
     81<p><i>Description:</i> Delete an entry in the SIM phonebook. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><i>i: index</i><p>Index of entry to delete.</p> 
    8282<h3><a name="StoreEntry">StoreEntry</a> ( siss )</h3> 
    83 <p><i>Description:</i> Store an entry in the SIM phonebook.</p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBW=(index),"(name)",(number),(ntype), see 3GPP TS 07.07 Chapter 8.14.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><i>i: index</i><p>The index of the entry to store.</p><i>s: name</i><p>The name corresponding to the number.</p><i>s: number</i><p>The number corresponding to the name.</p> 
     83<p><i>Description:</i> Store an entry in the SIM phonebook. </p><p><div class="rationale"><p>This maps to the GSM 07.07 command +CPBW=(index),"(name)",(number),(ntype), see 3GPP TS 07.07 Chapter 8.14.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><i>i: index</i><p>The index of the entry to store.</p><i>s: name</i><p>The name corresponding to the number.</p><i>s: number</i><p>The number corresponding to the name.</p> 
    8484<h3><a name="RetrieveEntry">RetrieveEntry</a> ( si ) &rarr; ss</h3> 
    8585<h4>Parameters</h4><i>s: category</i><p>The phonebook storage category. See org.freesmartphone.GSM.SIM.ListPhonebooks  for valid categories.</p><i>i: index</i><p>The index of the entry to retrieve.</p><h4>Returns</h4><i>s: name</i><p>The name corresponding to the number.</p><i>s: number</i><p>The number corresponding to the name.</p> 
    8686<h3><a name="GetMessagebookInfo">GetMessagebookInfo</a> ( ) &rarr; a{sv}</h3> 
    87 <p><i>Description:</i> Request information about the SIM messagebook.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CPMS="SM","SM","SM", see 3GPP TS 07.07 Chapter 3.2.2.</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM messagebook storage. Tuples to expect:  <ul>  <li>("first", int:value) = first storage index of messages on the SIM,</li>  <li>("last", int:value) = last index of messages stored on the SIM,</li>  <li>("used", int:value) = number of messages currently stored on the SIM.</li>  </ul></p> 
     87<p><i>Description:</i> Request information about the SIM messagebook. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CPMS="SM","SM","SM", see 3GPP TS 07.07 Chapter 3.2.2.</p></div></p><h4>Returns</h4><i>a{sv}: info</i><p>Information about the SIM messagebook storage. Tuples to expect:  <ul>  <li>("first", int:value) = first storage index of messages on the SIM,</li>  <li>("last", int:value) = last index of messages stored on the SIM,</li>  <li>("used", int:value) = number of messages currently stored on the SIM.</li>  </ul></p> 
    8888<h3><a name="RetrieveMessagebook">RetrieveMessagebook</a> ( s ) &rarr; a(isssa{sv})</h3> 
    89 <p><i>Description:</i> Retrieve all messages from the SIM messagebook that match a given category.</p><p><div class="rationale"><p>This vaguely maps to the GSM 07.05 command +CMGL="(category)", see 3GPP TS 07.07 Chapter 3.4.2.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The category of messages you want to receive. Valid categories are:  <ul>  <li>"all" = all messages,</li>  <li>"read" = message you have received and read,</li>  <li>"unread" = new messages you have received,</li>  <li>"sent" = messages you have sent,</li>  <li>"unsent" = message you have not sent yet.</li>  </ul></p><h4>Returns</h4><i>a(isssa{sv}): messages</i><p>Messages matching the given category. This is an array of four-tuples. Every entry has the following structure:  <ul>  <li>(int:index) = storage index,</li>  <li>(string:status) = status of message, one of ("read", "unread", "sent", "unsent"),</li>  <li>(string:number) = sender or receiver number.</li>  <li>(string:content) = contents of the message.</li>  <li>(map:properties) = Map with additional properties (see RetrieveMessage)</li>  </ul></p> 
     89<p><i>Description:</i> Retrieve all messages from the SIM messagebook that match a given category. </p><p><div class="rationale"><p>This vaguely maps to the GSM 07.05 command +CMGL="(category)", see 3GPP TS 07.07 Chapter 3.4.2.</p></div></p><h4>Parameters</h4><i>s: category</i><p>The category of messages you want to receive. Valid categories are:  <ul>  <li>"all" = all messages,</li>  <li>"read" = message you have received and read,</li>  <li>"unread" = new messages you have received,</li>  <li>"sent" = messages you have sent,</li>  <li>"unsent" = message you have not sent yet.</li>  </ul></p><h4>Returns</h4><i>a(isssa{sv}): messages</i><p>Messages matching the given category. This is an array of four-tuples. Every entry has the following structure:  <ul>  <li>(int:index) = storage index,</li>  <li>(string:status) = status of message, one of ("read", "unread", "sent", "unsent"),</li>  <li>(string:number) = sender or receiver number.</li>  <li>(string:content) = contents of the message.</li>  <li>(map:properties) = Map with additional properties (see RetrieveMessage)</li>  </ul></p> 
    9090<h3><a name="GetServiceCenterNumber">GetServiceCenterNumber</a> ( ) &rarr; s</h3> 
    91 <p><i>Description:</i> Retrieve phone number of SMS Center Number.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CSCA?, see 3GPP TS 07.05 Chapter 3.3.1.</p></div></p><h4>Returns</h4><i>s: number</i><p>The SMS Center Number.</p> 
     91<p><i>Description:</i> Retrieve phone number of SMS Center Number. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CSCA?, see 3GPP TS 07.05 Chapter 3.3.1.</p></div></p><h4>Returns</h4><i>s: number</i><p>The SMS Center Number.</p> 
    9292<h3><a name="SetServiceCenterNumber">SetServiceCenterNumber</a> ( s )</h3> 
    93 <p><i>Description:</i> Set phone number of SMS Center Number.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CSCA=(number),(type), see 3GPP TS 07.05 Chapter 3.3.1.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The SMS Center Number.</p> 
     93<p><i>Description:</i> Set phone number of SMS Center Number. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CSCA=(number),(type), see 3GPP TS 07.05 Chapter 3.3.1.</p></div></p><h4>Parameters</h4><i>s: number</i><p>The SMS Center Number.</p> 
    9494<h3><a name="DeleteMessage">DeleteMessage</a> ( i )</h3> 
    95 <p><i>Description:</i> Delete a message in the SIM messagebook.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGD=(index), see 3GPP TS 07.05 Chapter 3.5.4.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The storage index of the message to delete.</p> 
     95<p><i>Description:</i> Delete a message in the SIM messagebook. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGD=(index), see 3GPP TS 07.05 Chapter 3.5.4.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The storage index of the message to delete.</p> 
    9696<h3><a name="StoreMessage">StoreMessage</a> ( ssa{sv} ) &rarr; i</h3> 
    97 <p><i>Description:</i> Store a message in the SIM messagebook.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGW=..., see 3GPP TS 07.05 Chapter 3.5.3.</p></div></p><h4>Parameters</h4><i>s: recipient_number</i><p>The number of the recipient.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Valid tuples are:  <ul>  <li>(string:type) = The type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the CSM (messages belonging to the same csm must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this CSM,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the CSM.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p><h4>Returns</h4><i>i: index</i><p>The index of the new message.</p> 
     97<p><i>Description:</i> Store a message in the SIM messagebook. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGW=..., see 3GPP TS 07.05 Chapter 3.5.3.</p></div></p><h4>Parameters</h4><i>s: recipient_number</i><p>The number of the recipient.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Valid tuples are:  <ul>  <li>(string:type) = The type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the CSM (messages belonging to the same csm must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this CSM,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the CSM.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p><h4>Returns</h4><i>i: index</i><p>The index of the new message.</p> 
    9898<h3><a name="SendStoredMessage">SendStoredMessage</a> ( i ) &rarr; i</h3> 
    99 <p><i>Description:</i> Sends a message stored in the SIM messagebook.</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGS=(index)..., see 3GPP TS 07.05 Chapter 3.5.x.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The index of the message.</p><h4>Returns</h4><i>i: transaction_index</i><p>The given transaction index for this message.</p> 
     99<p><i>Description:</i> Sends a message stored in the SIM messagebook. </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGS=(index)..., see 3GPP TS 07.05 Chapter 3.5.x.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The index of the message.</p><h4>Returns</h4><i>i: transaction_index</i><p>The given transaction index for this message.</p> 
    100100<h3><a name="RetrieveMessage">RetrieveMessage</a> ( i ) &rarr; sssa{sv}</h3> 
    101 <p><i>Description:</i> Retrieve a message from the SIM messagebook.</p><p><div class="rationale"><p>This can map to the GSM 07.05 command +CMGR=(index), see 3GPP TS 07.05 Chapter 3.4.3.  It might also map to the GSM 07.05 command +CMGL=(storage_spec), see 3GPP TS 07.05 Chapter 3.4.2.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The index of the message to retrieve.</p><h4>Returns</h4><i>s: status</i><p>The category the message is in, one of ("read", "sent", "unread", "unsent").</p><i>s: sender_number</i><p>The number of the sender.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Tuples to expect:  <ul>  <li>(string:type) = Type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>(string:timestamp) = Timestamp when the message was received by the service center,</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the CSM (messages belonging to the same CSM must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this CSM,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the CSM.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p> 
    102 <h1>Signals</h1><h3><h3><a name="AuthStatus">AuthStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the authentication status for the SIM card changes.</p><h4>Parameters</h4><i>s: status</i><p>The authentication status for the SIM card. See method GetAuthStatus for expected values.</p></h3> 
    103 <h3><h3><a name="IncomingStoredMessage">IncomingStoredMessage</a> ( i )</h3><p><i>Description:</i> Sent, when a new message has been received and stored on the SIM card.</p><h4>Parameters</h4><i>i: index</i><p>The storage index of the new message.</p></h3> 
    104 <h1>Errors</h1><h3><a name="NotPresent">NotPresent</a></h3><p><i>Description:</i> Raised, if there is no SIM card present.</p> 
    105 <h3><a name="AuthFailed">AuthFailed</a></h3><p><i>Description:</i> Raised, if the SIM authentication code is not accepted.</p> 
    106 <h3><a name="Blocked">Blocked</a></h3><p><i>Description:</i> Raised, if the SIM has been deactivated or is otherwise not allowed to join a network.</p> 
    107 <h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if a data record on the SIM is not present.</p> 
    108 <h3><a name="MemoryFull">MemoryFull</a></h3><p><i>Description:</i> Raised, if there is not enough space for a data record on the SIM.</p> 
    109 <h3><a name="InvalidIndex">InvalidIndex</a></h3><p><i>Description:</i> Raised, if the requested messagebook or phonebook entry is out of bounds.</p> 
     101<p><i>Description:</i> Retrieve a message from the SIM messagebook. </p><p><div class="rationale"><p>This can map to the GSM 07.05 command +CMGR=(index), see 3GPP TS 07.05 Chapter 3.4.3.  It might also map to the GSM 07.05 command +CMGL=(storage_spec), see 3GPP TS 07.05 Chapter 3.4.2.</p></div></p><h4>Parameters</h4><i>i: index</i><p>The index of the message to retrieve.</p><h4>Returns</h4><i>s: status</i><p>The category the message is in, one of ("read", "sent", "unread", "unsent").</p><i>s: sender_number</i><p>The number of the sender.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Tuples to expect:  <ul>  <li>(string:type) = Type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>(string:timestamp) = Timestamp when the message was received by the service center,</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the CSM (messages belonging to the same CSM must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this CSM,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the CSM.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p> 
     102<h1>Signals</h1><h3><h3><a name="AuthStatus">AuthStatus</a> ( s )</h3><p><i>Description:</i> Sent, when the authentication status for the SIM card changes. </p><h4>Parameters</h4><i>s: status</i><p>The authentication status for the SIM card. See method GetAuthStatus for expected values.</p></h3> 
     103<h3><h3><a name="IncomingStoredMessage">IncomingStoredMessage</a> ( i )</h3><p><i>Description:</i> Sent, when a new message has been received and stored on the SIM card. </p><h4>Parameters</h4><i>i: index</i><p>The storage index of the new message.</p></h3> 
     104<h1>Errors</h1><h3><a name="NotPresent">NotPresent</a></h3><p><i>Description:</i> Raised, if there is no SIM card present. </p> 
     105<h3><a name="AuthFailed">AuthFailed</a></h3><p><i>Description:</i> Raised, if the SIM authentication code is not accepted. </p> 
     106<h3><a name="Blocked">Blocked</a></h3><p><i>Description:</i> Raised, if the SIM has been deactivated or is otherwise not allowed to join a network. </p> 
     107<h3><a name="NotFound">NotFound</a></h3><p><i>Description:</i> Raised, if a data record on the SIM is not present. </p> 
     108<h3><a name="MemoryFull">MemoryFull</a></h3><p><i>Description:</i> Raised, if there is not enough space for a data record on the SIM. </p> 
     109<h3><a name="InvalidIndex">InvalidIndex</a></h3><p><i>Description:</i> Raised, if the requested messagebook or phonebook entry is out of bounds. </p> 
    110110 
    111111    <hr/> 

  • html/org.freesmartphone.GSM.SMS.html

    r9e6994a r41a0c40  
    2222<h2>Errors</h2><i>None</i> 
    2323<h1>Methods</h1><h3><a name="SendMessage">SendMessage</a> ( ssa{sv} ) &rarr; i</h3> 
    24 <p><i>Description:</i> Sends a message via the GSM Short Message Service (SMS)</p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGS=..., see 3GPP TS 07.05 Chapter 3.5.1 (text mode)  and 4.3 (pdu mode).</p></div></p><h4>Parameters</h4><i>s: recipient_number</i><p>The number of the recipient.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Valid tuples are:  <ul>  <li>(string:type) = type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this csm,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the csm.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p><h4>Returns</h4><i>i: transaction_index</i><p>The given transaction index for this message</p> 
    25 <h1>Signals</h1><h3><h3><a name="IncomingMessage">IncomingMessage</a> ( ssa{sv} )</h3><p><i>Description:</i> Sent, when a message has been received</p><h4>Parameters</h4><i>s: sender_number</i><p>The number of the sender.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. See org.freesmartphone.GSM.SIM.SendMessage.</p></h3> 
     24<p><i>Description:</i> Sends a message via the GSM Short Message Service (SMS) </p><p><div class="rationale"><p>This maps to the GSM 07.05 command +CMGS=..., see 3GPP TS 07.05 Chapter 3.5.1 (text mode)  and 4.3 (pdu mode).</p></div></p><h4>Parameters</h4><i>s: recipient_number</i><p>The number of the recipient.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. Valid tuples are:  <ul>  <li>(string:type) = type of the SMS, must be one of ("SMS_SUBMIT", "SMS_DELIVER", "SMS_COMMAND", "SMS_SUBMIT_REPORT", "SMS_DELIVER_REPORT"),</li>  <li>(string:alphabet) = Encoding of the short message, must be one of ("binary", "gsm", "usc2"),</li>  <li>Properties for concatenated short messages (CSM):  <ul>  <li>(int:csm_id) = Id of the csm (messages belonging to the same csm must have the same id),</li>  <li>(int:csm_num) = Total number of messages in this csm,</li>  <li>(int:csm_seq) = Number defining the order of the messages in the csm.</li>  </ul>  </li>  <li>Properties for port addressing (similar to UDP ports):  <ul>  <li>(int:src_port) = Source port this short message comes from,</li>  <li>(int:dst_port) = Destination port this short message should be routed to.</li>  </ul>  </li>  </ul></p><h4>Returns</h4><i>i: transaction_index</i><p>The given transaction index for this message</p> 
     25<h1>Signals</h1><h3><h3><a name="IncomingMessage">IncomingMessage</a> ( ssa{sv} )</h3><p><i>Description:</i> Sent, when a message has been received </p><h4>Parameters</h4><i>s: sender_number</i><p>The number of the sender.</p><i>s: contents</i><p>The contents of the message.</p><i>a{sv}: properties</i><p>Additional properties of the message. See org.freesmartphone.GSM.SIM.SendMessage.</p></h3> 
    2626 
    2727    <hr/> 

  • html/org.freesmartphone.Phone.Call.html

    r8910efc r41a0c40  
    3232</ul> 
    3333<h1>Methods</h1><h3><a name="GetPeer">GetPeer</a> ( ) &rarr; s</h3> 
    34 <p><i>Description:</i> Return the number of the peer (usually the number of the call).</p><h4>Returns</h4><i>s: peer</i><p>The number of the peer.</p> 
     34<p><i>Description:</i> Return the number of the peer (usually the number of the call). </p><h4>Returns</h4><i>s: peer</i><p>The number of the peer.</p> 
    3535<h3><a name="Initiate">Initiate</a> ( ) &rarr; s</h3> 
    36 <p><i>Description:</i> Initiate the call.</p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Initiating').</p> 
     36<p><i>Description:</i> Initiate the call. </p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Initiating').</p> 
    3737<h3><a name="Activate">Activate</a> ( ) &rarr; s</h3> 
    38 <p><i>Description:</i> Accept the call.</p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Activating').</p> 
     38<p><i>Description:</i> Accept the call. </p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Activating').</p> 
    3939<h3><a name="Release">Release</a> ( ) &rarr; s</h3> 
    40 <p><i>Description:</i> Release the call.</p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Releasing').</p> 
     40<p><i>Description:</i> Release the call. </p><h4>Returns</h4><i>s: status</i><p>The new status of the Call (should be 'Releasing').</p> 
    4141<h3><a name="GetStatus">GetStatus</a> ( ) &rarr; s</h3> 
    42 <p><i>Description:</i> Return the current status of the call.</p><h4>Returns</h4><i>s: status</i><p>The current status of the Call.</p> 
    43 <h3><a name="Remove">Remove</a> ( )</h3><p><i>Description:</i> Remove the call object when it is not needed anymore.</p> 
     42<p><i>Description:</i> Return the current status of the call. </p><h4>Returns</h4><i>s: status</i><p>The current status of the Call.</p> 
     43<h3><a name="Remove">Remove</a> ( )</h3><p><i>Description:</i> Remove the call object when it is not needed anymore. </p> 
    4444<h1>Signals</h1><h3><a name="Incoming">Incoming</a> ( )</h3> 
    4545<h3><a name="Outgoing">Outgoing</a> ( )</h3> 
    4646<h3><a name="Released">Released</a> ( )</h3> 
    4747<h3><a name="Activated">Activated</a> ( )</h3> 
    48 <h1>Errors</h1><h3><a name="Unauthorized">Unauthorized</a></h3><p><i>Description:</i> Raised, if registering with the specified network is not possible.</p> 
     48<h1>Errors</h1><h3><a name="Unauthorized">Unauthorized</a></h3><p><i>Description:</i> Raised, if registering with the specified network is not possible. </p> 
    4949 
    5050    <hr/> 

  • html/org.freesmartphone.Phone.html

    r2dae11c r41a0c40  
    2323<h2>Errors</h2><i>None</i> 
    2424<h1>Methods</h1><h3><a name="InitProtocols">InitProtocols</a> ( ) &rarr; as</h3> 
    25 <p><i>Description:</i> Initialize all the protocols.</p><h4>Returns</h4><i>as: protocols</i><p>The list of all the protocols names.</p> 
     25<p><i>Description:</i> Initialize all the protocols. </p><h4>Returns</h4><i>as: protocols</i><p>The list of all the protocols names.</p> 
    2626<h3><a name="CreateCall">CreateCall</a> ( ssb ) &rarr; o</h3> 
    27 <p><i>Description:</i> Create a new Call to a given number, with an optional protocol.</p><h4>Parameters</h4><i>s: number</i><p>A string representing the number of the peer.</p><i>s: protocol</i><p>The name of the protocol as returned by InitProtocols,  if None the best protocol will be used. Default to None</p><i>b: force</i><p>If true, we destroy any already present call object to this number. Default to True</p><h4>Returns</h4><i>o: call</i><p>The path to the new Call object</p> 
    28 <h1>Signals</h1><h3><h3><a name="Incoming">Incoming</a> ( o )</h3><p><i>Description:</i> Emitted when a new call is incoming</p><h4>Parameters</h4><i>o: call</i><p>Path to the Call object.</p></h3> 
     27<p><i>Description:</i> Create a new Call to a given number, with an optional protocol. </p><h4>Parameters</h4><i>s: number</i><p>A string representing the number of the peer.</p><i>s: protocol</i><p>The name of the protocol as returned by InitProtocols,  if None the best protocol will be used. Default to None</p><i>b: force</i><p>If true, we destroy any already present call object to this number. Default to True</p><h4>Returns</h4><i>o: call</i><p>The path to the new Call object</p> 
     28<h1>Signals</h1><h3><h3><a name="Incoming">Incoming</a> ( o )</h3><p><i>Description:</i> Emitted when a new call is incoming </p><h4>Parameters</h4><i>o: call</i><p>Path to the Call object.</p></h3> 
    2929 
    3030    <hr/> 

  • html/org.freesmartphone.Preferences.Service.html

    rc46e113 r41a0c40  
    2626<h2>Errors</h2><i>None</i> 
    2727<h1>Methods</h1><h3><a name="GetKeys">GetKeys</a> ( ) &rarr; as</h3> 
    28 <p><i>Description:</i> Retrieve all the keys of the service.    This method should be used only for introspection purposes.</p><h4>Returns</h4><i>as: keys</i><p>The list of keys.</p> 
     28<p><i>Description:</i> Retrieve all the keys of the service.    This method should be used only for introspection purposes. </p><h4>Returns</h4><i>as: keys</i><p>The list of keys.</p> 
    2929<h3><a name="GetValue">GetValue</a> ( s ) &rarr; v</h3> 
    30 <p><i>Description:</i> Get a parameter value.</p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>v: value</i><p>The value associated with the key.</p> 
     30<p><i>Description:</i> Get a parameter value. </p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>v: value</i><p>The value associated with the key.</p> 
    3131<h3><a name="SetValue">SetValue</a> ( sv )</h3> 
    32 <p><i>Description:</i> Set a parameter value.</p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><i>v: value</i><p>The new value associated with the key.</p> 
     32<p><i>Description:</i> Set a parameter value. </p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><i>v: value</i><p>The new value associated with the key.</p> 
    3333<h3><a name="IsProfilable">IsProfilable</a> ( s ) &rarr; b</h3> 
    34 <p><i>Description:</i> Return true if a parameter depends on the current profile.</p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>b: profileable</i><p>True if a parameter depends on the current profile.</p> 
     34<p><i>Description:</i> Return true if a parameter depends on the current profile. </p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>b: profileable</i><p>True if a parameter depends on the current profile.</p> 
    3535<h3><a name="GetType">GetType</a> ( s ) &rarr; s</h3> 
    36 <p><i>Description:</i> Return a string representing the type of the parameter.</p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>s: type</i><p>A string representing the type of the parameter.</p> 
    37 <h1>Signals</h1><h3><h3><a name="Notify">Notify</a> ( sv )</h3><p><i>Description:</i> Sent whenever there is a change in a parameter value in the service</p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><i>v: value</i><p>The new value of the parameter.</p></h3> 
     36<p><i>Description:</i> Return a string representing the type of the parameter. </p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><h4>Returns</h4><i>s: type</i><p>A string representing the type of the parameter.</p> 
     37<h1>Signals</h1><h3><h3><a name="Notify">Notify</a> ( sv )</h3><p><i>Description:</i> Sent whenever there is a change in a parameter value in the service </p><h4>Parameters</h4><i>s: key</i><p>The parameter key string.</p><i>v: value</i><p>The new value of the parameter.</p></h3> 
    3838 
    3939    <hr/> 

  • html/org.freesmartphone.Preferences.html

    r2dae11c r41a0c40  
    2525<h2>Errors</h2><i>None</i> 
    2626<h1>Methods</h1><h3><a name="GetServices">GetServices</a> ( ) &rarr; as</h3> 
    27 <p><i>Description:</i> Return the list of all available services.</p><h4>Returns</h4><i>as: services</i><p>The list of all available services.</p> 
     27<p><i>Description:</i> Return the list of all available services. </p><h4>Returns</h4><i>as: services</i><p>The list of all available services.</p> 
    2828<h3><a name="GetService">GetService</a> ( s ) &rarr; o</h3> 
    29 <p><i>Description:</i> Retrieve a given service.</p><h4>Parameters</h4><i>s: name</i><p>the name of the service, as returned by `GetServices`.</p><h4>Returns</h4><i>o: service</i><p>the path to the service object</p> 
     29<p><i>Description:</i> Retrieve a given service. </p><h4>Parameters</h4><i>s: name</i><p>the name of the service, as returned by `GetServices`.</p><h4>Returns</h4><i>o: service</i><p>the path to the service object</p> 
    3030<h3><a name="GetProfiles">GetProfiles</a> ( ) &rarr; as</h3> 
    31 <p><i>Description:</i> Return a list of all the available profiles.</p><h4>Returns</h4><i>as: profile</i><p>The list of all the available profiles.</p> 
     31<p><i>Description:</i> Return a list of all the available profiles. </p><h4>Returns</h4><i>as: profile</i><p>The list of all the available profiles.</p> 
    3232<h3><a name="GetProfile">GetProfile</a> ( ) &rarr; s</h3> 
    33 <p><i>Description:</i> Retrieve the current top profile.</p><h4>Returns</h4><i>s: profile</i><p>The name of the current profile.</p> 
     33<p><i>Description:</i> Retrieve the current top profile. </p><h4>Returns</h4><i>s: profile</i><p>The name of the current profile.</p> 
    3434<h3><a name="SetProfile">SetProfile</a> ( s )</h3> 
    35 <p><i>Description:</i> Set the current top profile.</p><h4>Parameters</h4><i>s: profile</i><p>The name of the new current profile.</p> 
     35<p><i>Description:</i> Set the current top profile. </p><h4>Parameters</h4><i>s: profile</i><p>The name of the new current profile.</p> 
    3636<h3><a name="GetProfiles">GetProfiles</a> ( ) &rarr; as</h3> 
    37 <p><i>Description:</i> Return a list of all the available profiles.</p><h4>Returns</h4><i>as: profiles</i><p>An array of all the profile names.</p> 
     37<p><i>Description:</i> Return a list of all the available profiles. </p><h4>Returns</h4><i>as: profiles</i><p>An array of all the profile names.</p> 
    3838 
    3939    <hr/> 

  • html/org.freesmartphone.Resource.html

    r8910efc r41a0c40  
    2424<li><a href="#NotEnabled">NotEnabled</a></li> 
    2525</ul> 
    26 <h1>Methods</h1><h3><a name="Enable">Enable</a> ( )</h3><p><i>Description:</i> Enable the resource.</p> 
    27 <h3><a name="Disable">Disable</a> ( )</h3><p><i>Description:</i> Disable the resource.</p> 
    28 <h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Suspend the resource.</p> 
    29 <h3><a name="Resume">Resume</a> ( )</h3><p><i>Description:</i> Suspend the resource.</p> 
    30 <h1>Errors</h1><h3><a name="NotEnabled">NotEnabled</a></h3><p><i>Description:</i> Raised, if the resource is not enabled.</p> 
     26<h1>Methods</h1><h3><a name="Enable">Enable</a> ( )</h3><p><i>Description:</i> Enable the resource. </p> 
     27<h3><a name="Disable">Disable</a> ( )</h3><p><i>Description:</i> Disable the resource. </p> 
     28<h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Suspend the resource. </p> 
     29<h3><a name="Resume">Resume</a> ( )</h3><p><i>Description:</i> Suspend the resource. </p> 
     30<h1>Errors</h1><h3><a name="NotEnabled">NotEnabled</a></h3><p><i>Description:</i> Raised, if the resource is not enabled. </p> 
    3131 
    3232    <hr/> 

  • html/org.freesmartphone.Usage.html

    r8910efc r41a0c40  
    3838</ul> 
    3939<h1>Methods</h1><h3><a name="ListResources">ListResources</a> ( ) &rarr; as</h3> 
    40 <p><i>Description:</i> List available resources.</p><h4>Returns</h4><i>as: resources</i><p>An array of resource names.</p> 
     40<p><i>Description:</i> List available resources. </p><h4>Returns</h4><i>as: resources</i><p>An array of resource names.</p> 
    4141<h3><a name="GetResourcePolicy">GetResourcePolicy</a> ( s ) &rarr; s</h3> 
    42 <p><i>Description:</i> Get the current resource policy for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>s: policy</i><p>The resource policy. Expected values are:  <ul>  <li>"disabled" - using this resource is currently not allowed,</li>  <li>"auto" - the resource is enabled as long as it is used by at least one client,</li>  <li>"enabled" - the resource is enabled even without a client.</li>  </ul></p> 
     42<p><i>Description:</i> Get the current resource policy for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>s: policy</i><p>The resource policy. Expected values are:  <ul>  <li>"disabled" - using this resource is currently not allowed,</li>  <li>"auto" - the resource is enabled as long as it is used by at least one client,</li>  <li>"enabled" - the resource is enabled even without a client.</li>  </ul></p> 
    4343<h3><a name="SetResourcePolicy">SetResourcePolicy</a> ( ss )</h3> 
    44 <p><i>Description:</i> Set a new resource policy for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><i>s: policy</i><p>The new resource policy. See 'GetResourcePolicy' for valid values.</p> 
     44<p><i>Description:</i> Set a new resource policy for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><i>s: policy</i><p>The new resource policy. See 'GetResourcePolicy' for valid values.</p> 
    4545<h3><a name="GetResourceState">GetResourceState</a> ( s ) &rarr; b</h3> 
    46 <p><i>Description:</i> Get the current state for a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p> 
     46<p><i>Description:</i> Get the current state for a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p> 
    4747<h3><a name="GetResourceUsers">GetResourceUsers</a> ( s ) &rarr; as</h3> 
    48 <p><i>Description:</i> Get the users which currently use a given resource.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>as: users</i><p>An array of bus names using the resource.</p> 
     48<p><i>Description:</i> Get the users which currently use a given resource. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p><h4>Returns</h4><i>as: users</i><p>An array of bus names using the resource.</p> 
    4949<h3><a name="RequestResource">RequestResource</a> ( s )</h3> 
    50 <p><i>Description:</i> Occupy a given resource. An error is returned if the resource was not occupied sucessfully.</p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
     50<p><i>Description:</i> Occupy a given resource. An error is returned if the resource was not occupied sucessfully. </p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
    5151<h3><a name="ReleaseResource">ReleaseResource</a> ( s )</h3> 
    52 <p><i>Description:</i> Release a given resource.</p><p><div class="rationale"><p>Resources in use get autoreleased when a client leaves the bus.</p></div></p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
    53 <h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Triggers a suspend on all managed resources and puts the device into suspend mode.  When the device comes back from suspend, all resources are resumed.</p><p><div class="rationale"><p>Resources need to implement org.freesmartphone.Resource.Suspend and  org.freesmartphone.Resource.Resume if they have anything to do  on suspend and resume.</p></div></p> 
    54 <h1>Signals</h1><h3><h3><a name="ResourceAvailable">ResourceAvailable</a> ( sb )</h3><p><i>Description:</i> Sent whenever a resource is added or removed.</p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: availability</i><p>The resource availability. True if the resource is currently available.</p></h3> 
    55 <h3><h3><a name="ResourceChanged">ResourceChanged</a> ( sba{sv} )</h3><p><i>Description:</i> Sent whenever a resource status changes.</p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p><i>a{sv}: attributes</i><p>The new status of the resource. Expected values are:  <ul>  <li>"policy": The current resource policy</li>  <li>"refcount": The count of clients that have requested the resource</li>  </ul>  Further information can be part of the properties.</p></h3> 
    56 <h1>Errors</h1><h3><a name="PolicyUnknown">PolicyUnknown</a></h3><p><i>Description:</i> Raised, if the requested policy is unknown.</p> 
    57 <h3><a name="PolicyDisabled">PolicyDisabled</a></h3><p><i>Description:</i> Raised, if the requested resource is set to policy "disabled".</p> 
    58 <h3><a name="ResourceUnknown">ResourceUnknown</a></h3><p><i>Description:</i> Raised, if the requested resource is unknown.</p> 
    59 <h3><a name="ResourceExists">ResourceExists</a></h3><p><i>Description:</i> Raised, if a (new) resource has already been registered.</p> 
    60 <h3><a name="ResourceInUse">ResourceInUse</a></h3><p><i>Description:</i> Raised, if the to-be-disabled (by policy) resource is still in use.</p> 
    61 <h3><a name="UserExists">UserExists</a></h3><p><i>Description:</i> Raised, if the requested resource has already been requested by the same user.</p> 
    62 <h3><a name="UserUnknown">UserUnknown</a></h3><p><i>Description:</i> Raised, if the to-be-released resource has never been requested by the user.</p> 
     52<p><i>Description:</i> Release a given resource. </p><p><div class="rationale"><p>Resources in use get autoreleased when a client leaves the bus.</p></div></p><h4>Parameters</h4><i>s: name</i><p>The resource name.</p> 
     53<h3><a name="Suspend">Suspend</a> ( )</h3><p><i>Description:</i> Triggers a suspend on all managed resources and puts the device into suspend mode.  When the device comes back from suspend, all resources are resumed. </p><p><div class="rationale"><p>Resources need to implement org.freesmartphone.Resource.Suspend and  org.freesmartphone.Resource.Resume if they have anything to do  on suspend and resume.</p></div></p> 
     54<h1>Signals</h1><h3><h3><a name="ResourceAvailable">ResourceAvailable</a> ( sb )</h3><p><i>Description:</i> Sent whenever a resource is added or removed. </p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: availability</i><p>The resource availability. True if the resource is currently available.</p></h3> 
     55<h3><h3><a name="ResourceChanged">ResourceChanged</a> ( sba{sv} )</h3><p><i>Description:</i> Sent whenever a resource status changes. </p><h4>Parameters</h4><i>s: name</i><p>The name of the resource.</p><i>b: state</i><p>The resource state. True if the resource is currently enabled.</p><i>a{sv}: attributes</i><p>The new status of the resource. Expected values are:  <ul>  <li>"policy": The current resource policy</li>  <li>"refcount": The count of clients that have requested the resource</li>  </ul>  Further information can be part of the properties.</p></h3> 
     56<h1>Errors</h1><h3><a name="PolicyUnknown">PolicyUnknown</a></h3><p><i>Description:</i> Raised, if the requested policy is unknown. </p> 
     57<h3><a name="PolicyDisabled">PolicyDisabled</a></h3><p><i>Description:</i> Raised, if the requested resource is set to policy "disabled". </p> 
     58<h3><a name="ResourceUnknown">ResourceUnknown</a></h3><p><i>Description:</i> Raised, if the requested resource is unknown. </p> 
     59<h3><a name="ResourceExists">ResourceExists</a></h3><p><i>Description:</i> Raised, if a (new) resource has already been registered. </p> 
     60<h3><a name="ResourceInUse">ResourceInUse</a></h3><p><i>Description:</i> Raised, if the to-be-disabled (by policy) resource is still in use. </p> 
     61<h3><a name="UserExists">UserExists</a></h3><p><i>Description:</i> Raised, if the requested resource has already been requested by the same user. </p> 
     62<h3><a name="UserUnknown">UserUnknown</a></h3><p><i>Description:</i> Raised, if the to-be-released resource has never been requested by the user. </p> 
    6363 
    6464    <hr/> 
Note: See TracChangeset for help on using the changeset viewer.