git.maemo.org Git - connman/blob - doc/element-api.txt

   1 Element hierarchy
   2 *****************
   3
   4 Service name    org.moblin.connman
   5 Interface name  org.moblin.connman.Element
   6 Object path     [element object]
   7
   8 Methods         dict GetProperties()
   9
  10 Properties      string Type
  11                 string Subtype
  12                 string Driver
  13                 string Vendor
  14                 string Product
  15
  16
  17 Method: GetProperties
  18 =====================
  19 This method allows to retrieve all properties of an element at once. The
  20 properties are presented in a dictionary.
  21
  22 Property: Type
  23 ==============
  24 This property represents the main type of an element. It can have the values
  25 like "device", "network", "ipv4", "ipv6", "dhcp", "bootp" and "zeroconf".
  26
  27 Property: Subtype
  28 =================
  29 This property represents the subtype of an element. In the normal case this
  30 is the hardware type. It can have values like "ethernet", "wifi", "wimax",
  31 "modem" and "bluetooth".
  32
  33 The element system will inherit the subtype from the parent if not overwritten
  34 manually and so it should be present in every element.
  35
  36 Property: Driver
  37 ================
  38 This property represents the driver that is assigned to this element. This
  39 value will only be present in case of Device elements. On Linux system this
  40 is the kernel driver name.
  41
  42 Property: Vendor
  43 ================
  44 This property represent the vendor string for this element. This value is only
  45 present in case of a Device element. This information are taken from HAL.
  46
  47 Property: Product
  48 =================
  49 This property represent the product string for this element. This value is only
  50 present in case of a Device element. This information are taken from HAL.