vcs.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                 boolean Powered [readwrite]
  58
  59                         Switch a device on or off. This will also modify
  60                         the list of networks in range. All known networks
  61                         will be still available via the Networks property.
  62
  63                 boolean Scanning [readonly]
  64
  65                         Indicates if a device is scanning. Not all device
  66                         types might support this. Also some hardware might
  67                         execute background scanning without notifying the
  68                         driver about it. Use this property only for visual
  69                         indication.
  70
  71                 array{object} Networks [readonly]
  72
  73                         List of networks objects paths. Every object path
  74                         represents a network in range or a known network.