summaryrefslogtreecommitdiff
path: root/doc/device-api.txt
blob: d50a6c5f66272230de10d26accdb9f83b5662e92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Device hierarchy
================

Service		org.moblin.connman
Interface	org.moblin.connman.Device
Object path	[variable prefix]/{device0,device1,...}

Methods		dict GetProperties()

			Returns properties for the device object. See
			the properties section for available properties.

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.DoesNotExist

		void SetProperty(string name, variant value)

			Changes the value of the specified property. Only
			properties that are listed as read-write are
			changeable. On success a PropertyChanged signal
			will be emitted.

			Possible Errors: [service].Error.InvalidArguments
					 [service].Error.DoesNotExist

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string Name [readonly]

			The device name (for example eth0, wlan0 etc.)

		string Type [readonly]

			The device type (for example ethernet, wifi etc.)

		boolean Powered [readwrite]

			Switch a device on or off. This will also modify
			the list of networks in range. All known networks
			will be still available via the Networks property.

		boolean Scanning [readonly]

			Indicates if a device is scanning. Not all device
			types might support this. Also some hardware might
			execute background scanning without notifying the
			driver about it. Use this property only for visual
			indication.

		array{object} Networks [readonly]

			List of networks objects paths. Every object path
			represents a network in range or a known network.