Developer World
Spresense Arduino Library v3.3.0-b2e6327
LTEModemVerification Class Reference

[en] The class to get modem information.
[ja] モデムの情報を取得するクラス。 More...

#include <LTEModemVerification.h>

Public Member Functions

 LTEModemVerification ()
 Construct LTEModemVerification instance.
 
 ~LTEModemVerification ()
 Destruct LTEModemVerification instance.
 
LTEModemStatus begin ()
 Power on the modem. More...
 
String getIMEI ()
 Get IMEI. More...
 
String getFirmwareVersion ()
 Get firmware version of the modem. More...
 
LTENetworkRatType getRAT ()
 Get RAT(Radio Access Technology). More...
 
LTEModemStatus getStatus ()
 Get the modem status. More...
 

Detailed Description

[en] The class to get modem information.
[ja] モデムの情報を取得するクラス。

Attention
[en] To use this class, include LTE.h.
[ja] このクラスを使用する場合、 LTE.h をインクルードしてください。

Member Function Documentation

◆ begin()

LTEModemStatus LTEModemVerification::begin ( )

Power on the modem.

[en] Power on the modem. If the modem is powered on, restart it. This method must be called before use any other methods.

[ja] モデムの電源をONにします。モデムの電源がONの場合はモデムの電源をOFFにしてから電源をONにします。 このメソッドはほかのメソッドを利用する前に必ず呼び出す必要があります。

Returns
[en] Returns LTE_IDLE on success, LTE_ERROR if an error occurs.
[ja] 成功時はLTE_IDLE、エラーが発生した場合、LTE_ERRORを返します。

◆ getIMEI()

String LTEModemVerification::getIMEI ( )

Get IMEI.

[en] Get IMEI(International Mobile Equipment Identity) of modem.

[ja] モデムのIMEI(International Mobile Equipment Identity)を取得します。

Returns
[en] Returns IMEI of the modem on success, "N/A" if an error occurs.
[ja] 成功時はモデムのIMEIを返し、エラーが発生した場合、"N/A"を返します。

◆ getFirmwareVersion()

String LTEModemVerification::getFirmwareVersion ( )

Get firmware version of the modem.

Get firmware version.

[en] Get firmware version of the modem.

[ja] モデムのファームウェアバージョンを取得します。

Returns
[en] Returns firmware version of the modem on success, "N/A" if an error occurs.
[ja] 成功時はモデムのファームウェアバージョンを返し、エラーが発生した場合、"N/A"を返します。

◆ getRAT()

LTENetworkRatType LTEModemVerification::getRAT ( )

Get RAT(Radio Access Technology).

[en] Get the RAT(Radio Access Technology) currently used by the modem.

[ja] モデムが現在使用しているRAT(Radio Access Technology)を取得します。

Returns
[en] RAT type defined as LTENetworkRatType. Returns LTE_NET_RAT_UNKNOWN if an error occurs.
[ja] 成功時は LTENetworkRatType が定義するRAT形式を返し、エラーが発生した場合、LTE_NET_RAT_UNKNOWNを返します。

◆ getStatus()

LTEModemStatus LTEModemVerification::getStatus ( )

Get the modem status.

[en] Get the modem status.

[ja] モデムの状態を取得します。

Returns
[en] Status code defined as LTEModemStatus.
[ja] LTEModemStatus で定義するステータスコード。

The documentation for this class was generated from the following file: