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                 void JoinNetwork(dict network)
  26
  27                         Join network specified by the given properties. The
  28                         properties for WiFi networks can be WiFi.SSID,
  29                         WiFi.Security and WiFi.Passphrase.
  30
  31                         Possible Errors: [service].Error.InvalidArguments
  32
  33                 object CreateNetwork(dict network)
  34
  35                         Creates a network object from the specified
  36                         properties. Valid properties are WiFi.SSID,
  37                         WiFi.Security and WiFi.Passphrase. Check the
  38                         network interface description for details.
  39
  40                         Possible Errors: [service].Error.InvalidArguments
  41
  42                 void RemoveNetwork(object network)
  43
  44                         Removes a previously created network object.
  45
  46                         Possible Errors: [service].Error.InvalidArguments
  47                                          [service].Error.DoesNotExist
  48
  49                 void ProposeScan()
  50
  51                         Proposes to trigger a scan transaction.
  52
  53                         Possible Errors: [service].Error.InvalidArguments
  54
  55 Signals         PropertyChanged(string name, variant value)
  56
  57                         This signal indicates a changed value of the given
  58                         property.
  59
  60 Properties      string Address [readonly]
  61
  62                         The address of the device.
  63
  64                 string Name [readonly]
  65
  66                         The device name (for example "Wireless" etc.)
  67
  68                         This name can be used for directly displaying it in
  69                         the application. It has pure informational purpose.
  70
  71                 string Type [readonly]
  72
  73                         The device type (for example "ethernet", "wifi" etc.)
  74
  75                 string Interface [readonly]
  76
  77                         The device interface (for example "eth0" etc.)
  78
  79                         This value is for pure informational purposes. It
  80                         is not guaranteed that it is always present.
  81
  82                 string Policy [readwrite]
  83
  84                         Setting of the device power and connection policy.
  85                         Possible values are "ignore", "off", "auto"
  86                         and "manual".
  87
  88                         The policy defines on how the device is initialized
  89                         when brought up and how it connects. The actual
  90                         device power state can be changed independently to
  91                         this value.
  92
  93                         If a device is switched off and the policy is changed
  94                         to "auto" or "manual", the device will be switched
  95                         on. For a current active device changing the policy
  96                         to "off" results in powering down the device.
  97
  98                         The "ignore" policy can be set for devices that are
  99                         detected, but managed by a different entity on the
 100                         system. For example for complex network setups.
 101
 102                         Devices that can connect to various networks, the
 103                         difference between "auto" or "manual" defines if
 104                         known networks are connected automatically or not.
 105                         For simple devices like Ethernet cards, setting
 106                         the "manual" policy might fail.
 107
 108                 uint8 Priority [readwrite]
 109
 110                         The device priority. Higher values indicate the
 111                         preference for this device.
 112
 113                 boolean Powered [readwrite]
 114
 115                         Switch a device on or off. This will also modify
 116                         the list of networks in range. All known networks
 117                         will be still available via the Networks property.
 118
 119                         Changing this value doesn't change the value of the
 120                         Policy property.
 121
 122                         The value of this property can be changed by other
 123                         parts of the system (including the kernel). An
 124                         example would be modifications via the "ifconfig"
 125                         command line utility.
 126
 127                 uint16 ScanInterval [readwrite]
 128
 129                         The scan interval describes the time in seconds
 130                         between automated scan attempts. Setting this
 131                         value to 0 will disable the background scanning.
 132
 133                         The default value is 300 and so every 5 minutes
 134                         a scan procedure will be triggered.
 135
 136                         This property is not available with all types
 137                         of devices. Some might not support background
 138                         scanning at all.
 139
 140                 boolean Scanning [readonly]
 141
 142                         Indicates if a device is scanning. Not all device
 143                         types might support this. Also some hardware might
 144                         execute background scanning without notifying the
 145                         driver about it. Use this property only for visual
 146                         indication.
 147
 148                 array{object} Networks [readonly]
 149
 150                         List of networks objects paths. Every object path
 151                         represents a network in range or a known network.