freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.GSM.MUX

Description

The MUX interface is used to manage and control virtual serial channels (implemented through pseudo TTYs) which are multiplexed to one serial line as described in 3GPP TS 07.10.

Namespace

org.freesmartphone.GSM.MUX

Methods

Signals

Errors

Methods

OpenSession ( bisi )

Description: Initiate a new multiplexing session.

The device needs to support the +CMUX command.

Parameters

b: advanced

True, to use 07.10 Advanced Mode multiplexing, False to use 07.10 Basic Mode multiplexing.

i: framesize

The maximum framesize for 07.10 multiplexing frames.

s: portname

The port name to use.

i: portspeed

The port speed to use.

CloseSession ( )

Description: Closes a multiplexing session.

The device will be left in AT command mode.

AllocChannel ( si ) → si

Description: Allocate a new virtual channel. Raises NoChannel if the requested channel can not be allocated. Raises ChannelTaken if the requested channel is already allocated.

Parameters

s: origin

A handle for channel user identification.

i: channel

The requested channel. Submit 0 to request the next free channel.

Returns

s: path

The pseudo tty connected to the virtual channel.

i: allocated_channel

The channel number that has been allocated.

ReleaseChannel ( s )

Description: Release all channels requested by a specified user.

Parameters

s: origin

A handle for channel user identification.

SetStatus ( is )

Description: Modify the v24 status of a virtual channel.

Parameters

i: channel

The virtual channel you want to change the outgoing status for.

s: status

The new v.24 status. See Status for the format.

Signals

Status ( s )

Description: Sent whenever there is v.24 incoming status change on a virtual channel.

Parameters

s: status

The new v.24 status, which is a string combined of elements that make up the status. Valid elements are:

Errors

ChannelTaken

Description: Raised, when the requested channel is already allocated.

NoChannel

Description: Raised, when the device can't allocate the requested channel.

NoSession

Description: Raised, when there is no active session.

SessionAlreadyOpen

Description: Raised, when a session has already been opened.

SessionOpenError

Description: Raised, when the session can not be opened.


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