1 Star 0 Fork 379

长风 / LuatOS

forked from 合宙Luat / LuatOS 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
luat_lib_nbiot.md 10.68 KB
一键复制 编辑 原始数据 按行查看 历史
三个字儿 提交于 2020-08-13 13:01 . 更新文档
module summary version date
nbiot
NB-IOT操作库
V0001
2020.04.30

nbiot.isReady

nbiot.isReady()

网络是否就绪

参数表

无参数

返回值

boolean: 已联网返回true,否则返回false

调用示例

-- 判断是否已经联网
if nbiot.isReady() then 
    log.info("nbiot", "net is ready")
end

nbiot.imsi

nbiot.imsi()

读取IMSI

参数表

无参数

返回值

string: 返回IMSI值,如果不存在就返回nil

调用示例

-- 读取imsi
log.info("nbiot", "imsi", nbiot.imsi())

nbiot.iccid

nbiot.iccid()

读取ICCID

参数表

无参数

返回值

string: 返回ICCID值,如果不存在就返回nil

调用示例

-- 读取iccid
log.info("nbiot", "iccid", nbiot.iccid())

nbiot.imei

nbiot.imei(val)

读取或设置IMEI

参数表

Name Type Description
val string 传入需要设置的imei值,不传就是读取

返回值

string: 返回imei值,如果不存在就返回nil

调用示例

-- 读取imei
log.info("nbiot", "imei", nbiot.imei())
-------------------------
-- 设置imei
log.info("nbiot", "imei", nbiot.imei("898989898989899898"))

nbiot.rssi

nbiot.rssi()

读取RSSI

参数表

无参数

返回值

int: 返回rssi值

调用示例

-- 读取rssi
log.info("nbiot", "rssi", nbiot.rssi())

nbiot.apn

nbiot.apn()

读取APN

参数表

无参数

返回值

string: 返回apn值

调用示例

-- 读取APN
log.info("nbiot", "apn", nbiot.apn())

nbiot.tac

nbiot.tac()

读取TAC

参数表

无参数

返回值

int: 返回TAC值

调用示例

-- 读取TAC
log.info("nbiot", "tac", nbiot.tac())

nbiot.tacTime

nbiot.tacTime()

读取Tac Time

参数表

无参数

返回值

int: 返回Tac Time值

调用示例

-- 读取Tac Time
log.info("nbiot", "tac time", nbiot.tacTime())

nbiot.activeTime

nbiot.activeTime()

读取Active Time

参数表

无参数

返回值

int: 返回Active Time值

调用示例

-- 读取Active Time
log.info("nbiot", "Active Time", nbiot.activeTime())

nbiot.cellID

nbiot.cellID()

读取CellID

参数表

无参数

返回值

int: 返回CellID值

调用示例

-- 读取CellID
log.info("nbiot", "CellID", nbiot.cellID())

nbiot.snr

nbiot.snr()

读取SNR

参数表

无参数

返回值

int: 返回SNR值

调用示例

-- 读取SNR
log.info("nbiot", "SNR", nbiot.snr())

nbiot.csq

nbiot.csq()

读取CSQ, 并不完全等价于GSM的CSQ

参数表

无参数

返回值

int: 返回csq值

调用示例

-- 读取csq
log.info("nbiot", "csq", nbiot.csq())

nbiot.ceLevel

nbiot.ceLevel()

读取CE Level

参数表

无参数

返回值

int: 返回CE Level值

调用示例

-- 读取CE Level
log.info("nbiot", "CE Level", nbiot.ceLevel())

nbiot.sn

nbiot.sn(val)

读取或设置SN,普通刷机(刷底层/刷脚本)不会清除

参数表

Name Type Description
val string 需要设置的SN值(只能是可见字符),不传值则为读取

返回值

string: 返回SN值

调用示例

-- 读取SN
log.info("nbiot", "SN", nbiot.sn())
-------------------------
-- 设置SN
log.info("nbiot", "SN", nbiot.sn("My Custom SN"))

nbiot.updateCellInfo

nbiot.updateCellInfo()

刷新网络信息,可通过定时任务刷新,最小间隔5秒

参数表

无参数

返回值

boolean: 成功启动刷新线程返回true,否则返回false.

调用示例

-- 刷新网络信息
nbiot.updateCellInfo()
sys.waitUntil("CELL_INFO_IND", 3000)
log.info("nbiot", "cell", json.encode(nbiot.getCellInfo()))

nbiot.mcc

nbiot.mcc()

读取MCC值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商MCC值

调用示例

-- 读取MCC
log.info("nbiot", "mcc", nbiot.mcc())

nbiot.mnc

nbiot.mnc()

读取MNC值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商MNC值

调用示例

-- 读取MNC
log.info("nbiot", "mnc", nbiot.mnc())

nbiot.earfcn

nbiot.earfcn()

读取earfcn值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商earfcn值

调用示例

-- 读取earfcn
log.info("nbiot", "earfcn", nbiot.earfcn())

nbiot.phyCellId

nbiot.phyCellId()

读取phyCellId值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商phyCellId值

调用示例

-- 读取phyCellId
log.info("nbiot", "phyCellId", nbiot.phyCellId())

nbiot.rsrq

nbiot.rsrq()

读取rsrq值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商ersrq值

调用示例

-- 读取rsrq
log.info("nbiot", "rsrq", nbiot.rsrq())

nbiot.rsrp

nbiot.rsrp()

读取rsrp值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商rsrp值

调用示例

-- 读取rsrp
log.info("nbiot", "rsrp", nbiot.rsrp())

nbiot.powerLevel

nbiot.powerLevel()

读取PowerLevel值,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

int: 运营商PowerLevel值

调用示例

-- 读取PowerLevel
log.info("nbiot", "PowerLevel", nbiot.powerLevel())

nbiot.getCellInfo

nbiot.getCellInfo()

获取网络基站详情,注册网络后可用,通过nbiot.updateCellInfo()刷新

参数表

无参数

返回值

table: 网络基站详情

调用示例

-- 读取基站信息
log.info("nbiot", "cell info", json.encode(nbiot.getCellInfo()))

nbiot.setCFUN

nbiot.setCFUN(val)

进入或退出飞行模式

参数表

Name Type Description
val int 0飞行模式,1普通联网模式

返回值

boolean: 设置成功返回true,否则返回false

调用示例

-- 进入飞行模式
nbiot.setCFUN(0)

nbiot.setBootCFUN

nbiot.setBootCFUN(val)

设置设备上电启动时,是否进入飞行模式

参数表

Name Type Description
val int 0飞行模式,1普通联网模式

返回值

boolean: 设置成功返回true,否则返回false

调用示例

-- 设置为上电进入飞行模式
nbiot.setBootCFUN(0)

nbiot.getBootCFUN

nbiot.getBootCFUN(val)

获取设备上电启动时,是否进入飞行模式

参数表

Name Type Description
val null

返回值

int: 开机就进入飞行模式返回0,进入普通模式返回1

调用示例

-- 获取上电模式
nbiot.getBootCFUN()

nbiot.setPSM

nbiot.setPSM(psmMode, tauTimeS, activeTimeS)

设置PSM参数

参数表

Name Type Description
psmMode int psm模式, CMI_MM_DISABLE_PSM(0)/CMI_MM_ENABLE_PSM(1)/CMI_MM_DISCARD_PSM(2)
tauTimeS int TAU time(unit: S)---related to T3412
activeTimeS int active time(unit: S)---related to T3324

返回值

boolean: 设置成功返回true,否则返回false

调用示例

-- 设置PSM
nbiot.setPSM(1, 60, 120)

nbiot.setEDRX

nbiot.setEDRX(modeVal, actType, reqEdrxValueMs)

设置EDRX参数

参数表

Name Type Description
modeVal int 模式,CMI_MM_DISABLE_EDRX = 0/CMI_MM_ENABLE_EDRX_AND_DISABLE_IND = 1/CMI_MM_ENABLE_EDRX_AND_ENABLE_IND = 2/CMI_MM_DISCARD_EDRX = 3
actType int 可选值, 0或者5. CMI_MM_EDRX_NO_ACT_OR_NOT_USE_EDRX = 0/CMI_MM_EDRX_NB_IOT = 5
reqEdrxValueMs int edrx值,单位毫秒

返回值

boolean: 设置成功返回true,否则返回false

调用示例

-- 设置EDRX
nbiot.setPSM(1, 5, 30000)

nbiot.getPSM

nbiot.getPSM()

获取PSM参数

参数表

无参数

返回值

No. Type Description
1 int psm模式, CMI_MM_DISABLE_PSM(0)/CMI_MM_ENABLE_PSM(1)/CMI_MM_DISCARD_PSM(2)
2 int TAU time(unit: S)---related to T3412
3 int active time(unit: S)---related to T3324

调用示例

-- 获取PSM
log.info("psm", nbiot.getPSM())

nbiot.getEDRX

nbiot.getEDRX()

获取EDRX参数

参数表

无参数

返回值

No. Type Description
1 int 模式,CMI_MM_DISABLE_EDRX = 0/CMI_MM_ENABLE_EDRX_AND_DISABLE_IND = 1/CMI_MM_ENABLE_EDRX_AND_ENABLE_IND = 2/CMI_MM_DISCARD_EDRX = 3
2 int 可选值, 0或者5. CMI_MM_EDRX_NO_ACT_OR_NOT_USE_EDRX = 0/CMI_MM_EDRX_NB_IOT = 5
3 int edrx值,单位毫秒

调用示例

-- 获取EDRX
log.info("edrx", nbiot.getEDRX())
Lua
1
https://gitee.com/LCF228/LuatOS.git
git@gitee.com:LCF228/LuatOS.git
LCF228
LuatOS
LuatOS
master

搜索帮助