Developer World
Spresense Arduino Library v3.3.0-b2e6327
Public Member Functions | List of all members
LTEAccessProvider Class Reference
LTE Library API

[en] The class to construct a path for communication between the LTE network and modem.
[ja] LTEネットワークとモデム間で通信するための通信経路を構築するクラス。 More...

#include <LTEAccessProvider.h>

Public Member Functions

 LTEAccessProvider ()
 Construct LTEAccessProvider instance.
 
 ~LTEAccessProvider ()
 Destruct LTEAccessProvider instance.
 
LTEModemStatus begin (char *pinCode=NULL, bool restart=true, bool synchronous=true)
 Power on the modem and start the network search. More...
 
void shutdown ()
 Power off the LTE modem and detach the modem from the LTE network. More...
 
LTEModemStatus attach (const char *apn, const char *userName=NULL, const char *password=NULL, LTENetworkAuthType authType=LTE_NET_AUTHTYPE_CHAP, LTENetworkIPType ipType=LTE_NET_IPTYPE_V4V6, bool synchronous=true)
 Register the modem on the LTE network. More...
 
LTEModemStatus attach (LTENetworkRatType rat, const char *apn, const char *userName=NULL, const char *password=NULL, LTENetworkAuthType authType=LTE_NET_AUTHTYPE_CHAP, LTENetworkIPType ipType=LTE_NET_IPTYPE_V4V6, bool synchronous=true)
 Register the modem on the LTE network after configuring RAT. More...
 
LTEModemStatus detach ()
 Detach the modem from the LTE network. More...
 
IPAddress getIPAddress ()
 Get IP address assigned by LTE network. More...
 
unsigned long getTime ()
 Gets the number of seconds since the epoch. More...
 
LTEModemStatus getStatus ()
 Get the modem status. More...
 

Detailed Description

[en] The class to construct a path for communication between the LTE network and modem.
[ja] LTEネットワークとモデム間で通信するための通信経路を構築するクラス。

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

Member Function Documentation

◆ begin()

LTEModemStatus LTEAccessProvider::begin ( char *  pinCode = NULL,
bool  restart = true,
bool  synchronous = true 
)

Power on the modem and start the network search.

[en] Power on the modem and search for the LTE network. If the restart flag is true, restart the modem and search for the LTE network. This method must be called before use any other methods.

[ja] モデムの電源をONにし、LTEネットワークをサーチします。 再起動フラグがtrueの場合、モデムの電源をOFFにしてから電源をONにし、LTEネットワークをサーチします。 このメソッドはほかのメソッドを利用する前に必ず呼び出す必要があります。

Parameters
[in]pinCode[en] PIN unlock code. If PIN lock is disabled, set this parameter to NULL.
[ja] PINロック解除コード。PINロックが無効な場合、NULLを設定してください。
[in]restart[en] Restart flag
[ja] 再起動フラグ
[in]synchronous[en] Synchronization wait flag
[ja] 同期待ちフラグ
Attention
[en] If you enter the PIN code, check the operation on the serial console in advance. If the PIN code is incorrect, an error message will be displayed with the remaining try count that can be executed. If you have locked your modem beyond the remaining try count, please refer to the SIM manual to find out how to unlock it.
[ja] PINロック解除コードを入力した場合は、事前にシリアルコンソールでの動作確認を行ってください。 PINロック解除コードが間違っている場合は残り施行可能回数と共にエラーメッセージが出力されます。 残り施行可能回数を超えてロックされてしまった場合はSIMの説明書を参照して解除方法を確認してください。
Returns
[en] Returns LTE_SEARCHING on success, LTE_ERROR if an error occurs.
[ja] 成功時はLTE_SEARCHING、エラーが発生した場合、LTE_ERRORを返します。

◆ shutdown()

void LTEAccessProvider::shutdown ( )

Power off the LTE modem and detach the modem from the LTE network.

[en] Power off the LTE modem and detach the modem from the LTE network.

[ja] モデムの電源をOFFにし、LTEネットワークからモデムを切り離します。

◆ attach() [1/2]

LTEModemStatus LTEAccessProvider::attach ( const char *  apn,
const char *  userName = NULL,
const char *  password = NULL,
LTENetworkAuthType  authType = LTE_NET_AUTHTYPE_CHAP,
LTENetworkIPType  ipType = LTE_NET_IPTYPE_V4V6,
bool  synchronous = true 
)

Register the modem on the LTE network.

[en] Register the modem on the LTE network. If the synchronous parameter is false, please check the modem has been registered on the LTE network using the getStatus() method.
The RAT used in this method will be the one previously configured on the modem. If you want to connect to the LTE network by specifying RAT, use the attach() method described later.

[ja] LTEネットワークにモデムを登録します。 synchronousパラメータがfalseの場合、getStatus()メソッドを使用して、 LTEネットワークにモデムが登録できたことを確認してください。
このメソッドで使用されるRATは、以前モデムに設定されたものになります。 RATを指定してLTEネットワークに接続したい場合は、後述するattach()メソッドを使用してください。

Parameters
[in]apn[en] Access point name [ja] アクセスポイント名
[in]userName[en] Authentication user name. If authentication is not required, set this parameter to NULL.
[ja] 認証ユーザ名。ユーザ認証が必要ない場合、NULLを設定してください。
[in]password[en] Authentication password. If authentication is not required, set this parameter to NULL.
[ja] 認証パスワード。ユーザ認証が必要ない場合、NULLを設定してください。
[in]authType[en] Authentication type. Set the value defined in LTENetworkAuthType.
[ja] 認証形式。 LTENetworkAuthType で定義された値を設定してください。
[in]ipType[en] Connection IP type. Set the value defined in LTENetworkIPType.
[ja] 接続IP形式。 LTENetworkIPType で定義された値を設定してください。
[in]synchronous[en] Synchronization wait flag
[ja] 同期待ちフラグ
Attention
[en] If rejected from the LTE network, the status changes to LTE_ERROR.
[ja] LTEネットワークからリジェクトされた場合、ステータスはLTE_ERRORに遷移します。
Returns
[en] The return value on success depends on the value of synchronous.
  • If synchronous is true
    Returns LTE_READY on success, LTE_ERROR if an error occurs.
  • If synchronous is false
    Returns LTE_CONNECTING on success, LTE_ERROR if an error occurs.
[ja] 成功時の戻り値は、synchronousパラメータの値によって変わります。
  • synchronousの値がtrueの場合
    成功時はLTE_READY、エラーが発生した場合、LTE_ERRORを返します。
  • synchronousの値がfalseの場合
    成功時はLTE_CONNECTING、エラーが発生した場合、LTE_ERRORを返します。

◆ attach() [2/2]

LTEModemStatus LTEAccessProvider::attach ( LTENetworkRatType  rat,
const char *  apn,
const char *  userName = NULL,
const char *  password = NULL,
LTENetworkAuthType  authType = LTE_NET_AUTHTYPE_CHAP,
LTENetworkIPType  ipType = LTE_NET_IPTYPE_V4V6,
bool  synchronous = true 
)

Register the modem on the LTE network after configuring RAT.

[en] Registers the modem with the LTE network for the specified RAT. RAT can specify LTE-M (LTE Cat-M1) / NB-IoT depending on the SIM contract you are using. Please check your SIM contract and specify RAT.
If the synchronous parameter is false, please check the modem has been registered on the LTE network using the getStatus() method.

[ja] 指定されたRATのLTEネットワークにモデムを登録します。 RATは使用しているSIM契約に応じて、LTE-M (LTE Cat-M1)/NB-IoTを指定できます。 ご使用のSIMの契約を確認し、RATを指定してください。
synchronousパラメータがfalseの場合、getStatus()メソッドを使用して、 LTEネットワークにモデムが登録できたことを確認してください。

Parameters
[in]rat[en] RAT(Radio Access Technology). Set the value defined in LTENetworkRatType.
[ja] RAT(Radio Access Technology)。 LTENetworkRatType で定義された値を設定してください。
[in]apn[en] Access point name [ja] アクセスポイント名
[in]userName[en] Authentication user name. If authentication is not required, set this parameter to NULL.
[ja] 認証ユーザ名。ユーザ認証が必要ない場合、NULLを設定してください。
[in]password[en] Authentication password. If authentication is not required, set this parameter to NULL.
[ja] 認証パスワード。ユーザ認証が必要ない場合、NULLを設定してください。
[in]authType[en] Authentication type. Set the value defined in LTENetworkAuthType.
[ja] 認証形式。 LTENetworkAuthType で定義された値を設定してください。
[in]ipType[en] Connection IP type. Set the value defined in LTENetworkIPType.
[ja] 接続IP形式。 LTENetworkIPType で定義された値を設定してください。
[in]synchronous[en] Synchronization wait flag
[ja] 同期待ちフラグ
Attention
[en] If rejected from the LTE network, the status changes to LTE_ERROR.
[ja] LTEネットワークからリジェクトされた場合、ステータスはLTE_ERRORに遷移します。
Returns
[en] The return value on success depends on the value of synchronous.
  • If synchronous is true
    Returns LTE_READY on success, LTE_ERROR if an error occurs.
  • If synchronous is false
    Returns LTE_CONNECTING on success, LTE_ERROR if an error occurs.
[ja] 成功時の戻り値は、synchronousパラメータの値によって変わります。
  • synchronousの値がtrueの場合
    成功時はLTE_READY、エラーが発生した場合、LTE_ERRORを返します。
  • synchronousの値がfalseの場合
    成功時はLTE_CONNECTING、エラーが発生した場合、LTE_ERRORを返します。

◆ detach()

LTEModemStatus LTEAccessProvider::detach ( )

Detach the modem from the LTE network.

[en] Detach the modem from the LTE network. If this method is called during the asynchronous execution of attach(), modem registration processing is canceled.

[ja] LTEネットワークからモデムを切り離します。attach()を非同期実行中に本メソッドが呼ばれた場合、 モデムの登録処理をキャンセルします。

Attention
[en] If this method is called when the modem status is LTE_CONNECTING, LTE_READY may be returned in conflict with the LTE network registration process. When detaching from the LTE network, please execute detach() again.
[ja] モデムの状態がLTE_CONNECTINGの時に本メソッドを呼んだ場合、LTEネットワークへの登録処理と競合して、LTE_READYが返る場合があります。 LTEネットワークから切り離す場合、 detach() をもう一度実行してください。
Return values
LTE_SEARCHING[en] Returns when the modem is detached from the LTE network.
[ja] LTEネットワークからモデムが切り離された場合に返す。
LTE_READY[en] Returns when the modem is registered to the LTE network by calling this method if the modem status is LTE_CONNECTING.
[ja] モデムの状態がLTE_CONNECTINGの時に本メソッドを呼び出し、LTEネットワークにモデムが登録された場合に返す。
LTE_ERROR[en] Returns when an error occurred.
[ja] エラーが発生した場合に返す。

◆ getIPAddress()

IPAddress LTEAccessProvider::getIPAddress ( )

Get IP address assigned by LTE network.

[en] Get IP address assigned by LTE network.

[ja] LTEネットワークが割り当てたIPアドレスを取得します。

Attention
[en] The IP address cannot be obtained unless the modem status is LTE_READY. The only IP address that can be obtained with this method is IPv4.
IP address may not be acquired immediately after the LTE_READY state transition. Please execute this API after waiting for 1 second or more after transitioning to the LTE_READY state.
[ja] モデムがLTE_READY状態でないとIPアドレスは取得出来ません。 このメソッドで取得できるIPアドレスはIPv4のみです。
LTE_READY状態遷移直後はIPアドレスが取得できない場合があります。 LTE_READY状態に遷移してから1秒以上待機してから本APIを実行してください。
Returns
[en] Returns IP address on success, empty object if an error occurs.
[ja] 成功時はIP address、エラーが発生した場合、空のIPAddressオブジェクトを返します。

◆ getTime()

unsigned long LTEAccessProvider::getTime ( )

Gets the number of seconds since the epoch.

[en] Gets the number of seconds since the epoch (1970-01-01 00:00:00 (UTC)).

[ja] 紀元 (Epoch; 1970-01-01 00:00:00 (UTC)) からの秒数を取得します。

Attention
[en] The time cannot be obtained when the modem status is not LTE_READY.
[ja] モデムの状態がLTE_READY状態でない場合は時刻を取得出来ません。
Returns
[en] Returns the time in seconds since the epoch (1970-01-01 00:00:00 (UTC)) on success, 0 if an error occurs.
[ja] 成功時は紀元 (Epoch; 1970-01-01 00:00:00 (UTC)) からの秒数を返し、 エラーが発生した場合、0を返します。

◆ getStatus()

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