doc: Add Type to the Modem object
authorDaniel Wagner <daniel.wagner@bmw-carit.de>
Tue, 22 Nov 2011 17:10:01 +0000 (18:10 +0100)
committerDenis Kenzior <denkenz@gmail.com>
Wed, 23 Nov 2011 02:36:05 +0000 (20:36 -0600)
Indicate the kind of modem it is before it is powered up.

doc/modem-api.txt

index fa400a2..95ce782 100644 (file)
@@ -98,3 +98,14 @@ Properties   boolean Powered [readwrite]
 
                        TODO: Better to split this into Status and
                              Capabilites properties?
+
+               string Type [readonly]
+
+                       Indicates whether the modem is virtual or a real
+                       hardware one. This information should only be used
+                       to identify which componet (e.g. ConnMan or a phone
+                       dialer) should take control over the modem. It does
+                       not give any hints on which Interfaces will be
+                       supported by this modem.
+
+                       Possible values are "hfp", "sap" and "hardware".