summaryrefslogtreecommitdiff
path: root/doc/device-lowlevel-api.txt
blob: f01751bbc67465525ebed1a8f3e359060c30f6bc (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
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

		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.InvalidProperty

		void ProposeScan()

			Proposes to trigger a scan transaction.

			Possible Errors: [service].Error.InvalidArguments

Signals		PropertyChanged(string name, variant value)

			This signal indicates a changed value of the given
			property.

Properties	string Address [readonly]

			The address of the device.

		string Name [readonly]

			The device name (for example "Wireless" etc.)

			This name can be used for directly displaying it in
			the application. It has pure informational purpose
			and there is not guarantee that it is present.

		string Type [readonly]

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

		string Interface [readonly]

			The device interface (for example "eth0" etc.)

			This value is for pure informational purposes. It
			is not guaranteed that it is always present.

		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.

			Changing this value doesn't change the value of the
			Policy property.

			The value of this property can be changed by other
			parts of the system (including the kernel). An
			example would be modifications via the "ifconfig"
			command line utility.

		boolean Blocked [readonly]

			Indicates if a device transmission capability is
			blocked or not. This property is a translation of
			the device rfkill status. If it is hard or soft
			blocked, this property will be true.

			Once a device is blocked, enabling it will fail.

		uint16 ScanInterval [readwrite]

			The scan interval describes the time in seconds
			between automated scan attempts. Setting this
			value to 0 will disable the background scanning.

			The default value is 300 and so every 5 minutes
			a scan procedure will be triggered.

			This property is not available with all types
			of devices. Some might not support background
			scanning at all.

		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.