com.esf.device.modem.service
Interface IEvdoModemService

All Superinterfaces:

ICellularModemService, IModemService, IUsbModemService

All Known Subinterfaces:

IMC572xModemService

public interface IEvdoModemService
extends IModemService

Defines EVDO modem service.
Applicable for SierraWireless MC572x EvDO modems.

Author:

ilya.binshtok

Field Summary

static java.lang.String

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

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

NEW_CONFIGURATION_TOPIC

Method Summary

java.util.GregorianCalendar	getActivationDate() Reports Activation Date
int	getCallStatus() Reports Call Status
java.lang.String	getCallStatusString() Reports Call Status String.
int	getChannelNumber() Reports channel number
int	getChannelState() Reports channel state
java.lang.String	getChannelStateString() Reports channel state string.
int	getCurrentBandClass() Report current band class
java.lang.String	getCurrentBandClassString() Report current band class string.
java.lang.String	getMobileDirectoryNumber() Reports Mobile Directory Number (MDN)
java.lang.String	getMobileIdentificationNumber() Reports Mobile Identification Number (MIN)
int	getNetworkID() Reports current Network Identifier (NID)
int	getPRLversion() Obtains current PRL (Preferred Roaming List) Version
int	getSystemID() Reports current System Identifier (SID)
boolean	isActivated() Answers if EVDO modem is activated
boolean	isClientInitiatedDeviceConfigEnabled() Reports if Client-Initiated Device Configuration (CIDC) is enabled.
boolean	isClientInitiatedDeviceConfigSupported() Reports if Client-Initiated Device Configuration (CIDC) is supported by the modem.
boolean	isClientInitiatedFirmwareUpdateEnabled() Reports if Client-Initiated Firmware Update (CIFUMO) is enabled.
boolean	isClientInitiatedFirmwareUpdateSupported() Reports if Client-Initiated Firmware Update (CIFUMO) is supported.
boolean	isClientInitiatedPrlUpdateEnabled() Reports if Client-Initiated PRL Update (CIPRL) is enabled.
boolean	isClientInitiatedPrlUpdateSupported() Reports if Client-Initiated PRL Update (CIPRL) is supported by the modem.
boolean	isDMsupported() Reports if Device Management (DM) is supported by the modem.
void	provision() This method provisions EVDO modem
void	setMobileDirectoryNumber(java.lang.String msl, java.lang.String mdn) Sets Mobile Directory Number (MDN)
void	setMobileIdentificationNumber(java.lang.String msl, java.lang.String min) Sets Mobile Identification Number (MIN)
void	setNamProfile(java.lang.String msl, java.lang.String mdn, java.lang.String min, int sid, int nid) Sets NAM profile specified by the index.
void	updatePRL() Updates PRL (Preferred Roaming List) on the modem by launching Client-Initiated 'PRL Update' session with the service provider.
void	updatePRL(java.lang.String msl, byte[] prldata) Updates PRL (Preferred Roaming List) to the modem using PRL data supplied.
void	updatePRL(java.lang.String msl, java.lang.String prlfilename) Updates PRL (Preferred Roaming List) on the modem given full path to the PRL file.

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

applyNewConfiguration, connect, disconnect, getCallRxCounter, getCallTxCounter, getIPaddress, getNetworkTechnology, getPeerIPaddress, getPowerMode, getServiceType, getSignalStrength, isConnected, isConnecting, isRoaming, provideConfiguration, reset, 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

disable, enable, getManufacturer, getModel, getRevisionID, getSerialNumber, 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.modem.service.IEvdoModemService)

Method Detail

isActivated

boolean isActivated()
                    throws java.lang.Exception

Answers if EVDO modem is activated

Returns:

true - modem is activated false - modem is not activated

Throws:

java.lang.Exception

getActivationDate

java.util.GregorianCalendar getActivationDate()
                                              throws java.lang.Exception

Reports Activation Date

Returns:

activation date

Throws:

java.lang.Exception

getMobileDirectoryNumber

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

Reports Mobile Directory Number (MDN)

Returns:

MDN

Throws:

java.lang.Exception

setMobileDirectoryNumber

void setMobileDirectoryNumber(java.lang.String msl,
                              java.lang.String mdn)
                              throws java.lang.Exception

Sets Mobile Directory Number (MDN)

Parameters:

msl - - subsidy lock

mdn - - mobile directory number

Throws:

java.lang.Exception

getMobileIdentificationNumber

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

Reports Mobile Identification Number (MIN)

Returns:

MIN

Throws:

java.lang.Exception

setMobileIdentificationNumber

void setMobileIdentificationNumber(java.lang.String msl,
                                   java.lang.String min)
                                   throws java.lang.Exception

Sets Mobile Identification Number (MIN)

Parameters:

msl - - subsidy lock

min - - mobile identificaiton number

Throws:

java.lang.Exception

setNamProfile

void setNamProfile(java.lang.String msl,
                   java.lang.String mdn,
                   java.lang.String min,
                   int sid,
                   int nid)
                   throws java.lang.Exception

Sets NAM profile specified by the index.
This method uses modem's AT/PPP port and it terminates PPP session before setting the profile.
For the changes to take effect the modem must be reset

Parameters:

msl - - six digit Master Subsidy Lock

mdn - - ten digit Mobile Directory Number

min - - ten digit Mobile Identification Number

sid - - system ID

nid - - network ID

Throws:

java.lang.Exception

provision

void provision()
               throws java.lang.Exception

This method provisions EVDO modem

Throws:

java.lang.Exception

getPRLversion

int getPRLversion()
                  throws java.lang.Exception

Obtains current PRL (Preferred Roaming List) Version

Returns:

current PRL version

Throws:

java.lang.Exception

updatePRL

void updatePRL(java.lang.String msl,
               java.lang.String prlfilename)
               throws java.lang.Exception

Updates PRL (Preferred Roaming List) on the modem given full path to the PRL file.

Parameters:

msl - - Master Subsidy Lock

prlfilename - - absolute pass to prlfilename

Throws:

java.lang.Exception

updatePRL

void updatePRL(java.lang.String msl,
               byte[] prldata)
               throws java.lang.Exception

Updates PRL (Preferred Roaming List) to the modem using PRL data supplied. For changes to take affect, modem needs to be reset after this operation.

Parameters:

msl - - Master Subsidy Lock

prldata - - PRL data

Throws:

java.lang.Exception

updatePRL

void updatePRL()
               throws java.lang.Exception

Updates PRL (Preferred Roaming List) on the modem by launching Client-Initiated 'PRL Update' session with the service provider. For changes to take affect, modem needs to be reset after this operation.

Throws:

java.lang.Exception

isDMsupported

boolean isDMsupported()

Reports if Device Management (DM) is supported by the modem.

Returns:

true - DM is supported
false - DMis not supported

isClientInitiatedDeviceConfigSupported

boolean isClientInitiatedDeviceConfigSupported()

Reports if Client-Initiated Device Configuration (CIDC) is supported by the modem.

Returns:

true - CIDC is supported
false - CIDC is not supported

isClientInitiatedPrlUpdateSupported

boolean isClientInitiatedPrlUpdateSupported()

Reports if Client-Initiated PRL Update (CIPRL) is supported by the modem.

Returns:

true - CIPRL is supported
false - CIPRL is not supported

isClientInitiatedFirmwareUpdateSupported

boolean isClientInitiatedFirmwareUpdateSupported()

Reports if Client-Initiated Firmware Update (CIFUMO) is supported.

Returns:

true - CIFUMO is supported
false - CIFUMO is not supported

isClientInitiatedDeviceConfigEnabled

boolean isClientInitiatedDeviceConfigEnabled()

Reports if Client-Initiated Device Configuration (CIDC) is enabled.

Returns:

true - CIDC is enabled
false - CIDC is disabled

isClientInitiatedPrlUpdateEnabled

boolean isClientInitiatedPrlUpdateEnabled()

Reports if Client-Initiated PRL Update (CIPRL) is enabled.

Returns:

true - CIPRL is enabled
false - CIPRL is disabled

isClientInitiatedFirmwareUpdateEnabled

boolean isClientInitiatedFirmwareUpdateEnabled()

Reports if Client-Initiated Firmware Update (CIFUMO) is enabled.

Returns:

true - CIFUMO is enabled
false - CIFUMO is disabled

getSystemID

int getSystemID()
                throws java.lang.Exception

Reports current System Identifier (SID)

Returns:

- system ID

Throws:

java.lang.Exception

getNetworkID

int getNetworkID()
                 throws java.lang.Exception

Reports current Network Identifier (NID)

Returns:

network ID

Throws:

java.lang.Exception

getChannelNumber

int getChannelNumber()
                     throws java.lang.Exception

Reports channel number

Returns:

channel number

Throws:

java.lang.Exception

getChannelState

int getChannelState()
                    throws java.lang.Exception

Reports channel state

Returns:

channel state

Throws:

java.lang.Exception

getChannelStateString

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

Reports channel state string. (e.g. 'acquired', 'not acquired', 'scanning')

Returns:

channel state s

Throws:

java.lang.Exception

getCurrentBandClass

int getCurrentBandClass()
                        throws java.lang.Exception

Report current band class

Returns:

current band class.

Throws:

java.lang.Exception

getCurrentBandClassString

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

Report current band class string. (e.g. cellular, PCS)

Returns:

current band class

Throws:

java.lang.Exception

getCallStatus

int getCallStatus()
                  throws java.lang.Exception

Reports Call Status

Returns:

call status

Throws:

java.lang.Exception

getCallStatusString

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

Reports Call Status String. (e.g. 'Disconnected', 'Connecting', 'Connected', 'Dormant')

Returns:

call status

Throws:

java.lang.Exception