doc/call-meter-api.txt

   1 Call Meter hierarchy
   2 ===============
   3 Service         org.ofono
   4 Interface       org.ofono.CallMeter
   5 Object path     [variable prefix]/{modem0,modem1,...}
   6
   7 Methods         dict GetProperties()
   8
   9                         Contains the properties for this object.
  10
  11                         Possible Errors: [service].Error.InProgress
  12
  13                 void SetProperty(string property, variant value,
  14                                  string password)
  15
  16                         Sets the property to value specified in the
  17                         call parameter.  The last parameter is used
  18                         to pass the SIM PIN2 code which may be
  19                         required by the SIM.
  20
  21                         Possible Errors: [service].Error.InProgress
  22                                          [service].Error.NotImplemented
  23                                          [service].Error.InvalidArguments
  24                                          [service].Error.InvalidFormat
  25                                          [service].Error.Failed
  26
  27                 void Reset(string password)
  28
  29                         Attempts to reset the Accumulated Call Meter.
  30                         Reseting this value requires SIM PIN2, provided
  31                         by the password parameter.
  32
  33                         Possible Errors: [service].Error.InProgress
  34                                          [service].Error.NotImplemented
  35                                          [service].Error.InvalidArguments
  36                                          [service].Error.InvalidFormat
  37                                          [service].Error.Failed
  38
  39 Signals         PropertyChanged(string property, variant value)
  40
  41                         Signal is emitted whenever a property has changed.
  42                         The new value is passed as the signal argument.
  43
  44                 NearMaximumWarning()
  45
  46                         Emitted shortly before the ACM (Accumulated Call
  47                         Meter) maximum values is reached.  The warning is
  48                         issued approximately when 30 seconds call time
  49                         remains or when starting a call with less than
  50                         30 seconds remaining.
  51
  52 Properties      uint32 CallMeter [readonly]
  53
  54                         Contains the current call meter value from the ME.
  55                         The values are in 24-bit range, counted in home
  56                         units.
  57
  58                 uint32 AccumulatedCallMeter [readonly]
  59
  60                         Contains the Accumulated Call Meter (ACM) value
  61                         from the SIM.  When the AccumulatedCallMeter
  62                         value reaches AccumulatedCallMeterMaximum value,
  63                         no further calls can be made until the ACM
  64                         value is reset.  Reset is accomplished using
  65                         the Reset() function.
  66
  67                         The values are in 24-bit range.
  68
  69                 uint32 AccumulatedCallMeterMaximum [readwrite]
  70
  71                         Contains the Accumulated Call Meter maximum value
  72                         on reaching which, calls are prohibited.  This is
  73                         effectively the maximum number of home units
  74                         allowed to be consumed by subscriber.
  75
  76                         According to the GSM specification, setting the value
  77                         to 0, turns off this feature.
  78
  79                         The values are in 24-bit range.
  80
  81                 double PricePerUnit [readwrite]
  82
  83                         Contains price-per-unit conversion value.  This
  84                         information can be used to convert the home units
  85                         into currency units.
  86
  87                 string Currency [readwrite]
  88
  89                         Contains three-character currency code.  This
  90                         information can be used to convert the home
  91                         units into currency units.