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 cdc962fd555fc7998043b6a9fb2e10f7a3d34bf1..3b6a9a8cc430678e31baa1c7565203ea7c1c2d89 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,10 +1,10 @@ -# `ujson` - JSON编码和解码 +# ujson - JSON编码和解码 `ujson`模块实现在Python数据对象和JSON数据格式之间进行转换的功能。该模块实现相应CPython模块的子集。更多信息请参阅阅CPython文档：[json](https://docs.python.org/3.5/library/json.html#module-json) ## 编码json数据 -主要将`Python`对象编码成json字符串 +将`Python`对象编码成json字符串 ### `ujson.dump` @@ -24,7 +24,7 @@ ujson.dumps(obj) ## 解码json数据 -主要将JSON数据解码成`Python`对象。 +将JSON数据解码成`Python`对象。 ### `ujson.load` 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 3acb48d53cce79401379f689d5ef31d593c05c0d..58e33f6a00221539557d3f4cb692d0631611a88f 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" @@ -1,37 +1,29 @@ -# `class CH395` - CH395以太网卡控制 +# class CH395 - CH395以太网卡控制 该类用于控制`CH395`型号以太网网卡设备。 -
- -当前仅支持EC600U系列 - -
+> 当前仅支持EC600U系列 ## 构造函数 ### `ethernet.CH395` ```python -class ethernet.CH395(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1, spi_cs_pin=-1, exint_pin=-1, reset_pin=-1, work_mode=0) +class ethernet.CH395(mac, ip='', subnet='', gateway='', spi_port=-1, spi_cs_pin=-1, extint_pin=-1, reset_pin=-1, work_mode=0) ``` 加载CH395驱动，初始化CH395以太网卡，并返回CH395网卡对象。 **参数描述：** -- `mac` - 字节流，6字节长度的 `mac` 地址. -- `ip_addr` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中 -的默认值，`192.168.1.100`。 -- `mask_addr` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用 -`255.255.255.0`作为子网掩码。 -- `gw_addr` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址 -的最后一位替换成`1`作为子网掩码。 +- `mac` - 字节流，6字节长度的 `mac` 地址。 +- `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`。 -- `eint_pin` - 连接`CH395`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO24`。 -- `reset_pin` - 连接`CH395`的重置[GPIO管脚](./machine.Pin.md), 表示上次配置的值， -程序中默认配置为 `Pin.GPIO30`。 +- `extint_pin` - 连接`CH395`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO24`。 +- `reset_pin` - 连接`CH395`的重置[GPIO管脚](./machine.Pin.md), 表示上次配置的值，程序中默认配置为 `Pin.GPIO30`。 - `work_mode` - 以太网工作模式配置，默认为终端模式，`0`/`1` 分别表示终端模式/网关模式。终端模式表示该模块作为终端设备连接供网设备上网。网关模式表示该模块作为网关，为外部设备提供网络访问，通过`4G`上网。 ## 方法 @@ -41,13 +33,13 @@ class ethernet.CH395(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1, spi nic.set_addr(ip, subnet, gateway) ``` -网卡静态ip地址配置 +网卡静态ip地址配置。 **参数描述：** -- `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`作为网关。 **返回值描述：** @@ -56,7 +48,7 @@ nic.set_addr(ip, subnet, gateway) * 示例 ```python -nic.set_addr('192.168.31.203', '', '') +nic.set_addr('192.168.1.100', '', '') ``` ### `CH395.set_dns` @@ -65,12 +57,12 @@ nic.set_addr('192.168.31.203', '', '') nic.set_dns(primary_dns, secondary_dns) ``` -网卡dns服务器配置 +网卡dns服务器配置。 **参数描述：** -- `primary_dns` - `DNS`服务器主地址 -- `secondary_dns` - `DNS`服务器辅地址 +- `primary_dns` - `DNS`服务器主地址。 +- `secondary_dns` - `DNS`服务器辅地址。 **返回值描述：** @@ -88,7 +80,7 @@ nic.set_dns('8.8.8.8', '114.114.114.114') nic.set_up() ``` -网卡启动,启动后网卡正常处理网口网络报文 +网卡启动，启动后网卡正常处理网口网络报文。 ### `CH395.set_down` @@ -96,7 +88,7 @@ nic.set_up() nic.set_down() ``` -网卡禁用，禁用后网卡不再处理网口网络报文 +网卡禁用，禁用后网卡不再处理网口网络报文。 ### `CH395.dhcp` @@ -104,7 +96,7 @@ nic.set_down() nic.dhcp() ``` -动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息 +动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息。 **返回值描述：** @@ -116,16 +108,17 @@ nic.dhcp() nic.ipconfig() ``` -获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址 +获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址。 **返回值描述：** -返回list类型 +返回list类型。 格式如下: [(mac, hostname), (iptype, ip, subnet, gateway, primary_dns，secondary_dns)] + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `mac` | `str` | `mac`地址,格式为`'XX-XX-XX-XX-XX-XX'` | | `hostname`| `str` | 网卡名称 | | `iptype` | `str` | `ip`类型，`4`表示`ipv4`，`6`表示`ipv6`，目前仅支持`ip4` | @@ -135,18 +128,17 @@ nic.ipconfig() | `primary_dns`| `str` | DNS服务器主地址 | | `secondary_dns`| `str` | DNS服务器辅地址 | - ### `CH395.set_default_NIC` ```python nic.set_default_NIC(ip) ``` -默认网卡配置 +默认网卡配置。 **参数描述：** -- `ip` - 默认网卡ip地址 +- `ip` - 默认网卡ip地址。 **返回值描述：** @@ -164,16 +156,17 @@ nic.set_default_NIC('192.168.1.100') nic.status() ``` -获取网卡当前状态 +获取网卡当前状态。 **返回值描述：** -返回tuble类型 +返回tuble类型。 格式内容如下: (dev, active, link) + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `dev` | `bool` | 表示网卡设备是否连接正常，`True`/`False`表示有连接/未连接 | | `active`| `bool` | 表示网卡是否激活使用，`True`/`False`表示启用/禁用，与`set_up`/`set_down`对应 | | `link` | `bool` | 表示网卡网线是否连接，`True`/`False`表示已连接/未连接 | \ No newline at end of file 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 eca377b8d430be245c82e345d8d39431ac07370b..5756c149bdc2a7a1dff373da7b976a0c9df553d3 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" @@ -1,32 +1,25 @@ -# `class DM9051` - DM9051以太网卡控制 +# class DM9051 - DM9051以太网卡控制 该类用于控制`DM9051`型号以太网网卡设备。 -
- -当前仅支持EC600N系列 - -
+> 当前仅支持EC600N系列 ## 构造函数 ### `ethernet.DM9051` ```python -class ethernet.DM9051(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1,spi_cs_pin=-1) +class ethernet.DM9051(mac, ip='', subnet='', gateway='', spi_port=-1,spi_cs_pin=-1) ``` 加载DM9051驱动，初始化DM9051以太网卡，并返回DM9051网卡对象。 **参数描述：** -- `mac` - 字节流，6字节长度的 `mac` 地址. -- `ip_addr` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中 -的默认值，`192.168.1.100`。 -- `mask_addr` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用 -`255.255.255.0`作为子网掩码。 -- `gw_addr` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址 -的最后一位替换成`1`作为子网掩码。 +- `mac` - 字节流，6字节长度的 `mac` 地址。 +- `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`。 @@ -37,13 +30,13 @@ class ethernet.DM9051(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1,spi nic.set_addr(ip, subnet, gateway) ``` -网卡静态ip地址配置 +网卡静态ip地址配置。 **参数描述：** -- `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`作为网关。 **返回值描述：** @@ -52,7 +45,7 @@ nic.set_addr(ip, subnet, gateway) * 示例 ```python -nic.set_addr('192.168.31.203', '', '') +nic.set_addr('192.168.1.100', '', '') ``` ### `DM9051.set_dns` @@ -61,12 +54,12 @@ nic.set_addr('192.168.31.203', '', '') nic.set_dns(primary_dns, secondary_dns) ``` -网卡dns服务器配置 +网卡dns服务器配置。 **参数描述：** -- `primary_dns` - `DNS`服务器主地址 -- `secondary_dns` - `DNS`服务器辅地址 +- `primary_dns` - `DNS`服务器主地址。 +- `secondary_dns` - `DNS`服务器辅地址。 **返回值描述：** @@ -84,7 +77,7 @@ nic.set_dns('8.8.8.8', '114.114.114.114') nic.set_up() ``` -网卡启动,启动后网卡正常处理网口网络报文 +网卡启动，启动后网卡正常处理网口网络报文。 ### `DM9051.set_down` @@ -92,7 +85,7 @@ nic.set_up() nic.set_down() ``` -网卡禁用，禁用后网卡不再处理网口网络报文 +网卡禁用，禁用后网卡不再处理网口网络报文。 ### `DM9051.dhcp` @@ -100,7 +93,7 @@ nic.set_down() nic.dhcp() ``` -动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息 +动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息。 **返回值描述：** @@ -112,16 +105,17 @@ nic.dhcp() nic.ipconfig() ``` -获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址 +获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址。 **返回值描述：** -返回list类型 +返回list类型。 格式如下: [(mac, hostname), (iptype, ip, subnet, gateway, primary_dns，secondary_dns)] + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `mac` | `str` | `mac`地址,格式为`'XX-XX-XX-XX-XX-XX'` | | `hostname`| `str` | 网卡名称 | | `iptype` | `str` | `ip`类型，`4`表示`ipv4`，`6`表示`ipv6`，目前仅支持`ip4` | 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 8078d2f9616499a7692f06fee9ba94c12c3a8cfc..c70a030460f8f19d87e1ffd35cbe3b2ee3f90ae1 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" @@ -1,36 +1,29 @@ - - -# `class W5500` - W5500以太网卡控制 +# class W5500 - W5500以太网卡控制 该类用于控制`W5500`型号以太网网卡设备。 -
- -当前仅支持EC600N/EC600U系列 - -
+ +> 当前仅支持EC600N/EC600U系列 + ## 构造函数 ### `ethernet.W5500` ```python -class ethernet.W5500(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1, spi_cs_pin=-1, exint_pin=-1, reset_pin=-1, work_mode=0) +class ethernet.W5500(mac, ip='', subnet='', gateway='', spi_port=-1, spi_cs_pin=-1, extint_pin=-1, reset_pin=-1, work_mode=0) ``` 加载W5500驱动，初始化W5500以太网卡，并返回W5500网卡对象。 **参数描述：** -- `mac` - 字节流，6字节长度的 `mac` 地址. -- `ip_addr` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中 -的默认值，`192.168.1.100`。 -- `mask_addr` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用 -`255.255.255.0`作为子网掩码。 -- `gw_addr` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址 -的最后一位替换成`1`作为子网掩码。 +- `mac` - 字节流，6字节长度的 `mac` 地址。 +- `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`。 -- `eint_pin` - 连接`W5500`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO19`。 +- `extint_pin` - 连接`W5500`的外部中断[GPIO管脚](./machine.Pin.md)，默认值为`-1`，表示上次配置的值，程序中默认配置为 `Pin.GPIO19`。 - `reset_pin` - 连接`W5500`的重置[GPIO管脚](./machine.Pin.md)，默认值为`-1`, 表示上次配置的值，程序中默认配置为 `Pin.GPIO17`。 - `work_mode` - 以太网工作模式配置，默认为终端模式，`0`/`1` 分别表示终端模式/网关模式。终端模式表示该模块作为终端设备连接供网设备上网。网关模式表示该模块作为网关，为外部设备提供网络访问，通过`4G`上网。 @@ -41,13 +34,13 @@ class ethernet.W5500(mac, ip_addr='', mask_addr='', gw_addr='', spi_port=-1, spi nic.set_addr(ip, subnet, gateway) ``` -网卡静态ip地址配置 +网卡静态ip地址配置。 **参数描述：** -- `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`作为网关。 **返回值描述：** @@ -56,7 +49,7 @@ nic.set_addr(ip, subnet, gateway) * 示例 ```python -nic.set_addr('192.168.31.203', '', '') +nic.set_addr('192.168.1.100', '', '') ``` ### `W5500.set_dns` @@ -65,12 +58,12 @@ nic.set_addr('192.168.31.203', '', '') nic.set_dns(primary_dns, secondary_dns) ``` -网卡dns服务器配置 +网卡dns服务器配置。 **参数描述：** -- `primary_dns` - `DNS`服务器主地址 -- `secondary_dns` - `DNS`服务器辅地址 +- `primary_dns` - `DNS`服务器主地址。 +- `secondary_dns` - `DNS`服务器辅地址。 **返回值描述：** @@ -88,7 +81,7 @@ nic.set_dns('8.8.8.8', '114.114.114.114') nic.set_up() ``` -网卡启动,启动后网卡正常处理网口网络报文 +网卡启动，启动后网卡正常处理网口网络报文。 ### `W5500.set_down` @@ -96,7 +89,7 @@ nic.set_up() nic.set_down() ``` -网卡禁用，禁用后网卡不再处理网口网络报文 +网卡禁用，禁用后网卡不再处理网口网络报文。 ### `W5500.dhcp` @@ -104,7 +97,7 @@ nic.set_down() nic.dhcp() ``` -动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息 +动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息。 **返回值描述：** @@ -116,16 +109,17 @@ nic.dhcp() nic.ipconfig() ``` -获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址 +获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址。 **返回值描述：** -返回list类型 +返回list类型。 格式如下: [(mac, hostname), (iptype, ip, subnet, gateway, primary_dns，secondary_dns)] + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `mac` | `str` | `mac`地址,格式为`'XX-XX-XX-XX-XX-XX'` | | `hostname`| `str` | 网卡名称 | | `iptype` | `str` | `ip`类型，`4`表示`ipv4`，`6`表示`ipv6`，目前仅支持`ip4` | @@ -135,18 +129,17 @@ nic.ipconfig() | `primary_dns`| `str` | DNS服务器主地址 | | `secondary_dns`| `str` | DNS服务器辅地址 | - ### `W5500.set_default_NIC` ```python nic.set_default_NIC(ip) ``` -默认网卡配置 +默认网卡配置。 **参数描述：** -- `ip` - 默认网卡ip地址 +- `ip` - 默认网卡ip地址。 **返回值描述：** 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 b12af59e4580c442e7780b1bcc593372045a95a4..23dd1e57d378f7aab3d8f5032301d687cb7dd64c 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" @@ -1,32 +1,25 @@ -# `class YT8512H` - YT8512H PHY控制 +# class YT8512H - YT8512H PHY控制 -该类用于控制`YT8512H`型号以太网网卡设备。 +该类用于控制`YT8512H/SZ18201`型号以太网网卡设备。 -
- -当前仅支持EC200A系列 - -
+> 当前仅支持EC200A系列 ## 构造函数 ### `ethernet.YT8512H` ```python -class ethernet.YT8512H(mac, ip_addr='', mask_addr='', gw_addr='') +class ethernet.YT8512H(mac, ip='', subnet='', gateway='') ``` -加载YT8512H驱动，初始化YT8512H PHY，并返回YT8512H网卡对象。 +加载YT8512H驱动，初始化YT8512H phy设备，并返回YT8512H网卡对象。 **参数描述：** -- `mac` - 字节流，6字节长度的 `mac` 地址. -- `ip_addr` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中 -的默认值，`192.168.1.100`。 -- `mask_addr` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用 -`255.255.255.0`作为子网掩码。 -- `gw_addr` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址 -的最后一位替换成`1`作为子网掩码。 +- `mac` - 字节流，6字节长度的 `mac` 地址。 +- `ip` - 以太网卡的 `ip` 地址，默认值为空字符串''，表示使用程序中的默认值，`192.168.1.100`。 +- `subnet` - 以太网卡的子网掩码地址，默认值为空字符串'',表示使用`255.255.255.0`作为子网掩码。 +- `gateway` - 以太网卡的网关地址，默认值为空字符串''，表示将 ip 地址的最后一位替换成`1`作为网关。 ## 方法 @@ -35,13 +28,13 @@ class ethernet.YT8512H(mac, ip_addr='', mask_addr='', gw_addr='') nic.set_addr(ip, subnet, gateway) ``` -网卡静态ip地址配置 +网卡静态ip地址配置。 **参数描述：** -- `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`作为网关。 **返回值描述：** @@ -50,7 +43,7 @@ nic.set_addr(ip, subnet, gateway) * 示例 ```python -nic.set_addr('192.168.31.203', '', '') +nic.set_addr('192.168.1.100', '', '') ``` ### `YT8512H.set_dns` @@ -59,12 +52,12 @@ nic.set_addr('192.168.31.203', '', '') nic.set_dns(primary_dns, secondary_dns) ``` -网卡dns服务器配置 +网卡dns服务器配置。 **参数描述：** -- `primary_dns` - `DNS`服务器主地址 -- `secondary_dns` - `DNS`服务器辅地址 +- `primary_dns` - `DNS`服务器主地址。 +- `secondary_dns` - `DNS`服务器辅地址。 **返回值描述：** @@ -82,7 +75,7 @@ nic.set_dns('8.8.8.8', '114.114.114.114') nic.set_up() ``` -网卡启动,启动后网卡正常处理网口网络报文 +网卡启动，启动后网卡正常处理网口网络报文。 ### `YT8512H.set_down` @@ -90,7 +83,7 @@ nic.set_up() nic.set_down() ``` -网卡禁用，禁用后网卡不再处理网口网络报文 +网卡禁用，禁用后网卡不再处理网口网络报文。 ### `YT8512H.dhcp` @@ -98,7 +91,7 @@ nic.set_down() nic.dhcp() ``` -动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息 +动态ip获取，此方法是作为终端模式下使用，从而自动获取ip信息。 **返回值描述：** @@ -110,16 +103,17 @@ nic.dhcp() nic.ipconfig() ``` -获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址 +获取网卡网络信息，通过该方法获取到mac地址、主机名、IP地址类型、IP地址、子网掩码、网关地址和DNS服务器地址。 **返回值描述：** -返回list类型 +返回list类型。 格式如下: [(mac, hostname), (iptype, ip, subnet, gateway, primary_dns，secondary_dns)] + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `mac` | `str` | `mac`地址,格式为`'XX-XX-XX-XX-XX-XX'` | | `hostname`| `str` | 网卡名称 | | `iptype` | `str` | `ip`类型，`4`表示`ipv4`，`6`表示`ipv6`，目前仅支持`ip4` | @@ -129,18 +123,17 @@ nic.ipconfig() | `primary_dns`| `str` | DNS服务器主地址 | | `secondary_dns`| `str` | DNS服务器辅地址 | - ### `YT8512H.set_default_NIC` ```python nic.set_default_NIC(ip) ``` -默认网卡配置 +默认网卡配置。 **参数描述：** -- `ip` - 默认网卡ip地址 +- `ip` - 默认网卡ip地址。 **返回值描述：** @@ -158,16 +151,17 @@ nic.set_default_NIC('192.168.1.100') nic.status() ``` -获取网卡当前状态 +获取网卡当前状态。 **返回值描述：** -返回tuble类型 +返回tuble类型。 格式内容如下: (dev, active, link) + | 参数 | 类型 | 说明 | -|-|-|-| +| ---- | ---- |---------- | | `dev` | `bool` | 表示网卡设备是否连接正常，`True`/`False`表示有连接/未连接 | | `active`| `bool` | 表示网卡是否激活使用，`True`/`False`表示启用/禁用，与`set_up`/`set_down`对应 | | `link` | `bool` | 表示网卡网线是否连接，`True`/`False`表示已连接/未连接 | 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 6f6e744de80dcb896b18daab9654301913683ce4..283c566ed4e3903755b6dbbb650a481f551a1e1c 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" @@ -1,16 +1,14 @@ -# `ethernet` - 以太网相关功能 -`ethernet`模块包含以太网控制及网络配置功能。主要是针对不同类型以太网卡提供统一的管理方式。 +# ethernet - 以太网相关功能 +`ethernet`模块包含以太网控制及网络配置功能，主要是针对不同类型以太网卡提供统一的管理方式。 -**示例：** +**示例：** -根据不同应用场景，分别以终端模式、网关模式、静态ip配置举例网卡初始化使用过程。 +根据不同应用场景，分别以终端模式、网关模式、静态ip配置介绍网卡初始化过程。 + + +> 1. 以下示例只是针对模组侧的网卡应用配置，也需要对端进行对应操作方可正常使用。 +> 2. 以下示例部分网卡未完全实现，请根据不同网卡驱动对应说明进行使用。 -
- -1. 以下示例只是针对模组侧的网卡应用配置，也需要对端进行对应操作方可正常使用。
-2. 以下示例部分网卡未完全实现，请根据不同网卡驱动对应说明进行使用。 - -
终端模式： @@ -19,15 +17,15 @@ import ethernet -# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动 +# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动。 nic = ethernet.diver(...) print(nic.ipconfig()) -# 获取动态IP地址 +# 获取动态IP地址。 nic.dhcp() print(nic.ipconfig()) -# 此时可以启动其他网络服务，并通过以太网进行网络访问 +# 此时可以启动其他网络服务，并通过以太网进行网络访问。 ... ``` @@ -39,21 +37,21 @@ print(nic.ipconfig()) import ethernet import dataCall -# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动 +# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动。 nic = ethernet.diver(...) print(nic.ipconfig()) -# 获取当前4G拨号ip信息 +# 获取当前4G拨号ip信息。 lte=dataCall.getInfo(1, 0) print(lte) if lte[2][0] == 1: - # 设置默认网卡，将4G作为默认网卡 + # 设置默认网卡，将4G作为默认网卡。 nic.set_default_NIC(lte[2][2]) -#启动网卡 +#启动网卡。 nic.set_up() -# 此时其他设备可以通过网线连接模组，实现4G上网 +# 此时其他设备可以通过网线连接模组，实现4G上网。 ... ``` @@ -64,18 +62,19 @@ nic.set_up() # 静态ip配置，根据当前已有环境，自定义网络信息。 import ethernet -# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动 +# 加载对应的网卡驱动，并初始化网卡相关配置，driver替换成实际对应的网卡驱动。 nic = ethernet.diver(...) print(nic.ipconfig()) -# 配置静态ip地址192.168.0.2，子网掩码255.255.255.0，网关地址192.168.0.1 -nic.set_addr('192.168.0.2','255.255.255.0','') +# 配置静态ip地址192.168.0.2，子网掩码255.255.255.0，网关地址192.168.0.1。 +nic.set_addr('192.168.1.100','255.255.255.0','192.168.1.1') print(nic.ipconfig()) -# 启动网卡 +# 启动网卡。 nic.set_up() -# 终端模式下，此时可以启动其他网络服务，并通过以太网进行网络访问 +# 1. 终端模式下，此时可以启动其他网络服务，并通过以太网进行网络访问。 +# 2. 网关模式下，此时按照上例网关使用说明，配置默认网卡及对端静态ip，即可使用该模块提供网络服务。 ... ``` @@ -84,4 +83,4 @@ nic.set_up() - [class W5500 – W5500驱动](./ethernet.W5500.md) - [class DM9051 – DM9051驱动](./ethernet.DM9051.md) - [class CH395 – CH395驱动](./ethernet.CH395.md) -- [class YT8512H/SZ18201 – YT8512H/SZ18201驱动](./ethernet.YT8512H.md) +- [class YT8512H – YT8512H驱动](./ethernet.YT8512H.md)