com.esf.device.modem.service
Interface ISierraEvdoModemService

All Superinterfaces:
IBasicCellularModemService, ICellularModemService, IUsbCellularModemService, IUsbModemService

public interface ISierraEvdoModemService
extends IUsbCellularModemService


Field Summary
static java.lang.String SERVICE_NAME
          service name of this interface for the bundle activator (com.esf.device.modem.service.IEvdoModemService)
 
Method Summary
 java.util.GregorianCalendar getActivationDate()
          Reports Activation Date
 java.lang.String getActivationStatus()
          Reports activation status
 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 getFirmwareDate()
          Reports firmware date
 java.lang.String getFirmwareVersion()
          Reports firmware version
 java.lang.String getMobileDirectoryNumber()
          Reports Mobile Directory Number (MDN)
 java.lang.String getMobileIdentificationNumber()
          Reports Mobile Identification Number (MIN)
 int getNetworkID()
           
 int getPRLversion()
          Obtains current PRL (Preferred Roaming List) version
 java.lang.String getRoamingStatus()
          Reports roaming status
 int getSystemID()
           
 boolean isActivated()
          Answers if EVDO modem is activated
 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
 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.IUsbCellularModemService
getSupportedInterfaceType
 
Methods inherited from interface com.esf.device.modem.service.ICellularModemService
applyNewConfiguration, connect, disconnect, getCallRxCounter, getCallTxCounter, getConnectionInfo, getIPaddress, getNetworkTechnology, getPeerIPaddress, getPowerMode, getServiceType, getSignalStrength, isConnected, isConnecting, isEnabledInConfiguration, isRoaming, provideConfiguration, reset, turnOff, turnOn
 
Methods inherited from interface com.esf.device.modem.service.IBasicCellularModemService
allowConnect, disable, enable, getManufacturer, getModel, getRevisionID, getSerialNumber, isConnectAllowed, isEnabled, isOn
 
Methods inherited from interface com.esf.device.modem.service.IUsbModemService
getProductID, getUsbPortAddress, getVendorID
 

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

getMobileIdentificationNumber

java.lang.String getMobileIdentificationNumber()
                                               throws java.lang.Exception
Reports Mobile Identification Number (MIN)

Returns:
MIN
Throws:
java.lang.Exception

getFirmwareVersion

java.lang.String getFirmwareVersion()
                                    throws java.lang.Exception
Reports firmware version

Returns:
firmware version as String
Throws:
java.lang.Exception

getFirmwareDate

java.lang.String getFirmwareDate()
                                 throws java.lang.Exception
Reports firmware date

Returns:
firmware date as String
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

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

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

Parameters:
msl - - Master Subsidy Lock (MSL) as String
mdn - - Mobile Directory Number (MDN) as String
min - - Mobile Identification Number (MIN) as String
sid - - System ID (SID) as int
nid - - Network ID (NID) as int
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

provision

void provision()
               throws java.lang.Exception
This method provisions EVDO modem

Throws:
java.lang.Exception

getSystemID

int getSystemID()
                throws java.lang.Exception
Throws:
java.lang.Exception

getNetworkID

int getNetworkID()
                 throws java.lang.Exception
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

getRoamingStatus

java.lang.String getRoamingStatus()
                                  throws java.lang.Exception
Reports roaming status

Returns:
roaming status as String
Throws:
java.lang.Exception

getActivationStatus

java.lang.String getActivationStatus()
                                     throws java.lang.Exception
Reports activation status

Returns:
activation status as String
Throws:
java.lang.Exception