LTE-M Leaf Library
Public Member Functions | Protected Attributes | List of all members
HL7800Modem Class Reference

Public Member Functions

 HL7800Modem ()
 
bool Init ()
 
bool activatePdp (const char *accessPointName, const char *userName, const char *password, long waitForRegistTimeoutMs=120000)
 
bool deactivate (void)
 
bool isActive ()
 
bool chkModem ()
 
bool waitModem (void)
 
IPAddress getIpAddress (void)
 
bool chkIpAddress (void)
 
int getRssi (void)
 
bool chkPin (void)
 
int getImei (char *buff)
 
int getCcid (char *buff)
 
int getRTC (char *buff)
 
bool setEDRX (int edrx_value)
 
bool enterSleep (int mode)
 
bool leaveSleep ()
 
bool powerDown (void)
 
bool powerUp ()
 

Protected Attributes

bool activated
 

Constructor & Destructor Documentation

◆ HL7800Modem()

HL7800Modem::HL7800Modem ( )

モデムライブラリ

Parameters
なし
Returns
なし

Member Function Documentation

◆ activatePdp()

bool HL7800Modem::activatePdp ( const char *  accessPointName,
const char *  userName,
const char *  password,
long  waitForRegistTimeoutMs = 120000 
)

PDP接続を行う

Parameters
accessPointNameAPN名
userName接続ユーザー名
password接続パスワード
waitForRegistTimeoutMs接続までのタイムアウト(ms)
Returns
true:成功, false:失敗

◆ chkIpAddress()

bool HL7800Modem::chkIpAddress ( void  )

PDP接続中の WWAN IPアドレスから接続判定

Parameters
なし
Returns
1:有効IPアドレス, 0:無効IPアドレス

◆ chkModem()

bool HL7800Modem::chkModem ( void  )

モデム応答チェック

Parameters
なし
Returns
true:成功, false:モデム応答なし

◆ chkPin()

bool HL7800Modem::chkPin ( void  )

SIMのPINチェック

Parameters
なし
Returns
1:成功, 0:失敗

◆ deactivate()

bool HL7800Modem::deactivate ( void  )

PDP切断

Parameters
なし
Returns
true:成功, false:失敗

◆ enterSleep()

bool HL7800Modem::enterSleep ( int  mode)

モデム省電力設定
モデムを省電力状態に移行する

Parameters
mode省電力モード 0:SLEEP_MODE 1:LIGHT_HIBERNATE 2:HIBERNATE
Returns
true:成功, false:モデム応答なし

◆ getCcid()

int HL7800Modem::getCcid ( char *  buff)

モデムのCCID取得

Parameters
buff受け取りデータバッファ
Returns
CCIDの文字列長

◆ getImei()

int HL7800Modem::getImei ( char *  buff)

モデムのIMEI取得

Parameters
buff受け取りデータバッファ
Returns
IMEIの文字列長

◆ getIpAddress()

IPAddress HL7800Modem::getIpAddress ( void  )

PDP接続中の WWAN IPアドレスを取得

Parameters
なし
Returns
IPアドレス

◆ getRssi()

int HL7800Modem::getRssi ( void  )

電界強度(RSSI)を取得
戻り値は1~40で99は圏外

Parameters
なし
Returns
RSSI値

◆ getRTC()

int HL7800Modem::getRTC ( char *  buff)

モデム内時間取得
成功時は次のような文字列が取得できる
"yy/MM/dd,hh:mm:ss±zz"

Parameters
buff受け取りデータバッファ
Returns
時計の文字列長

◆ Init()

bool HL7800Modem::Init ( void  )

モデム初期化
モデムへのHWリセットから初期パラメータ設定までを行う

Parameters
なし
Returns
true:成功, false:失敗

◆ isActive()

bool HL7800Modem::isActive ( void  )

PDP接続チェック

Parameters
なし
Returns
true:接続中, false:接続なし

◆ leaveSleep()

bool HL7800Modem::leaveSleep ( )

モデム省電力復帰
省電力状態からの復帰はWAKEUP信号を出してからAT+KSLEEP=2で省電力設定を解除することにより実現する

Parameters
なし
Returns
true:成功, false:モデム応答なし

◆ powerDown()

bool HL7800Modem::powerDown ( void  )

モデム電源オフ
モデムを電源オフに移行する 復帰はPOWER_ON_N信号で行う

Parameters
fast
Returns
true:成功, false:モデム応答なし

◆ powerUp()

bool HL7800Modem::powerUp ( )

モデム電源復帰
PowerDown状態となったモデムを復帰させる
復帰時は電源ONと同じであるため使用前に初期化を行うこと

Parameters
なし
Returns
true:成功, false:モデム応答なし

◆ setEDRX()

bool HL7800Modem::setEDRX ( int  edrx_value)

モデムeDRX設定
モデムにeDRXパラメータを設定する

Parameters
edrx_valueeDRX設定値
String type; half a byte in a 4-bit format. The eDRX value refers to bit 4 to 1 of octet 3 of the Extended DRX parameters information element.
設定値が-1の場合はeDRX無効とする
Returns
true:成功, false:モデム応答なし

◆ waitModem()

bool HL7800Modem::waitModem ( void  )

モデム応答待ち
スリープ復帰等でATコマンド応答可能となるまで時間がある場合があるので、このAPIで応答待ちを行う

Parameters
なし
Returns
true:成功, false:モデム応答なし

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