summaryrefslogtreecommitdiffstats
path: root/doc/modem-api.txt
blob: b92e53cd73867f68e486230023caba3aa48ecad3 (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
Modem hierarchy
===============

Service		org.ofono
Interface	org.ofono.Modem
Object path	[variable prefix]/{modem0,modem1,...}

Methods		dict GetProperties()

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

			Possible Errors: [service].Error.InvalidArguments

		void SetProperty(string property, variant value)

			Changes the value of the specified property. Only
			properties that are listed as readwrite 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	boolean Powered [readwrite]

			Boolean representing the power state of the modem
			device.

		boolean Online [readwrite]

			Boolean representing the rf state of the modem.
			Online is false in flight mode.

		boolean Emergency [readonly, optional, experimental]

			Boolean representing the emergency mode of the
			modem. The Emergency is true if an emergency call or
			related operation is currently active.

		string Name [readonly, optional]

			Friendly name of the modem device.

		string Manufacturer [readonly, optional]

			String representing the manufacturer of the modem
			device.

			This is usually obtained by the +CGMI AT command.

		string Model [readonly, optional]

			String representing the model of the modem device.

			This is usually obtained by the +CGMM AT command.

		string Revision [readonly, optional]

			String representing the revision of the modem device.

			This is usually obtained by using the +CGMR AT command.

		string Serial [readonly, optional]

			String represeting the serial number of the modem
			device.

			This is usually obtained by using the +CGSN AT command.

		array{string} Features [readonly]

			List of currently enabled features. It uses simple
			string abbreviations like "sms", "sim" etc.

		array{string} Interfaces [readonly]

			Set of interfaces currently supported by the mode
			device. The set depends on the state of the device
			(registration status, SIM inserted status,
			network capabilities, device capabilities, etc.)

			TODO: Better to split this into Status and
			      Capabilites properties?