org.eclipse.kura.net.modem

Interface CellularModem

@ProviderType
public interface CellularModem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CellularModem.SerialPortType

Method Summary

Modifier and Type	Method and Description
void	disableDiversity()
void	disableGps()
void	enableDiversity()
void	enableGps()
java.lang.String	getAtPort()
java.lang.String	getBand()
long	getCallRxCounter() Reports number of bytes received during a call
long	getCallTxCounter() Reports number of bytes transmitted during a call
java.lang.String	getCI()
java.util.List<NetConfig>	getConfiguration()
java.lang.String	getDataPort()
java.lang.String	getFirmwareVersion() Return the firmware version of the modem module
java.lang.String	getGpsPort()
java.lang.String	getIntegratedCirquitCardId() Deprecated. since 2.4. Use getIntegratedCirquitCardId(boolean recompute) instead.
java.lang.String	getIntegratedCirquitCardId(boolean recompute) Answers Integrated Circuit Card Identification (ICCID)
java.lang.String	getLAC()
java.lang.String	getManufacturer() Returns modem's manufacturer identification
java.lang.String	getMobileSubscriberIdentity() Deprecated. since 2.4. Use getMobileSubscriberIdentity(boolean recompute) instead.
java.lang.String	getMobileSubscriberIdentity(boolean recompute) Answers International Mobile Subscribe Identity (IMSI)
java.lang.String	getModel() Reports modem's model
ModemDevice	getModemDevice() Returns the associated UsbModemDevice
java.lang.String	getNetworkName()
java.util.List<ModemPdpContext>	getPdpContextInfo()
java.lang.String	getPLMNID()
java.lang.String	getRadio()
ModemRegistrationStatus	getRegistrationStatus() Deprecated. since 2.4. Use getRegistrationStatus(boolean recompute) instead.
ModemRegistrationStatus	getRegistrationStatus(boolean recompute) Reports modem registration status
java.lang.String	getRevisionID() Reports modem's revision identification
CommURI	getSerialConnectionProperties(CellularModem.SerialPortType portType)
java.lang.String	getSerialNumber() Answers modem's serial number (IMEI/MEID/ESN)
java.lang.String	getServiceType() Reports Service Type
int	getSignalStrength() Deprecated. since 2.4. Use getSignalStrength(boolean recompute) instead.
int	getSignalStrength(boolean recompute) Reports signal strength in dBm
java.util.List<ModemTechnologyType>	getTechnologyTypes()
boolean	hasDiversityAntenna()
boolean	isDiversityEnabled()
boolean	isGpsEnabled()
boolean	isGpsSupported()
boolean	isPortReachable(java.lang.String port) Reports if specified port can be opened
boolean	isReachable() Reports if Modem replies to the 'AT' command
void	reset() resets the modem and tries to restore the state of the modem driver.
void	setConfiguration(java.util.List<NetConfig> netConfigs)

Method Detail

getModel

java.lang.String getModel()
                   throws KuraException

Reports modem's model

Returns:

model, null if not known

Throws:

KuraException

getManufacturer

java.lang.String getManufacturer()
                          throws KuraException

Returns modem's manufacturer identification

Returns:

manufacturer, null if not known

Throws:

KuraException

getSerialNumber

java.lang.String getSerialNumber()
                          throws KuraException

Answers modem's serial number (IMEI/MEID/ESN)

Returns:

serial number, null if not known

Throws:

KuraException

getMobileSubscriberIdentity

@Deprecated
java.lang.String getMobileSubscriberIdentity()
                                                  throws KuraException

Deprecated. since 2.4. Use getMobileSubscriberIdentity(boolean recompute) instead.

Answers International Mobile Subscribe Identity (IMSI)

Returns:

IMSI number, null if not known

Throws:

KuraException

getIntegratedCirquitCardId

@Deprecated
java.lang.String getIntegratedCirquitCardId()
                                                 throws KuraException

Deprecated. since 2.4. Use getIntegratedCirquitCardId(boolean recompute) instead.

Answers Integrated Circuit Card Identification (ICCID)

Returns:

ICCID, "N/A" if not applicable

Throws:

KuraException

getRevisionID

java.lang.String getRevisionID()
                        throws KuraException

Reports modem's revision identification

Returns:

revision ID, null if not known

Throws:

KuraException

isReachable

boolean isReachable()
             throws KuraException

Reports if Modem replies to the 'AT' command

Returns:

'true' if AT reachable, 'false' otherwise

Throws:

KuraException

isPortReachable

boolean isPortReachable(java.lang.String port)

Reports if specified port can be opened

Parameters:

port - - modem's serial port

Returns:

'true' if port can be opened, 'false' otherwise

reset

void reset()
    throws KuraException

resets the modem and tries to restore the state of the modem driver. (e.g. PPP connection, status thread)

Throws:

KuraException

getSignalStrength

@Deprecated
int getSignalStrength()
                           throws KuraException

Deprecated. since 2.4. Use getSignalStrength(boolean recompute) instead.

Reports signal strength in dBm

Returns:

signal strength

Throws:

KuraException

getRegistrationStatus

@Deprecated
ModemRegistrationStatus getRegistrationStatus()
                                                   throws KuraException

Deprecated. since 2.4. Use getRegistrationStatus(boolean recompute) instead.

Reports modem registration status

Returns:

modem registration status as ModemRegistrationStatus

Throws:

KuraException

getCallTxCounter

long getCallTxCounter()
               throws KuraException

Reports number of bytes transmitted during a call

Returns:

number of bytes transmitted

Throws:

KuraException

getCallRxCounter

long getCallRxCounter()
               throws KuraException

Reports number of bytes received during a call

Returns:

number of bytes received

Throws:

KuraException

getServiceType

java.lang.String getServiceType()
                         throws KuraException

Reports Service Type

Returns:

service indication

Throws:

KuraException

getModemDevice

ModemDevice getModemDevice()

Returns the associated UsbModemDevice

Returns:

UsbModemDevice

getLAC

java.lang.String getLAC()
                 throws KuraException

Throws:

KuraException

Since:

2.4

getCI

java.lang.String getCI()
                throws KuraException

Throws:

KuraException

Since:

2.4

getPLMNID

java.lang.String getPLMNID()
                    throws KuraException

Throws:

KuraException

Since:

2.4

getBand

java.lang.String getBand()
                  throws KuraException

Throws:

KuraException

Since:

2.4

getNetworkName

java.lang.String getNetworkName()
                         throws KuraException

Throws:

KuraException

Since:

2.4

getRadio

java.lang.String getRadio()
                   throws KuraException

Throws:

KuraException

Since:

2.4

getDataPort

java.lang.String getDataPort()
                      throws KuraException

Throws:

KuraException

getAtPort

java.lang.String getAtPort()
                    throws KuraException

Throws:

KuraException

getGpsPort

java.lang.String getGpsPort()
                     throws KuraException

Throws:

KuraException

getSerialConnectionProperties

CommURI getSerialConnectionProperties(CellularModem.SerialPortType portType)
                               throws KuraException

Throws:

KuraException

isGpsSupported

boolean isGpsSupported()
                throws KuraException

Throws:

KuraException

isGpsEnabled

boolean isGpsEnabled()

enableGps

void enableGps()
        throws KuraException

Throws:

KuraException

disableGps

void disableGps()
         throws KuraException

Throws:

KuraException

hasDiversityAntenna

boolean hasDiversityAntenna()

Since:

2.2

isDiversityEnabled

boolean isDiversityEnabled()

Since:

2.2

enableDiversity

void enableDiversity()
              throws KuraException

Throws:

KuraException

Since:

2.2

disableDiversity

void disableDiversity()
               throws KuraException

Throws:

KuraException

Since:

2.2

getConfiguration

java.util.List<NetConfig> getConfiguration()

setConfiguration

void setConfiguration(java.util.List<NetConfig> netConfigs)

getTechnologyTypes

java.util.List<ModemTechnologyType> getTechnologyTypes()
                                                throws KuraException

Throws:

KuraException

getPdpContextInfo

java.util.List<ModemPdpContext> getPdpContextInfo()
                                           throws KuraException

Throws:

KuraException

Since:

1.4

getFirmwareVersion

java.lang.String getFirmwareVersion()
                             throws KuraException

Return the firmware version of the modem module

Returns:

a string representing the firmware version

Throws:

KuraException

Since:

2.3

getSignalStrength

int getSignalStrength(boolean recompute)
               throws KuraException

Reports signal strength in dBm

Parameters:

recompute: - if true the value is recomputed. Otherwise, a cached value is returned

Returns:

an integer representing the rssi

Throws:

KuraException

Since:

2.4

getRegistrationStatus

ModemRegistrationStatus getRegistrationStatus(boolean recompute)
                                       throws KuraException

Reports modem registration status

Parameters:

recompute: - if true the value is recomputed. Otherwise, a cached value is returned

Returns:

modem registration status as ModemRegistrationStatus

Throws:

KuraException

Since:

2.4

getMobileSubscriberIdentity

java.lang.String getMobileSubscriberIdentity(boolean recompute)
                                      throws KuraException

Answers International Mobile Subscribe Identity (IMSI)

Parameters:

recompute: - if true the value is recomputed. Otherwise, a cached value is returned

Returns:

IMSI number, null if not known

Throws:

KuraException

Since:

2.4

getIntegratedCirquitCardId

java.lang.String getIntegratedCirquitCardId(boolean recompute)
                                     throws KuraException

Answers Integrated Circuit Card Identification (ICCID)

Parameters:

recompute: - if true the value is recomputed. Otherwise, a cached value is returned

Returns:

ICCID, "N/A" if not applicable

Throws:

KuraException

Since:

2.4