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                 object CreateNetwork(dict network)
  27
  28                         Creates a network object from the specified
  29                         properties. Valid properties are WiFi.SSID,
  30                         WiFi.Security and WiFi.Passphrase. Check the
  31                         network interface description for details.
  32
  33                         Possible Errors: [service].Error.InvalidArguments
  34
  35                 void RemoveNetwork(object network)
  36
  37                         Removes a previously created network object.
  38
  39                         Possible Errors: [service].Error.InvalidArguments
  40                                          [service].Error.DoesNotExist
  41
  42 Signals         PropertyChanged(string name, variant value)
  43
  44                         This signal indicates a changed value of the given
  45                         property.
  46
  47 Properties      string Name [readonly]
  48
  49                         The device name (for example eth0, wlan0 etc.)
  50
  51                 string Type [readonly]
  52
  53                         The device type (for example ethernet, wifi etc.)
  54
  55                 boolean Powered [readwrite]
  56
  57                         Switch a device on or off. This will also modify
  58                         the list of networks in range. All known networks
  59                         will be still available via the Networks property.
  60
  61                 boolean Scanning [readonly]
  62
  63                         Indicates if a device is scanning. Not all device
  64                         types might support this. Also some hardware might
  65                         execute background scanning without notifying the
  66                         driver about it. Use this property only for visual
  67                         indication.
  68
  69                 array{object} Networks [readonly]
  70
  71                         List of networks objects paths. Every object path
  72                         represents a network in range or a known network.