doc/device-api.txt

   1 Device hierarchy
   2 ================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.connman.Device
   6 Object path     [variable prefix]/{device0,device1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the device object. See
  11                         the properties section for available properties.
  12
  13                         Possible Errors: [service].Error.InvalidArguments
  14
  15                 void SetProperty(string name, variant value)
  16
  17                         Changes the value of the specified property. Only
  18                         properties that are listed as read-write are
  19                         changeable. On success a PropertyChanged signal
  20                         will be emitted.
  21
  22                         Possible Errors: [service].Error.InvalidArguments
  23                                          [service].Error.DoesNotExist
  24
  25                 object CreateNetwork(dict network)
  26
  27                         Creates a network object from the specified
  28                         properties. Valid properties are WiFi.SSID,
  29                         WiFi.Security and WiFi.Passphrase. Check the
  30                         network interface description for details.
  31
  32                         Possible Errors: [service].Error.InvalidArguments
  33
  34                 void RemoveNetwork(object network)
  35
  36                         Removes a previously created network object.
  37
  38                         Possible Errors: [service].Error.InvalidArguments
  39                                          [service].Error.DoesNotExist
  40
  41 Signals         PropertyChanged(string name, variant value)
  42
  43                         This signal indicates a changed value of the given
  44                         property.
  45
  46 Properties      string Name [readonly]
  47
  48                         The device name (for example "Wireless" etc.)
  49
  50                         This name can be used for directly displaying it in
  51                         the application. It has pure informational purpose.
  52
  53                 string Type [readonly]
  54
  55                         The device type (for example "ethernet", "wifi" etc.)
  56
  57                 string Interface [readonly]
  58
  59                         The device interface (for example "eth0" etc.)
  60
  61                         This value is for pure informational purposes. It
  62                         is not guaranteed that it is always present.
  63
  64                 string Policy [readwrite]
  65
  66                         Setting of the device power and connection policy.
  67                         Possible values are "ignore", "off", "auto"
  68                         and "manual".
  69
  70                         The policy defines on how the device is initialized
  71                         when brought up and how it connects. The actual
  72                         device power state can be changed independently to
  73                         this value.
  74
  75                         If a device is switched off and the policy is changed
  76                         to "auto" or "manual", the device will be switched
  77                         on. For a current active device changing the policy
  78                         to "off" results in powering down the device.
  79
  80                         The "ignore" policy can be set for devices that are
  81                         detected, but managed by a different entity on the
  82                         system. For example for complex network setups.
  83
  84                         Devices that can connect to various networks, the
  85                         difference between "auto" or "manual" defines if
  86                         known networks are connected automatically or not.
  87                         For simple devices like Ethernet cards, setting
  88                         the "manual" policy might fail.
  89
  90                 boolean Powered [readwrite]
  91
  92                         Switch a device on or off. This will also modify
  93                         the list of networks in range. All known networks
  94                         will be still available via the Networks property.
  95
  96                         Changing this value doesn't change the value of the
  97                         Policy property.
  98
  99                         The value of this property can be changed by other
 100                         parts of the system (including the kernel). An
 101                         example would be modifications via the "ifconfig"
 102                         command line utility.
 103
 104                 boolean Scanning [readonly]
 105
 106                         Indicates if a device is scanning. Not all device
 107                         types might support this. Also some hardware might
 108                         execute background scanning without notifying the
 109                         driver about it. Use this property only for visual
 110                         indication.
 111
 112                 array{object} Networks [readonly]
 113
 114                         List of networks objects paths. Every object path
 115                         represents a network in range or a known network.