freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.GSM.Device

Description

The Device interface is used to give information about the GSM device and its capabilities. Use it also to enable or disable the RF subsystem (which is mandatory for implementing a flight mode).

Namespace

org.freesmartphone.GSM.Device

Methods

Signals

None

Errors

Methods

GetInfo ( ) → a{sv}

Description: Get information about the GSM device.

This can map to the following GSM 07.07 commands:

Returns

a{sv}: info

Information about this GSM device. Mandatory tuples are:

Optional tuples are:

GetAntennaPower ( ) → b

Description: Retrieve antenna power status from the device.

This maps to the GSM 07.07 command +CFUN=?, see 3GPP TS 07.07 Chapter 8.2.

Returns

b: antenna_power

True, when the antenna is powered on. False, otherwise.

SetAntennaPower ( b )

Description: Set antenna power status for this device. Will raise AuthFailed if the SIM is protected with an authentication code.

This maps to the GSM 07.07 command +CFUN=(antenna_power), see 3GPP TS 07.07 Chapter 8.2.

Parameters

b: antenna_power

True, for powering on the antenna. False, otherwise.

GetFeatures ( ) → a{sv}

Description: Get information about the telephony features supported by this device.

This maps to the GSM 07.07 command +GCAP, see 3GPP TS 07.07 Chapter 5.8.

Returns

a{sv}: features

The telephony features supported by this device. Expected tuples are:

GetSpeakerVolume ( ) → i

Description: Retrieve the current loudspeaker volume.

This maps to the GSM 07.07 command +CLVL?, see 3GPP TS 07.07 Chapter 8.2.3.

Returns

i: volume

The volume in percent (0-100).

SetSpeakerVolume ( i )

Description: Set the current loudspeaker volume.

This maps to the GSM 07.07 command +CLVL=... see 3GPP TS 07.07 Chapter 8.2.3.

Parameters

i: volume

The volume in percent (0-100).

GetMicrophoneMuted ( ) → b

Description: Retrieve whether the microphone is currently muted.

This maps to the GSM 07.07 command +CMUT?, see 3GPP TS 07.07 Chapter 8.2.4.

Returns

b: muted

True, if the microphone is muted. False, otherwise.

SetMicrophoneMuted ( b )

Description: Mute or unmute the microphone.

This maps to the GSM 07.07 command +CMUT=... see 3GPP TS 07.07 Chapter 8.2.4.

Parameters

b: muted

True, to mute the microphone. False, otherwise.

GetPowerStatus ( ) → si

Description: Retrieve the power status. This call is not implemented on most smartphones, since the battery is monitored by the application processor (as opposed to the baseband processor) there.

This maps to the GSM 07.07 command +CBC, see 3GPP TS 07.07 Chapter 8.4.

Returns

s: status

The power status. Valid values are:

i: level

The charging level in percent (0-100), if a battery is built in. -1, otherwise.

GetSimBuffersSms ( ) → b

Description: Retrieve whether incoming SMS are buffered on the SIM (in which case IncomingStoredMessage is sent) or sent directly via the IncomingMessage signal).

This maps to the GSM 07.07 command +CNMI?, see 3GPP TS 07.05 Chapter 3.4.1.

Returns

b: sim_buffers_sms

True, if incoming SMS are buffered on the SIM. False, otherwise.

SetSimBuffersSms ( b )

Description: Set whether incoming SMS should be buffered on the SIM (in which case IncomingStoredMessage is sent) or sent directly via the IncomingMessage signal).

This maps to the GSM 07.07 command +CNMI=..., see 3GPP TS 07.05 Chapter 3.4.1.

Parameters

b: sim_buffers_sms

True, if incoming SMS should be buffered on the SIM. False, otherwise.

Errors

NotPresent

Description: Raised, when the device is not present.

Timeout

Description: Raised, when the device does not answer within the specified time for this operation.

Failed

Description: Raised, when the device reported an unrecoverable error.


| Specified 2008 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org