freesmartphone.org GSM MUX Interface

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

Properties

None

Errors

None

Methods

OpenSession ( bisi )

Description: Initiate a new multiplexing session.

Implementation Note

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.

Implementation Note

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: