diff options
author | Marcel Holtmann <marcel@holtmann.org> | 2009-09-19 04:03:16 -0700 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2009-09-19 04:03:16 -0700 |
commit | e2887ed34e49a7134294360a224a897d7cd05c56 (patch) | |
tree | f365852c8de802a9cec315f48e7fe428c464e1c5 /doc | |
parent | bd077911148a31bf0db60a12a773886abea574eb (diff) | |
download | connman-e2887ed34e49a7134294360a224a897d7cd05c56.tar.gz connman-e2887ed34e49a7134294360a224a897d7cd05c56.tar.bz2 connman-e2887ed34e49a7134294360a224a897d7cd05c56.zip |
Add cellular specific properties to service documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/service-api.txt | 50 |
1 files changed, 45 insertions, 5 deletions
diff --git a/doc/service-api.txt b/doc/service-api.txt index 0678c821..b4b60a76 100644 --- a/doc/service-api.txt +++ b/doc/service-api.txt @@ -147,12 +147,17 @@ Properties string State [readonly] string Mode [readonly] - If the service type is WiFi, then this property is - present and contains the mode of the network. The - possible values are "managed" or "adhoc". + If the service type is WiFi or Cellular, then this + property is present and contains the mode of the + network. - This property might be only present for WiFi - services. + For WiFi services the possible values are "managed" + and "adhoc". For Cellular services it describes the + network technology. Possible values are "gprs", "edge" + and "umts". + + This property might be only present for WiFi and + Cellular services. string Security [readonly] @@ -212,6 +217,41 @@ Properties string State [readonly] this value to prevent or permit automatic connection attempts. + boolean SetupRequired [readonly] + + If the service is Cellular, then this property + indicates that some extra setup steps are required. + + In most cases it is required to fill in the APN + details. + + string APN [readwrite] + + If the service is Cellular, then this property + contains the APN details. + + The APN is network provider specific and even + sometimes data plan specific. Possible examples + are "isp.cingular" or "internet.t-mobile". + + string MCC [readonly] + + If the service is Cellular, then this property + contains the Mobile Country Code. + + string MNC [readonly] + + If the service is Cellular, then this property + contains the Mobile Network Code. + + boolean Roaming [readonly] + + This property indicates if this service is roaming. + + In the case of Cellular services this normally + indicates connections to a foreign provider when + traveling abroad. + string IPv4.Method [readwrite] The IPv4 configuration method. Possible values here |