LTEScanNetworks Class Reference

[en] The class to get LTE network information.
[ja] LTEネットワークの情報を取得するためのクラス。 More...

#include <LTEScanNetworks.h>

Public Member Functions
	LTEScanNetworks ()
	Construct LTEScanNetworks instance.
	~LTEScanNetworks ()
	Destruct LTEScanNetworks instance.
LTEModemStatus	begin ()
	Power on the modem. More...
String	getSignalStrength ()
	Get signal strength. More...
String	getCurrentCarrier ()
	Get the name of the connected LTE network carrier. More...
LTEModemStatus	getStatus ()
	Get the modem status. More...

Detailed Description

[en] The class to get LTE network information.
[ja] LTEネットワークの情報を取得するためのクラス。

Attention

[en] To use this class, include LTE.h.

[ja] このクラスを使用する場合、 LTE.h をインクルードしてください。

Member Function Documentation

begin()

LTEModemStatus LTEScanNetworks::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を返します。

getSignalStrength()

String LTEScanNetworks::getSignalStrength

(

)

Get signal strength.

[en] Get received signal strength of the LTE network.

[ja] LTEネットワークの受信強度を取得します。

Attention

[en] The received signal strength cannot be obtained when the modem status is OFF or IDLE.

[ja] モデムの状態がOFFまたはIDLEの場合は受信強度を取得出来ません。

Returns

[en] Returns RSSI(Received Signal Strength Indication)[dBm] on success, "N/A" if the received strength could not be obtained or an error occurs.

[ja] 成功時はRSSI(Received Signal Strength Indication)[dBm]を返し、 受信強度が取得できなかった場合、またはエラーが発生した場合、"N/A"を返します。

getCurrentCarrier()

String LTEScanNetworks::getCurrentCarrier

(

)

Get the name of the connected LTE network carrier.

[en] Get the name of the connected LTE network carrier.

[ja] 接続したLTEネットワークキャリア名を取得します。

Attention

[en] The carrier name cannot be obtained when the modem status is not LTE_READY.

[ja] モデムの状態がLTE_READY状態でない場合はキャリア名を取得出来ません。

Returns

[en] Returns the name of the connected LTE network carrier on success, "N/A" if the received LTE network carrier could not be obtained or an error occurs.

[ja] 成功時は接続したLTEネットワークキャリア名を返し、 LTEネットワークキャリア名が取得出来なかった場合、またはエラーが発生した場合、"N/A"を返します。

getStatus()

LTEModemStatus LTEScanNetworks::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:

• LTE/src/LTEScanNetworks.h