diff --git a/docs/API_reference/en/stdlib/uos.md b/docs/API_reference/en/stdlib/uos.md index 2fe46e482b5d91fb0e48e8b25ff00f12c8ca17c2..806adaf6cc893bba9ae7c7d617ff795e55590adb 100644 --- a/docs/API_reference/en/stdlib/uos.md +++ b/docs/API_reference/en/stdlib/uos.md @@ -484,7 +484,7 @@ udev.set_callback(call_back) ## Registering the Storage Device littleFS - SPI NOR FLASH -> Only EG915U and EC600N series modules support this feature currently. +> Only EG915U and EC600N series modules support this feature currently. It only supports 4-wire spi nor flash. ### `uos.VfsLfs1` diff --git a/docs/API_reference/zh/stdlib/uos.md b/docs/API_reference/zh/stdlib/uos.md index 1b8b3f9d908333d326f72915e07118c482a0a942..d0eba04fd9088128263172cf0e18739b76e4f34e 100644 --- a/docs/API_reference/zh/stdlib/uos.md +++ b/docs/API_reference/zh/stdlib/uos.md @@ -324,7 +324,7 @@ b'\xb3\xc9Y\x1b\xe9' ## 注册存储设备 - SPI - SD卡 -> 目前仅ECx00N&EGx00N平台支持。 +> 目前仅ECx00N&EG91xN平台支持。 ### `uos.VfsFat` @@ -491,9 +491,9 @@ def call_back(para): udev.set_callback(call_back) ``` -## 注册littleFS存储设备 - SPI NOR FLASH +## 注册存储设备 - SPI NOR FLASH -> 目前仅ECx00N&EGx00N&ECx00M&EGx00M&ECx00U&EGx00U系列平台支持 +> 目前仅ECx00N&EG91xN&ECx00M&EG810M&ECx00U&EG91xU系列平台支持。且只支持4线spi nor flash。 ### `uos.VfsLfs1` @@ -501,7 +501,7 @@ udev.set_callback(call_back) uos.VfsLfs1(readsize,progsize,lookahead,pname,spi_port,spi_clk) ``` -初始化spi nor flash,和外挂nor flash通信。使用SPI通信方式,将此存储设备挂载为littleFS文件系统。 +初始化spi nor flash，和外挂nor flash通信。使用SPI通信方式将此存储设备挂载为littleFS文件系统。 **参数描述** diff --git a/docs/API_reference/zh/syslib/fota.md b/docs/API_reference/zh/syslib/fota.md index e6b5e5164af2a80a6f549e4a8652fa85f7d42a95..f462f1b3d9e1b5ec65d0d64af7cbd6f6724fa075 100644 --- a/docs/API_reference/zh/syslib/fota.md +++ b/docs/API_reference/zh/syslib/fota.md @@ -25,6 +25,8 @@ def run(): res = fota_obj.httpDownload(url1="http://www.example.com/fota.bin",callback=result) #mini fota方式 #res = fota_obj.httpDownload(url1="http://www.example.com/fota1.bin",url2="http://www.example.com/fota2.bin") + #差分升级FTP方式 + #res = fota_obj.httpDownload(url1="ftp://user:password@ip:port/fota.bin",callback=result) #其中user,password,ip,port需要填写具体使用的FTP服务器信息 if res != 0: fota_log.error("httpDownload error") return @@ -123,22 +125,34 @@ fota_obj = fota() #下载完自动重启 ### `fota_obj.httpDownload` ```python -fota_obj.httpDownload(url1=, url2=, callback=) +fota_obj.httpDownload(url1=, url2=, callback=, ssl_params=) ``` -升级包下载、写入、校验及重启升级。 +升级包下载、写入、校验及重启升级，下载协议为HTTP。 **参数描述：** -- `url1`-可选参数，升级包的url，该url类型可以是HTTP或FTP，类型为str。注：仅EC200A型号支持FTP url。 +- `url1`-可选参数，升级包的url，类型为str。 - `url2`-可选参数，mini fota第二阶段升级包的url，类型为str。注：仅mini fota方式需要传入该参数，差分升级方式该参数禁止传入。mini fota方式为小存储平台特殊的固件升级方式，分为2个阶段。而差分升级方式只有一个阶段，仅EC600N/EC800N/EG912N/EC600M/EC800M/EG810M型号支持mini fota方式。 - `callback`-可选参数，回调函数，显示下载进度和状态，类型为function。注：mini fota方式不支持回调函数。回调函数参数含义如下。 | callback参数 | 参数类型 | 参数说明 | -| ------------ | -------- | ------------------------------------------------------------ | +| ------------ | :------- | ------------------------------------------------------------ | | args[0] | int | 表示下载状态，下载成功返回整型值：0或1或2，下载失败返回整型值：非0、1、2，表示错误码。 | | args[1] | int | 表示下载进度(注：EC600N/EC800N/EG912N平台当下载状态是成功时表示百分比，下载状态是失败时表示错误码)。 | +- `ssl_params`-可选参数，SSL认证时传入证书、密钥、SSL版本和身份验证模式，类型为字典。格式为{"ca_cert": ca_certificate_content, "client_cert": client_certificate_content, "client_key": client_key_content, "ssl_version": 1, "sec_level": 2}。参数含义如下。 + +| key | value类型 | value含义 | +| ------------- | --------- | ------------------------------------------------------------ | +| "ca_cert" | str | 受信任CA证书 | +| "client_cert" | str | 客户端证书 | +| "client_key" | str | 客户端密钥 | +| "ssl_version" | int | SSL版本：0-SSL 3.0，1-TLS 1.0，2-TLS 1.1，3-TLS 1.2，4-全部 | +| "sec_level" | int | 身份验证模式：0-无身份验证模式，1-进行服务器身份验证，2-进行服务器和客户端身份验证 | + +> SSL认证功能支持的型号：EC200A/UC200A。 + **返回值描述：** 执行成功返回整形值0，执行失败返回整形值-1。注：EC600N/EC800N/EG912N/EC600M/EC800M/EG810M/BC25PA型号，返回值只代表接口执行成功或失败，升级状态和结果需通过回调反馈。其他型号返回0表示下载和校验成功，返回-1表示下载或校验失败。 @@ -151,12 +165,45 @@ def result(args): #差分升级HTTP方式 fota_obj.httpDownload(url1="http://www.example.com/fota.bin",callback=result) -#差分升级FTP方式 -fota_obj.httpDownload(url1="ftp://user:password@ip:port/fota.bin",callback=result) #其中user,password,ip,port需要填写具体使用的FTP服务器信息 +#差分升级HTTPS双向认证方式 +fota_obj.httpDownload(url1="https://www.example.com/fota.bin",callback=result,ssl_params={"ca_cert": ca_certificate_content, "client_cert": client_certificate_content, "client_key": client_key_content, "ssl_version": 1, "sec_level": 2}) #mini fota方式 fota_obj.httpDownload(url1="http://www.example.com/fota1.bin",url2="http://www.example.com/fota2.bin") ``` +### `fota_obj.ftpDownload` + +```python +fota_obj.ftpDownload(url=, callback=) +``` + +升级包下载、写入、校验及重启升级，下载协议为FTP。 + +**参数描述：** + +- `url`-必选参数，升级包的url，类型为str。 +- `callback`-可选参数，回调函数，显示下载进度和状态，类型为function。回调函数参数含义如下。 + +| callback参数 | 参数类型 | 参数说明 | +| ------------ | :------- | ------------------------------------------------------------ | +| args[0] | int | 表示下载状态，下载成功返回整型值：0，下载失败返回整型值：非0，表示错误码。 | +| args[1] | int | 表示下载进度。 | + +**返回值描述：** + +执行成功返回整形值0，执行失败返回整形值-1。 + +**示例**： + +```python +def result(args): + print('download status:',args[0],'download process:',args[1]) + +fota_obj.ftpDownload(url="ftp://user:password@ip:port/fota.bin",callback=result) #其中user,password,ip,port需要填写具体使用的FTP服务器信息 +``` + +> FTP下载接口支持型号：EC200A/UC200A/BG95/BG600L/EC600U/EC200U/EG915U。 + ### `fota_obj.apn_set` ```python diff --git a/docs/Application_guide/en/firmware-upgrade/firmware-ota-issues.md b/docs/Application_guide/en/firmware-upgrade/firmware-ota-issues.md index 5361c2dda7f679677ac389714e0b7e8cb7bc1acf..bddf466e7ab2cd442de58a707f6256ad46d261ea 100644 --- a/docs/Application_guide/en/firmware-upgrade/firmware-ota-issues.md +++ b/docs/Application_guide/en/firmware-upgrade/firmware-ota-issues.md @@ -63,7 +63,7 @@ The download protocols supported include HTTP, HTTPS, and FTP. The specific supp | Model | HTTP | HTTPS | FTP | | ------------------------------------ | ---- | ------ | ------ | | EG91xN series | Support | Support | Not support | -| EC200U series | Support | Support | Support | +| EC200U&EG915U series | Support | Support | Support | | EC200A series | Support | Support | Support | | BG95&BG600L series | Support | Support | Support | @@ -104,12 +104,12 @@ if ql_fs.path_exists("usr/.updater"): 2. The difference between the old and target firmware versions is too large, resulting in an upgrade package that is too big to be stored in the storage space. Check the size of the upgrade package. The maximum size limit for an upgrade package for each model is as follows. - | Model | Maximum Size of an Upgrade Package | - | ------------------ | ---------------------------------- | - | EG91xN series | 3 MB | - | EC200U series | 700 KB | - | EC200A series | 3.5 MB | - | BG95&BG600L series | 7 MB | +| Model | Maximum Size of an Upgrade Package | +| -------------------- | ---------------------------------- | +| EG91xN series | 3 MB | +| EC200U&EG915U series | 700 KB | +| EC200A series | 3.5 MB | +| BG95&BG600L series | 7 MB | #### 0 is returned after the upgrade API is called, but the version number remains unchanged after the device reboots. diff --git a/docs/Application_guide/zh/firmware-upgrade/firmware-ota-issues.md b/docs/Application_guide/zh/firmware-upgrade/firmware-ota-issues.md index 6cf31df1afce80d027b5f3707559f8c409509870..b88013a520b4b922e1107b791a37ce571ccb30c3 100644 --- a/docs/Application_guide/zh/firmware-upgrade/firmware-ota-issues.md +++ b/docs/Application_guide/zh/firmware-upgrade/firmware-ota-issues.md @@ -64,8 +64,9 @@ OTA功能模块本身没有，客户可以自己加入完整性校验。方法 | ------------------------------------ | ---- | ------ | ------ | | EC600NCNLC&EC600NCNLF&EG91xN系列 | 支持 | 支持 | 不支持 | | EC600NCNLA&EC600NCNLE&EC800NCNLA系列 | 支持 | 不支持 | 不支持 | -| ECx00M&EGx00M系列 | 支持 | 不支持 | 不支持 | -| ECx00U&EGx00U&ECx00G系列 | 支持 | 支持 | 支持 | +| ECx00M&EG810M系列 | 支持 | 不支持 | 不支持 | +| ECx00U&EG91xU系列 | 支持 | 支持 | 支持 | +| ECx00G系列 | 支持 | 支持 | 不支持 | | ECx00E系列 | 支持 | 不支持 | 不支持 | | EC200A系列 | 支持 | 支持 | 支持 | | BG95&BG600L系列 | 支持 | 支持 | 支持 | @@ -97,7 +98,7 @@ if ql_fs.path_exists("usr/.updater"): 1.检查网络是否正常，是否插了SIM卡、是否接了天线，是否拨号成功。 -2.是否使用HTTPS下载协议，仅部分型号支持HTTPS协议，不支持HTTPS协议的设备使用HTTPS协议的URL会下载失败，需要换成HTTP协议的URL。支持HTTPS协议的情况有ECx00N&EG91xN系列、EC200A系列、ECx00U&EGx00U&ECx00G系列、BG95&BG600L系列且使用差分升级方案时。 +2.是否使用HTTPS下载协议，仅部分型号支持HTTPS协议，不支持HTTPS协议的设备使用HTTPS协议的URL会下载失败，需要换成HTTP协议的URL。支持HTTPS协议的情况有ECx00N&EG91xN系列、EC200A系列、ECx00U&EG91xU&ECx00G系列、BG95&BG600L系列且使用差分升级方案时。 3.检查URL正确，可以使用浏览器输入该URL查看是否能下载成功。 diff --git a/docs/Application_guide/zh/system/memory-device.md b/docs/Application_guide/zh/system/memory-device.md index e5212e59339afb30146140af49f0aa264ff0d497..ac29b5ba3be12b6bf794870bcb38166c9099e21e 100644 --- a/docs/Application_guide/zh/system/memory-device.md +++ b/docs/Application_guide/zh/system/memory-device.md @@ -342,7 +342,7 @@ d）烧录完成，重启设备运行已烧录的固件。 ##### 软件接口 -其中文件系统分区使用的场景，文件系统需要执行挂载操作后才能使用，外置flash文件系统初始化接口用法参考[注册littleFS存储设备 - SPI NOR FLASH](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8ClittleFS%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI-NOR-FLASH)。 +其中文件系统分区使用的场景，文件系统需要执行挂载操作后才能使用，外置4线spi nor flash文件系统初始化接口用法参考[注册littleFS存储设备 - SPI NOR FLASH](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8ClittleFS%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI-NOR-FLASH)。外置6线spi nor flash仅特定型号特定固件支持，且不支持用户进行挂载操作，仅作内部使用。 ##### 读写速率