diff --git a/docs/API_reference/en/btlib/ble.md b/docs/API_reference/en/btlib/ble.md index 7187345e6673ec01abc0b1c286ff6280e75ed432..292729b2a4e20fae722d626ee3e701a94a12348a 100644 --- a/docs/API_reference/en/btlib/ble.md +++ b/docs/API_reference/en/btlib/ble.md @@ -1289,7 +1289,7 @@ if __name__ == '__main__': **Note**： -Currently, only EC200U/EC600U/EG915U/EG912U series module supports `ble` feature. +Currently, only EC200U/EC600U/EG915U/EG912U/FCM360W series module supports `ble` feature. ## Initialization Related Features diff --git a/docs/API_reference/zh/btlib/ble.md b/docs/API_reference/zh/btlib/ble.md index 3ce55911f2ac165eab4dd640ab7a90024df85f77..656a9f261c535d872dd8c96fdce1c845e9a8446d 100644 --- a/docs/API_reference/zh/btlib/ble.md +++ b/docs/API_reference/zh/btlib/ble.md @@ -6,7 +6,7 @@ 见github：https://github.com/QuecPython/example_BLE -> 当前仅EC200U/EC600U/EG915U/EG912U型号支持`ble`功能。 +> 当前仅EC200U/EC600U/EG915U/EG912U/FCM360W型号支持`ble`功能。 diff --git a/docs/Application_guide/en/hardware/USB-interfaces.md b/docs/Application_guide/en/hardware/USB-interfaces.md index f06953d730c6cc7b1491f044d0e169706670e17d..b05ce856a9c47874d7f1e506652e305234102287 100644 --- a/docs/Application_guide/en/hardware/USB-interfaces.md +++ b/docs/Application_guide/en/hardware/USB-interfaces.md @@ -202,7 +202,7 @@ Please refer to **[Network Application Guide - USB NIC](TODO 链接)** for speci ## Firmware Download -For firmware download examples, please refer to [QPYcom Instructions]([QuecPython (quectel.com)](https://python.quectel.com/doc/Advanced_development/en/QuecPythonTools/QPYcom.html)) or [Quick Start Guide](https://python.quectel.com/doc/Getting_started/en/index.html). +For firmware download examples, please refer to [QPYcom Instructions]([QuecPython (quectel.com)](https://python.quectel.com/en/)) or [Quick Start Guide](https://python.quectel.com/doc/Getting_started/en/index.html). The USB firmware download for modules includes the following steps: diff --git a/docs/Application_guide/en/hardware/display/display.md b/docs/Application_guide/en/hardware/display/display.md index bea5544a5e086d1ac78da187406f4b68b8984fde..2d05991ae58afd8080f80a4bc2408033e9d8338d 100644 --- a/docs/Application_guide/en/hardware/display/display.md +++ b/docs/Application_guide/en/hardware/display/display.md @@ -708,7 +708,7 @@ mipilcd.lcd_write(test_buf1,10,10,20,20) ###### Clear LCD Screen -[Prototype of *lcd.lcd_clear*](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[Prototype of *lcd.lcd_clear*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **Example (st7701s):** diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md index bb101764d0671f3a41e67583e587abcb1fc50c7c..cee7de964b6dcba32895e910aa9161382929df03 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md @@ -358,6 +358,7 @@ Disadvantage See specific supports of QuecPython Series +For details, please refer to the [GPIO Multiplexing table](https://python.quectel.com/en/download) of each module. For details, please refer to the [GPIO Multiplexing table](https://python.quectel.com/en/resource-download?cid=254) of each module. | Module | Floating input | Pull-up input | Pull-down input | Open-drain output | Pull-push output | Supported quantity | @@ -396,6 +397,7 @@ It is mainly divided into two types: GPIO and Extlnt. In this chapter, it will introduce how to use QuecPython GPIO and relevant notes. +For specific API on QuecPython GPIO, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) For specific API on QuecPython GPIO, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html) #### Create object @@ -406,7 +408,7 @@ Input/output, pull-up/down and default pin of GPIO can be implemented in this st class machine.Pin(GPIOn, [dir], [pull], [value] ``` -For parameter introduction and GPIO pin number & physical mapping, please see [machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). +For parameter introduction and GPIO pin number & physical mapping, please see [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). If the pin is to be available in relevant module, please import it first. Then, you can create one pin as following method. @@ -428,7 +430,7 @@ It is available to take it as input pull-up/down via `PULL_PU` `PULL_PD` or `PU Pin.read() ``` -For specific method, please refer to [Pin.read](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.read%3C/code%3E). +For specific method, please refer to [Pin.read](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3EPin.read%3C/code%3E). When the GPIO is configured as input, its inner structure allows itself to detect and reflect the voltage imposed. It is available for you to read this status via querying internal register in micro-controller or `Pin.read`. @@ -452,7 +454,7 @@ Note Pin.write(value) ``` -For specific method, please refer to [Pin.write](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.write%3C/code%3E). +For specific method, please refer to [Pin.write](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3EPin.write%3C/code%3E). When the GPIO is configured as output mode, it is capable to output high or low level. @@ -480,7 +482,7 @@ Note Pin.set_dir(value) ``` -For specific method, please refer to [Pin.set_dir](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.set_dir%3C/code%3E). +For specific method, please refer to [Pin.set_dir](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3EPin.set_dir%3C/code%3E). Direction selection @@ -509,7 +511,7 @@ This class is used to configure the I/O pin to trigger an interrupt when an exte class machine.ExtInt(GPIOn, mode, pull, callback) ``` -For specific method, please refer to [machine.ExtInt](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html). +For specific method, please refer to [machine.ExtInt](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html). Types to trigger interrupt @@ -544,7 +546,7 @@ extint.enable() extint.disable() ``` -For specific method, please refer to [Eextint.enable](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.enable%3C/code%3E) and [Extint.disable](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.disable%3C/code%3E) +For specific method, please refer to [Eextint.enable](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.enable%3C/code%3E) and [Extint.disable](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.disable%3C/code%3E) Enable @@ -564,6 +566,7 @@ Note 2. **Global and local**: In some systems, it is available to disable all interrupts (disable globally) or specialized interrupt (disable locally). 3. **Security**: After disabling interrupt, it is mandatory to enable it again in appropriate situation. Otherwise, it will cause a failure to respond some vital events in system. +For other method, please refer to wiki -[machine.ExtInt](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html) in detail. For other method, please refer to wiki -[machine.ExtInt](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html) in detail. ## Application examples @@ -607,7 +610,7 @@ It mainly introduces applications related to GPIO. - When reading mechanical switch or button via GPIO, it may occur bounce. In this situation, the HW or SW debounce can be applied to solve. -For specific, please refer to [Debounce](#Debounce). +For specific, please refer to [Debounce](#debounce). ### **Interrupt**: @@ -644,6 +647,9 @@ For specific, please refer to [Debounce](#Debounce). Displayed by table or document, the GPIO Multiplexing table is used to describe different functions and alternative options of GPIO pins in specialized chip, micro-controller or system. In most of chips and micro-controllers, the GPIO pin is endowed with multiple functions and alternative options. That means each GPIO pin can be configured as various input or output such as data input/output, analog input/output or special peripherals. (I.e. SPI, UART and I2C) +The [GPIO multiplexing table](https://python.quectel.com/en/download) of QuecPython illustrates the function and alternative option of each GPIO pin in detail as well as status change in stage of booting. It lists the number, default function and available alternative option of each pin to make it convenient for user to configure and use GPIO pin properly, which is vital in connecting peripherals, driving screen ad controlling communication interface. + +> The format and contents of specific GPIO multiplexing table will be varied according to different module. Therefore, for given module, please refer to relevant [Hardware Design](https://python.quectel.com/en/download) or [GPIO multiplexing table](https://python.quectel.com/en/download) for detailed GPIO configuration. The [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254) of QuecPython illustrates the function and alternative option of each GPIO pin in detail as well as status change in stage of booting. It lists the number, default function and available alternative option of each pin to make it convenient for user to configure and use GPIO pin properly, which is vital in connecting peripherals, driving screen ad controlling communication interface. > The format and contents of specific GPIO multiplexing table will be varied according to different module. Therefore, for given module, please refer to relevant [Hardware Design](https://python.quectel.com/en/resource-download?cid=250) or [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254) for detailed GPIO configuration. @@ -669,6 +675,9 @@ Explanation on each column The pin at Reset will be varied according to different HW platform and development environment. Normally, when powering up or rebooting system. the initial status of GPIO pin is undefined and is out of control by SW. Therefore, in terms of controlling LED or enabling peripheral switch, the pin with special reset status is needed. Before designing HW circuit, please query relevant documents or references to make acquaintance with pin at Reset in dedicated platform and environment. +The GPIO pin at Reset of individual platform can be acquired via querying [GPIO multiplexing table](https://python.quectel.com/en/download) . + +Most GPIO pins are stable when powered on, and a small number of GPIO pins are changed by software after powered on. See QuecPython [GPIO multiplexing table](https://python.quectel.com/en/download) in detail. The GPIO pin at Reset of individual platform can be acquired via querying [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254) . Most GPIO pins are stable when powered on, and a small number of GPIO pins are changed by software after powered on. See QuecPython [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254) in detail. @@ -681,10 +690,12 @@ Query whether there exists interrupt function in pin and corresponding method to Except for BG95 module, all GPIOs support interrupt function. +In terms of BG95 Series, it is also available to get the GPIOs that support interrupt function via querying [GPIO multiplexing table](https://python.quectel.com/en/download). In terms of BG95 Series, it is also available to get the GPIOs that support interrupt function via querying [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254). ### Wake up interrupt +The GPIOs in EC200U/EC600U/EG912U/EG915U modules support waking up module in sleep mode. While for others, most of which support waking up module. For specific, please query and confirm via [GPIO multiplexing table](https://python.quectel.com/en/download). The GPIOs in EC200U/EC600U/EG912U/EG915U modules support waking up module in sleep mode. While for others, most of which support waking up module. For specific, please query and confirm via [GPIO multiplexing table](https://python.quectel.com/en/resource-download?cid=254). ![1692429975477](../../media/hardware/peripheral-interfaces/GPIO/GPIO_wake-up_interrupt.png) diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_One_wire.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_One_wire.md index 8970fedc068e7049ab77897ca384133210233abf..942fa26e2b6a970aa6436c9a4703a410209d171f 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_One_wire.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_One_wire.md @@ -90,7 +90,7 @@ Among QuecPython modules, EC200U/EC600U/EG912U/EG915U support GPIO 1-Wire Protoc ```python class machine.OneWire(GPIOn) ``` -For relationship between pin number and physical pins, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). +For relationship between pin number and physical pins, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). It is available in the module, so please make sure to import it first. You can then create an one-wire like this: diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md b/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md index abbf32905eccbce5f5032e027ad55de60dd623d6..6dfd3d5d451b19e3f704fb4b50fe36b8d81a0dee 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md @@ -116,7 +116,7 @@ When receiving data over IIC, a couple of points should be noted: -For API and parameter introductions, please refer to [machine.UART.read](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) +For API and parameter introductions, please refer to [machine.UART.read](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) ## Application Examples diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md b/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md index e59523c1182859ffcb85487407b92dcacfbd684a..8d1ef74ec32a6eac4089c0bc24d959a23b6dafae 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md @@ -278,11 +278,11 @@ Rx communication: Receive data for 64 bytes or OT -> trigger interrupt-> trigger In this chapter, it will illustrate how to communicate between QuecPython Series and other UART devices based on function of UART driver program and data type. -1. [Create object](#create object) -2. [Transmit data](#Transmit data) -3. [Receive data](#receive data) +1. [Create object](#create-object) +2. [Transmit data](#transmit-data) +3. [Receive data](#receive-data) 4. [Interrupt](#interrupt) -5. [RS485 control](#RS485 control) +5. [RS485 control](#rs485-control) For specific API, see [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html). @@ -368,7 +368,7 @@ For API introduction, please refer to [machine.UART.control_485](https://python. | ------------------------------------- | ------------------------------------------------------------ | | [Basic Tx/Rx](#Basic Tx/Rx) | Configure UART setting and read and write via UART1. It will read data in a method of callback | | [External GNSS](#External GNSS) | By decrypting the GNGGA, GNRMC and GPGSV in raw GNSS data packet read from external GNSS by UART to get positioning info. | -| [RS485application](#RS485application) | Set UART driver programm in half duplex to communicate via RS485 interface | +| [RS485application](https://python.quectel.com/doc/Application_guide/en/hardware/peripheral-interfaces/UART.html#RS-485-application) | Set UART driver programm in half duplex to communicate via RS485 interface | | [Power meter chip](#Power meter chip) | Take power meter chip as an example: read and write corresponding parameter via UART to get power data or execute other controlling commands. | ### Basic Tx/Rx @@ -583,7 +583,7 @@ This GPIO will be targeted at the line for "direction control". When the line is Before sending data, the GPIO will be set as HIGH and transmits data afterwards. Once former step is accomplished, the GPIO will be set as LOW and switched to Rx mode. -QuecPython supports the transfer of GPIO control directions in the UART. The [uart.control_485](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E) can be applied to control 485 communication direction. The designated GPIO will be pulled up/down to indicate the communication direction of 485 before and after transmitting data via serial interface. +QuecPython supports the transfer of GPIO control directions in the UART. The [uart.control_485](#rs-485-application) can be applied to control 485 communication direction. The designated GPIO will be pulled up/down to indicate the communication direction of 485 before and after transmitting data via serial interface. Direction is set as 1: it will be pulled from low to high before transmitting data and pulled from high to low after transmitting data via serial interface. diff --git a/docs/Application_guide/en/system/exceptional-handling.md b/docs/Application_guide/en/system/exceptional-handling.md index 969ddd8385b667a0327f78d4d192c967edad2558..09037bc1e8cea0c70c95d8dc646408d068c34b0a 100644 --- a/docs/Application_guide/en/system/exceptional-handling.md +++ b/docs/Application_guide/en/system/exceptional-handling.md @@ -1,4 +1,4 @@ -# Exception Handling +# Handle Exception ## Kernel Exceptions