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.InvalidProperty
  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                         and there is not guarantee that it is present.
  71
  72                 string Type [readonly]
  73
  74                         The device type (for example "ethernet", "wifi" etc.)
  75
  76                 string Interface [readonly]
  77
  78                         The device interface (for example "eth0" etc.)
  79
  80                         This value is for pure informational purposes. It
  81                         is not guaranteed that it is always present.
  82
  83                 boolean Powered [readwrite]
  84
  85                         Switch a device on or off. This will also modify
  86                         the list of networks in range. All known networks
  87                         will be still available via the Networks property.
  88
  89                         Changing this value doesn't change the value of the
  90                         Policy property.
  91
  92                         The value of this property can be changed by other
  93                         parts of the system (including the kernel). An
  94                         example would be modifications via the "ifconfig"
  95                         command line utility.
  96
  97                 uint16 ScanInterval [readwrite]
  98
  99                         The scan interval describes the time in seconds
 100                         between automated scan attempts. Setting this
 101                         value to 0 will disable the background scanning.
 102
 103                         The default value is 300 and so every 5 minutes
 104                         a scan procedure will be triggered.
 105
 106                         This property is not available with all types
 107                         of devices. Some might not support background
 108                         scanning at all.
 109
 110                 boolean Scanning [readonly]
 111
 112                         Indicates if a device is scanning. Not all device
 113                         types might support this. Also some hardware might
 114                         execute background scanning without notifying the
 115                         driver about it. Use this property only for visual
 116                         indication.
 117
 118                 array{object} Networks [readonly]
 119
 120                         List of networks objects paths. Every object path
 121                         represents a network in range or a known network.