From 86dec8e0005afd3de1450e27995ad9c429e901ee Mon Sep 17 00:00:00 2001 From: "kunming.wang" Date: Tue, 11 Apr 2023 13:42:22 +0800 Subject: [PATCH] =?UTF-8?q?docs=20(ujson,=20ethernet):=20=E6=A0=B9?= =?UTF-8?q?=E6=8D=AEwiki=E6=A3=80=E6=9F=A5=E7=BB=93=E6=9E=9C,=E4=BF=AE?= =?UTF-8?q?=E6=94=B9=E9=97=AE=E9=A2=98=E7=82=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 固件版本: N/A 是否需要文案翻译: 是 --- .../ujson.md" | 2 +- .../ethernet.CH395.md" | 28 ++++++++++++------- .../ethernet.DM9051.md" | 26 +++++++++++------ .../ethernet.W5500.md" | 28 ++++++++++++------- .../ethernet.YT8512H.md" | 28 ++++++++++++------- .../ethernet.md" | 2 +- docs/API_reference/zh/sidebar.yaml | 9 ++++++ 7 files changed, 82 insertions(+), 41 deletions(-) diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ujson.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ujson.md" index 3b6a9a8c..48605377 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ujson.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ujson.md" @@ -1,5 +1,5 @@ # ujson - JSON编码和解码 -`ujson`模块实现在Python数据对象和JSON数据格式之间进行转换的功能。该模块实现相应CPython模块的子集。更多信息请参阅阅CPython文档：[json](https://docs.python.org/3.5/library/json.html#module-json) +`ujson`模块实现在Python数据对象和JSON数据格式之间进行转换的功能。该模块实现相应CPython模块的子集。更多信息请参阅CPython文档：[json](https://docs.python.org/3.5/library/json.html#module-json) ## 编码json数据 diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.CH395.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.CH395.md" index 58e33f6a..a6b23548 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.CH395.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.CH395.md" @@ -17,9 +17,9 @@ class ethernet.CH395(mac, ip='', subnet='', gateway='', spi_port=-1, spi_cs_pin= **参数描述：** - `mac` - 字节流，6字节长度的 `mac` 地址。 -- `ip` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中的默认值，`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址的最后一位替换成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 - `spi_port` - 连接`CH395`的[SPI端口](./machine.SPI.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为了 `SPI1` 端口。 - `spi_cs_pin` - 连接`CH395`的 `SPI` 片选[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为了 `Pin.GPIO4`。 - `extint_pin` - 连接`CH395`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO24`。 @@ -37,13 +37,13 @@ nic.set_addr(ip, subnet, gateway) **参数描述：** -- `ip` - 以太网卡的`ip`地址，值为空字符串''，表示使用程序中的默认值，即`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，值为空字符串''，表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，值为空字符串''，表示将 ip 地址的最后一位替换 成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 * 示例 @@ -66,7 +66,7 @@ nic.set_dns(primary_dns, secondary_dns) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** @@ -82,6 +82,10 @@ nic.set_up() 网卡启动，启动后网卡正常处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `CH395.set_down` ```python @@ -90,6 +94,10 @@ nic.set_down() 网卡禁用，禁用后网卡不再处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `CH395.dhcp` ```python @@ -100,7 +108,7 @@ nic.dhcp() **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 ### `CH395.ipconfig` @@ -142,7 +150,7 @@ nic.set_default_NIC(ip) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.DM9051.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.DM9051.md" index 5756c149..441708be 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.DM9051.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.DM9051.md" @@ -17,9 +17,9 @@ class ethernet.DM9051(mac, ip='', subnet='', gateway='', spi_port=-1,spi_cs_pin= **参数描述：** - `mac` - 字节流，6字节长度的 `mac` 地址。 -- `ip` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中的默认值，`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址的最后一位替换成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 - `spi_port` - 连接`DM9051`的[SPI端口](./machine.SPI.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为了 `SPI1` 端口。 - `spi_cs_pin` - 连接`DM9051`的 `SPI` 片选[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为了 `Pin.GPIO13`。 @@ -34,13 +34,13 @@ nic.set_addr(ip, subnet, gateway) **参数描述：** -- `ip` - 以太网卡的`ip`地址，值为空字符串''，表示使用程序中的默认值，即`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，值为空字符串''，表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，值为空字符串''，表示将 ip 地址的最后一位替换 成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 * 示例 @@ -63,7 +63,7 @@ nic.set_dns(primary_dns, secondary_dns) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** @@ -79,6 +79,10 @@ nic.set_up() 网卡启动，启动后网卡正常处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `DM9051.set_down` ```python @@ -87,6 +91,10 @@ nic.set_down() 网卡禁用，禁用后网卡不再处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `DM9051.dhcp` ```python @@ -97,7 +105,7 @@ nic.dhcp() **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 ### `DM9051.ipconfig` diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.W5500.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.W5500.md" index c70a0304..6ccdc9ff 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.W5500.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.W5500.md" @@ -18,9 +18,9 @@ class ethernet.W5500(mac, ip='', subnet='', gateway='', spi_port=-1, spi_cs_pin= **参数描述：** - `mac` - 字节流，6字节长度的 `mac` 地址。 -- `ip` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中的默认值，`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址的最后一位替换成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 - `spi_port` - 连接`W5500`的[SPI端口](./machine.SPI.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为 `SPI1` 端口。 - `spi_cs_pin` - 连接`W5500`的 `SPI` 片选[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为 `Pin.GPIO34`。 - `extint_pin` - 连接`W5500`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO19`。 @@ -38,13 +38,13 @@ nic.set_addr(ip, subnet, gateway) **参数描述：** -- `ip` - 以太网卡的`ip`地址，值为空字符串''，表示使用程序中的默认值，即`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，值为空字符串''，表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，值为空字符串''，表示将 ip 地址的最后一位替换 成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 * 示例 @@ -67,7 +67,7 @@ nic.set_dns(primary_dns, secondary_dns) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** @@ -83,6 +83,10 @@ nic.set_up() 网卡启动，启动后网卡正常处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `W5500.set_down` ```python @@ -91,6 +95,10 @@ nic.set_down() 网卡禁用，禁用后网卡不再处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `W5500.dhcp` ```python @@ -101,7 +109,7 @@ nic.dhcp() **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 ### `W5500.ipconfig` @@ -143,7 +151,7 @@ nic.set_default_NIC(ip) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.YT8512H.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.YT8512H.md" index 23dd1e57..dcb4a53a 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.YT8512H.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.YT8512H.md" @@ -17,9 +17,9 @@ class ethernet.YT8512H(mac, ip='', subnet='', gateway='') **参数描述：** - `mac` - 字节流，6字节长度的 `mac` 地址。 -- `ip` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中的默认值，`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址的最后一位替换成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 ## 方法 @@ -32,13 +32,13 @@ nic.set_addr(ip, subnet, gateway) **参数描述：** -- `ip` - 以太网卡的`ip`地址，值为空字符串''，表示使用程序中的默认值，即`192.168.1.100`。 -- `subnet` - 以太网卡的子网掩码地址，值为空字符串''，表示使用`255.255.255.0`作为子网掩码。 -- `gateway` - 以太网卡的网关地址，值为空字符串''，表示将 ip 地址的最后一位替换 成`1`作为网关。 +- `ip` - 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，若值为空字符串'',表示使用默认值`255.255.255.0`。 +- `gateway` - 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 * 示例 @@ -61,7 +61,7 @@ nic.set_dns(primary_dns, secondary_dns) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** @@ -77,6 +77,10 @@ nic.set_up() 网卡启动，启动后网卡正常处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `YT8512H.set_down` ```python @@ -85,6 +89,10 @@ nic.set_down() 网卡禁用，禁用后网卡不再处理网口网络报文。 +**返回值描述：** + +成功返回整型值0，失败返回整型值-1。 + ### `YT8512H.dhcp` ```python @@ -95,7 +103,7 @@ nic.dhcp() **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 ### `YT8512H.ipconfig` @@ -137,7 +145,7 @@ nic.set_default_NIC(ip) **返回值描述：** -成功返回整型值0，其他值表示失败。 +成功返回整型值0，失败返回整型值-1。 **示例：** diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.md" index 283c566e..5066a89b 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/ethernet.md" @@ -66,7 +66,7 @@ import ethernet nic = ethernet.diver(...) print(nic.ipconfig()) -# 配置静态ip地址192.168.0.2，子网掩码255.255.255.0，网关地址192.168.0.1。 +# 配置静态ip地址192.168.1.100，子网掩码255.255.255.0，网关地址192.168.1.1。 nic.set_addr('192.168.1.100','255.255.255.0','192.168.1.1') print(nic.ipconfig()) diff --git a/docs/API_reference/zh/sidebar.yaml b/docs/API_reference/zh/sidebar.yaml index 4733ff23..62d8bf69 100644 --- a/docs/API_reference/zh/sidebar.yaml +++ b/docs/API_reference/zh/sidebar.yaml @@ -63,6 +63,15 @@ items: file: QuecPython类库/wifiScan.md - label: ethernet - 以太网相关功能 file: QuecPython类库/ethernet.md + items: + - label: W5500 - W5500驱动 + file: QuecPython类库/ethernet.W5500.md + - label: DM9051 - DM9051驱动 + file: QuecPython类库/ethernet.DM9051.md + - label: CH395 - CH395驱动 + file: QuecPython类库/ethernet.CH395.md + - label: YT8512H - YT8512H驱动 + file: QuecPython类库/ethernet.YT8512H.md - label: camera - 摄像扫码 file: QuecPython类库/camera.md items: -- Gitee