Przeglądaj źródła

update:更新部分注释

alienwalker 11 miesięcy temu
rodzic
commit
2fc1b09375

+ 1 - 1
components/cc/luat_lib_cc.c

@@ -7,7 +7,7 @@
 @demo    cc
 @tag LUAT_USE_VOLTE
 @usage
--- 当前仅Air780EPV支持VoLTE通话功能
+-- 选型手册上支持VoLTE通话功能的模组支持
 */
 
 #include "luat_base.h"

+ 1 - 1
components/mobile/luat_mobile.h

@@ -528,7 +528,7 @@ typedef enum LUAT_MOBILE_EVENT
 	LUAT_MOBILE_EVENT_CSCON, /**< RRC状态,0 idle 1 active*/
 	LUAT_MOBILE_EVENT_BEARER,/**< PDP承载状态*/
 	LUAT_MOBILE_EVENT_SMS,	/**< SMS短信 >*/
-	LUAT_MOBILE_EVENT_NAS_ERROR,/**< NAS异常消息,air780e, air780ep有效*/
+	LUAT_MOBILE_EVENT_NAS_ERROR,/**< NAS异常消息,air780exxx系列有效*/
 	LUAT_MOBILE_EVENT_IMS_REGISTER_STATUS, /**< IMS注册状态,volte必须在注册成功情况下使用*/
 	LUAT_MOBILE_EVENT_CC,	/**< 通话相关消息*/
 	LUAT_MOBILE_EVENT_USB_ETH_ON,

+ 1 - 1
components/multimedia/luat_lib_multimedia_codec.c

@@ -27,7 +27,7 @@
 @api codec.create(type, isDecoder, quality)
 @int 多媒体类型,目前支持codec.MP3 codec.AMR
 @boolean 是否是解码器,true解码器,false编码器,默认true,是解码器
-@int 编码等级,部分bsp有内部编码器,可能需要提前输入编码等级,比如air780ep的内部amr编码器
+@int 编码等级,部分bsp有内部编解码器,可能需要提前输入编解码等级,不知道的就填7
 @return userdata 成功返回一个数据结构,否则返回nil
 @usage
 -- 创建解码器

+ 1 - 1
components/network/netdrv/binding/luat_lib_netdrv.c

@@ -260,7 +260,7 @@ static const rotable_Reg_t reg_netdrv[] =
     //@const CH390 number 南京沁恒CH390系列,支持CH390D/CH390H, SPI通信
     { "CH390",          ROREG_INT(1)},
     { "CH395",          ROREG_INT(2)}, // 考虑兼容Air724UG/Air820UG的老客户
-    { "W5500",          ROREG_INT(3)}, // 考虑兼容Air780E/Air105的老客户
+    { "W5500",          ROREG_INT(3)}, // 考虑兼容Air780EXXX/Air105的老客户
     { "UART",           ROREG_INT(16)}, // UART形式的网卡, 不带MAC, 直接IP包
     { "SPINET",         ROREG_INT(32)}, // SPI形式的网卡, 可以带MAC, 也可以不带
     { "WHALE",          ROREG_INT(64)}, // 通用WHALE设备

+ 3 - 3
components/repl/luat_lib_repl.c

@@ -13,11 +13,11 @@ Air105           UART0   1500000 8 None 1
 ESP32C3          UART0   921600  8 None 1 -- 注意, 简约版(无CH343)不支持
 ESP32C2          UART0   921600  8 None 1
 ESP32S2          UART0   921600  8 None 1
-Air780E          虚拟串口 任意             -- 暂不支持从物理UART调用
+Air780EXXX       虚拟串口 任意             -- 暂不支持从物理UART调用
 
 使用方法:
-1. 非Air780E系列可以使用任意串口工具, 打开对应的串口, 记得勾选"回车换行"
-2. Air780E请配合LuaTools使用, 菜单里有 "简易串口工具" 可发送, 记得勾选"回车换行"
+1. 非Air780EXXX系列可以使用任意串口工具, 打开对应的串口, 记得勾选"回车换行"
+2. Air780EXXX请配合LuaTools使用, 菜单里有 "简易串口工具" 可发送, 记得勾选"回车换行"
 2. 发送lua语句, 并以回车换行结束
 
 语句支持情况:

+ 1 - 1
components/wlan/luat_lib_wlan.c

@@ -12,7 +12,7 @@
 提醒:
 对于仅支持wifiscan的模块, 仅 init/scan/scanResult 函数是可用的
 
-例如: Air780E/Air600E/Air780EG等仅支持wifiscan
+例如: Air780EXXX等仅支持wifiscan
 ]]
 
 */

+ 6 - 6
luat/modules/luat_lib_adc.c

@@ -49,7 +49,7 @@ static int l_adc_open(lua_State *L) {
 }
 
 /**
-设置ADC的测量范围,注意这个和具体芯片有关,目前只支持air105/Air780E系列
+设置ADC的测量范围,注意这个和具体芯片有关,目前只支持air105/Air780EXXX系列
 @api adc.setRange(range)
 @int range参数,与具体设备有关,比如air105填adc.ADC_RANGE_1_8和adc.ADC_RANGE_3_6
 @return nil
@@ -62,9 +62,9 @@ adc.setRange(adc.ADC_RANGE_1_8)
 adc.setRange(adc.ADC_RANGE_3_6)
 
 
--- EC618系列(Air780E等)/EC718E系列(Air780EP/Air780EPV等)支持以下2种
-adc.setRange(adc.ADC_RANGE_1_2) -- 关闭分压
-adc.setRange(adc.ADC_RANGE_3_8) -- 启用分压
+-- Air780EXXX支持多种,但是建议用以下2种
+adc.setRange(adc.ADC_RANGE_MIN) -- 关闭分压
+adc.setRange(adc.ADC_RANGE_MAX) -- 启用分压
  */
 static int l_adc_set_range(lua_State *L) {
 	luat_adc_global_config(ADC_SET_GLOBAL_RANGE, luaL_checkinteger(L, 1));
@@ -152,9 +152,9 @@ static const rotable_Reg_t reg_adc[] =
 	{ "ADC_RANGE_3_6",   ROREG_INT(1)},
 	//@const ADC_RANGE_1_8 number air105的ADC分压电阻关闭,范围0~1.88V
 	{ "ADC_RANGE_1_8",   ROREG_INT(0)},
-	//@const ADC_RANGE_3_8 number air780E开启ADC0,1分压电阻,范围0~3.8V
+	//@const ADC_RANGE_3_8 number air780E开启ADC0,1分压电阻,范围0~3.8V,将要废弃,不建议使用
 	{ "ADC_RANGE_3_8",   ROREG_INT(LUAT_ADC_AIO_RANGE_3_8)},
-	//@const ADC_RANGE_1_2 number air780E关闭ADC0,1分压电阻,范围0~1.2V
+	//@const ADC_RANGE_1_2 number air780E关闭ADC0,1分压电阻,范围0~1.2V,将要废弃,不建议使用
 	{ "ADC_RANGE_1_2",   ROREG_INT(0)},
 	//@const ADC_RANGE_MAX number ADC开启内部分压后所能到达最大量程,由具体芯片决定
 	{ "ADC_RANGE_MAX",   ROREG_INT(LUAT_ADC_AIO_RANGE_MAX)},

+ 3 - 3
luat/modules/luat_lib_gpio.c

@@ -215,12 +215,12 @@ end, gpio.PULLUP, gpio.RISING)
 gpio.setup(7, gpio.count)
 
 -- alt_func 于2023.7.2新增
--- 本功能仅对部分平台有效, 且仅用于调整GPIO复用,其他复用方式请使用muc.iomux函数
+-- 本功能仅对AIR780EXXX有效,仅用于调整GPIO复用,不能用于外设复用调整
 -- 以下示例代码, 将I2S_DOUT复用成gpio18
 -- AIR780E的PIN33(模块管脚序号), 对应paddr 38, 默认功能是I2S_DOUT, 复用成gpio18
 -- 方向输出,且初始化电平为低,使用硬件默认上下拉配置
--- Air780E(EC618系列的GPIO复用请查阅 https://air780e.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
--- Air780EP(EC718P系列的GPIO复用请查阅 https://air780ep.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
+-- Air780E(GPIO复用请查阅 https://air780e.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
+-- Air780EP(GPIO复用请查阅 https://air780ep.cn 首页硬件资料表格中的Air780E&Air780EG&Air780EX&Air700E_GPIO_table_20231227.pdf)
 gpio.setup(18, 0, nil, nil, 4)
 
 -- 提醒: 

+ 1 - 1
luat/modules/luat_lib_i2s.c

@@ -153,7 +153,7 @@ static int l_i2s_send(lua_State *L) {
 }
 
 /*
-接收i2s数据,注意在数据在回调时已经存放在zbuff里,目前只有air780e系列支持
+接收i2s数据,注意在数据在回调时已经存放在zbuff里,目前只有air780exxx系列支持
 @api i2s.recv(id, buffer, len)
 @int 通道id
 @zbuff 数据缓存区

+ 1 - 1
luat/modules/luat_lib_mcu.c

@@ -381,7 +381,7 @@ static int l_mcu_ticks2(lua_State* L) {
 @boolean 低速32K晶振参考时钟是否输出
 @usage
 -- 本函数于2024.5.17新增
--- 当前仅Air780EP系列支持
+-- 当前仅Air780EXXX系列支持
 mcu.XTALRefOutput(true, false)	--高速晶振参考时钟输出,低速32K不输出
 */
 static int l_mcu_xtal_ref_output(lua_State* L) {

+ 15 - 15
luat/modules/luat_lib_pm.c

@@ -35,7 +35,7 @@
         wakeup脚可唤醒
         唤醒后程序从头运行,休眠前的运行时数据全丢
 
-对部分模块,例如Air780E, DEEP/HIB对用户代码没有区别
+对部分模块,例如Air780EXXX, DEEP/HIB对用户代码没有区别
 
 除pm.shutdown()外, RTC总是运行的, 除非掉电
 ]]
@@ -43,10 +43,10 @@
 -- 定时器唤醒, 请使用 pm.dtimerStart()
 -- wakeup唤醒
     -- 如Air101/Air103, 有独立的wakeup脚, 不需要配置,可直接控制唤醒
-    -- 如Air780E系列, 有多个wakeup可用, 通过gpio.setup(32)配置虚拟GPIO进行唤醒配置
+    -- 如Air780EXXX系列, 有多个wakeup可用, 通过gpio.setup()配置虚拟GPIO进行唤醒配置,参考demo/gpio/virtualIO
 
 pm.request(pm.IDLE) -- 通过切换不同的值请求进入不同的休眠模式
--- 对应Air780E系列, 执行后并不一定马上进入休眠模式, 如无后续数据传输需求,可先进入飞行模式,然后快速休眠
+-- 对应Air780EXXX系列, 执行后并不一定马上进入休眠模式, 如无后续数据传输需求,可先进入飞行模式,然后快速休眠
 */
 #include "lua.h"
 #include "lauxlib.h"
@@ -121,7 +121,7 @@ static int l_pm_request(lua_State *L) {
 @usage
 -- 添加底层定时器
 pm.dtimerStart(0, 300 * 1000) -- 5分钟后唤醒
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)
+-- 针对Air780EXXX有如下限制
 -- id = 0 或者 id = 1 是, 最大休眠时长是2.5小时
 -- id >= 2是, 最大休眠时长是740小时
  */
@@ -260,7 +260,7 @@ static int l_pm_last_reson(lua_State *L) {
 @usage
 -- 请求进入休眠模式
 pm.force(pm.HIB)
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等), 该操作会关闭USB通信
+-- 针对Air780EXXX, 该操作会关闭USB通信
 -- 唤醒后如需开启USB, 请打开USB电压
 --pm.power(pm.USB, true)
  */
@@ -280,7 +280,7 @@ pm.request(pm.HIB)
 if pm.check() then
     log.info("pm", "it is ok to hib")
 else
-    -- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等), 该操作会关闭USB通信
+    -- 针对Air780EXXX, 该操作会关闭USB通信
     pm.force(pm.HIB) -- 强制休眠
     -- 唤醒后如需开启USB, 请打开USB电压
     --sys.wait(100)
@@ -342,12 +342,12 @@ pm.power(pm.USB, false)
 -- Air780EG,为内置的GPS芯片上电. 注意, Air780EG的GPS和GPS_ANT是一起控制的,所以合并了.
 pm.power(pm.GPS, true)
 
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)开启pwrkey开机防抖
+-- Air780EXXX开启pwrkey开机防抖
 -- 注意: 开启后, 复位键就变成关机了!!! pwrkey要长按2秒才能开机
 -- pm.power(pm.PWK_MODE, true)
 
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)PSM+低功耗设置
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)节能模式,0~3,0完全关闭,1性能优先,2平衡,3极致功耗
+-- Air780EXXX PSM+低功耗设置
+-- Air780EXXX节能模式,0~3,0完全关闭,1~2普通低功耗,3超低功耗,深度休眠
 -- 详情访问: https://airpsm.cn
 -- pm.power(pm.WORK_MODE, 1)
  */
@@ -372,7 +372,7 @@ IO高电平电压控制
 @int 电平值,单位毫伏
 @return boolean 处理结果true成功,false失败
 @usage
--- 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)设置IO电平, 范围 1650 ~ 2000,2650~3400 , 单位毫伏, 步进50mv
+-- Air780EXXX设置IO电平, 范围 1650 ~ 2000,2650~3400 , 单位毫伏, 步进50mv
 -- 注意, 这里的设置优先级会高于硬件IOSEL脚的配置
 -- 但开机时依然先使用硬件配置,直至调用本API进行配置, 所以io电平会变化
 -- pm.ioVol(pm.IOVOL_ALL_GPIO, 3300)    -- 所有GPIO高电平输出3.3V
@@ -462,15 +462,15 @@ static const rotable_Reg_t reg_pm[] =
     { "GPS_ANT",        ROREG_INT(LUAT_PM_POWER_GPS_ANT)},
     //@const CAMERA number camera电源,CAM_VCC输出
     { "CAMERA",         ROREG_INT(LUAT_PM_POWER_CAMERA)},
-    //@const DAC_EN number Air780E和Air600E,Air780EP的DAC_EN(新版硬件手册的LDO_CTL,同一个PIN,命名变更),注意audio的默认配置会自动使用这个脚来控制CODEC的使能
+    //@const DAC_EN number Air780EXXX的DAC_EN(新版硬件手册的LDO_CTL,同一个PIN,命名变更),注意audio的默认配置会自动使用这个脚来控制CODEC的使能
     { "DAC_EN",         ROREG_INT(LUAT_PM_POWER_DAC_EN_PIN)},
-    //@const LDO_CTL number Air780E和Air600E,Air780EP的LDO_CTL(老版硬件手册的DAC_EN,同一个PIN,命名变更),Air780EP的LDO_CTL, 注意audio的默认配置会自动使用这个脚来控制CODEC的使能
+    //@const LDO_CTL number Air780EXXX的LDO_CTL(老版硬件手册的DAC_EN,同一个PIN,命名变更),Air780EXXX的LDO_CTL, 注意audio的默认配置会自动使用这个脚来控制CODEC的使能
     { "LDO_CTL",         ROREG_INT(LUAT_PM_POWER_LDO_CTL_PIN)},
-    //@const PWK_MODE number 是否开启移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)的powerkey滤波模式,true开,注意滤波模式下reset变成直接关机
+    //@const PWK_MODE number 是否Air780EXXX的powerkey滤波模式,true开,注意滤波模式下reset变成直接关机
     { "PWK_MODE",       ROREG_INT(LUAT_PM_POWER_POWERKEY_MODE)},
-    //@const WORK_MODE number 移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)的节能模式,0~3,0完全关闭,1性能优先,2平衡,3极致功耗
+    //@const WORK_MODE number Air780EXXX的节能模式,0~3,0完全关闭,1~2普通低功耗,3超低功耗,深度休眠
     { "WORK_MODE",    ROREG_INT(LUAT_PM_POWER_WORK_MODE)},
-	//@const IOVL number 所有GPIO高电平电压控制,当前仅移芯CAT1平台系列(Air780E/Air700E/Air780EP等等)可用
+	//@const IOVL number 所有GPIO高电平电压控制,当前仅Air780EXXX可用
     { "IOVOL_ALL_GPIO",    ROREG_INT(LUAT_PM_ALL_GPIO)},
 
 	{ NULL,             ROREG_INT(0) }

+ 3 - 3
luat/modules/luat_lib_uart.c

@@ -731,7 +731,7 @@ static int l_uart_exist(lua_State *L)
 
 
 /*
-buff形式读串口,一次读出全部数据存入buff中,如果buff空间不够会自动扩展,目前air105,air780e支持这个操作
+buff形式读串口,一次读出全部数据存入buff中,如果buff空间不够会自动扩展,目前air105,Air780EXXX支持这个操作
 @api    uart.rx(id, buff)
 @int 串口id, uart0写0, uart1写1
 @zbuff zbuff对象
@@ -787,7 +787,7 @@ static int l_uart_rx(lua_State *L)
 }
 
 /*
-读串口Rx缓存中剩余数据量,目前air105,air780e支持这个操作
+读串口Rx缓存中剩余数据量,目前air105,Air780EXXX支持这个操作
 @api    uart.rxSize(id)
 @int 串口id, uart0写0, uart1写1
 @return int 返回读到的长度
@@ -819,7 +819,7 @@ LUAT_WEAK void luat_uart_clear_rx_cache(int uart_id)
 
 }
 /*
-清除串口Rx缓存中剩余数据量,目前air105,air780e支持这个操作
+清除串口Rx缓存中剩余数据量,目前air105,Air780EXXX支持这个操作
 @api    uart.rxClear(id)
 @int 串口id, uart0写0, uart1写1
 @usage