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                                          [service].Error.DoesNotExist
  15
  16                 void SetProperty(string name, variant value)
  17
  18                         Changes the value of the specified property. Only
  19                         properties that are listed as read-write are
  20                         changeable. On success a PropertyChanged signal
  21                         will be emitted.
  22
  23                         Possible Errors: [service].Error.InvalidArguments
  24                                          [service].Error.DoesNotExist
  25
  26 Signals         PropertyChanged(string name, variant value)
  27
  28                         This signal indicates a changed value of the given
  29                         property.
  30
  31 Properties      string Name [readonly]
  32
  33                         The device name (for example eth0, wlan0 etc.)
  34
  35                 string Type [readonly]
  36
  37                         The device type (for example ethernet, wifi etc.)
  38
  39                 boolean Powered [readwrite]
  40
  41                         Switch a device on or off. This will also modify
  42                         the list of networks in range. All known networks
  43                         will be still available via the Networks property.
  44
  45                 boolean Scanning [readonly]
  46
  47                         Indicates if a device is scanning. Not all device
  48                         types might support this. Also some hardware might
  49                         execute background scanning without notifying the
  50                         driver about it. Use this property only for visual
  51                         indication.
  52
  53                 array{object} Networks [readonly]
  54
  55                         List of networks objects paths. Every object path
  56                         represents a network in range or a known network.