Developer World
Spresense SDK Library v2.0.1-3834d32
LTE Library API

LTE library for using LTE network. More...

Files

file  lte_api.h
 

Classes

struct  lte_version
 
struct  lte_getpin
 
struct  lte_localtime
 
struct  lte_quality
 
struct  lte_cellinfo
 
struct  lte_edrx_setting
 
struct  lte_psm_timeval
 
struct  lte_psm_setting
 
struct  lte_apn_setting
 
struct  lte_ipaddr
 
struct  lte_pdn
 
struct  lte_reject_cause
 
struct  lte_nw_err_info
 
struct  lte_netinfo
 
struct  lte_error_info
 
struct  lte_ce_setting
 
struct  lte_siminfo
 

Macros

#define LTE_RESULT_OK   (0)
 
#define LTE_RESULT_ERROR   (1)
 
#define LTE_RESULT_CANCEL   (2)
 
#define LTE_VALID   (true)
 
#define LTE_INVALID   (false)
 
#define LTE_ENABLE   (true)
 
#define LTE_DISABLE   (false)
 
#define LTE_ERR_WAITENTERPIN   (1)
 
#define LTE_ERR_REJECT   (2)
 
#define LTE_ERR_MAXRETRY   (3)
 
#define LTE_ERR_BARRING   (4)
 
#define LTE_ERR_DETACHED   (5)
 
#define LTE_ERR_UNEXPECTED   (255)
 
#define LTE_SESSION_ID_MIN   (1)
 
#define LTE_SESSION_ID_MAX   (5)
 
#define LTE_NETSTAT_NOT_REG_NOT_SEARCHING   (0)
 
#define LTE_NETSTAT_REG_HOME   (1)
 
#define LTE_NETSTAT_NOT_REG_SEARCHING   (2)
 
#define LTE_NETSTAT_REG_DENIED   (3)
 
#define LTE_NETSTAT_UNKNOWN   (4)
 
#define LTE_NETSTAT_REG_ROAMING   (5)
 
#define LTE_NETSTAT_REG_SMS_ONLY_HOME   (6)
 
#define LTE_NETSTAT_REG_SMS_ONLY_ROAMING   (7)
 
#define LTE_NETSTAT_NOT_REG_EMERGENCY   (8)
 
#define LTE_NETSTAT_REG_CSFB_NOT_PREF_HOME   (9)
 
#define LTE_NETSTAT_REG_CSFB_NOT_PREF_ROAMING   (10)
 
#define LTE_APN_LEN   (101)
 
#define LTE_APN_USER_NAME_LEN   (64)
 
#define LTE_APN_PASSWD_LEN   (32)
 
#define LTE_IPTYPE_V4   (0)
 
#define LTE_IPTYPE_V6   (1)
 
#define LTE_IPTYPE_V4V6   (2)
 
#define LTE_APN_IPTYPE_IP   LTE_IPTYPE_V4
 
#define LTE_APN_IPTYPE_IPV6   LTE_IPTYPE_V6
 
#define LTE_APN_IPTYPE_IPV4V6   LTE_IPTYPE_V4V6
 
#define LTE_APN_AUTHTYPE_NONE   (0)
 
#define LTE_APN_AUTHTYPE_PAP   (1)
 
#define LTE_APN_AUTHTYPE_CHAP   (2)
 
#define LTE_APN_TYPE_UNKNOWN   (0x01)
 
#define LTE_APN_TYPE_DEFAULT   (0x02)
 
#define LTE_APN_TYPE_MMS   (0x04)
 
#define LTE_APN_TYPE_SUPL   (0x08)
 
#define LTE_APN_TYPE_DUN   (0x10)
 
#define LTE_APN_TYPE_HIPRI   (0x20)
 
#define LTE_APN_TYPE_FOTA   (0x40)
 
#define LTE_APN_TYPE_IMS   (0x80)
 
#define LTE_APN_TYPE_CBS   (0x100)
 
#define LTE_APN_TYPE_IA   (0x200)
 
#define LTE_APN_TYPE_EMERGENCY   (0x400)
 
#define LTE_NETERR_MAXRETRY   (0)
 
#define LTE_NETERR_REJECT   (1)
 
#define LTE_NETERR_NWDTCH   (2)
 
#define LTE_REJECT_CATEGORY_EMM   (0)
 
#define LTE_REJECT_CATEGORY_ESM   (1)
 
#define LTE_VER_BB_PRODUCT_LEN   (5)
 
#define LTE_VER_NP_PACKAGE_LEN   (32)
 
#define LTE_PIN_ENABLE   LTE_ENABLE
 
#define LTE_PIN_DISABLE   LTE_DISABLE
 
#define LTE_PINSTAT_READY   (0)
 
#define LTE_PINSTAT_SIM_PIN   (1)
 
#define LTE_PINSTAT_SIM_PUK   (2)
 
#define LTE_PINSTAT_PH_SIM_PIN   (3)
 
#define LTE_PINSTAT_PH_FSIM_PIN   (4)
 
#define LTE_PINSTAT_PH_FSIM_PUK   (5)
 
#define LTE_PINSTAT_SIM_PIN2   (6)
 
#define LTE_PINSTAT_SIM_PUK2   (7)
 
#define LTE_PINSTAT_PH_NET_PIN   (8)
 
#define LTE_PINSTAT_PH_NET_PUK   (9)
 
#define LTE_PINSTAT_PH_NETSUB_PIN   (10)
 
#define LTE_PINSTAT_PH_NETSUB_PUK   (11)
 
#define LTE_PINSTAT_PH_SP_PIN   (12)
 
#define LTE_PINSTAT_PH_SP_PUK   (13)
 
#define LTE_PINSTAT_PH_CORP_PIN   (14)
 
#define LTE_PINSTAT_PH_CORP_PUK   (15)
 
#define LTE_TARGET_PIN   (0)
 
#define LTE_TARGET_PIN2   (1)
 
#define LTE_SIMSTAT_REMOVAL   (0)
 
#define LTE_SIMSTAT_INSERTION   (1)
 
#define LTE_SIMSTAT_WAIT_PIN_UNLOCK   (2)
 
#define LTE_SIMSTAT_PERSONAL_FAILED   (3)
 
#define LTE_SIMSTAT_ACTIVATE   (4)
 
#define LTE_SIMSTAT_DEACTIVATE   (5)
 
#define LTE_MCC_DIGIT   (3)
 
#define LTE_MNC_DIGIT_MAX   (3)
 
#define LTE_CELLINFO_MCC_DIGIT   LTE_MCC_DIGIT
 
#define LTE_CELLINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX
 
#define LTE_EDRX_ACTTYPE_WBS1   (0)
 
#define LTE_EDRX_ACTTYPE_NBS1   (1)
 
#define LTE_EDRX_ACTTYPE_ECGSMIOT   (2)
 
#define LTE_EDRX_ACTTYPE_GSM   (3)
 
#define LTE_EDRX_ACTTYPE_IU   (4)
 
#define LTE_EDRX_ACTTYPE_NOTUSE   (5)
 
#define LTE_EDRX_CYC_512   (0)
 
#define LTE_EDRX_CYC_1024   (1)
 
#define LTE_EDRX_CYC_2048   (2)
 
#define LTE_EDRX_CYC_4096   (3)
 
#define LTE_EDRX_CYC_6144   (4)
 
#define LTE_EDRX_CYC_8192   (5)
 
#define LTE_EDRX_CYC_10240   (6)
 
#define LTE_EDRX_CYC_12288   (7)
 
#define LTE_EDRX_CYC_14336   (8)
 
#define LTE_EDRX_CYC_16384   (9)
 
#define LTE_EDRX_CYC_32768   (10)
 
#define LTE_EDRX_CYC_65536   (11)
 
#define LTE_EDRX_CYC_131072   (12)
 
#define LTE_EDRX_CYC_262144   (13)
 
#define LTE_EDRX_PTW_128   (0)
 
#define LTE_EDRX_PTW_256   (1)
 
#define LTE_EDRX_PTW_384   (2)
 
#define LTE_EDRX_PTW_512   (3)
 
#define LTE_EDRX_PTW_640   (4)
 
#define LTE_EDRX_PTW_768   (5)
 
#define LTE_EDRX_PTW_896   (6)
 
#define LTE_EDRX_PTW_1024   (7)
 
#define LTE_EDRX_PTW_1152   (8)
 
#define LTE_EDRX_PTW_1280   (9)
 
#define LTE_EDRX_PTW_1408   (10)
 
#define LTE_EDRX_PTW_1536   (11)
 
#define LTE_EDRX_PTW_1664   (12)
 
#define LTE_EDRX_PTW_1792   (13)
 
#define LTE_EDRX_PTW_1920   (14)
 
#define LTE_EDRX_PTW_2048   (15)
 
#define LTE_PSM_T3324_UNIT_2SEC   (0)
 
#define LTE_PSM_T3324_UNIT_1MIN   (1)
 
#define LTE_PSM_T3324_UNIT_6MIN   (2)
 
#define LTE_PSM_T3324_UNIT_DEACT   (3)
 
#define LTE_PSM_T3412_UNIT_2SEC   (0)
 
#define LTE_PSM_T3412_UNIT_30SEC   (1)
 
#define LTE_PSM_T3412_UNIT_1MIN   (2)
 
#define LTE_PSM_T3412_UNIT_10MIN   (3)
 
#define LTE_PSM_T3412_UNIT_1HOUR   (4)
 
#define LTE_PSM_T3412_UNIT_10HOUR   (5)
 
#define LTE_PSM_T3412_UNIT_320HOUR   (6)
 
#define LTE_PSM_T3412_UNIT_DEACT   (7)
 
#define LTE_PSM_TIMEVAL_MIN   (0)
 
#define LTE_PSM_TIMEVAL_MAX   (31)
 
#define LTE_IPADDR_MAX_LEN   (40)
 
#define LTE_PDN_SESSIONID_INVALID_ID   (0)
 
#define LTE_PDN_SESSIONID_MIN   (LTE_PDN_SESSIONID_INVALID_ID)
 
#define LTE_PDN_SESSIONID_MAX   (255)
 
#define LTE_PDN_DEACTIVE   (0)
 
#define LTE_PDN_ACTIVE   (1)
 
#define LTE_PDN_IPADDR_MAX_COUNT   (2)
 
#define LTE_IMS_NOT_REGISTERED   (0)
 
#define LTE_IMS_REGISTERED   (1)
 
#define LTE_DATA_DISALLOW   (0)
 
#define LTE_DATA_ALLOW   (1)
 
#define LTE_RESTART_USER_INITIATED   (0)
 
#define LTE_RESTART_MODEM_INITIATED   (1)
 
#define LTE_ERR_INDICATOR_ERRCODE   (0x01)
 
#define LTE_ERR_INDICATOR_ERRNO   (0x02)
 
#define LTE_ERR_INDICATOR_ERRSTR   (0x04)
 
#define LTE_ERROR_STRING_MAX_LEN   (64)
 
#define LTE_SIMINFO_GETOPT_MCCMNC   (1 << 0)
 
#define LTE_SIMINFO_GETOPT_SPN   (1 << 1)
 
#define LTE_SIMINFO_GETOPT_ICCID   (1 << 2)
 
#define LTE_SIMINFO_GETOPT_IMSI   (1 << 3)
 
#define LTE_SIMINFO_GETOPT_GID1   (1 << 4)
 
#define LTE_SIMINFO_GETOPT_GID2   (1 << 5)
 
#define LTE_SIMINFO_MCC_DIGIT   LTE_MCC_DIGIT
 
#define LTE_SIMINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX
 
#define LTE_SIMINFO_SPN_LEN   (16)
 
#define LTE_SIMINFO_ICCID_LEN   (10)
 
#define LTE_SIMINFO_IMSI_LEN   (15)
 
#define LTE_SIMINFO_GID_LEN   (128)
 
#define LTE_PHONENO_LEN   (41)
 
#define LTE_IMEI_LEN   (16)
 
#define LTE_OPERATOR_LEN   (17)
 
#define EXTERN   extern "C"
 

Typedefs

typedef struct lte_version lte_version_t
 
typedef struct lte_getpin lte_getpin_t
 
typedef struct lte_localtime lte_localtime_t
 
typedef struct lte_quality lte_quality_t
 
typedef struct lte_cellinfo lte_cellinfo_t
 
typedef struct lte_edrx_setting lte_edrx_setting_t
 
typedef struct lte_psm_timeval lte_psm_timeval_t
 
typedef struct lte_psm_setting lte_psm_setting_t
 
typedef struct lte_apn_setting lte_apn_setting_t
 
typedef struct lte_ipaddr lte_ipaddr_t
 
typedef struct lte_pdn lte_pdn_t
 
typedef struct lte_reject_cause lte_reject_cause_t
 
typedef struct lte_nw_err_info lte_nw_err_info_t
 
typedef struct lte_netinfo lte_netinfo_t
 
typedef struct lte_error_info lte_errinfo_t
 
typedef struct lte_ce_setting lte_ce_setting_t
 
typedef struct lte_siminfo lte_siminfo_t
 
typedef void(* get_ver_cb_t) (uint32_t result, lte_version_t *version)
 
typedef void(* get_phoneno_cb_t) (uint32_t result, uint8_t errcause, int8_t *phoneno)
 
typedef void(* get_imsi_cb_t) (uint32_t result, uint8_t errcause, int8_t *imsi)
 
typedef void(* get_imei_cb_t) (uint32_t result, int8_t *imei)
 
typedef void(* get_pinset_cb_t) (uint32_t result, lte_getpin_t *pinset)
 
typedef void(* set_pinenable_cb_t) (uint32_t result, uint8_t attemptsleft)
 
typedef void(* change_pin_cb_t) (uint32_t result, uint8_t attemptsleft)
 
typedef void(* enter_pin_cb_t) (uint32_t result, uint8_t simstat, uint8_t attemptsleft)
 
typedef void(* get_localtime_cb_t) (uint32_t result, lte_localtime_t *localtime)
 
typedef void(* get_operator_cb_t) (uint32_t result, int8_t *oper)
 
typedef void(* get_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)
 
typedef void(* set_edrx_cb_t) (uint32_t result)
 
typedef void(* get_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)
 
typedef void(* set_psm_cb_t) (uint32_t result)
 
typedef void(* get_ce_cb_t) (uint32_t result, lte_ce_setting_t *settings)
 
typedef void(* set_ce_cb_t) (uint32_t result)
 
typedef void(* simstat_report_cb_t) (uint32_t simstat)
 
typedef void(* localtime_report_cb_t) (lte_localtime_t *localtime)
 
typedef void(* quality_report_cb_t) (lte_quality_t *quality)
 
typedef void(* cellinfo_report_cb_t) (lte_cellinfo_t *cellinfo)
 
typedef void(* radio_on_cb_t) (uint32_t result)
 
typedef void(* radio_off_cb_t) (uint32_t result)
 
typedef void(* get_netinfo_cb_t) (uint32_t result, lte_netinfo_t *info)
 
typedef void(* get_imscap_cb_t) (uint32_t result, bool imscap)
 
typedef void(* activate_pdn_cb_t) (uint32_t result, lte_pdn_t *pdn)
 
typedef void(* deactivate_pdn_cb_t) (uint32_t result)
 
typedef void(* data_allow_cb_t) (uint32_t result)
 
typedef void(* restart_report_cb_t) (uint32_t reason)
 
typedef void(* netinfo_report_cb_t) (lte_netinfo_t *info)
 
typedef void(* get_siminfo_cb_t) (uint32_t result, lte_siminfo_t *siminfo)
 
typedef void(* get_dynamic_edrx_param_cb_t) (uint32_t result, lte_edrx_setting_t *param)
 
typedef void(* get_dynamic_psm_param_cb_t) (uint32_t result, lte_psm_setting_t *param)
 
typedef void(* get_current_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)
 
typedef void(* get_current_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)
 
typedef void(* get_quality_cb_t) (uint32_t result, lte_quality_t *quality)
 

Functions

int32_t lte_initialize (void)
 
int32_t lte_finalize (void)
 
int32_t lte_set_report_restart (restart_report_cb_t restart_callback)
 
int32_t lte_power_on (void)
 
int32_t lte_power_off (void)
 
int32_t lte_radio_on_sync (void)
 
int32_t lte_radio_on (radio_on_cb_t callback)
 
int32_t lte_radio_off_sync (void)
 
int32_t lte_radio_off (radio_off_cb_t callback)
 
int32_t lte_get_netinfo_sync (uint8_t pdn_num, lte_netinfo_t *info)
 
int32_t lte_get_netinfo (get_netinfo_cb_t callback)
 
int32_t lte_activate_pdn_sync (lte_apn_setting_t *apn, lte_pdn_t *pdn)
 
int32_t lte_activate_pdn (lte_apn_setting_t *apn, activate_pdn_cb_t callback)
 
int32_t lte_activate_pdn_cancel (void)
 
int32_t lte_deactivate_pdn_sync (uint8_t session_id)
 
int32_t lte_deactivate_pdn (uint8_t session_id, deactivate_pdn_cb_t callback)
 
int32_t lte_data_allow_sync (uint8_t session_id, uint8_t allow, uint8_t roaming_allow)
 
int32_t lte_data_allow (uint8_t session_id, uint8_t allow, uint8_t roaming_allow, data_allow_cb_t callback)
 
int32_t lte_get_imscap_sync (bool *imscap)
 
int32_t lte_get_imscap (get_imscap_cb_t callback)
 
int32_t lte_get_version_sync (lte_version_t *version)
 
int32_t lte_get_version (get_ver_cb_t callback)
 
int32_t lte_get_phoneno_sync (int8_t *phoneno)
 
int32_t lte_get_phoneno (get_phoneno_cb_t callback)
 
int32_t lte_get_imsi_sync (int8_t *imsi)
 
int32_t lte_get_imsi (get_imsi_cb_t callback)
 
int32_t lte_get_imei_sync (int8_t *imei)
 
int32_t lte_get_imei (get_imei_cb_t callback)
 
int32_t lte_get_pinset_sync (lte_getpin_t *pinset)
 
int32_t lte_get_pinset (get_pinset_cb_t callback)
 
int32_t lte_set_pinenable_sync (bool enable, int8_t *pincode, uint8_t *attemptsleft)
 
int32_t lte_set_pinenable (bool enable, int8_t *pincode, set_pinenable_cb_t callback)
 
int32_t lte_change_pin_sync (int8_t target_pin, int8_t *pincode, int8_t *new_pincode, uint8_t *attemptsleft)
 
int32_t lte_change_pin (int8_t target_pin, int8_t *pincode, int8_t *new_pincode, change_pin_cb_t callback)
 
int32_t lte_enter_pin_sync (int8_t *pincode, int8_t *new_pincode, uint8_t *simstat, uint8_t *attemptsleft)
 
int32_t lte_enter_pin (int8_t *pincode, int8_t *new_pincode, enter_pin_cb_t callback)
 
int32_t lte_get_localtime_sync (lte_localtime_t *localtime)
 
int32_t lte_get_localtime (get_localtime_cb_t callback)
 
int32_t lte_get_operator_sync (int8_t *oper)
 
int32_t lte_get_operator (get_operator_cb_t callback)
 
int32_t lte_get_edrx_sync (lte_edrx_setting_t *settings)
 
int32_t lte_get_edrx (get_edrx_cb_t callback)
 
int32_t lte_set_edrx_sync (lte_edrx_setting_t *settings)
 
int32_t lte_set_edrx (lte_edrx_setting_t *settings, set_edrx_cb_t callback)
 
int32_t lte_get_psm_sync (lte_psm_setting_t *settings)
 
int32_t lte_get_psm (get_psm_cb_t callback)
 
int32_t lte_set_psm_sync (lte_psm_setting_t *settings)
 
int32_t lte_set_psm (lte_psm_setting_t *settings, set_psm_cb_t callback)
 
int32_t lte_get_ce_sync (lte_ce_setting_t *settings)
 
int32_t lte_get_ce (get_ce_cb_t callback)
 
int32_t lte_set_ce_sync (lte_ce_setting_t *settings)
 
int32_t lte_set_ce (lte_ce_setting_t *settings, set_ce_cb_t callback)
 
int32_t lte_set_report_simstat (simstat_report_cb_t simstat_callback)
 
int32_t lte_set_report_localtime (localtime_report_cb_t localtime_callback)
 
int32_t lte_set_report_quality (quality_report_cb_t quality_callback, uint32_t period)
 
int32_t lte_set_report_cellinfo (cellinfo_report_cb_t cellinfo_callback, uint32_t period)
 
int32_t lte_set_report_netinfo (netinfo_report_cb_t netinfo_callback)
 
int32_t lte_get_errinfo (lte_errinfo_t *info)
 
int32_t lte_get_siminfo_sync (uint32_t option, lte_siminfo_t *siminfo)
 
int32_t lte_get_siminfo (uint32_t option, get_siminfo_cb_t callback)
 
int32_t lte_get_dynamic_edrx_param (get_dynamic_edrx_param_cb_t callback)
 
int32_t lte_get_current_edrx_sync (lte_edrx_setting_t *settings)
 
int32_t lte_get_current_edrx (get_current_edrx_cb_t callback)
 
int32_t lte_get_dynamic_psm_param (get_dynamic_psm_param_cb_t callback)
 
int32_t lte_get_current_psm_sync (lte_psm_setting_t *settings)
 
int32_t lte_get_current_psm (get_current_psm_cb_t callback)
 
int32_t lte_get_quality_sync (lte_quality_t *quality)
 
int32_t lte_get_quality (get_quality_cb_t callback)
 
int32_t lte_get_cellinfo_sync (lte_cellinfo_t *cellinfo)
 

Detailed Description

LTE library for using LTE network.

Synchronous API Asynchronous API
lte_initialize
lte_finalize
lte_set_report_restart
lte_power_on
lte_power_off
lte_set_report_netinfo
lte_set_report_simstat
lte_set_report_localtime
lte_set_report_quality
lte_set_report_cellinfo
lte_get_errinfo
lte_activate_pdn_cancel
lte_radio_on_sync lte_radio_on
lte_radio_off_sync lte_radio_off
lte_activate_pdn_sync lte_activate_pdn
lte_deactivate_pdn_sync lte_deactivate_pdn
lte_data_allow_sync lte_data_allow
lte_get_netinfo_sync lte_get_netinfo
lte_get_imscap_sync lte_get_imscap
lte_get_version_sync lte_get_version
lte_get_phoneno_sync lte_get_phoneno
lte_get_imsi_sync lte_get_imsi
lte_get_imei_sync lte_get_imei
lte_get_pinset_sync lte_get_pinset
lte_set_pinenable_sync lte_set_pinenable
lte_change_pin_sync lte_change_pin
lte_enter_pin_sync lte_enter_pin
lte_get_localtime_sync lte_get_localtime
lte_get_operator_sync lte_get_operator
lte_get_edrx_sync lte_get_edrx
lte_set_edrx_sync lte_set_edrx
lte_get_psm_sync lte_get_psm
lte_set_psm_sync lte_set_psm
lte_get_ce_sync lte_get_ce
lte_set_ce_sync lte_set_ce
lte_get_siminfo_sync lte_get_siminfo
lte_get_current_edrx_sync lte_get_current_edrx
lte_get_current_psm_sync lte_get_current_psm
lte_get_quality_sync lte_get_quality
lte_get_cellinfo_sync

Macro Definition Documentation

◆ LTE_RESULT_OK

#define LTE_RESULT_OK   (0)

Result code on success

◆ LTE_RESULT_ERROR

#define LTE_RESULT_ERROR   (1)

Result code on failure

◆ LTE_RESULT_CANCEL

#define LTE_RESULT_CANCEL   (2)

Result code on cancel

◆ LTE_VALID

#define LTE_VALID   (true)

Valid

◆ LTE_INVALID

#define LTE_INVALID   (false)

Invalid

◆ LTE_ENABLE

#define LTE_ENABLE   (true)

Enable

◆ LTE_DISABLE

#define LTE_DISABLE   (false)

Disable

◆ LTE_ERR_WAITENTERPIN

#define LTE_ERR_WAITENTERPIN   (1)

Waiting for PIN enter

◆ LTE_ERR_REJECT

#define LTE_ERR_REJECT   (2)

Rejected from the network

◆ LTE_ERR_MAXRETRY

#define LTE_ERR_MAXRETRY   (3)

No response from the network

◆ LTE_ERR_BARRING

#define LTE_ERR_BARRING   (4)

Network barring

◆ LTE_ERR_DETACHED

#define LTE_ERR_DETACHED   (5)

Network detached

◆ LTE_ERR_UNEXPECTED

#define LTE_ERR_UNEXPECTED   (255)

Unexpected cause

◆ LTE_SESSION_ID_MIN

#define LTE_SESSION_ID_MIN   (1)

Minimum value of session ID

◆ LTE_SESSION_ID_MAX

#define LTE_SESSION_ID_MAX   (5)

Maximum value of session ID

◆ LTE_NETSTAT_NOT_REG_NOT_SEARCHING

#define LTE_NETSTAT_NOT_REG_NOT_SEARCHING   (0)

Network status: Not registered, MT is not currently searching a new operator to register to

◆ LTE_NETSTAT_REG_HOME

#define LTE_NETSTAT_REG_HOME   (1)

Network status: Registered, home network

◆ LTE_NETSTAT_NOT_REG_SEARCHING

#define LTE_NETSTAT_NOT_REG_SEARCHING   (2)

Network status: Not registered, but MT is currently searching a new operator to register to

◆ LTE_NETSTAT_REG_DENIED

#define LTE_NETSTAT_REG_DENIED   (3)

Network status: Registration denied

◆ LTE_NETSTAT_UNKNOWN

#define LTE_NETSTAT_UNKNOWN   (4)

Network status: Unknown

◆ LTE_NETSTAT_REG_ROAMING

#define LTE_NETSTAT_REG_ROAMING   (5)

Network status: Registered, roaming

◆ LTE_NETSTAT_REG_SMS_ONLY_HOME

#define LTE_NETSTAT_REG_SMS_ONLY_HOME   (6)

Network status: Registered for "SMS only", home network

◆ LTE_NETSTAT_REG_SMS_ONLY_ROAMING

#define LTE_NETSTAT_REG_SMS_ONLY_ROAMING   (7)

Network status: Registered for "SMS only", roaming

◆ LTE_NETSTAT_NOT_REG_EMERGENCY

#define LTE_NETSTAT_NOT_REG_EMERGENCY   (8)

Network status: Attached for emergency bearer services only

◆ LTE_NETSTAT_REG_CSFB_NOT_PREF_HOME

#define LTE_NETSTAT_REG_CSFB_NOT_PREF_HOME   (9)

Network status: Registered for "CSFB not preferred", home network

◆ LTE_NETSTAT_REG_CSFB_NOT_PREF_ROAMING

#define LTE_NETSTAT_REG_CSFB_NOT_PREF_ROAMING   (10)

Network status: Registered for "CSFB not preferred", roaming

◆ LTE_APN_LEN

#define LTE_APN_LEN   (101)

The maximum string length of the APN name

◆ LTE_APN_USER_NAME_LEN

#define LTE_APN_USER_NAME_LEN   (64)

The maximum string length of the APN user name

◆ LTE_APN_PASSWD_LEN

#define LTE_APN_PASSWD_LEN   (32)

The maximum string length of the APN password

◆ LTE_IPTYPE_V4

#define LTE_IPTYPE_V4   (0)

Internet protocol type: IPv4

◆ LTE_IPTYPE_V6

#define LTE_IPTYPE_V6   (1)

Internet protocol type: IPv6

◆ LTE_IPTYPE_V4V6

#define LTE_IPTYPE_V4V6   (2)

Internet protocol type: IPv4/v6

◆ LTE_APN_IPTYPE_IP

#define LTE_APN_IPTYPE_IP   LTE_IPTYPE_V4

Internet protocol type: IP

Deprecated:
Use LTE_IPTYPE_V4 instead.

◆ LTE_APN_IPTYPE_IPV6

#define LTE_APN_IPTYPE_IPV6   LTE_IPTYPE_V6

Internet protocol type: IPv6

Deprecated:
Use LTE_IPTYPE_V6 instead.

◆ LTE_APN_IPTYPE_IPV4V6

#define LTE_APN_IPTYPE_IPV4V6   LTE_IPTYPE_V4V6

Internet protocol type: IPv4/v6

Deprecated:
Use LTE_IPTYPE_V4V6 instead.

◆ LTE_APN_AUTHTYPE_NONE

#define LTE_APN_AUTHTYPE_NONE   (0)

PPP authentication type: NONE

◆ LTE_APN_AUTHTYPE_PAP

#define LTE_APN_AUTHTYPE_PAP   (1)

PPP authentication type: PAP

◆ LTE_APN_AUTHTYPE_CHAP

#define LTE_APN_AUTHTYPE_CHAP   (2)

PPP authentication type: CHAP

◆ LTE_APN_TYPE_UNKNOWN

#define LTE_APN_TYPE_UNKNOWN   (0x01)

APN type: Unknown

◆ LTE_APN_TYPE_DEFAULT

#define LTE_APN_TYPE_DEFAULT   (0x02)

APN type: Default data traffic

◆ LTE_APN_TYPE_MMS

#define LTE_APN_TYPE_MMS   (0x04)

APN type: MMS traffic(Multimedia Messaging Service)

◆ LTE_APN_TYPE_SUPL

#define LTE_APN_TYPE_SUPL   (0x08)

APN type: SUPL assisted GPS

◆ LTE_APN_TYPE_DUN

#define LTE_APN_TYPE_DUN   (0x10)

APN type: DUN traffic(Dial Up Networking bridge )

◆ LTE_APN_TYPE_HIPRI

#define LTE_APN_TYPE_HIPRI   (0x20)

APN type: HiPri traffic(High Priority Mobile data)

◆ LTE_APN_TYPE_FOTA

#define LTE_APN_TYPE_FOTA   (0x40)

APN type: FOTA(Firmware On The Air)

◆ LTE_APN_TYPE_IMS

#define LTE_APN_TYPE_IMS   (0x80)

APN type: IMS(IP Multimedia Subsystem)

◆ LTE_APN_TYPE_CBS

#define LTE_APN_TYPE_CBS   (0x100)

APN type: CBS(Carrier Branded Services)

◆ LTE_APN_TYPE_IA

#define LTE_APN_TYPE_IA   (0x200)

APN type: IA(Initial Attach APN)

◆ LTE_APN_TYPE_EMERGENCY

#define LTE_APN_TYPE_EMERGENCY   (0x400)

APN type: Emergency PDN

◆ LTE_NETERR_MAXRETRY

#define LTE_NETERR_MAXRETRY   (0)

Network error type: MAX_RETRY

◆ LTE_NETERR_REJECT

#define LTE_NETERR_REJECT   (1)

Network error type: REJECT

◆ LTE_NETERR_NWDTCH

#define LTE_NETERR_NWDTCH   (2)

Network error type: Network Detach

◆ LTE_REJECT_CATEGORY_EMM

#define LTE_REJECT_CATEGORY_EMM   (0)

Network reject category: NAS-EMM

◆ LTE_REJECT_CATEGORY_ESM

#define LTE_REJECT_CATEGORY_ESM   (1)

Network reject category: NAS-ESM

◆ LTE_VER_BB_PRODUCT_LEN

#define LTE_VER_BB_PRODUCT_LEN   (5)

Length of character string for BB product

◆ LTE_VER_NP_PACKAGE_LEN

#define LTE_VER_NP_PACKAGE_LEN   (32)

Length of character string for NP package

◆ LTE_PIN_ENABLE

#define LTE_PIN_ENABLE   LTE_ENABLE

Enable setting of PIN lock

Deprecated:
Use LTE_ENABLE instead.

◆ LTE_PIN_DISABLE

#define LTE_PIN_DISABLE   LTE_DISABLE

Disable setting of PIN lock

Deprecated:
Use LTE_DISABLE instead.

◆ LTE_PINSTAT_READY

#define LTE_PINSTAT_READY   (0)

PIN status: Not pending for any password

◆ LTE_PINSTAT_SIM_PIN

#define LTE_PINSTAT_SIM_PIN   (1)

PIN status: Waiting SIM PIN to be given

◆ LTE_PINSTAT_SIM_PUK

#define LTE_PINSTAT_SIM_PUK   (2)

PIN status: Waiting SIM PUK to be given

◆ LTE_PINSTAT_PH_SIM_PIN

#define LTE_PINSTAT_PH_SIM_PIN   (3)

PIN status: Waiting phone to SIM card password to be given

◆ LTE_PINSTAT_PH_FSIM_PIN

#define LTE_PINSTAT_PH_FSIM_PIN   (4)

PIN status: Waiting phone-to-very first SIM card password to be given

◆ LTE_PINSTAT_PH_FSIM_PUK

#define LTE_PINSTAT_PH_FSIM_PUK   (5)

PIN status: Waiting phone-to-very first SIM card unblocking password to be given

◆ LTE_PINSTAT_SIM_PIN2

#define LTE_PINSTAT_SIM_PIN2   (6)

PIN status: Waiting SIM PIN2 to be given

◆ LTE_PINSTAT_SIM_PUK2

#define LTE_PINSTAT_SIM_PUK2   (7)

PIN status: Waiting SIM PUK2 to be given

◆ LTE_PINSTAT_PH_NET_PIN

#define LTE_PINSTAT_PH_NET_PIN   (8)

PIN status: Waiting network personalization password to be given

◆ LTE_PINSTAT_PH_NET_PUK

#define LTE_PINSTAT_PH_NET_PUK   (9)

PIN status: Waiting network personalization unblocking password to be given

◆ LTE_PINSTAT_PH_NETSUB_PIN

#define LTE_PINSTAT_PH_NETSUB_PIN   (10)

PIN status: Waiting network subset personalization password to be given

◆ LTE_PINSTAT_PH_NETSUB_PUK

#define LTE_PINSTAT_PH_NETSUB_PUK   (11)

PIN status: Waiting network subset personalization unblocking password to be given

◆ LTE_PINSTAT_PH_SP_PIN

#define LTE_PINSTAT_PH_SP_PIN   (12)

PIN status: Waiting service provider personalization password to be given

◆ LTE_PINSTAT_PH_SP_PUK

#define LTE_PINSTAT_PH_SP_PUK   (13)

PIN status: Waiting service provider personalization unblocking password to be given

◆ LTE_PINSTAT_PH_CORP_PIN

#define LTE_PINSTAT_PH_CORP_PIN   (14)

PIN status: Waiting corporate personalization password to be given

◆ LTE_PINSTAT_PH_CORP_PUK

#define LTE_PINSTAT_PH_CORP_PUK   (15)

PIN status: Waiting corporate personalization unblocking password to be given

◆ LTE_TARGET_PIN

#define LTE_TARGET_PIN   (0)

Select of PIN change

◆ LTE_TARGET_PIN2

#define LTE_TARGET_PIN2   (1)

Select of PIN2 change

◆ LTE_SIMSTAT_REMOVAL

#define LTE_SIMSTAT_REMOVAL   (0)

SIM status: SIM removal signal detected

◆ LTE_SIMSTAT_INSERTION

#define LTE_SIMSTAT_INSERTION   (1)

SIM status: SIM insertion signal detected

◆ LTE_SIMSTAT_WAIT_PIN_UNLOCK

#define LTE_SIMSTAT_WAIT_PIN_UNLOCK   (2)

SIM status: SIM init passed, wait for PIN unlock

◆ LTE_SIMSTAT_PERSONAL_FAILED

#define LTE_SIMSTAT_PERSONAL_FAILED   (3)

SIM status: Personalization failed, wait for run-time depersonalization

◆ LTE_SIMSTAT_ACTIVATE

#define LTE_SIMSTAT_ACTIVATE   (4)

SIM status: Activation completed. Event is sent always at any SIM activation completion

◆ LTE_SIMSTAT_DEACTIVATE

#define LTE_SIMSTAT_DEACTIVATE   (5)

SIM status: SIM is deactivated

◆ LTE_MCC_DIGIT

#define LTE_MCC_DIGIT   (3)

Digit number of Mobile Country Code

◆ LTE_MNC_DIGIT_MAX

#define LTE_MNC_DIGIT_MAX   (3)

Max digit number of Mobile Network Code

◆ LTE_CELLINFO_MCC_DIGIT

#define LTE_CELLINFO_MCC_DIGIT   LTE_MCC_DIGIT

Digit number of mcc

Deprecated:
Use LTE_MCC_DIGIT instead.

◆ LTE_CELLINFO_MNC_DIGIT_MAX

#define LTE_CELLINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX

Max digit number of mnc

Deprecated:
Use LTE_MNC_DIGIT_MAX instead.

◆ LTE_EDRX_ACTTYPE_WBS1

#define LTE_EDRX_ACTTYPE_WBS1   (0)

E-UTRAN (WB-S1 mode)

◆ LTE_EDRX_ACTTYPE_NBS1

#define LTE_EDRX_ACTTYPE_NBS1   (1)

E-UTRAN (NB-S1 mode)

◆ LTE_EDRX_ACTTYPE_ECGSMIOT

#define LTE_EDRX_ACTTYPE_ECGSMIOT   (2)

EC-GSM-IoT (A/Gb mode)

◆ LTE_EDRX_ACTTYPE_GSM

#define LTE_EDRX_ACTTYPE_GSM   (3)

GSM (A/Gb mode)

◆ LTE_EDRX_ACTTYPE_IU

#define LTE_EDRX_ACTTYPE_IU   (4)

UTRAN (Iu mode)

◆ LTE_EDRX_ACTTYPE_NOTUSE

#define LTE_EDRX_ACTTYPE_NOTUSE   (5)

eDRX is not running

◆ LTE_EDRX_CYC_512

#define LTE_EDRX_CYC_512   (0)

eDRX cycle: 5.12 sec

◆ LTE_EDRX_CYC_1024

#define LTE_EDRX_CYC_1024   (1)

eDRX cycle: 10.24 sec

◆ LTE_EDRX_CYC_2048

#define LTE_EDRX_CYC_2048   (2)

eDRX cycle: 20.48 sec

◆ LTE_EDRX_CYC_4096

#define LTE_EDRX_CYC_4096   (3)

eDRX cycle: 40.96 sec

◆ LTE_EDRX_CYC_6144

#define LTE_EDRX_CYC_6144   (4)

eDRX cycle: 61.44 sec

◆ LTE_EDRX_CYC_8192

#define LTE_EDRX_CYC_8192   (5)

eDRX cycle: 81.92 sec

◆ LTE_EDRX_CYC_10240

#define LTE_EDRX_CYC_10240   (6)

eDRX cycle: 102.40 sec

◆ LTE_EDRX_CYC_12288

#define LTE_EDRX_CYC_12288   (7)

eDRX cycle: 122.88 sec

◆ LTE_EDRX_CYC_14336

#define LTE_EDRX_CYC_14336   (8)

eDRX cycle: 143.36 sec

◆ LTE_EDRX_CYC_16384

#define LTE_EDRX_CYC_16384   (9)

eDRX cycle: 163.84 sec

◆ LTE_EDRX_CYC_32768

#define LTE_EDRX_CYC_32768   (10)

eDRX cycle: 327.68 sec

◆ LTE_EDRX_CYC_65536

#define LTE_EDRX_CYC_65536   (11)

eDRX cycle: 655.36 sec

◆ LTE_EDRX_CYC_131072

#define LTE_EDRX_CYC_131072   (12)

eDRX cycle: 1310.72 sec

◆ LTE_EDRX_CYC_262144

#define LTE_EDRX_CYC_262144   (13)

eDRX cycle: 2621.44 sec

◆ LTE_EDRX_PTW_128

#define LTE_EDRX_PTW_128   (0)

Paging time window: 1.28 sec

◆ LTE_EDRX_PTW_256

#define LTE_EDRX_PTW_256   (1)

Paging time window: 2.56 sec

◆ LTE_EDRX_PTW_384

#define LTE_EDRX_PTW_384   (2)

Paging time window: 3.84 sec

◆ LTE_EDRX_PTW_512

#define LTE_EDRX_PTW_512   (3)

Paging time window: 5.12 sec

◆ LTE_EDRX_PTW_640

#define LTE_EDRX_PTW_640   (4)

Paging time window: 6.40 sec

◆ LTE_EDRX_PTW_768

#define LTE_EDRX_PTW_768   (5)

Paging time window: 7.68 sec

◆ LTE_EDRX_PTW_896

#define LTE_EDRX_PTW_896   (6)

Paging time window: 8.96 sec

◆ LTE_EDRX_PTW_1024

#define LTE_EDRX_PTW_1024   (7)

Paging time window: 10.24 sec

◆ LTE_EDRX_PTW_1152

#define LTE_EDRX_PTW_1152   (8)

Paging time window: 11.52 sec

◆ LTE_EDRX_PTW_1280

#define LTE_EDRX_PTW_1280   (9)

Paging time window: 12.80 sec

◆ LTE_EDRX_PTW_1408

#define LTE_EDRX_PTW_1408   (10)

Paging time window: 14.08 sec

◆ LTE_EDRX_PTW_1536

#define LTE_EDRX_PTW_1536   (11)

Paging time window: 15.36 sec

◆ LTE_EDRX_PTW_1664

#define LTE_EDRX_PTW_1664   (12)

Paging time window: 16.64 sec

◆ LTE_EDRX_PTW_1792

#define LTE_EDRX_PTW_1792   (13)

Paging time window: 17.92 sec

◆ LTE_EDRX_PTW_1920

#define LTE_EDRX_PTW_1920   (14)

Paging time window: 19.20 sec

◆ LTE_EDRX_PTW_2048

#define LTE_EDRX_PTW_2048   (15)

Paging time window: 20.48 sec

◆ LTE_PSM_T3324_UNIT_2SEC

#define LTE_PSM_T3324_UNIT_2SEC   (0)

Unit of request active time(T3324): 2 sec

◆ LTE_PSM_T3324_UNIT_1MIN

#define LTE_PSM_T3324_UNIT_1MIN   (1)

Unit of request active time(T3324): 1 min

◆ LTE_PSM_T3324_UNIT_6MIN

#define LTE_PSM_T3324_UNIT_6MIN   (2)

Unit of request active time(T3324): 6 min

◆ LTE_PSM_T3324_UNIT_DEACT

#define LTE_PSM_T3324_UNIT_DEACT   (3)

Unit of request active time(T3324): The value indicates that the timer is deactivated.

◆ LTE_PSM_T3412_UNIT_2SEC

#define LTE_PSM_T3412_UNIT_2SEC   (0)

Unit of extended periodic TAU time(T3412): 2 sec

◆ LTE_PSM_T3412_UNIT_30SEC

#define LTE_PSM_T3412_UNIT_30SEC   (1)

Unit of extended periodic TAU time(T3412): 30 sec

◆ LTE_PSM_T3412_UNIT_1MIN

#define LTE_PSM_T3412_UNIT_1MIN   (2)

Unit of extended periodic TAU time(T3412): 1 min

◆ LTE_PSM_T3412_UNIT_10MIN

#define LTE_PSM_T3412_UNIT_10MIN   (3)

Unit of extended periodic TAU time(T3412): 10 min

◆ LTE_PSM_T3412_UNIT_1HOUR

#define LTE_PSM_T3412_UNIT_1HOUR   (4)

Unit of extended periodic TAU time(T3412): 1 hour

◆ LTE_PSM_T3412_UNIT_10HOUR

#define LTE_PSM_T3412_UNIT_10HOUR   (5)

Unit of extended periodic TAU time(T3412): 10 hour

◆ LTE_PSM_T3412_UNIT_320HOUR

#define LTE_PSM_T3412_UNIT_320HOUR   (6)

Unit of extended periodic TAU time(T3412): 320 hour

◆ LTE_PSM_T3412_UNIT_DEACT

#define LTE_PSM_T3412_UNIT_DEACT   (7)

Unit of extended periodic TAU time(T3412): The value indicates that the timer is deactivated.

◆ LTE_PSM_TIMEVAL_MIN

#define LTE_PSM_TIMEVAL_MIN   (0)

The minimum timer value used by PSM related timers

◆ LTE_PSM_TIMEVAL_MAX

#define LTE_PSM_TIMEVAL_MAX   (31)

The maxmum timer value used by PSM related timers

◆ LTE_IPADDR_MAX_LEN

#define LTE_IPADDR_MAX_LEN   (40)

Maximum length of the IP address

◆ LTE_PDN_SESSIONID_INVALID_ID

#define LTE_PDN_SESSIONID_INVALID_ID   (0)

Invalid Session ID

◆ LTE_PDN_SESSIONID_MIN

#define LTE_PDN_SESSIONID_MIN   (LTE_PDN_SESSIONID_INVALID_ID)

Minimum value of Session ID

◆ LTE_PDN_SESSIONID_MAX

#define LTE_PDN_SESSIONID_MAX   (255)

Maximum value of Session ID

◆ LTE_PDN_DEACTIVE

#define LTE_PDN_DEACTIVE   (0)

PDN status: Not active

◆ LTE_PDN_ACTIVE

#define LTE_PDN_ACTIVE   (1)

PDN status: Active

◆ LTE_PDN_IPADDR_MAX_COUNT

#define LTE_PDN_IPADDR_MAX_COUNT   (2)

Maximum number of IP addresses

◆ LTE_IMS_NOT_REGISTERED

#define LTE_IMS_NOT_REGISTERED   (0)

IMS status: Not registered

◆ LTE_IMS_REGISTERED

#define LTE_IMS_REGISTERED   (1)

IMS status: Registered

◆ LTE_DATA_DISALLOW

#define LTE_DATA_DISALLOW   (0)

Data communication: Not allow

◆ LTE_DATA_ALLOW

#define LTE_DATA_ALLOW   (1)

Data communication: Allow

◆ LTE_RESTART_USER_INITIATED

#define LTE_RESTART_USER_INITIATED   (0)

Modem restert cause: User initiated

◆ LTE_RESTART_MODEM_INITIATED

#define LTE_RESTART_MODEM_INITIATED   (1)

Modem restert cause: Modem initiated

◆ LTE_ERR_INDICATOR_ERRCODE

#define LTE_ERR_INDICATOR_ERRCODE   (0x01)

Error indicator for error code

◆ LTE_ERR_INDICATOR_ERRNO

#define LTE_ERR_INDICATOR_ERRNO   (0x02)

Error indicator for error number

◆ LTE_ERR_INDICATOR_ERRSTR

#define LTE_ERR_INDICATOR_ERRSTR   (0x04)

Error indicator for error string

◆ LTE_ERROR_STRING_MAX_LEN

#define LTE_ERROR_STRING_MAX_LEN   (64)

Maximum length of the error string

◆ LTE_SIMINFO_GETOPT_MCCMNC

#define LTE_SIMINFO_GETOPT_MCCMNC   (1 << 0)

Indicates to get for Mobile Country Code/Mobile Network Code of SIM

◆ LTE_SIMINFO_GETOPT_SPN

#define LTE_SIMINFO_GETOPT_SPN   (1 << 1)

Indicates to get for SPN of SIM

◆ LTE_SIMINFO_GETOPT_ICCID

#define LTE_SIMINFO_GETOPT_ICCID   (1 << 2)

Indicates to get for ICCID of SIM

◆ LTE_SIMINFO_GETOPT_IMSI

#define LTE_SIMINFO_GETOPT_IMSI   (1 << 3)

Indicates to get for IMSI of SIM

◆ LTE_SIMINFO_GETOPT_GID1

#define LTE_SIMINFO_GETOPT_GID1   (1 << 4)

Indicates to get for GID1(Group Identifier Level 1) of SIM

◆ LTE_SIMINFO_GETOPT_GID2

#define LTE_SIMINFO_GETOPT_GID2   (1 << 5)

Indicates to get for GID2(Group Identifier Level 2) of SIM

◆ LTE_SIMINFO_MCC_DIGIT

#define LTE_SIMINFO_MCC_DIGIT   LTE_MCC_DIGIT

Digit number of mcc

Deprecated:
Use LTE_MCC_DIGIT instead.

◆ LTE_SIMINFO_MNC_DIGIT_MAX

#define LTE_SIMINFO_MNC_DIGIT_MAX   LTE_MNC_DIGIT_MAX

Max digit number of mnc

Deprecated:
Use LTE_MNC_DIGIT_MAX instead.

◆ LTE_SIMINFO_SPN_LEN

#define LTE_SIMINFO_SPN_LEN   (16)

Maximum length of SPN

◆ LTE_SIMINFO_ICCID_LEN

#define LTE_SIMINFO_ICCID_LEN   (10)

Maximum length of ICCCID

◆ LTE_SIMINFO_IMSI_LEN

#define LTE_SIMINFO_IMSI_LEN   (15)

Maximum length of IMSI

◆ LTE_SIMINFO_GID_LEN

#define LTE_SIMINFO_GID_LEN   (128)

Maximum length of GID

◆ LTE_PHONENO_LEN

#define LTE_PHONENO_LEN   (41)

Maximum length of phone number

◆ LTE_IMEI_LEN

#define LTE_IMEI_LEN   (16)

Maximum length of IMEI

◆ LTE_OPERATOR_LEN

#define LTE_OPERATOR_LEN   (17)

Maximum length of network operator

Typedef Documentation

◆ lte_version_t

◆ lte_getpin_t

◆ lte_localtime_t

◆ lte_quality_t

◆ lte_cellinfo_t

◆ lte_edrx_setting_t

◆ lte_psm_timeval_t

◆ lte_psm_setting_t

◆ lte_apn_setting_t

◆ lte_ipaddr_t

◆ lte_pdn_t

◆ lte_reject_cause_t

◆ lte_nw_err_info_t

◆ lte_netinfo_t

◆ lte_errinfo_t

◆ lte_ce_setting_t

◆ lte_siminfo_t

◆ get_ver_cb_t

typedef void(* get_ver_cb_t) (uint32_t result, lte_version_t *version)

Definition of callback function.

Since lte_get_version() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_version(). As below value stored.
[in]version: The version information of the modem. See lte_version_t

◆ get_phoneno_cb_t

typedef void(* get_phoneno_cb_t) (uint32_t result, uint8_t errcause, int8_t *phoneno)

Definition of callback function.

Since lte_get_phoneno() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_phoneno(). As below value stored.
[in]errcause: Error cause. It is set only if the result is not successful. As below value stored.
[in]phoneno: A character string indicating phone number. It is terminated with '\0'

◆ get_imsi_cb_t

typedef void(* get_imsi_cb_t) (uint32_t result, uint8_t errcause, int8_t *imsi)

Definition of callback function.

Since lte_get_imsi() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_imsi(). As below value stored.
[in]errcause: Error cause. It is set only if the result is not successful. As below value stored.
[in]imsi: A character string indicating IMSI. It is terminated with '\0'

◆ get_imei_cb_t

typedef void(* get_imei_cb_t) (uint32_t result, int8_t *imei)

Definition of callback function.

Since lte_get_imei() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_imei(). As below value stored.
[in]imei: A character string indicating IMEI. It is terminated with '\0'

◆ get_pinset_cb_t

typedef void(* get_pinset_cb_t) (uint32_t result, lte_getpin_t *pinset)

Definition of callback function.

Since lte_get_pinset() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_pinset(). As below value stored.
[in]pinset: PIN settings information. See lte_getpin_t

◆ set_pinenable_cb_t

typedef void(* set_pinenable_cb_t) (uint32_t result, uint8_t attemptsleft)

Definition of callback function.

Since lte_set_pinenable() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_set_pinenable(). As below value stored.
[in]attemptsleft: Number of attempts left. It is set only if the result is not successful.

◆ change_pin_cb_t

typedef void(* change_pin_cb_t) (uint32_t result, uint8_t attemptsleft)

Definition of callback function.

Since lte_change_pin() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_change_pin(). As below value stored.
[in]attemptsleft: Number of attempts left. It is set only if the result is not successful.

◆ enter_pin_cb_t

typedef void(* enter_pin_cb_t) (uint32_t result, uint8_t simstat, uint8_t attemptsleft)

Definition of callback function.

Since lte_enter_pin() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_enter_pin(). As below value stored.
[in]simstat: State after PIN enter. As below value stored.
[in]attemptsleft: Number of attempts left. It is set only if the result is not successful. If simstat is other than PIN, PUK, PIN2, PUK2, set the number of PIN.

◆ get_localtime_cb_t

typedef void(* get_localtime_cb_t) (uint32_t result, lte_localtime_t *localtime)

Definition of callback function.

Since lte_get_localtime() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_localtime(). As below value stored.
[in]localtime: Local time. See lte_localtime_t

◆ get_operator_cb_t

typedef void(* get_operator_cb_t) (uint32_t result, int8_t *oper)

Definition of callback function.

Since lte_get_operator() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_operator(). As below value stored.
[in]oper: A character string indicating network operator. It is terminated with '\0' If it is not connected, the first character is '\0'.

◆ get_edrx_cb_t

typedef void(* get_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)

Definition of callback function.

Since lte_get_edrx() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_edrx(). As below value stored.
[in]settings: eDRX settings. See lte_edrx_setting_t

◆ set_edrx_cb_t

typedef void(* set_edrx_cb_t) (uint32_t result)

Definition of callback function.

Since lte_set_edrx() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_set_edrx(). As below value stored.

◆ get_psm_cb_t

typedef void(* get_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)

Definition of callback function.

Since lte_get_psm() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_psm(). As below value stored.
[in]settings: PSM settings. See lte_psm_setting_t

◆ set_psm_cb_t

typedef void(* set_psm_cb_t) (uint32_t result)

Definition of callback function.

Since lte_set_psm() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_set_psm(). As below value stored.

◆ get_ce_cb_t

typedef void(* get_ce_cb_t) (uint32_t result, lte_ce_setting_t *settings)

Definition of callback function.

Since lte_get_ce() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_ce(). As below value stored.
[in]settings: CE settings. See lte_ce_setting_t

◆ set_ce_cb_t

typedef void(* set_ce_cb_t) (uint32_t result)

Definition of callback function.

Since lte_set_ce() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_set_ce(). As below value stored.

◆ simstat_report_cb_t

typedef void(* simstat_report_cb_t) (uint32_t simstat)

Definition of callback function.

When the SIM state changes, the SIM state is reported by this function.

Parameters
[in]simstat: The SIM state. As below value stored.

◆ localtime_report_cb_t

typedef void(* localtime_report_cb_t) (lte_localtime_t *localtime)

Definition of callback function.

When the local time changes, the local time is reported by this function.

Parameters
[in]localtime: Local time. See lte_localtime_t

◆ quality_report_cb_t

typedef void(* quality_report_cb_t) (lte_quality_t *quality)

Definition of callback function.

The quality information is reported by this function. It is reported at intervals of the set report period.

Parameters
[in]quality: Quality information. See lte_quality_t

◆ cellinfo_report_cb_t

typedef void(* cellinfo_report_cb_t) (lte_cellinfo_t *cellinfo)

Definition of callback function.

The cell information is reported by this function. It is reported at intervals of the set report period.

Parameters
[in]cellinfo: Cell information. See lte_cellinfo_t

◆ radio_on_cb_t

typedef void(* radio_on_cb_t) (uint32_t result)

Definition of callback function.

Since lte_radio_on() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_radio_on(). As below value stored.

◆ radio_off_cb_t

typedef void(* radio_off_cb_t) (uint32_t result)

Definition of callback function.

Since lte_radio_off() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_radio_off(). As below value stored.

◆ get_netinfo_cb_t

typedef void(* get_netinfo_cb_t) (uint32_t result, lte_netinfo_t *info)

Definition of callback function.

Since lte_get_netinfo() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_netinfo(). As below value stored.
[in]info: Pointer of LTE network information. See lte_netinfo_t

◆ get_imscap_cb_t

typedef void(* get_imscap_cb_t) (uint32_t result, bool imscap)

Definition of callback function.

Since lte_get_imscap() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_imscap. As below value stored.
[in]imscap: The IMS capability. As below value stored.

◆ activate_pdn_cb_t

typedef void(* activate_pdn_cb_t) (uint32_t result, lte_pdn_t *pdn)

Definition of callback function.

Since lte_activate_pdn() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_activate_pdn. As below value stored.
[in]pdn: The connect pdn information. See lte_pdn_t

◆ deactivate_pdn_cb_t

typedef void(* deactivate_pdn_cb_t) (uint32_t result)

Definition of callback function.

Since lte_deactivate_pdn() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_deactivate_pdn. As below value stored.

◆ data_allow_cb_t

typedef void(* data_allow_cb_t) (uint32_t result)

Definition of callback function.

Since lte_dataallow() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_dataallow. As below value stored.

◆ restart_report_cb_t

typedef void(* restart_report_cb_t) (uint32_t reason)

Definition of callback function.

The modem restart is reported by this function. It is reported at modem reset.

Parameters
[in]reason: Reason of modem restart. As below value stored.

◆ netinfo_report_cb_t

typedef void(* netinfo_report_cb_t) (lte_netinfo_t *info)

Definition of callback function.

The change LTE network information is reported by this function. It is reported at LTE network connection status.

Parameters
[in]info: Pointer of LTE network information. See lte_netinfo_t

◆ get_siminfo_cb_t

typedef void(* get_siminfo_cb_t) (uint32_t result, lte_siminfo_t *siminfo)

Definition of callback function.

Since lte_get_siminfo() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_siminfo(). As below value stored.
[in]siminfo: SIM information. See lte_siminfo_t

◆ get_dynamic_edrx_param_cb_t

typedef void(* get_dynamic_edrx_param_cb_t) (uint32_t result, lte_edrx_setting_t *param)

Definition of callback function.

Since lte_get_dynamic_edrx_param() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_dynamic_edrx_param(). As below value stored.
[in]param: eDRX dynamic parameter. See lte_edrx_setting_t.

◆ get_dynamic_psm_param_cb_t

typedef void(* get_dynamic_psm_param_cb_t) (uint32_t result, lte_psm_setting_t *param)

Definition of callback function.

Since lte_get_dynamic_psm_param() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_dynamic_psm_param(). As below value stored.
[in]param: PSM dynamic parameter. See lte_psm_setting_t

◆ get_current_edrx_cb_t

typedef void(* get_current_edrx_cb_t) (uint32_t result, lte_edrx_setting_t *settings)

Definition of callback function.

Since lte_get_current_edrx() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_current_edrx(). As below value stored.
[in]settings: Current eDRX settings. See lte_edrx_setting_t.

◆ get_current_psm_cb_t

typedef void(* get_current_psm_cb_t) (uint32_t result, lte_psm_setting_t *settings)

Definition of callback function.

Since lte_get_current_psm() is an asynchronous API, the result is notified by this function.

Parameters
[in]result: The result of lte_get_current_psm(). As below value stored.
[in]settings: Current PSM settings. See lte_psm_setting_t

◆ get_quality_cb_t

typedef void(* get_quality_cb_t) (uint32_t result, lte_quality_t *quality)

Definition of callback function.

Since lte_get_quality() is an asynchronous API, the quality information is notified by this function.

Parameters
[in]result: The result of lte_get_quality(). As below value stored.
[in]quality: Quality information. See lte_quality_t

Function Documentation

◆ lte_initialize()

int32_t lte_initialize ( void  )

Initialize resources used in LTE API.

Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_finalize()

int32_t lte_finalize ( void  )

Release resources used in LTE API.

Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_restart()

int32_t lte_set_report_restart ( restart_report_cb_t  restart_callback)

Register the callback to notify that the modem has started up.

The callback will be invoked if the modem starts successfully after calling lte_power_on. Some APIs have to wait until this callback is invoked. If no wait, those API return with an error. (-ENETDOWN)

The callback is also invoked when the modem is restarted. The cause of the restart can be obtained from the callback argument.

This function must be called after lte_initialize.

Attention
Attention to the following when LTE_RESTART_MODEM_INITIATED is set.
  • Asynchronous API callbacks for which results have not been notified are canceled and becomes available.
  • The processing result of the synchronous API being called results in an error. (Return value is -ENETDOWN) The errno is ENETDOWN for the socket API.
  • It should close the socket by user application.
Parameters
[in]restart_callbackCallback function to notify that modem restarted.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_power_on()

int32_t lte_power_on ( void  )

Power on the modem.

The callback which registered by lte_set_report_restart will be invoked if the modem starts successfully.

This function must be called after lte_set_report_restart.

Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_power_off()

int32_t lte_power_off ( void  )

Power off the modem

Attention
Attention to the following when this API calling.
  • For asynchronous API
    • callback is canceled.
  • For synchronous API
    • API returns with an error.
      • The return value is -ENETDOWN for the LTE API.
      • The errno is ENETDOWN for the socket API.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_radio_on_sync()

int32_t lte_radio_on_sync ( void  )

With the radio on, to start the LTE network search.

Attention
Attention to the following when this API calling.
  • If SIM is PIN locked, the result will be an error.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_radio_on()

int32_t lte_radio_on ( radio_on_cb_t  callback)

With the radio on, to start the LTE network search.

Attention
Attention to the following when this API calling.
  • If SIM is PIN locked, the result will be an error.
Parameters
[in]callbackCallback function to notify that radio on is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_radio_off_sync()

int32_t lte_radio_off_sync ( void  )

Exit LTE network searches with the radio off.

If this function is called when a PDN has already been constructed, the PDN is discarded.

Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_radio_off()

int32_t lte_radio_off ( radio_off_cb_t  callback)

Exit LTE network searches with the radio off.

If this function is called when a PDN has already been constructed, the PDN is discarded.

Parameters
[in]callbackCallback function to notify that radio off is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_netinfo_sync()

int32_t lte_get_netinfo_sync ( uint8_t  pdn_num,
lte_netinfo_t info 
)

Get LTE network information.

Attention
The maximum number of PDNs status areas must be allocated before calls this API.
Parameters
[in]pdn_numNumber of pdn_stat allocated by the user. The range is from LTE_PDN_SESSIONID_MIN to LTE_PDN_SESSIONID_MAX.
[out]infoThe LTE network information. See lte_netinfo_t
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_netinfo()

int32_t lte_get_netinfo ( get_netinfo_cb_t  callback)

Get LTE network information.

Parameters
[in]callbackCallback function to notify that get network information completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_activate_pdn_sync()

int32_t lte_activate_pdn_sync ( lte_apn_setting_t apn,
lte_pdn_t pdn 
)

Constructs a PDN with the specified APN settings.

When constructs the initial PDN, LTE_APN_TYPE_IA must be set to the APN type.

When PDN construction is successful, an IP address is given from the LTE network.

Attention
Attention to the following when this API calling.
  • The initial PDN construction may take a few minutes depending on radio conditions.
  • If API is not returned, please check if the APN settings are correct.
Parameters
[in]apnThe pointer of the apn setting. See lte_apn_setting_t for valid parameters.
[out]pdnThe construction PDN information. See lte_pdn_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>. If canceling, -ECANCELED is returned.

◆ lte_activate_pdn()

int32_t lte_activate_pdn ( lte_apn_setting_t apn,
activate_pdn_cb_t  callback 
)

Constructs a PDN with the specified APN settings.

When constructs the initial PDN, LTE_APN_TYPE_IA must be set to the APN type.

When PDN construction is successful, an IP address is given from the LTE network.

Attention
Attention to the following when this API calling.
  • The initial PDN construction may take a few minutes depending on radio conditions.
  • If the callback is not notified, please check if the APN settings are correct.
Parameters
[in]apnThe pointer of the apn setting. See lte_apn_setting_t for valid parameters.
[in]callbackCallback function to notify that PDN activation completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_activate_pdn_cancel()

int32_t lte_activate_pdn_cancel ( void  )

Cancel PDN construction.

Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_deactivate_pdn_sync()

int32_t lte_deactivate_pdn_sync ( uint8_t  session_id)

Discard the constructed PDN.

Discards the PDN corresponding to the session ID obtained by lte_activate_pdn.

When the discard process is successful, the IP address assigned to the modem is released to the LTE network.

Parameters
[in]session_idThe numeric value of the session ID. Use the value obtained by the lte_activate_pdn.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_deactivate_pdn()

int32_t lte_deactivate_pdn ( uint8_t  session_id,
deactivate_pdn_cb_t  callback 
)

Discard the constructed PDN.

Discards the PDN corresponding to the session ID obtained by lte_activate_pdn.

When the discard process is successful, the IP address assigned to the modem is released to the LTE network.

Parameters
[in]session_idThe numeric value of the session ID. Use the value obtained by the lte_activate_pdn.
[in]callbackCallback function to notify that LTE PDN deactivation completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_data_allow_sync()

int32_t lte_data_allow_sync ( uint8_t  session_id,
uint8_t  allow,
uint8_t  roaming_allow 
)

Allow or disallow to data communication for specified PDN.

If the application performs data communication in the disallow state, the modem discards the data.

Parameters
[in]session_idThe numeric value of the session ID. Use the value obtained by the lte_activate_pdn.
[in]allowAllow or disallow to data communication for all network. Definition is as below.
[in]roaming_allowAllow or disallow to data communication for roaming network. Definition is as below.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_data_allow()

int32_t lte_data_allow ( uint8_t  session_id,
uint8_t  allow,
uint8_t  roaming_allow,
data_allow_cb_t  callback 
)

Allow or disallow to data communication for specified PDN.

If the application performs data communication in the disallow state, the modem discards the data.

Parameters
[in]session_idThe numeric value of the session ID. Use the value obtained by the lte_activate_pdn.
[in]allowAllow or disallow to data communication for all network. Definition is as below.
[in]roaming_allowAllow or disallow to data communication for roaming network. Definition is as below.
[in]callbackCallback function to notify that configuration has changed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imscap_sync()

int32_t lte_get_imscap_sync ( bool *  imscap)

Get whether the modem supports IMS or not.

Parameters
[out]imscapThe IMS capability. As below value stored.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imscap()

int32_t lte_get_imscap ( get_imscap_cb_t  callback)

Get whether the modem supports IMS or not.

Parameters
[in]callbackCallback function to notify when getting IMS capability is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_version_sync()

int32_t lte_get_version_sync ( lte_version_t version)

Acquires the FW version information of the modem.

Parameters
[out]versionThe version information of the modem. See lte_version_t
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_version()

int32_t lte_get_version ( get_ver_cb_t  callback)

Acquires the FW version information of the modem.

Parameters
[in]callbackCallback function to notify when getting the version is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_phoneno_sync()

int32_t lte_get_phoneno_sync ( int8_t *  phoneno)

Get phone number from SIM.

Parameters
[out]phonenoA character string indicating phone number. It is terminated with '\0'. The maximum number of phone number areas must be allocated. See LTE_PHONENO_LEN.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_phoneno()

int32_t lte_get_phoneno ( get_phoneno_cb_t  callback)

Get phone number from SIM.

Parameters
[in]callbackCallback function to notify when getting the phone number is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imsi_sync()

int32_t lte_get_imsi_sync ( int8_t *  imsi)

Get International Mobile Subscriber Identity from SIM.

Parameters
[out]imsiA character string indicating IMSI. It is terminated with '\0'. The maximum number of IMSI areas must be allocated. See LTE_SIMINFO_IMSI_LEN.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imsi()

int32_t lte_get_imsi ( get_imsi_cb_t  callback)

Get International Mobile Subscriber Identity from SIM.

Parameters
[in]callbackCallback function to notify when getting IMSI is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imei_sync()

int32_t lte_get_imei_sync ( int8_t *  imei)

Get International Mobile Equipment Identifier from the modem.

Parameters
[out]imeiA character string indicating IMEI. It is terminated with '\0'. The maximum number of IMEI areas must be allocated. See LTE_IMEI_LEN.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_imei()

int32_t lte_get_imei ( get_imei_cb_t  callback)

Get International Mobile Equipment Identifier from the modem.

Parameters
[in]callbackCallback function to notify when getting IMEI is completed
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_pinset_sync()

int32_t lte_get_pinset_sync ( lte_getpin_t pinset)

Get Personal Identification Number settings.

Parameters
[out]pinsetPIN settings information. See lte_getpin_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_pinset()

int32_t lte_get_pinset ( get_pinset_cb_t  callback)

Get Personal Identification Number settings.

Parameters
[in]callbackCallback function to notify when getting the PIN setting is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_pinenable_sync()

int32_t lte_set_pinenable_sync ( bool  enable,
int8_t *  pincode,
uint8_t *  attemptsleft 
)

Set Personal Identification Number enable.

Parameters
[in]enable"Enable" or "Disable". Definition is as below.
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[out]attemptsleftNumber of attempts left. Set only if failed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_pinenable()

int32_t lte_set_pinenable ( bool  enable,
int8_t *  pincode,
set_pinenable_cb_t  callback 
)

Set Personal Identification Number enable.

Parameters
[in]enable"Enable" or "Disable". Definition is as below.
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]callbackCallback function to notify that setting of PIN enables/disables is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_change_pin_sync()

int32_t lte_change_pin_sync ( int8_t  target_pin,
int8_t *  pincode,
int8_t *  new_pincode,
uint8_t *  attemptsleft 
)

Change Personal Identification Number.

It can be changed only when PIN is enable.

Parameters
[in]target_pinTarget of change PIN. Definition is as below.
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]new_pincodeNew PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[out]attemptsleftNumber of attempts left. Set only if failed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_change_pin()

int32_t lte_change_pin ( int8_t  target_pin,
int8_t *  pincode,
int8_t *  new_pincode,
change_pin_cb_t  callback 
)

Change Personal Identification Number.

It can be changed only when PIN is enable.

Parameters
[in]target_pinTarget of change PIN. Definition is as below.
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]new_pincodeNew PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]callbackCallback function to notify that change of PIN is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_enter_pin_sync()

int32_t lte_enter_pin_sync ( int8_t *  pincode,
int8_t *  new_pincode,
uint8_t *  simstat,
uint8_t *  attemptsleft 
)

Enter Personal Identification Number.

Parameters
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]new_pincodeIf not used, set NULL. If the PIN is SIM PUK or SIM PUK2, the new_pincode is required. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[out]simstatState after PIN enter. As below value stored.
[out]attemptsleftNumber of attempts left. Set only if failed. If simstat is other than PIN, PUK, PIN2, PUK2, set the number of PIN.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_enter_pin()

int32_t lte_enter_pin ( int8_t *  pincode,
int8_t *  new_pincode,
enter_pin_cb_t  callback 
)

Enter Personal Identification Number.

Parameters
[in]pincodeCurrent PIN code. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]new_pincodeIf not used, set NULL. If the PIN is SIM PUK or SIM PUK2, the new_pincode is required. Minimum number of digits is 4. Maximum number of digits is 8, end with '\0'. (i.e. Max 9 byte)
[in]callbackCallback function to notify that PIN enter is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_localtime_sync()

int32_t lte_get_localtime_sync ( lte_localtime_t localtime)

Get local time.

Parameters
[out]localtimeLocal time. See lte_localtime_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_localtime()

int32_t lte_get_localtime ( get_localtime_cb_t  callback)

Get local time.

Parameters
[in]callbackCallback function to notify when getting local time is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_operator_sync()

int32_t lte_get_operator_sync ( int8_t *  oper)

Get connected network operator information.

Parameters
[out]operA character string indicating network operator. It is terminated with '\0' If it is not connected, the first character is '\0'. The maximum number of network operator areas must be allocated. See LTE_OPERATOR_LEN.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_operator()

int32_t lte_get_operator ( get_operator_cb_t  callback)

Get connected network operator information.

Parameters
[in]callbackCallback function to notify when getting network operator information is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_edrx_sync()

int32_t lte_get_edrx_sync ( lte_edrx_setting_t settings)

Get eDRX settings.

Parameters
[out]settingseDRX settings. See lte_edrx_setting_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_edrx()

int32_t lte_get_edrx ( get_edrx_cb_t  callback)

Get eDRX settings.

Parameters
[in]callbackCallback function to notify when getting eDRX settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_edrx_sync()

int32_t lte_set_edrx_sync ( lte_edrx_setting_t settings)

Set eDRX settings.

Parameters
[in]settingseDRX settings.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_edrx()

int32_t lte_set_edrx ( lte_edrx_setting_t settings,
set_edrx_cb_t  callback 
)

Set eDRX settings.

Parameters
[in]settingseDRX settings.
[in]callbackCallback function to notify that eDRX settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_psm_sync()

int32_t lte_get_psm_sync ( lte_psm_setting_t settings)

Get PSM settings.

Parameters
[out]settingsPSM settings. See lte_psm_setting_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_psm()

int32_t lte_get_psm ( get_psm_cb_t  callback)

Get PSM settings.

Parameters
[in]callbackCallback function to notify when getting PSM settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_psm_sync()

int32_t lte_set_psm_sync ( lte_psm_setting_t settings)

Set PSM settings.

Parameters
[in]settingsPSM settings.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_psm()

int32_t lte_set_psm ( lte_psm_setting_t settings,
set_psm_cb_t  callback 
)

Set PSM settings.

Parameters
[in]settingsPSM settings.
[in]callbackCallback function to notify that PSM settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_ce_sync()

int32_t lte_get_ce_sync ( lte_ce_setting_t settings)

Get CE settings.

Parameters
[out]settingsCE settings. See lte_ce_setting_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_ce()

int32_t lte_get_ce ( get_ce_cb_t  callback)

Get CE settings.

Parameters
[in]callbackCallback function to notify when getting CE settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_ce_sync()

int32_t lte_set_ce_sync ( lte_ce_setting_t settings)

Set CE settings.

Parameters
[in]settingsCE settings
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_ce()

int32_t lte_set_ce ( lte_ce_setting_t settings,
set_ce_cb_t  callback 
)

Set CE settings.

Parameters
[in]settingsCE settings
[in]callbackCallback function to notify that CE settings are completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_simstat()

int32_t lte_set_report_simstat ( simstat_report_cb_t  simstat_callback)

Notifies the SIM status to the application.

The default report setting is disable.

Parameters
[in]simstat_callbackCallback function to notify that SIM state. If NULL is set, the report setting is disabled.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_localtime()

int32_t lte_set_report_localtime ( localtime_report_cb_t  localtime_callback)

Notifies the Local time to the application.

The default report setting is disable.

Parameters
[in]localtime_callbackCallback function to notify that local time. If NULL is set, the report setting is disabled.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_quality()

int32_t lte_set_report_quality ( quality_report_cb_t  quality_callback,
uint32_t  period 
)

Notifies the communication quality information to the application.

Invoke the callback at the specified report interval.

The default report setting is disable.

Attention
When changing the notification cycle, stop and start again.
Parameters
[in]quality_callbackCallback function to notify that quality information. If NULL is set, the report setting is disabled.
[in]periodReporting cycle in sec (1-4233600)
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_cellinfo()

int32_t lte_set_report_cellinfo ( cellinfo_report_cb_t  cellinfo_callback,
uint32_t  period 
)

Notifies the LTE network cell information to the application.

Invoke the callback at the specified report interval.

The default report setting is disable.

Attention
When changing the notification cycle, stop and start again.
Parameters
[in]cellinfo_callbackCallback function to notify that cell information. If NULL is set, the report setting is disabled.
[in]periodReporting cycle in sec (1-4233600)
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_set_report_netinfo()

int32_t lte_set_report_netinfo ( netinfo_report_cb_t  netinfo_callback)

Notifies the LTE network status to the application.

The default report setting is disable.

Parameters
[in]netinfo_callbackCallback function to notify that cell information. If NULL is set, the report setting is disabled.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_errinfo()

int32_t lte_get_errinfo ( lte_errinfo_t info)

Get LTE API last error information.

Call this function when LTE_RESULT_ERROR is returned by callback function. The detailed error information can be obtained.

Parameters
[in]infoPointer of error information.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_siminfo_sync()

int32_t lte_get_siminfo_sync ( uint32_t  option,
lte_siminfo_t siminfo 
)

Get SIM information such as Mobile Country Code/Mobile Network Code.

Parameters
[in]optionIndicates which parameter to get. Bit setting definition is as below.
[out]siminfoSIM information. See lte_siminfo_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_siminfo()

int32_t lte_get_siminfo ( uint32_t  option,
get_siminfo_cb_t  callback 
)

Get SIM information such as Mobile Country Code/Mobile Network Code.

Parameters
[in]optionIndicates which parameter to get. Bit setting definition is as below.
[in]callbackCallback function to notify that get of SIM information is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_dynamic_edrx_param()

int32_t lte_get_dynamic_edrx_param ( get_dynamic_edrx_param_cb_t  callback)

Get eDRX dynamic parameter.

Deprecated:
Use lte_get_current_edrx instead.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Parameters
[in]callbackCallback function to notify when getting eDRX dynamic parameter is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_current_edrx_sync()

int32_t lte_get_current_edrx_sync ( lte_edrx_setting_t settings)

Get current eDRX settings.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Get the settings negotiated between the modem and the network.

Parameters
[out]settingsCurrent eDRX settings. See lte_edrx_setting_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_current_edrx()

int32_t lte_get_current_edrx ( get_current_edrx_cb_t  callback)

Get current eDRX settings.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Get the settings negotiated between the modem and the network.

Parameters
[in]callbackCallback function to notify when getting current eDRX settings is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_dynamic_psm_param()

int32_t lte_get_dynamic_psm_param ( get_dynamic_psm_param_cb_t  callback)

Get PSM dynamic parameter.

Deprecated:
Use lte_get_current_psm instead.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Parameters
[in]callbackCallback function to notify when getting PSM dynamic parameter is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_current_psm_sync()

int32_t lte_get_current_psm_sync ( lte_psm_setting_t settings)

Get current PSM settings.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Get the settings negotiated between the modem and the network.

Parameters
[OUT]settings: Current PSM settings. See lte_psm_setting_t.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_current_psm()

int32_t lte_get_current_psm ( get_current_psm_cb_t  callback)

Get current PSM settings.

This API can be issued after connect to the LTE network with lte_activate_pdn().

Get the settings negotiated between the modem and the network.

Parameters
[in]callbackCallback function to notify when getting current PSM settings is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_quality_sync()

int32_t lte_get_quality_sync ( lte_quality_t quality)

Get communication quality information.

Parameters
[out]qualityQuality information. See lte_quality_t
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_quality()

int32_t lte_get_quality ( get_quality_cb_t  callback)

Get communication quality information.

Parameters
[in]callbackCallback function to notify when getting quality information is completed.
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.

◆ lte_get_cellinfo_sync()

int32_t lte_get_cellinfo_sync ( lte_cellinfo_t cellinfo)

Get LTE network cell information.

Parameters
[out]cellinfoLTE network cell information. See lte_cellinfo_t
Returns
On success, 0 is returned. On failure, negative value is returned according to <errno.h>.