com.esf.device.modem.service
Interface I3gModemService

All Superinterfaces:

IBasicCellularModemService, ICellularModemService, IModemService, IUsbModemService

public interface I3gModemService
extends IModemService

Defines 3G modem service

Author:

ilya.binshtok

Field Summary

static java.lang.String

SERVICE_NAME service name of this interface for the bundle activator (com.esf.device._3G.modem.service.I3gModemService)

Fields inherited from interface com.esf.device.modem.service.IModemService

NEW_CONFIGURATION_TOPIC

Method Summary

java.lang.String[]	getAllowedFrequencyBands() Reports allowed values for <bandsetInd>
java.lang.String	getCurrentFrequencyBand() Reports Current Frequency Band.
java.lang.String	getICCID() Returns SIM card's ICCID (20-digit decimal number)
int	getPrlRegion() Reports PRL region
java.lang.String	getPrlRegionName() Reports name of the PRL region.
java.lang.String	getSelectedFrequencyBand() Reports frequency band selected with "at!band=<bandind>" command.
java.lang.String	getSIMstatus() Reports the status
java.lang.String	getSystemMode() Reports System Mode.
boolean	isSIMok() Answers if SIM card is ok
void	setFrequencyBand(java.lang.String bandInd) Sets frequencyBand using the at!band=<bandInd> command
void	setPrlRegion(java.lang.String password, int region) Sets PRL region.

Methods inherited from interface com.esf.device.modem.service.IModemService

applyNewConfiguration, connect, disconnect, getCallRxCounter, getCallTxCounter, getIPaddress, getNetworkTechnology, getPeerIPaddress, getPowerMode, getServiceType, getSignalStrength, isConfigured, isConnected, isConnecting, isRoaming, provideConfiguration, reset, sendSms, turnOff, turnOn

Methods inherited from interface com.esf.device.modem.service.IUsbModemService

getProductID, getUsbPortAddress, getVendorID

Methods inherited from interface com.esf.device.modem.service.ICellularModemService

getConnectionInfo, isEnabledInConfiguration

Methods inherited from interface com.esf.device.modem.service.IBasicCellularModemService

allowConnect, disable, enable, getManufacturer, getModel, getRevisionID, getSerialNumber, isConnectAllowed, isEnabled, isOn

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

service name of this interface for the bundle activator (com.esf.device._3G.modem.service.I3gModemService)

Method Detail

isSIMok

boolean isSIMok()
                throws java.lang.Exception

Answers if SIM card is ok

Returns:

true - SIM card is ok false - SIM card error

Throws:

java.lang.Exception

getSIMstatus

java.lang.String getSIMstatus()
                              throws java.lang.Exception

Reports the status

Returns:

status of the SIM card

Throws:

java.lang.Exception

getSystemMode

java.lang.String getSystemMode()
                               throws java.lang.Exception

Reports System Mode. (e.g. GPRS, EDGE, UMTS, HSDPA, HSUPA, HSPA)

Returns:

System mode string

Throws:

java.lang.Exception

getCurrentFrequencyBand

java.lang.String getCurrentFrequencyBand()
                                         throws java.lang.Exception

Reports Current Frequency Band. (e.g. GSN 900, WCDMA 2100, etc...)

Returns:

frequency band string

Throws:

java.lang.Exception

setFrequencyBand

void setFrequencyBand(java.lang.String bandInd)
                      throws java.lang.Exception

Sets frequencyBand using the at!band=<bandInd> command

Parameters:

bandInd - - band index

Throws:

java.lang.Exception

getAllowedFrequencyBands

java.lang.String[] getAllowedFrequencyBands()
                                            throws java.lang.Exception

Reports allowed values for <bandsetInd>

Returns:

list of allowed frequency bands

Throws:

java.lang.Exception

getSelectedFrequencyBand

java.lang.String getSelectedFrequencyBand()
                                          throws java.lang.Exception

Reports frequency band selected with "at!band=<bandind>" command.

Returns:

frequency band

Throws:

java.lang.Exception

getICCID

java.lang.String getICCID()
                          throws java.lang.Exception

Returns SIM card's ICCID (20-digit decimal number)

Returns:

ICCID

Throws:

java.lang.Exception

getPrlRegion

int getPrlRegion()
                 throws java.lang.Exception

Reports PRL region

Returns:

PRL region

Throws:

java.lang.Exception

getPrlRegionName

java.lang.String getPrlRegionName()
                                  throws java.lang.Exception

Reports name of the PRL region. (e.g. Europe, North America, Australia, etc...)

Returns:

name of the PRL region

Throws:

java.lang.Exception

setPrlRegion

void setPrlRegion(java.lang.String password,
                  int region)
                  throws java.lang.Exception

Sets PRL region. (e.g. Europe, North America, Australia, etc...)

Parameters:

password - - password to unlock protected API commands

region - - PRL region

Throws:

java.lang.Exception