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 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 Policy [readwrite]
  58
  59                         Setting of the device power policy. Possible values
  60                         are "off", "ignore" and "auto".
  61
  62                         The policy defines on how the device is initialized
  63                         when brought up. The actual device power state can
  64                         be changed independently to this value.
  65
  66                         If a device is switched off and the policy is changed
  67                         to "auto", the device will be switched. For a current
  68                         active device changing the policy to "off" results
  69                         in powering down the device.
  70
  71                         The "ignore" policy can be set for devices that are
  72                         detected, but managed by a different entity on the
  73                         system. For example complex network setups.
  74
  75                 boolean Powered [readwrite]
  76
  77                         Switch a device on or off. This will also modify
  78                         the list of networks in range. All known networks
  79                         will be still available via the Networks property.
  80
  81                         Changing this value doesn't change the value of the
  82                         Policy property.
  83
  84                         The value of this property can be changed by other
  85                         parts of the system (including the kernel). An
  86                         example would be modifications via the "ifconfig"
  87                         command line utility.
  88
  89                 boolean Scanning [readonly]
  90
  91                         Indicates if a device is scanning. Not all device
  92                         types might support this. Also some hardware might
  93                         execute background scanning without notifying the
  94                         driver about it. Use this property only for visual
  95                         indication.
  96
  97                 array{object} Networks [readonly]
  98
  99                         List of networks objects paths. Every object path
 100                         represents a network in range or a known network.