git.maemo.org Git - connman/blob - 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 Address [readonly]
  47
  48                         The address of the device.
  49
  50                 string Name [readonly]
  51
  52                         The device name (for example "Wireless" etc.)
  53
  54                         This name can be used for directly displaying it in
  55                         the application. It has pure informational purpose.
  56
  57                 string Type [readonly]
  58
  59                         The device type (for example "ethernet", "wifi" etc.)
  60
  61                 string Interface [readonly]
  62
  63                         The device interface (for example "eth0" etc.)
  64
  65                         This value is for pure informational purposes. It
  66                         is not guaranteed that it is always present.
  67
  68                 string Policy [readwrite]
  69
  70                         Setting of the device power and connection policy.
  71                         Possible values are "ignore", "off", "auto"
  72                         and "manual".
  73
  74                         The policy defines on how the device is initialized
  75                         when brought up and how it connects. The actual
  76                         device power state can be changed independently to
  77                         this value.
  78
  79                         If a device is switched off and the policy is changed
  80                         to "auto" or "manual", the device will be switched
  81                         on. For a current active device changing the policy
  82                         to "off" results in powering down the device.
  83
  84                         The "ignore" policy can be set for devices that are
  85                         detected, but managed by a different entity on the
  86                         system. For example for complex network setups.
  87
  88                         Devices that can connect to various networks, the
  89                         difference between "auto" or "manual" defines if
  90                         known networks are connected automatically or not.
  91                         For simple devices like Ethernet cards, setting
  92                         the "manual" policy might fail.
  93
  94                 uint8 Priority [readwrite]
  95
  96                         The device priority. Higher values indicate the
  97                         preference for this device.
  98
  99                 boolean Powered [readwrite]
 100
 101                         Switch a device on or off. This will also modify
 102                         the list of networks in range. All known networks
 103                         will be still available via the Networks property.
 104
 105                         Changing this value doesn't change the value of the
 106                         Policy property.
 107
 108                         The value of this property can be changed by other
 109                         parts of the system (including the kernel). An
 110                         example would be modifications via the "ifconfig"
 111                         command line utility.
 112
 113                 uint16 ScanInterval [readwrite]
 114
 115                         The scan interval describes the time in seconds
 116                         between automated scan attempts. Setting this
 117                         value to 0 will disable the background scanning.
 118
 119                         The default value is 300 and so every 5 minutes
 120                         a scan procedure will be triggered.
 121
 122                         This property is not available with all types
 123                         of devices. Some might not support background
 124                         scanning at all.
 125
 126                 boolean Scanning [readonly]
 127
 128                         Indicates if a device is scanning. Not all device
 129                         types might support this. Also some hardware might
 130                         execute background scanning without notifying the
 131                         driver about it. Use this property only for visual
 132                         indication.
 133
 134                 array{object} Networks [readonly]
 135
 136                         List of networks objects paths. Every object path
 137                         represents a network in range or a known network.