doc/radio-settings-api.txt

   1 Radio settings hierarchy
   2 ========================
   3
   4 Service         org.ofono
   5 Interface       org.ofono.RadioSettings
   6 Object path     [variable prefix]/{modem0,modem1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns all radio access properties. See the
  11                         properties section for available properties.
  12
  13                         Possible Errors: [service].Error.InProgress
  14                                          [service].Error.NotImplemented
  15                                          [service].Error.Failed
  16
  17                 void SetProperty(string name, variant value)
  18
  19                         Changes the value of the specified property. Only
  20                         properties that are listed as readwrite are
  21                         changeable. On success a PropertyChanged signal
  22                         will be emitted.
  23
  24                         Possible Errors: [service].Error.InProgress
  25                                          [service].Error.NotImplemented
  26                                          [service].Error.InvalidArguments
  27                                          [service].Error.Failed
  28
  29 Signals         PropertyChanged(string property, variant value)
  30
  31                         This signal indicates a changed value of the given
  32                         property.
  33
  34 Properties      string TechnologyPreference [readwrite]
  35
  36                         The current radio access selection mode, also known
  37                         as network preference.
  38
  39                         The possible values are:
  40                                 "any"   Radio access technology
  41                                         selection is done automatically,
  42                                         based on reception and
  43                                         availability.
  44                                 "gsm"   Only GSM used for radio access.
  45                                 "umts"  Only UMTS used for radio access.
  46                                 "lte"   Only LTE used for radio access.
  47
  48                 string GsmBand [readwrite, optional]
  49
  50                         Frequency band in which the modem is allowed to
  51                         operate when using "gsm" mode. Setting this property
  52                         has an immediate effect on modem only if
  53                         TechnologyPreference is set to "gsm" or "any".
  54                         Otherwise the value is kept and applied whenever modem
  55                         uses this mode.
  56
  57                         The possible values are:
  58                                 "any"   Frequency band is selected
  59                                         automatically by modem.
  60                                 "850"   Operate only on 850 MHz.
  61                                 "900P"  Operate only on 900 MHz, known as
  62                                         Primary GSM-900 Band
  63                                 "900E"  Operate only on 900 MHz, known as
  64                                         Extended GSM-900 Band.
  65                                 "1800"  Operate only on 1800 MHz, known as DCS.
  66                                 "1900"  Operate only on 1900 MHz, known as PCS.
  67
  68                 string UmtsBand [readwrite, optional]
  69
  70                         Frequency band in which the modem is allowed to
  71                         operate when using "umts" mode. Setting this property
  72                         has an immediate effect on modem only if
  73                         TechnologyPreference is set to "umts" or "any".
  74                         Otherwise the value is kept and applied whenever modem
  75                         uses this mode.
  76
  77                         The possible values are:
  78                                 "any"           Frequency band is selected
  79                                                 automatically by modem.
  80                                 "850"           Operate only on 850 MHz, known
  81                                                 as CLR (class V).
  82                                 "900"           Operate only on 900 MHz, known
  83                                                 as GSM (class VIII).
  84                                 "1700AWS"       Operate only on 1700 MHz, known
  85                                                 as AWS (class IV).
  86                                 "1900"          Operate only on 1900 MHz, known
  87                                                 as PCS (class II).
  88                                 "2100"          Operate only on 2100 MHz, known
  89                                                 as IMT (class I).
  90
  91                 boolean FastDormancy [readwrite, optional]
  92
  93                         This property will enable or disable the fast
  94                         dormancy feature in the modem. Fast dormancy
  95                         refers to a modem feature that allows the
  96                         modem to quickly release radio resources after
  97                         a burst of data transfer has ended. Normally,
  98                         radio resources are released by the network
  99                         after a timeout configured by the network.
 100                         Fast dormancy allows the modem to release the
 101                         radio resources more quickly.
 102
 103                         Fast dormancy is a major power-saving feature
 104                         for mobile devices. Typically, fast dormancy
 105                         would be enabled when the device is not being
 106                         interactively used by a human user and only
 107                         networking applications with keep-alive
 108                         traffic are active (e.g. mail client or a
 109                         presence application). In this case it is
 110                         desirable to release radio resources quickly
 111                         after a keep-alive transaction has ended,
 112                         since typically no network traffic will occur
 113                         until the next keep-alive transaction. Fast
 114                         dormancy should not be enabled during
 115                         interactive use because the release and setup
 116                         of radio resources introduces perceivable
 117                         delay for the end user.
 118
 119                         The fast dormancy implementation in the modem
 120                         is vendor specific. The implementation should
 121                         try to release radio resources more quickly,
 122                         when the situation allows it, but should also
 123                         take care not to increase the signalling load
 124                         on the cellular network by releasing and
 125                         re-establishing radio resources too often. The
 126                         modem should adjust its behaviour to the 3GPP
 127                         release supported by the network and the
 128                         parameters set by the operator.
 129
 130                         Fast dormancy can be ignored for externally
 131                         powered modems such as USB sticks or PCI
 132                         devices. If the modem does not support such a
 133                         feature the property should never be exposed
 134                         to the user.