diff --git a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-repl.md b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-repl.md index 802669622f54a53eb1865ed4e8f434dc22bacbd1..32a2009773d9c60b3051ef9b39a8c7cf15d00f8e 100644 --- a/docs/Application_guide/en/dev-tools/QPYcom/qpycom-repl.md +++ b/docs/Application_guide/en/dev-tools/QPYcom/qpycom-repl.md @@ -42,7 +42,7 @@ Initialize the **USB CDC PORT** as a serial port through the `UART` interface. >>> uart1 = UART(UART.UART3, 115200, 8, 0, 1, 0) ``` -After initialization, any data input through the **USB CDC PORT** will no longer be interpreted by the REPL. This method can be used to disable the interactive port. The data input through the interactive port will be interpreted as serial port data. For more information, refer to [UART - Duplex Serial Communication Bus](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html). +After initialization, any data input through the **USB CDC PORT** will no longer be interpreted by the REPL. This method can be used to disable the interactive port. The data input through the interactive port will be interpreted as serial port data. For more information, refer to [UART - Duplex Serial Communication Bus](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html). If there is a need to disable and re-enable the REPL debugging, call *uart.close()* to disable the UART object created above to restore the REPL debugging through the serial port. This method is usually used in the production testing process, where specific data formats need to be parsed in the serial port data interpretation to meet the requirement of re-enabling REPL debugging through a specific method. @@ -56,4 +56,4 @@ system.replSetEnable(flag, **kw_args) Once enabled, you can use the password set during startup to disable interaction protection. -For more information, refer to [system - System Configuration](https://python.quectel.com/doc/API_reference/en/syslib/system.html). \ No newline at end of file +For more information, refer to [system - System Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/system.html). \ No newline at end of file diff --git a/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md b/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md index c82a3c66c4a529675909671483d9ffbb0e7c5ffe..eabe933aeac5c07a1295f173a870d1609b1ce1d7 100644 --- a/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md +++ b/docs/Application_guide/en/dev-tools/VSCode-Plugin-quecpython/README.md @@ -27,7 +27,7 @@ It currently all QuecPython series modules. > Before you start, make sure you have downloaded the appropriate QuecPython firmware package for your module. [Click here to view how to download firmware packages](../../media/dev-tools/VSCode-Plugin-quecpython/download-fw-pkg.png). -The following steps are demonstrated based on the [U-235 development board](https://python.quectel.com/doc/Getting_started/en/evb/ec600u-235.html). +The following steps are demonstrated based on the [U-235 development board](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/ec600u-235.html). ### Firmware Flashing diff --git a/docs/Application_guide/en/firmware-upgrade/firmware-burning.md b/docs/Application_guide/en/firmware-upgrade/firmware-burning.md index 8b7aea7e07f6ec391732b7688baf81797b99a42b..19be3cff6477ed63029030860d2a469aaacd0ef4 100644 --- a/docs/Application_guide/en/firmware-upgrade/firmware-burning.md +++ b/docs/Application_guide/en/firmware-upgrade/firmware-burning.md @@ -8,7 +8,7 @@ If you want to run Python scripts on Quectel modules, the module firmware must s Before downloading the firmware into the module, you need to set a trigger condition for the module to execute a special program. This program is used to receive firmware data sent by the host and write the firmware data into the module's flash. This process is called entering the downloading mode. -Different series of modules ( [click here to view The Correspondence Between Platforms and Modules](https://python.quectel.com/doc/Application_guide/en/background/hardware-platform.html#The-Correspondence-Between-Platforms-and-Modules) ) have different methods to enter the downloading mode. In general, there are three methods: +Different series of modules ( [click here to view The Correspondence Between Platforms and Modules](https://developer.quectel.com/doc/quecpython/Application_guide/en/background/hardware-platform.html#The-Correspondence-Between-Platforms-and-Modules) ) have different methods to enter the downloading mode. In general, there are three methods: ### Ground the module's boot pin diff --git a/docs/Application_guide/en/firmware-upgrade/firmware-ota.md b/docs/Application_guide/en/firmware-upgrade/firmware-ota.md index f93495ea09511b7a06e71db0efce6030079c7b91..88d151d59f3e87903324982ae8dfae1537c96a49 100644 --- a/docs/Application_guide/en/firmware-upgrade/firmware-ota.md +++ b/docs/Application_guide/en/firmware-upgrade/firmware-ota.md @@ -89,7 +89,7 @@ Users create and deploy OTA jobs on the cloud platform webpage. The device peri ###### 3. Download Upgrade Package -Once the upgrade package URL is obtained, the device uses firmware upgrade-related APIs for package download, writing, and verification. For API details, refer to [fota - Firmware Upgrade](https://python.quectel.com/doc/API_reference/en/syslib/fota.html). +Once the upgrade package URL is obtained, the device uses firmware upgrade-related APIs for package download, writing, and verification. For API details, refer to [fota - Firmware Upgrade](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/fota.html). ###### 4. Restart @@ -200,7 +200,7 @@ When users create and deploy OTA tasks on the cloud platform's web page, the dev ###### 3. Download the Upgrade Package -Once the upgrade package URL is obtained, the device downloads the target files to be upgraded into the file system based on the URL. Both single-file and multi-file batch download methods are supported. For API details, refer to [app_fota - User File Upgrade](https://python.quectel.com/doc/API_reference/en/syslib/app_fota.html). +Once the upgrade package URL is obtained, the device downloads the target files to be upgraded into the file system based on the URL. Both single-file and multi-file batch download methods are supported. For API details, refer to [app_fota - User File Upgrade](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/app_fota.html). ###### 4. Set Upgrade Flag diff --git a/docs/Application_guide/en/hardware/USB-interfaces.md b/docs/Application_guide/en/hardware/USB-interfaces.md index b05ce856a9c47874d7f1e506652e305234102287..3d60b061013bc1d6e8952097dcf51813b88c590a 100644 --- a/docs/Application_guide/en/hardware/USB-interfaces.md +++ b/docs/Application_guide/en/hardware/USB-interfaces.md @@ -80,7 +80,7 @@ The USB electrical properties for the Type-A interface are as follows: A device driver is a special program that enables communication between a computer and a device. The operating system can only control the operation of hardware devices through this interface. -For detailed installation instructions, please refer to the [Quick Start Guide](https://python.quectel.com/doc/Getting_started/en/index.html). +For detailed installation instructions, please refer to the [Quick Start Guide](https://developer.quectel.com/doc/quecpython/Getting_started/en/index.html). **Currently, QuecPython generates the following types of serial ports and device types (taking the EC600M series module as an example).** @@ -166,7 +166,7 @@ In cellular communication modules, the principle of USB-REPL is to provide an in In general, the principle of USB-simulated REPL is to provide a real-time interactive programming and debugging environment through the USB interface. Its main applications are real-time programming and testing, device configuration and management, and troubleshooting and debugging. -> Note: For some QuecPython modules, the REPL port can also be used as a regular serial port by initializing UART3 through *machine.UART()* in [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). When UART3 is enabled, the REPL port functions as a regular serial port, and when UART3 is disabled, the port automatically reverts to REPL. +> Note: For some QuecPython modules, the REPL port can also be used as a regular serial port by initializing UART3 through *machine.UART()* in [machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). When UART3 is enabled, the REPL port functions as a regular serial port, and when UART3 is disabled, the port automatically reverts to REPL. ### Modem @@ -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/en/)) 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://developer.quectel.com/doc/quecpython/Getting_started/en/index.html). The USB firmware download for modules includes the following steps: @@ -220,7 +220,7 @@ The USB firmware download for modules includes the following steps: ### Plug-in/out Detection -For the USB plug-in/out detection interface, please refer to [misc.USB](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USB.html). +For the USB plug-in/out detection interface, please refer to [misc.USB](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USB.html). As a USB device (also known as a slave device), the cellular communication module can be connected to the host (such as a PC or embedded control panel) via the USB interface. In this case, plug-in/out detection is usually performed by the host, but the module itself should also be able to identify these connection and disconnection events. diff --git a/docs/Application_guide/en/hardware/audio-driver.md b/docs/Application_guide/en/hardware/audio-driver.md index d3c384a7acd1e9f4965b775a809e19cb59a76c7d..7c11657e953654fefd4184943e671566fba4f028 100644 --- a/docs/Application_guide/en/hardware/audio-driver.md +++ b/docs/Application_guide/en/hardware/audio-driver.md @@ -106,11 +106,11 @@ Audio playback refers to the process of using an audio codec to convert audio fi - To perform audio playback, an audio object needs to be created, specifying the output channel. For example, *`aud = audio.Audio(0)`* means using the earpieces for output. - Audio playback can be done through the *`aud.play(priority, breakin, filename)`* method, specifying the playback priority, interrupt mode, and file name. It supports playing files in mp3, amr, and wav formats. - The *`aud.playStream(format, buf)`* method can be used to play audio stream, specifying the audio stream format and content. It supports playing audio streams in mp3, amr, and wav formats. -For more interfaces and detailed usage of audio playback, please refer to [audio - Audio Playback](https://python.quectel.com/doc/API_reference/en/medialib/audio.Audio.html). +For more interfaces and detailed usage of audio playback, please refer to [audio - Audio Playback](https://developer.quectel.com/doc/quecpython/API_reference/en/medialib/audio.Audio.html). ## Voice Call Voice call refers to the process of converting voice signals into digital signals using a voice codec, transmitting them over the network to the other party, and then restoring them to voice signals using the other party's voice codec. -For more interfaces and detailed usage of voice call, please refer to [voiceCall - Voice Call](https://python.quectel.com/doc/API_reference/en/iotlib/voiceCall.html). +For more interfaces and detailed usage of voice call, please refer to [voiceCall - Voice Call](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/voiceCall.html). ## Recording External sound is converted into electrical signals through the microphone input device, and then converted into digital signals through the codec and transmitted to the module. The module converts the digital signals into audio files of different formats (such as AMR and WAV) and stores them into flash. @@ -118,7 +118,7 @@ The principle of recording is to convert sound signals into electrical signals o - To perform recording, a record object needs to be created, specifying the input channel. For example, *`record = audio.Record(0)`* means using the earpieces for input. - The *`record.start(file_name, seconds)`* method can be used to start recording, specifying the recording file name and duration. -For more interfaces and detailed usage of recording, please refer to [Record - Audio Record](https://python.quectel.com/doc/API_reference/en/medialib/audio.Record.html). +For more interfaces and detailed usage of recording, please refer to [Record - Audio Record](https://developer.quectel.com/doc/quecpython/API_reference/en/medialib/audio.Record.html). # Audio Parameter Calibration diff --git a/docs/Application_guide/en/hardware/display.md b/docs/Application_guide/en/hardware/display.md index 02486f60962986274d37d479ed340683d697bd0d..6f4c9398e7b7a9cf38d926c7258a7f0b6bbbe892 100644 --- a/docs/Application_guide/en/hardware/display.md +++ b/docs/Application_guide/en/hardware/display.md @@ -198,7 +198,7 @@ The screen driver IC contains multiple registers that control various functions ### API Documentation -For detailed API, please refer to [LCD - LCD Driver](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html). +For detailed API, please refer to [LCD - LCD Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html). **Note:** This section provides information about the QuecPython LCD driver's related APIs. Before driving the screen, please read it carefully. @@ -220,9 +220,9 @@ Before implementing the LCD driver, we need some preparations. This part introdu **Note:** The initialization parameters provided by the manufacture are very important because they are replaced with the format required by *lcd.lcd_init* when the SPI LCD is initialized. -Understanding the [QuecPython LCD interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) is essential for better utilizing it to light up the screen. +Understanding the [QuecPython LCD interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) is essential for better utilizing it to light up the screen. -**Note:** Currently, QuecPython SPI drivers are divided into two types: LCM (Liquid Crystal Module) and general SPI (Serial Peripheral Interface). The initialization interfaces of the two types are different. For specific details, please refer to the [QuecPython LCD interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) . +**Note:** Currently, QuecPython SPI drivers are divided into two types: LCM (Liquid Crystal Module) and general SPI (Serial Peripheral Interface). The initialization interfaces of the two types are different. For specific details, please refer to the [QuecPython LCD interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) . **Understanding the parameters in *LCD.lcd_init* is crucial for driving LCD with QuecPython. Please read the following content carefully.** @@ -371,7 +371,7 @@ mipi_lcd = LCD() ###### Introduction to SPI LCD Initialization Interfaces -Please refer to [LCM Interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#Interface-1%3A-The-device-connects-to-LCM-interfaces-of-modules) and [SPI LCD Interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#Interface-2%3A-The-device-connects-to-module-SPI) for more information. +Please refer to [LCM Interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#Interface-1%3A-The-device-connects-to-LCM-interfaces-of-modules) and [SPI LCD Interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#Interface-2%3A-The-device-connects-to-module-SPI) for more information. ###### Writing Initialization Parameters @@ -508,7 +508,7 @@ The effect is as follows: This interface is very important as it is used to draw UI on the screen. -[Prototype of *lcd.lcd_write*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[Prototype of *lcd.lcd_write*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) Note: @@ -527,7 +527,7 @@ The screen is displayed as follows: ###### Clear Screen -[Prototype of *lcd.lcd_clear*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[Prototype of *lcd.lcd_clear*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **Example (ST7789V):** @@ -541,7 +541,7 @@ The screen is displayed as follows: ###### Image Display -[Prototype of *lcd.lcd_show_jpg*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[Prototype of *lcd.lcd_show_jpg*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) Note: This interface is not supported by all modules. Please consult Quectel Technical Support for specific supporting status. @@ -561,7 +561,7 @@ The MIPI protocol is actually a series of interface protocols, including LCD, ca This chapter will drive the ST7701S (480*854) screen on the QuecPython U-235 EVB and introduce the debugging of MIPI LCD. -Since the relevant **[API](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)** for LCD under QuecPython has been developed, users can directly write the MIPI screen driver according to the [API](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) format. +Since the relevant **[API](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)** for LCD under QuecPython has been developed, users can directly write the MIPI screen driver according to the [API](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) format. **Note:** Currently QuecPython series modules that support MIPI only support the RGB565 format . @@ -588,7 +588,7 @@ mipi_lcd = LCD() ###### Introduction to MIPI Initialization Interface -[Prototype of *lcd.mipi_init*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) +[Prototype of *lcd.mipi_init*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) ```python lcd.mipi_init(initbuf, **kwargs) @@ -693,7 +693,7 @@ The screen is displayed as follows: This interface is very important as it is used to draw UI on the screen. -[Prototype of *lcd.lcd_write*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[Prototype of *lcd.lcd_write*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) Note: @@ -732,7 +732,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://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **Example (st7701s):** @@ -746,7 +746,7 @@ The screen is displayed as follows: ###### Image Displaying -[Prototype of *lcd.lcd_show_jpg*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[Prototype of *lcd.lcd_show_jpg*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) Note: This interface is not supported by all modules. Please refer to the WIKI for specific supporting status. diff --git a/docs/Application_guide/en/hardware/display/display.md b/docs/Application_guide/en/hardware/display/display.md index 2d05991ae58afd8080f80a4bc2408033e9d8338d..d0cde0bfdb41288e00c6c3603ee66f43985ca2c8 100644 --- a/docs/Application_guide/en/hardware/display/display.md +++ b/docs/Application_guide/en/hardware/display/display.md @@ -174,7 +174,7 @@ The screen driver IC contains multiple registers that control various functions ### API Documentation -For detailed API, please refer to [LCD - LCD Driver](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html). +For detailed API, please refer to [LCD - LCD Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html). **Note:** This section provides information about the QuecPython LCD driver's related APIs. Before driving the screen, please read it carefully. @@ -196,9 +196,9 @@ Before implementing the LCD driver, we need some preparations. This part introdu **Note:** The initialization parameters provided by the manufacture are very important because they are replaced with the format required by *lcd.lcd_init* when the SPI LCD is initialized. -Understanding the [QuecPython LCD interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) is essential for better utilizing it to light up the screen. +Understanding the [QuecPython LCD interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) is essential for better utilizing it to light up the screen. -**Note:** Currently, QuecPython SPI drivers are divided into two types: LCM (Liquid Crystal Module) and general SPI (Serial Peripheral Interface). The initialization interfaces of the two types are different. For specific details, please refer to the [QuecPython LCD interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) . +**Note:** Currently, QuecPython SPI drivers are divided into two types: LCM (Liquid Crystal Module) and general SPI (Serial Peripheral Interface). The initialization interfaces of the two types are different. For specific details, please refer to the [QuecPython LCD interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) . **Understanding the parameters in *LCD.lcd_init* is crucial for driving LCD with QuecPython. Please read the following content carefully.** @@ -347,7 +347,7 @@ mipi_lcd = LCD() ###### Introduction to SPI LCD Initialization Interfaces -Please refer to [LCM Interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#Interface-1%3A-The-device-connects-to-LCM-interfaces-of-modules) and [SPI LCD Interface](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#Interface-2%3A-The-device-connects-to-module-SPI) for more information. +Please refer to [LCM Interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#Interface-1%3A-The-device-connects-to-LCM-interfaces-of-modules) and [SPI LCD Interface](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#Interface-2%3A-The-device-connects-to-module-SPI) for more information. ###### Writing Initialization Parameters @@ -484,7 +484,7 @@ The effect is as follows: This interface is very important as it is used to draw UI on the screen. -[Prototype of *lcd.lcd_write*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[Prototype of *lcd.lcd_write*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) Note: @@ -503,7 +503,7 @@ The screen is displayed as follows: ###### Clear Screen -[Prototype of *lcd.lcd_clear*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[Prototype of *lcd.lcd_clear*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **Example (ST7789V):** @@ -517,7 +517,7 @@ The screen is displayed as follows: ###### Image Display -[Prototype of *lcd.lcd_show_jpg*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[Prototype of *lcd.lcd_show_jpg*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) Note: This interface is not supported by all modules. Please consult Quectel Technical Support for specific supporting status. @@ -537,7 +537,7 @@ The MIPI protocol is actually a series of interface protocols, including LCD, ca This chapter will drive the ST7701S (480*854) screen on the QuecPython U-235 EVB and introduce the debugging of MIPI LCD. -Since the relevant **[API](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)** for LCD under QuecPython has been developed, users can directly write the MIPI screen driver according to the [API](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) format. +Since the relevant **[API](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)** for LCD under QuecPython has been developed, users can directly write the MIPI screen driver according to the [API](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) format. **Note:** Currently QuecPython series modules that support MIPI only support the RGB565 format . @@ -564,7 +564,7 @@ mipi_lcd = LCD() ###### Introduction to MIPI Initialization Interface -[Prototype of *lcd.mipi_init*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) +[Prototype of *lcd.mipi_init*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) ```python lcd.mipi_init(initbuf, **kwargs) @@ -669,7 +669,7 @@ The screen is displayed as follows: This interface is very important as it is used to draw UI on the screen. -[Prototype of *lcd.lcd_write*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[Prototype of *lcd.lcd_write*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) Note: @@ -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/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[Prototype of *lcd.lcd_clear*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **Example (st7701s):** @@ -722,7 +722,7 @@ The screen is displayed as follows: ###### Image Displaying -[Prototype of *lcd.lcd_show_jpg*](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[Prototype of *lcd.lcd_show_jpg*](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) Note: This interface is not supported by all modules. Please refer to the WIKI for specific supporting status. diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md index 7cc6b36132273b9cf80b04f8d2c3c621fadfd34c..24fbb72c6189a433da6aba1817b2387aea380ff6 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO.md @@ -396,7 +396,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) +For specific API on QuecPython GPIO, please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) #### Create object @@ -406,7 +406,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/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). +For parameter introduction and GPIO pin number & physical mapping, please see [machine.Pin](https://developer.quectel.com/doc/quecpython/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 +428,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/en/peripherals/machine.Pin.html#%3Ccode%3EPin.read%3C/code%3E). +For specific method, please refer to [Pin.read](https://developer.quectel.com/doc/quecpython/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 +452,7 @@ Note Pin.write(value) ``` -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). +For specific method, please refer to [Pin.write](https://developer.quectel.com/doc/quecpython/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 +480,7 @@ Note Pin.set_dir(value) ``` -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). +For specific method, please refer to [Pin.set_dir](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3EPin.set_dir%3C/code%3E). Direction selection @@ -509,7 +509,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/en/peripherals/machine.ExtInt.html). +For specific method, please refer to [machine.ExtInt](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html). Types to trigger interrupt @@ -544,7 +544,7 @@ extint.enable() extint.disable() ``` -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) +For specific method, please refer to [Eextint.enable](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.enable%3C/code%3E) and [Extint.disable](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.disable%3C/code%3E) Enable @@ -564,8 +564,8 @@ 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. +For other method, please refer to wiki -[machine.ExtInt](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html) in detail. +For other method, please refer to wiki -[machine.ExtInt](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html) in detail. ## Application examples diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_Button.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_Button.md index 8b1b6105221a74302d31acc90bc8a8a6d39d17b4..6e6d57c7fa47dca9e0adf472aa6799095460a6d3 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_Button.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_Button.md @@ -96,7 +96,7 @@ class Button(gpio,timer_id) - Functionality: Create Button object - Return: Button object - Button: Button class -- gpio: GPIO number to control LED. For specific, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html). +- gpio: GPIO number to control LED. For specific, please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html). ```python import machine diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_LED.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_LED.md index d22be61181fe09ab3a26a1e0e2514e8d88ff1e67..b3513897b00769d9a408e8f7644c762824be229b 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_LED.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_LED.md @@ -21,7 +21,7 @@ LED(gpio) - Function: Create LED Object - Return: LED Object - LED: LED Classification -- gpio: GPIO number used to control LED. For specific, please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) +- gpio: GPIO number used to control LED. For specific, please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) ```python LED.on() @@ -132,7 +132,7 @@ In convenience of test, the LED in LTE OPEN-EVB_V1.1 such as NET_STATUS can be d -> The NET_STATUS will be taken as network indicator by default. However, it is mandatory to disable network indicator via API beforehand. See [misc](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.html) in detail. +> The NET_STATUS will be taken as network indicator by default. However, it is mandatory to disable network indicator via API beforehand. See [misc](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.html) in detail. > > Moreover, it is available to turn off network indicator via following commands in EC600U module > @@ -146,7 +146,7 @@ In convenience of test, the LED in LTE OPEN-EVB_V1.1 such as NET_STATUS can be d Execute following steps once above procedure is done 2. Reach pin that controls network indicator in EC600U module via [Hardware_Design](https://python.quectel.com/en/resource-download?cid=250). It is found the NET_STATUS of EC600U is controlled by pin 54. -4. After acquring pin number, it is available to find the exact GPIO 14 that corresponding to pin 54 in EC600U module based on the mapping relationship between GPIO pin number and physical pin via [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) +4. After acquring pin number, it is available to find the exact GPIO 14 that corresponding to pin 54 in EC600U module based on the mapping relationship between GPIO pin number and physical pin via [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) 5. Compile script to control LED and run it By running above codes via QPYcom, it is vivid that the NET_STATUS will blink with an interval of 1s. 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 942fa26e2b6a970aa6436c9a4703a410209d171f..d76d49363f06f6e4f509719ed2367ee97d64aa27 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 @@ -82,7 +82,7 @@ The master can communicate with up to 100 slaves on a 1-wire standard bus. Howev ## Functionality Briefing -Among QuecPython modules, EC200U/EC600U/EG912U/EG915U support GPIO 1-Wire Protocol. Please refer to the API introduction: [machine.OneWire](https://python.quectel.com/doc/API_reference/en/peripherals/machine.OneWire.html) +Among QuecPython modules, EC200U/EC600U/EG912U/EG915U support GPIO 1-Wire Protocol. Please refer to the API introduction: [machine.OneWire](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.OneWire.html) ### Object Creation @@ -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/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). +For relationship between pin number and physical pins, please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/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: @@ -176,7 +176,7 @@ class DS18B20Sensor(onewire_pin) - Functionality: Create a DS18B20 object. - Returns: DS18B20 object. - DS18B20Sensor: DS18B20Sensor class. -- onewire_pin: GPIO number of the One-Wire bus. Please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html). +- onewire_pin: GPIO number of the One-Wire bus. Please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html). ```python DS18B20Sensor.read_temperature() diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_sif.md b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_sif.md index dd5e9cabf998d1025a282f424c207c9fcca9cd23..99fff0344bacf19275767b7e923ef73a652c92f0 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_sif.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/GPIO_sif.md @@ -62,7 +62,7 @@ import sif sif.init(gpio, cb) ``` -For mapping 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). +For mapping between pin number and physical pins, please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E). It is available in multiple modules. As a result, please do import it beforehand. Then you can use the SIF slave function by calling methods below: @@ -102,7 +102,7 @@ class SifProtocol(gpio) - Function: Create SifProtocol object. - Return: SifProtocal object. - SifProtocal: SifProtocal class. -- gpio: the GPIO number of 1-wire bus. Please refer to [machine.Pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) +- gpio: the GPIO number of 1-wire bus. Please refer to [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) Software design: diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md b/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md index 6dfd3d5d451b19e3f704fb4b50fe36b8d81a0dee..c2151a6eb8fb2de5cd27a100f45c2ff80b07b2c7 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/IIC.md @@ -42,7 +42,7 @@ All modules support hardware IIC with both 100k and 400k frequency. Software Simulated IIC simulates IIC protocol by controlling GPIO pin levels in software. If the hardware IIC are not enough or are multiplexed as other functions, it is available to use simulated IIC to implement IIC communication. - - EC600M-CN Series @@ -67,7 +67,7 @@ This chapter will introduce how we can use IIC driver's functionalities and data 3. Receive data -For specific introduction on API, please refer to [machine.IIC](https://python.quectel.com/doc/API_reference/en/peripherals/machine.I2C.html) in detail. +For specific introduction on API, please refer to [machine.IIC](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.I2C.html) in detail. ### Create an Object @@ -78,7 +78,7 @@ It is mandatory to specify IIC channel and working mode when creating an IIC obj class machine.I2C(I2Cn, MODE) ``` -For the parameters introduction and pin relationships, please refer to [machine.IIC](https://python.quectel.com/doc/API_reference/en/peripherals/machine.I2C.html) +For the parameters introduction and pin relationships, please refer to [machine.IIC](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.I2C.html) When creating an object, please note following aspects. @@ -98,7 +98,7 @@ When sending data over IIC, a couple of points should be noted: - The `addr_len` refers to the address length of the register. You can get this information from the peripheral's datasheet. Commonly used IIC peripherals usually have an register address length of 1 byte such as QMA7981 3-Axis Accelerometer. -For API introduction, please refer to [machine.UART.write](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E). +For API introduction, please refer to [machine.UART.write](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E). ### Receive Data @@ -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/en/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) +For API and parameter introductions, please refer to [machine.UART.read](https://developer.quectel.com/doc/quecpython/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/SPI.md b/docs/Application_guide/en/hardware/peripheral-interfaces/SPI.md index 84e2636ed43b3642cc961dfb1507b99cb259dc23..1a93a8c7cab7d994f7a3b2572a8b9848ef5aaa50 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/SPI.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/SPI.md @@ -128,7 +128,7 @@ lcd.lcd_init(lcd_init_data, lcd_width, lcd_hight, lcd_clk, data_line, line_num, ``` Compared with LCD SPI pins, SPI mode, SPI port, CS, DC, and RST pins are added to the initialization parameters. -For specific examples, please refer to codes in [WIKI-LCD](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html). +For specific examples, please refer to codes in [WIKI-LCD](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html). ### MCP2515 CAN Controller diff --git a/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md b/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md index 76abf32c17f90c69c1c4b0a52bea6aede3c855a1..336c74472a36da5b2951f41918afefb490c4171d 100644 --- a/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md +++ b/docs/Application_guide/en/hardware/peripheral-interfaces/UART.md @@ -244,7 +244,7 @@ Application： ## Supported situation -For support of individual QuecPython module, see [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). +For support of individual QuecPython module, see [machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). ## Data flow @@ -284,7 +284,7 @@ In this chapter, it will illustrate how to communicate between QuecPython Series 4. [Interrupt](#interrupt) 5. [RS485 control](#rs485-control) -For specific API, see [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html). +For specific API, see [machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html). ### Create object @@ -294,7 +294,7 @@ The UART communication parameters will be configured in this step, including bau class machine.UART(UART.UARTn, baudrate, databits, parity, stopbits, flowctl ``` -About parameters introduction and pin mapping, see [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). +About parameters introduction and pin mapping, see [machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E). When creating objects, please pay attention to following aspects. @@ -315,7 +315,7 @@ msg = "This is a test string" uart.write(msg) ``` -About API, see [machine.UART.write](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) +About API, see [machine.UART.write](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) ### Receive data @@ -334,7 +334,7 @@ In terms of receiving data, following aspects shall be noted: **3. Data format**: The received data format shall be aligned with the settings in Tx, including data coding (ASCII, UTF-8 and binary), data bit quantity, start bit, stop bit and parity check bit. -For API introduction, please refer to [machine.UART.read](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E). +For API introduction, please refer to [machine.UART.read](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E). ### Interrupt @@ -351,7 +351,7 @@ def uart_call(para): uart1.set_callback(uart_call) ``` -For API introduction, please refer to [machine.UART.setCallback](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.set_callback%3C/code%3E) +For API introduction, please refer to [machine.UART.setCallback](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.set_callback%3C/code%3E) > To avoid executing interrupt for a long time, it is needed to notify other threads to read serial port data by sending semaphore in callback. @@ -359,23 +359,23 @@ For API introduction, please refer to [machine.UART.setCallback](https://python. Control 485 communication direction: Pull up/down dedicated GPIO to notify 485 communication direction before and after transmitting data by serial port. -For API introduction, please refer to [machine.UART.control_485](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E). +For API introduction, please refer to [machine.UART.control_485](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E). ## Applications | Cases | Description | | ------------------------------------- | ------------------------------------------------------------ | -| [Basic Tx/Rx](https://python.quectel.com/doc/Application_guide/en/hardware/peripheral-interfaces/UART.html#Basic-Tx/Rx) | Configure UART setting and read and write via UART1. It will read data in a method of callback | -| [External GNSS](https://python.quectel.com/doc/Application_guide/en/hardware/peripheral-interfaces/UART.html#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](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](https://python.quectel.com/doc/Application_guide/en/hardware/peripheral-interfaces/UART.html#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](https://developer.quectel.com/doc/quecpython/Application_guide/en/hardware/peripheral-interfaces/UART.html#Basic-Tx/Rx) | Configure UART setting and read and write via UART1. It will read data in a method of callback | +| [External GNSS](https://developer.quectel.com/doc/quecpython/Application_guide/en/hardware/peripheral-interfaces/UART.html#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](https://developer.quectel.com/doc/quecpython/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](https://developer.quectel.com/doc/quecpython/Application_guide/en/hardware/peripheral-interfaces/UART.html#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 In terms of communication module, one simplified method is provided by QuecPython to carry out UART communication. For real-time application or scenario needs deal with UART info effectively, it is suggested to read UART via callback function. -Before that, it is necessary to learn about UART QuecPython Interface, see [machine.UART](https://python.quectel.com/doc/API_reference/en/peripherals/machine.UART.html) +Before that, it is necessary to learn about UART QuecPython Interface, see [machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.UART.html) Procedure @@ -463,7 +463,7 @@ if __name__ == "__main__": In embedded system, it is common that the GNSS (Global Navigation Satellite System) receiver will be connected by UART, including GPS, GLONASS, Galileo, BeiDou and so on. Moreover, this connection allows system to decrypt GNSS data to acquire current location, speed, time and other relevant info. -Nowadays, some QuecPython modules are integrated with external GNSS and series of interfaces are provided. For specific, please refer to [gnss_wiki](https://python.quectel.com/doc/API_reference/en/gnsslib/gnss.html) in detail. Thus, it is available for user to acquire data via these above interfaces, including whether the module positioning is a success, coordinates, UTC time, positioning mode of GPS module, satellite quantity, visible satellite quantity, Azimuth, ground speed and Geoid Height. Currently, the data acquired is originated from raw GNSS data packet read by serial port, including GNGGA, GNRMC and GPGSV. +Nowadays, some QuecPython modules are integrated with external GNSS and series of interfaces are provided. For specific, please refer to [gnss_wiki](https://developer.quectel.com/doc/quecpython/API_reference/en/gnsslib/gnss.html) in detail. Thus, it is available for user to acquire data via these above interfaces, including whether the module positioning is a success, coordinates, UTC time, positioning mode of GPS module, satellite quantity, visible satellite quantity, Azimuth, ground speed and Geoid Height. Currently, the data acquired is originated from raw GNSS data packet read by serial port, including GNGGA, GNRMC and GPGSV. In this chapter, it will introduce based on L76K. diff --git a/docs/Application_guide/en/hardware/sensors/accelerometer/README.md b/docs/Application_guide/en/hardware/sensors/accelerometer/README.md index 4d8e8a38faca01e3bdc24d07b5218eaac8a773ac..0944591af6ab501b534d833f1823918982f9e3b9 100644 --- a/docs/Application_guide/en/hardware/sensors/accelerometer/README.md +++ b/docs/Application_guide/en/hardware/sensors/accelerometer/README.md @@ -407,7 +407,7 @@ class lis2dh12(object): > > - The parameter of `int_enable` needs to be determined according to the datasheet and specific application scenarios. For example, if you want to avoid frequent false triggering of the interrupt, the parameters `int_ths` and `duration` must be set greater, and the values depend on the test results. > - When the three-axis sensor is placed vertically with the z-axis upwards and there is no external force, the acceleration of the `x`, `y`, and `z` axes is basically (0,0,1), in units of `G`. This can be used to determine whether the sensor reading and acceleration calculation are normal. -> - It is recommended to use [external interrupt](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html) to handle interrupts, rather than polling the interrupt register of the sensor. The latter method will prevent entering low-power mode. +> - It is recommended to use [external interrupt](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html) to handle interrupts, rather than polling the interrupt register of the sensor. The latter method will prevent entering low-power mode. The main program code is designed as follows: diff --git a/docs/Application_guide/en/helios-sdk/junior.md b/docs/Application_guide/en/helios-sdk/junior.md index 6569c0f2275f1bfc61de99e9758e6db3d64fecef..587fc924758ee8a1d6689aecc52a8422d86f143d 100644 --- a/docs/Application_guide/en/helios-sdk/junior.md +++ b/docs/Application_guide/en/helios-sdk/junior.md @@ -166,4 +166,4 @@ The execution result is shown in the following image: Now, we have developed our first simple application with QuecPython. -For further exploration of QuecPython features and API usage, please visit [QuecPython API Reference Manual](https://python.quectel.com/doc/API_reference/en/index.html). \ No newline at end of file +For further exploration of QuecPython features and API usage, please visit [QuecPython API Reference Manual](https://developer.quectel.com/doc/quecpython/API_reference/en/index.html). \ No newline at end of file diff --git a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai.png b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai.png index 97a524333a7faf16a1cb32fffa1c4cc2a949f8cf..c8c70e96d117afb572d9980735f9a3f34bb804fe 100644 Binary files a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai.png and b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai.png differ diff --git a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_audio.png b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_audio.png index d382d867591bd7fb35e70baeb9af402187b98cd9..13aafe2026e60d8785280cd67ba8457cc946af92 100644 Binary files a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_audio.png and b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_audio.png differ diff --git a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_frame.png b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_frame.png index 582eb33246df500434fd1d0c1da4c1894cec9982..4573dac48fd2b47b184f6c89783fbf9e8bedac2d 100644 Binary files a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_frame.png and b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_frame.png differ diff --git a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_process.png b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_process.png index 4c3d37035829413693232a22f12e14f50ad53ea0..4c510a33334070268cd00fdb523e63c285979bf5 100644 Binary files a/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_process.png and b/docs/Application_guide/en/media/solutions/AIChatBot-Volcengine-webRTC/code_ai_process.png differ diff --git a/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/software.png b/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/software.png index 109eb429c64e49cf1a7e8abfad2ee9fd05dfc247..f1be5747868e64e9bccff80b70fa6bc41367699a 100644 Binary files a/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/software.png and b/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/software.png differ diff --git a/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/start.png b/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/start.png index 0dbee652969dfdcd0dbfb3e9f0e818fafe5fb6a0..883d43371410e04a2020771d7d32e5724e3659ac 100644 Binary files a/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/start.png and b/docs/Application_guide/en/media/solutions/Agriculture-Control-Panel/start.png differ diff --git a/docs/Application_guide/en/media/solutions/DTU/DTU_wires_connection.png b/docs/Application_guide/en/media/solutions/DTU/DTU_wires_connection.png index 2a1a5497716fd2ed4ffc8f5a71a67e8a7f2f4652..157a5dced18e5d9df9d51f6d0d01e4c670a58f95 100644 Binary files a/docs/Application_guide/en/media/solutions/DTU/DTU_wires_connection.png and b/docs/Application_guide/en/media/solutions/DTU/DTU_wires_connection.png differ diff --git a/docs/Application_guide/en/media/solutions/SensorHub/software1.png b/docs/Application_guide/en/media/solutions/SensorHub/software1.png index a3e6e48899859fdc4e63339ae7e2d0fbaf14f8de..ff78181a73664327ee707875ebd893ceb5902a8c 100644 Binary files a/docs/Application_guide/en/media/solutions/SensorHub/software1.png and b/docs/Application_guide/en/media/solutions/SensorHub/software1.png differ diff --git a/docs/Application_guide/en/media/solutions/SensorHub/software2.png b/docs/Application_guide/en/media/solutions/SensorHub/software2.png index 5ceccb68d4dc2c94a06ec26599c5487569b4fef8..ad7d01b5011b4566d142e0f90eae3f44ac287944 100644 Binary files a/docs/Application_guide/en/media/solutions/SensorHub/software2.png and b/docs/Application_guide/en/media/solutions/SensorHub/software2.png differ diff --git a/docs/Application_guide/en/media/solutions/Wear/image-20231124133650808.png b/docs/Application_guide/en/media/solutions/Wear/image-20231124133650808.png index 35a52d1ab614551e91f8da0f57954c1431881e27..fbcee9a4f988a1d4b5cf27909fa185334c1ec188 100644 Binary files a/docs/Application_guide/en/media/solutions/Wear/image-20231124133650808.png and b/docs/Application_guide/en/media/solutions/Wear/image-20231124133650808.png differ diff --git a/docs/Application_guide/en/media/solutions/electricity-meter/downloadfile.png b/docs/Application_guide/en/media/solutions/electricity-meter/downloadfile.png index 363abe8d74c9eb689832b91ab32b7ed566868e97..5da40922ae651cd3f5fd9fdc3d8c92f3d739f374 100644 Binary files a/docs/Application_guide/en/media/solutions/electricity-meter/downloadfile.png and b/docs/Application_guide/en/media/solutions/electricity-meter/downloadfile.png differ diff --git a/docs/Application_guide/en/media/solutions/electricity-meter/eletricity_to_tcp.png b/docs/Application_guide/en/media/solutions/electricity-meter/eletricity_to_tcp.png index aa9db61c972066543749f37adde60b9fe1610ab6..933492b35fcb44bc00bcba0d66130439ba9b907b 100644 Binary files a/docs/Application_guide/en/media/solutions/electricity-meter/eletricity_to_tcp.png and b/docs/Application_guide/en/media/solutions/electricity-meter/eletricity_to_tcp.png differ diff --git a/docs/Application_guide/en/media/solutions/electricity-meter/module_rfc.png b/docs/Application_guide/en/media/solutions/electricity-meter/module_rfc.png index 43f4d1c43b67061a41e4b1a99166ec63ba70d105..5f5ae21b37f688041d476592c5662f3dff2970d6 100644 Binary files a/docs/Application_guide/en/media/solutions/electricity-meter/module_rfc.png and b/docs/Application_guide/en/media/solutions/electricity-meter/module_rfc.png differ diff --git a/docs/Application_guide/en/media/solutions/electricity-meter/start.png b/docs/Application_guide/en/media/solutions/electricity-meter/start.png index 5711720a57f5e200b7b3ed60333c130718cf194a..1375d84f4fc8b4cf5f2498411ebc74dec679700a 100644 Binary files a/docs/Application_guide/en/media/solutions/electricity-meter/start.png and b/docs/Application_guide/en/media/solutions/electricity-meter/start.png differ diff --git a/docs/Application_guide/en/media/solutions/poc/files.png b/docs/Application_guide/en/media/solutions/poc/files.png index a8a328c5a79dd8e476ff73b21f3e1238a176aee8..70265ff0c7cdcdcfebaff15a67e91ed0defd328b 100644 Binary files a/docs/Application_guide/en/media/solutions/poc/files.png and b/docs/Application_guide/en/media/solutions/poc/files.png differ diff --git a/docs/Application_guide/en/media/solutions/poc/get_imei.png b/docs/Application_guide/en/media/solutions/poc/get_imei.png index 26db7f5e97cc0b759cbe5eea95b4744d0b7b409c..6a79538640a3d04e28cdc36cb8f9d8072ed878e1 100644 Binary files a/docs/Application_guide/en/media/solutions/poc/get_imei.png and b/docs/Application_guide/en/media/solutions/poc/get_imei.png differ diff --git a/docs/Application_guide/en/media/solutions/poc/start.png b/docs/Application_guide/en/media/solutions/poc/start.png index 39125f7dda5b5983084c6b1ab50b9e43510387ed..15184a02906873eefa9b12ea9e3d1b6041747a06 100644 Binary files a/docs/Application_guide/en/media/solutions/poc/start.png and b/docs/Application_guide/en/media/solutions/poc/start.png differ diff --git a/docs/Application_guide/en/multi-media/lvgl/lvgl_demo.md b/docs/Application_guide/en/multi-media/lvgl/lvgl_demo.md index c37eb5f5ac1d45b612825a6081fcc91265d3747a..c1c99f6d0a847d7b647b068dc45b11060d417144 100644 --- a/docs/Application_guide/en/multi-media/lvgl/lvgl_demo.md +++ b/docs/Application_guide/en/multi-media/lvgl/lvgl_demo.md @@ -38,7 +38,7 @@ Click [here]() to download the application code. ### Initialize LCD -For the initialization of LCD, see [machine LCD](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html). +For the initialization of LCD, see [machine LCD](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html). Here takes an ST7789 LCD with a resolution of 240*320 as an example. The following is the code for LCD initialization: diff --git a/docs/Application_guide/en/multi-media/lvgl/lvgl_flow.md b/docs/Application_guide/en/multi-media/lvgl/lvgl_flow.md index 413e61112625ac6a5650bc235f5f061721a73f25..6204927b510fb7f74dbadea0fb7385b766346735 100644 --- a/docs/Application_guide/en/multi-media/lvgl/lvgl_flow.md +++ b/docs/Application_guide/en/multi-media/lvgl/lvgl_flow.md @@ -20,7 +20,7 @@ LVGL refreshes the drawn graphics data to the LCD through the registered LCD dri The LVGL initialization process is as follows: -1. Properly initialize the LCD. Please refer to [LCD - LCD Driver](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html) for details. +1. Properly initialize the LCD. Please refer to [LCD - LCD Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html) for details. 2. Initialize the display buffer. 3. Initialize the display driver and bind the refresh API as the write interface of the LCD. 4. If there are input devices such as TP, initialize the TP. @@ -94,7 +94,7 @@ lv.task_handler() > **Note:** > -> - Please refer to [LCD - LCD Driver](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html) for the details about LCD initialization. +> - Please refer to [LCD - LCD Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html) for the details about LCD initialization. > > - LVGL requires *lcd_write* of the LCD to refresh the interface. > - LVGL requires reading API of the TP for touch input. diff --git a/docs/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.md b/docs/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.md index 1e31ed917c09f61702fd44de54fde20184417ac0..7571bf6128cb3d04e89a55c68fc71c4e5311e48b 100644 --- a/docs/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.md +++ b/docs/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.md @@ -96,7 +96,7 @@ The script generated by GUI Guider has some slight differences from the actual a ### Add LCD Initialization -Add the LCD initialization code at the beginning of the generated Python file from GUI Guider. Please refer to [LCD - LCD Driver](https://python.quectel.com/doc/API_reference/en/peripherals/machine.LCD.html) for details. +Add the LCD initialization code at the beginning of the generated Python file from GUI Guider. Please refer to [LCD - LCD Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.LCD.html) for details. ### Modify Generated Code diff --git a/docs/Application_guide/en/network-comm/esim/README.md b/docs/Application_guide/en/network-comm/esim/README.md index 13b797ffb308a88a0648a5a6aba98d76b2b83548..d2738716fb186566ecfb0aef494642fb1ecd0a03 100644 --- a/docs/Application_guide/en/network-comm/esim/README.md +++ b/docs/Application_guide/en/network-comm/esim/README.md @@ -527,5 +527,5 @@ If you are unable to access the internet after successfully downloading and inst ### "eSIM card not inserted" error message -Please refer to the QuecPtyhon official website wiki for cellular wireless card [Handle Network Exceptions](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Handle-Network-Exceptions-at-Startup). +Please refer to the QuecPtyhon official website wiki for cellular wireless card [Handle Network Exceptions](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Handle-Network-Exceptions-at-Startup). diff --git a/docs/Application_guide/en/network-comm/net-protocols/ftp.md b/docs/Application_guide/en/network-comm/net-protocols/ftp.md index c56db9904b0d3bf2fbbb07a792425063cdfc6021..4fc7ae665a5e728d8a9b272bd35b35af5fe46a91 100644 --- a/docs/Application_guide/en/network-comm/net-protocols/ftp.md +++ b/docs/Application_guide/en/network-comm/net-protocols/ftp.md @@ -123,14 +123,14 @@ To build an FTP client with `ftplib` on the module and establish a connection wi 2. Connect to network: Ensure your device can connect to the network. 3. QuecPython firmware includes ftplib module. -After downloading the firmware, you need to check whether the current firmware includes the `ftplib` module and check the network status. You can use [QPYcom](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html) for debugging. The demonstrations in this document are performed with this tool. On the interactive page of QPYcom, you can confirm whether the module contains and uses APIs to check the network status by importing the feature. In Python syntax, you can import APIs with `import xxx` or `from xx import xxx`. +After downloading the firmware, you need to check whether the current firmware includes the `ftplib` module and check the network status. You can use [QPYcom](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html) for debugging. The demonstrations in this document are performed with this tool. On the interactive page of QPYcom, you can confirm whether the module contains and uses APIs to check the network status by importing the feature. In Python syntax, you can import APIs with `import xxx` or `from xx import xxx`. ```python # Inclueded if no exception occurs from ftplib import FTP ``` -You can import the `checkNet` API to query the network status of the device. The status values are available in the [wiki](https://python.quectel.com/doc/API_reference/en/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E). +You can import the `checkNet` API to query the network status of the device. The status values are available in the [wiki](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E). ```python import checkNet diff --git a/docs/Application_guide/en/network-comm/net-protocols/mqtt.md b/docs/Application_guide/en/network-comm/net-protocols/mqtt.md index f4c9b2366a95724ab46f7cf1d9a32383150b51f8..4970590c7a12d11673f6179d54b970e5d6b0c1f7 100644 --- a/docs/Application_guide/en/network-comm/net-protocols/mqtt.md +++ b/docs/Application_guide/en/network-comm/net-protocols/mqtt.md @@ -41,7 +41,7 @@ Through these mechanisms, MQTT achieves reliable message delivery, decoupling, a ![image-20230701163911290](../../media/network-comm/net-protocols/mqtt/mqtt_1.png) -- MQTT Client: An MQTT client refers to a device or application that connects to an MQTT server. Each client is identified by a unique client identifier, which is used by the server to distinguish and differentiate between different clients. In QuecPython, we use `umqtt` to implement MQTT clients. A connection object is created by passing initialization parameters, and for more details, [click here](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3Eumqtt.MQTTClient%3C/code%3E). +- MQTT Client: An MQTT client refers to a device or application that connects to an MQTT server. Each client is identified by a unique client identifier, which is used by the server to distinguish and differentiate between different clients. In QuecPython, we use `umqtt` to implement MQTT clients. A connection object is created by passing initialization parameters, and for more details, [click here](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3Eumqtt.MQTTClient%3C/code%3E). ```python from umqtt import MQTTClient @@ -65,7 +65,7 @@ Through these mechanisms, MQTT achieves reliable message delivery, decoupling, a ### Publish-Subscribe -- Publisher: A publisher is the sender of messages in MQTT. Publishers publish messages to specific topics, and delivers these messages to all subscribers of that topic through the MQTT server. After creating a client object with `umqtt`, you can use the [publish](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.publish%3C/code%3E) method to publish messages. +- Publisher: A publisher is the sender of messages in MQTT. Publishers publish messages to specific topics, and delivers these messages to all subscribers of that topic through the MQTT server. After creating a client object with `umqtt`, you can use the [publish](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.publish%3C/code%3E) method to publish messages. ```python MQTTClient.publish(topic, msg, retain=False, qos=0) @@ -82,7 +82,7 @@ Through these mechanisms, MQTT achieves reliable message delivery, decoupling, a - Subscriber: A subscriber is the receiver of messages in MQTT. Subscribers can subscribe to topics of interest to receive messages related to those topics. Once a subscriber subscribes to a specific topic, it will receive all published messages under that topic. In projects, topics are often defined based on different events. When a device subscribes to an event topic, it can receive push messages related to that topic. - [Click here to see API references](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) + [Click here to see API references](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) ```python MQTTClient.subscribe(topic,qos) @@ -111,7 +111,7 @@ MQTT defines three different levels of Quality of Service (QoS) for controlling - QoS 1 (At least once): Message publishers ensure that the message is delivered at least once, which might lead to duplicate deliveries. This level uses a publish-and-acknowledge mechanism to achieve reliable delivery and is suitable for scenarios that require at least once delivery. - QoS 2 (Exactly once): Message publishers ensure that the message is delivered exactly once, achieved through a two-step handshake and four-step handshake confirmation mechanism. This level provides the highest level of delivery reliability and is suitable for scenarios where precise delivery is of utmost importance. -[Click here to see](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) the method of setting the QoS level in QuecPython. +[Click here to see](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) the method of setting the QoS level in QuecPython. ```python """ @@ -129,7 +129,7 @@ MQTTClient.publish("Quectel/Python/demo","Hello", qos=1) MQTT allows clients to set a Last Will and Testament (LWT) message when establishing a connection. During the connection setup process, a client can define the parameters for the LWT message, including the topic, message content, and QoS level. If the MQTT server detects that a client has not sent a keep-alive packet within the specified interval and the client has not requested to close the connection, the server considers the client to have disconnected abnormally. In such cases, the server publishes the LWT message to the specified topic based on the client's LWT settings. Subscribers of this topic can then receive the LWT message, indicating the offline status of the client. -The `set_last_will` API in QuecPython allows you to set the WT message. [Click here](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.set_last_will%3C/code%3E) for more details. +The `set_last_will` API in QuecPython allows you to set the WT message. [Click here](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.set_last_will%3C/code%3E) for more details. ```python MQTTClient.set_last_will(topic,msg,retain=False,qos=0) @@ -156,7 +156,7 @@ MQTT employs a long connection approach to maintain persistent communication bet - Disconnection Monitoring: If the server doesn't receive heartbeat requests or other messages from the client within a certain period, it considers that the client has disconnected and terminates the connection. Similarly, the client can detect the server's disconnection and attempt reconnection. -In MQTT initialization, configuring a non-zero value indicates that the the keep alive mechanism is enabled by default. QuecPython will actively send heartbeat packets within the defined heartbeat interval with`umqtt.ping()` . [Click here](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.ping%3C/code%3E) to fins more details. +In MQTT initialization, configuring a non-zero value indicates that the the keep alive mechanism is enabled by default. QuecPython will actively send heartbeat packets within the defined heartbeat interval with`umqtt.ping()` . [Click here](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html#%3Ccode%3EMQTTClient.ping%3C/code%3E) to fins more details. ```python MQTTClient.ping() @@ -164,7 +164,7 @@ MQTTClient.ping() ## MQTT Application -QuecPython provides the `umqtt` feature for client connection of MQTT protocol. For the usage of `umqtt` interfaces, [click here](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html) for details. +QuecPython provides the `umqtt` feature for client connection of MQTT protocol. For the usage of `umqtt` interfaces, [click here](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html) for details. This section will set up two MQTT clients for demonstration. For better demonstration, Client A is set up on a PC with the MQTT.fx tool and connect to the server. Client B is implemented with QuecPython `umqtt`. Once both clients are connected to the same server, they will push topic messages to each other, and the messages are forwarded between devices through the server. Before the MQTT application demonstration, please get a brief understanding of the process for implementing an MQTT client application with QuecPython in the following diagram. @@ -226,14 +226,14 @@ The module uses `umqtt` of QuecPython to set up the MQTT Client B, connects to 1. **Downlaod QuecPython Firmware**: Depending on your module model, flash the QuecPython firmware into your device. 2. **Connect to the Network**: Ensure that your device is properly connected to the network. -After downloading the firmware, you need to check whether the current firmware includes the `umqtt` module and check the network status. You can use [QPYcom](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html) for debugging. The demonstration in this document is performed with this tool. On the interactive page of QPYcom, you can confirm whether the module contains and uses APIs to check the network status by importing the feature. In Python syntax, you can import APIs with `import xxx` or `from xx import xxx`. +After downloading the firmware, you need to check whether the current firmware includes the `umqtt` module and check the network status. You can use [QPYcom](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html) for debugging. The demonstration in this document is performed with this tool. On the interactive page of QPYcom, you can confirm whether the module contains and uses APIs to check the network status by importing the feature. In Python syntax, you can import APIs with `import xxx` or `from xx import xxx`. ```python # Inclueded if no exception occurs import umqtt ``` -You can import the `checkNet` API to query the network status of the device. The status values are available in the [wiki](https://python.quectel.com/doc/API_reference/en/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E). +You can import the `checkNet` API to query the network status of the device. The status values are available in the [wiki](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E). ```python import checkNet diff --git a/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md b/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md index 3933857465bdb6982396ad6092866f18970d36c6..db31fdf34685fabc7f04de51fc43fbc62f0f4b15 100644 --- a/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md +++ b/docs/Application_guide/en/network-comm/net-protocols/tcp-udp.md @@ -98,7 +98,7 @@ The five-tuple that determines a TCP connection: protocol type (TCP), local IP, ## Socket Programming -QuecPython provides the `usocket` feature for socket programming for network communication. For the usage of the `usocket` , [click here](https://python.quectel.com/doc/API_reference/en/stdlib/usocket.html). +QuecPython provides the `usocket` feature for socket programming for network communication. For the usage of the `usocket` , [click here](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/usocket.html). This section is divided into three parts: TCP network programming, UDP network programming, and multi-NIC network programming. @@ -516,7 +516,7 @@ The above code calls `dataCall.getInfo()` to get the IP address of the module. `server_addr = dataCall.getInfo(1, 0)[2][2]` in the code means to get the IPv4 address of connection 1 as the local server IP address. > - QuecPython-supported cellular communication modules will automatically establish the first cellular data connection after power-on. -> - [Click here](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html) for more information about cellular data connection-related interface usage. +> - [Click here](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html) for more information about cellular data connection-related interface usage. > - [Click here to download the complete code in github](https://github.com/QuecPython/examples/blob/main/network-comm/net-protocols/tcp-udp/example_tcp_server_and_client.py) The running result of this sample code is as follows: @@ -768,7 +768,7 @@ eth.set_up() print('Ethernet nic enabled.') ``` -> - [Click here](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) to view the usage of Ethernet-related interfaces. +> - [Click here](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) to view the usage of Ethernet-related interfaces. > - For more NIC programming application notes, please refer to the relevant documentation. #### Wi-Fi NIC @@ -865,7 +865,7 @@ wifi.set_default_NIC(ip_conf[0]) print('Wi-Fi is set as default NIC.') ``` -> - [Click here](https://python.quectel.com/doc/API_reference/en/wifilib/index.html) to view the usage of the Wi-Fi NIC-related interfaces. +> - [Click here](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/index.html) to view the usage of the Wi-Fi NIC-related interfaces. > - For more Wi-Fi NIC programming application notes, please refer to the relevant documentation. ## FAQs diff --git a/docs/Application_guide/en/network-comm/nic/cellular/FAQ.md b/docs/Application_guide/en/network-comm/nic/cellular/FAQ.md index bcc2c1e97656fc8e6d3945331d31c8de38a4d3b3..cb92f129210579fff72138a31933b13087e0048f 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/FAQ.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/FAQ.md @@ -62,7 +62,7 @@ You can confirm the APN information by contacting your carrier. - **How to Configure the Network Attach APN** - The APN can be configured using the `dataCall.setPDPContext` interface, with the `profileID` parameter set to 1. For detailed instructions on using this interface, please refer to the [APN Configuration and Retrieval Functionality](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) section of the QuecPython official WIKI. + The APN can be configured using the `dataCall.setPDPContext` interface, with the `profileID` parameter set to 1. For detailed instructions on using this interface, please refer to the [APN Configuration and Retrieval Functionality](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) section of the QuecPython official WIKI. - **Is a Reboot Required After Configuration?** diff --git a/docs/Application_guide/en/network-comm/nic/cellular/api-instruction.md b/docs/Application_guide/en/network-comm/nic/cellular/api-instruction.md index 2b63e9b3dcb0815ed3cd05cd4c1232a631c88e2b..afdcba3c70df9eec220cc6dc07d12eb6a20312bf 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/api-instruction.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/api-instruction.md @@ -4,7 +4,7 @@ This document introduces APIs that are required in various user scenarios and pr ## Get/Set Module Work Mode -Device work modes refer to the functionality modes of mobile terminals, also known as CFUN states. QuecPython supports setting and getting the work mode of the module. Please refer to [Work Mode Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Work-Mode-Configuration) in the wiki on the QuecPython official website for details. +Device work modes refer to the functionality modes of mobile terminals, also known as CFUN states. QuecPython supports setting and getting the work mode of the module. Please refer to [Work Mode Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Work-Mode-Configuration) in the wiki on the QuecPython official website for details. ### Get the Module Work Mode @@ -12,7 +12,7 @@ Device work modes refer to the functionality modes of mobile terminals, also kno net.getModemFun() ``` -Referring to the [CFUN](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/common-concepts.html#CFUN) section in the introduction to cellular network basics, the module has three work modes. Only when the module is in mode 1 (full functionality), can it communicate with the cellular network. +Referring to the [CFUN](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/common-concepts.html#CFUN) section in the introduction to cellular network basics, the module has three work modes. Only when the module is in mode 1 (full functionality), can it communicate with the cellular network. ### Set the Module Work Mode @@ -38,7 +38,7 @@ You can call the above functions to get and set the module's work mode in the fo ## Get/Set Network Interface Card (NIC) Parameters -NIC parameters include IP protocol type, APN, username, password, and APN authentication method. QuecPython supports setting and getting the parameters of the cellular NIC. Please refer to [APN Configuration and Retrieval](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) in the wiki on the QuecPython official website for details. +NIC parameters include IP protocol type, APN, username, password, and APN authentication method. QuecPython supports setting and getting the parameters of the cellular NIC. Please refer to [APN Configuration and Retrieval](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) in the wiki on the QuecPython official website for details. ### Get NIC Parameters @@ -64,19 +64,19 @@ You can call the above functions to get and set the parameters of the NIC in the For how to configure APN, please refer to the following sections in the *Scenario Instructions* chapter, which provide detailed APN configuration examples: -* [Automatically Activate One NIC at Startup and Configure APN](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-One-NIC-at-Startup-and-Configure-APN) +* [Automatically Activate One NIC at Startup and Configure APN](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-One-NIC-at-Startup-and-Configure-APN) -* [Automatically Activate Multiple NICs at Startup and Configure APN](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-Multiple-NICs-at-Startup-and-Configure-APN) +* [Automatically Activate Multiple NICs at Startup and Configure APN](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-Multiple-NICs-at-Startup-and-Configure-APN) -* [Manually Activate One NIC](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) +* [Manually Activate One NIC](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) -* [Manually Activate Multiple NICs](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) +* [Manually Activate Multiple NICs](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) ## Activate/Deactivate NICs -QuecPython supports manual activation and deactivation of cellular NICs. Please refer to [Activation and Deactivation](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Activation-and-Deactivation) in the wiki on the QuecPython official website for details. +QuecPython supports manual activation and deactivation of cellular NICs. Please refer to [Activation and Deactivation](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Activation-and-Deactivation) in the wiki on the QuecPython official website for details. ### Activate NIC @@ -98,14 +98,14 @@ If you disable the automatic activation of cellular NICs at startup and set a pr For how to manually activate NICs, please refer to the following sections in the *Scenario Instructions* chapter, which provide detailed APN configuration examples: -* [Manually Activate One NIC](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) -* [Manually Activate Multiple NICs](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) +* [Manually Activate One NIC](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) +* [Manually Activate Multiple NICs](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) ## Configure DNS -When the module activates the cellular NIC, if the activation is successful, the core network will automatically assign DNS server addresses to the module. In other words, under normal circumstances, you do not need to manually configure DNS server addresses. However, sometimes the DNS server addresses assigned by the core network may be unavailable, and in this case, you have to manually configure DNS server addresses. QuecPython supports manual DNS configuration. Please refer to [DNS Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#DNS-Configuration) in the wiki on the QuecPython official website for details. +When the module activates the cellular NIC, if the activation is successful, the core network will automatically assign DNS server addresses to the module. In other words, under normal circumstances, you do not need to manually configure DNS server addresses. However, sometimes the DNS server addresses assigned by the core network may be unavailable, and in this case, you have to manually configure DNS server addresses. QuecPython supports manual DNS configuration. Please refer to [DNS Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#DNS-Configuration) in the wiki on the QuecPython official website for details. ### Configure DNS @@ -121,7 +121,7 @@ Sometimes the DNS server addresses assigned by the core network may be unavailab ## Get NIC Status Information -QuecPython supports getting NIC status information, such as NIC activation status, IP address, and DNS server address. Please refer to [Cellular Network Channel Establishment Information](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Cellular-Network-Channel-Establishment-Information) in the wiki on the QuecPython official website for details. +QuecPython supports getting NIC status information, such as NIC activation status, IP address, and DNS server address. Please refer to [Cellular Network Channel Establishment Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Cellular-Network-Channel-Establishment-Information) in the wiki on the QuecPython official website for details. ### Get NIC Status Information @@ -145,7 +145,7 @@ It is necessary for you to get NIC status information. Regardless of the applica ## Automatically Activate NIC at Startup -By default, QuecPython modules automatically activate the first cellular NIC at startup, and the IP protocol type used is IPv4 with APN address, username and password empty. You can configure the automatic activation of any one or multiple cellular NICs at startup by calling *dataCall.setAutoActivate()*. Please refer to [Establish the Cellular Network Channel Automatically at Startup](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Establish-the-Cellular-Network-Channel-Automatically-at-Startup) in the wiki on the QuecPython official website for details. +By default, QuecPython modules automatically activate the first cellular NIC at startup, and the IP protocol type used is IPv4 with APN address, username and password empty. You can configure the automatic activation of any one or multiple cellular NICs at startup by calling *dataCall.setAutoActivate()*. Please refer to [Establish the Cellular Network Channel Automatically at Startup](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Establish-the-Cellular-Network-Channel-Automatically-at-Startup) in the wiki on the QuecPython official website for details. ### Set Whether to Automatically Activate NIC at Startup @@ -172,7 +172,7 @@ You can call the above function to set whether to automatically activate an NIC ## Set Automatic Reconnection of NIC -By default, QuecPython modules will enable the automatic reconnection for the first cellular NIC at startup. You can configure the automatic reconnection for any one or multiple cellular NICs by calling *dataCall.setAutoConnect()*. Please refer to [Automatic Reconnection](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Automatic-Reconnection) in the wiki on the QuecPython official website for details. +By default, QuecPython modules will enable the automatic reconnection for the first cellular NIC at startup. You can configure the automatic reconnection for any one or multiple cellular NICs by calling *dataCall.setAutoConnect()*. Please refer to [Automatic Reconnection](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Automatic-Reconnection) in the wiki on the QuecPython official website for details. It is recommended not to disable the automatic reconnection of the NIC unless there are special requirements. @@ -196,7 +196,7 @@ You can call the above function to set whether the NIC automatically reconnects ## Network Event Listening -QuecPython provides APIs for users to listen to network state change events. The specific approach is to allow users to register callback functions. When the connection status to the network changes, the system will notify the current network connection status through the user's registered callback function. Please refer to [Register Callback Function](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Register-Callback-Function) in the wiki on the QuecPython official website for details. +QuecPython provides APIs for users to listen to network state change events. The specific approach is to allow users to register callback functions. When the connection status to the network changes, the system will notify the current network connection status through the user's registered callback function. Please refer to [Register Callback Function](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Register-Callback-Function) in the wiki on the QuecPython official website for details. ### Register Callback Function @@ -210,13 +210,13 @@ In practical use, due to various reasons (such as network exception, environment For how to use network event listening to handle network exceptions, please refer to the following section in the *Handle Network Exceptions* chapter: -* [Example of Handling Network Exception Events](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Example-of-Handling-Network-Exception-Events) +* [Example of Handling Network Exception Events](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Example-of-Handling-Network-Exception-Events) ## Get Signal Strength -QuecPython provides APIs to obtain parameters such as signal strength and signal quality. These parameters can help you determine the signal strength and signal quality of the current device's environment. The commonly used parameters include CSQ, RSSI, SINR, RSRP, and RSRQ. It is recommended to read the [Signal Quality](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/common-concepts.html#Signal-Quality) section in the *Basic Concepts of Cellular Network* chapter together. Please refer to [Get Signal Strength](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Signal-Strength) and [Get Detailed Signal Strength](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) in the wiki on the QuecPython official website for details. +QuecPython provides APIs to obtain parameters such as signal strength and signal quality. These parameters can help you determine the signal strength and signal quality of the current device's environment. The commonly used parameters include CSQ, RSSI, SINR, RSRP, and RSRQ. It is recommended to read the [Signal Quality](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/common-concepts.html#Signal-Quality) section in the *Basic Concepts of Cellular Network* chapter together. Please refer to [Get Signal Strength](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Signal-Strength) and [Get Detailed Signal Strength](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) in the wiki on the QuecPython official website for details. ### Query Signal Strength and Quality @@ -254,7 +254,7 @@ You may need to query signal strength and quality in the following scenarios: ## Get Cell Information -QuecPython provides APIs to get information about the current serving cell and neighboring cells. Cell information includes cell type (serving cell or neighboring cell), CID, MCC/MNC, ARFCN and physical cell identity. Please refer to [Get Cell Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Cell-Information) in the wiki on the QuecPython official website for details. +QuecPython provides APIs to get information about the current serving cell and neighboring cells. Cell information includes cell type (serving cell or neighboring cell), CID, MCC/MNC, ARFCN and physical cell identity. Please refer to [Get Cell Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Cell-Information) in the wiki on the QuecPython official website for details. ### Get Cell Information @@ -276,7 +276,7 @@ You may need to get the cell information in the following scenarios: ## Get/Set Cellular Network Mode -QuecPython supports various module models, some of which only support LTE, some support GSM and LTE, and some support GSM, WCDMA, and LTE. You can get and set the network modes of the module by calling corresponding APIs. Please refer to [Network Mode and Roaming Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration) in the wiki on the QuecPython official website for details. +QuecPython supports various module models, some of which only support LTE, some support GSM and LTE, and some support GSM, WCDMA, and LTE. You can get and set the network modes of the module by calling corresponding APIs. Please refer to [Network Mode and Roaming Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration) in the wiki on the QuecPython official website for details. ### Get Network Mode @@ -292,7 +292,7 @@ net.setConfig(mode [, roaming]) The first parameter of this function is the network mode you want to set. The second parameter is whether to enable roaming, which is an optional parameter that generally does not need to be set. -From the return value of `net.getConfig()` in [Network Mode and Roaming Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration), you can see that there are many configurable network modes, either single mode or a combination of multiple modes. The following points need to be clarified: +From the return value of `net.getConfig()` in [Network Mode and Roaming Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration), you can see that there are many configurable network modes, either single mode or a combination of multiple modes. The following points need to be clarified: * Although many modes are listed in the return value of `net.getConfig()`, not all modules support these modes. For the specific network modes supported by each module model, please refer to the corresponding module specification. @@ -313,7 +313,7 @@ You may need to set the network modes of the module in the following scenarios: ## Cellular Network Technology -As mentioned earlier, some modules support multiple network modes. When the default network mode of a module is set to a combination of multiple network modes, it is important to determine which network the module will register on. By getting the current network technology of the module, you can determine which network mode is currently used. QuecPython provides relevant APIs to get the current network technology of the module. Please refer to [Get Network Configuration Mode](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Configuration-Mode) in the wiki on the QuecPython official website for details. +As mentioned earlier, some modules support multiple network modes. When the default network mode of a module is set to a combination of multiple network modes, it is important to determine which network the module will register on. By getting the current network technology of the module, you can determine which network mode is currently used. QuecPython provides relevant APIs to get the current network technology of the module. Please refer to [Get Network Configuration Mode](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Configuration-Mode) in the wiki on the QuecPython official website for details. ### Get Network Technology @@ -329,7 +329,7 @@ The main application scenario is to determine the specific network that the modu ## Get Operator Information -Operator information refers to the information of the operator to which the currently connected cell belongs, including the operator name, MCC, and MNC. QuecPython provides an API to get the operator information. Please refer to [Get Operator Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Operator-Information) in the wiki on the QuecPython official website for details. +Operator information refers to the information of the operator to which the currently connected cell belongs, including the operator name, MCC, and MNC. QuecPython provides an API to get the operator information. Please refer to [Get Operator Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Operator-Information) in the wiki on the QuecPython official website for details. ### Get Operator Information @@ -347,7 +347,7 @@ As mentioned above, this function is used to get the operator information of the ## Get Device Network Registration Status -The cellular network registration status of a device is a very important parameter because a successful network registration is required for the activation of a cellular NIC. QuecPython provides an API to query the network registration status of the device. Please refer to [Get Network Registration Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Registration-Information) in the wiki on the QuecPython official website for details. +The cellular network registration status of a device is a very important parameter because a successful network registration is required for the activation of a cellular NIC. QuecPython provides an API to query the network registration status of the device. Please refer to [Get Network Registration Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Registration-Information) in the wiki on the QuecPython official website for details. ### Get Device Registration Status @@ -365,7 +365,7 @@ Under normal circumstances, you do not need to get the registration status of th ## Set and Get Band -QuecPython modules generally support multiple bands, and by default, all supported bands are enabled. QuecPython provides APIs to get and set the bands currently supported by the module. Please refer to [Set and Get Band](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Set-and-Get-Band) in the wiki on the QuecPython official website for details. +QuecPython modules generally support multiple bands, and by default, all supported bands are enabled. QuecPython provides APIs to get and set the bands currently supported by the module. Please refer to [Set and Get Band](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Set-and-Get-Band) in the wiki on the QuecPython official website for details. > Currently, only the BG95 series module and EG912N-ENAA module support the following APIs. diff --git a/docs/Application_guide/en/network-comm/nic/cellular/application.md b/docs/Application_guide/en/network-comm/nic/cellular/application.md index 28b85911e1081febe2063fbe16a40d49346a79dd..37b8ca3dcf47df50b273ec2f80379872e01d0927 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/application.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/application.md @@ -678,7 +678,7 @@ You can call the following function to configure the server address of the speci dataCall.setDNSServer(profileID, simID, priDNS, secDNS) ``` -Please refer to [DNS Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#DNS-Configuration) in the wiki on the QuecPython official website for details. +Please refer to [DNS Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#DNS-Configuration) in the wiki on the QuecPython official website for details. Parameter description: diff --git a/docs/Application_guide/en/network-comm/nic/cellular/common-concepts.md b/docs/Application_guide/en/network-comm/nic/cellular/common-concepts.md index 61d08632a27699378a9ff29c1f8add8557f53bda..7e859e9f43bfa0cb6844338325b85c717ed3ec6f 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/common-concepts.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/common-concepts.md @@ -12,17 +12,17 @@ All operators use specific APNs (Access Point Names), which are usually pre-conf For APN configuration interface description, please refer to the following sections: -[APN configuration interface description](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) +[APN configuration interface description](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#APN-Configuration-and-Retrieval) APN configuration example: -* [Automatically Activate One NIC at Startup and Configure APN](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-One-NIC-at-Startup-and-Configure-APN) +* [Automatically Activate One NIC at Startup and Configure APN](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-One-NIC-at-Startup-and-Configure-APN) -* [Automatically Activate Multiple NICs at Startup and Configure APN](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-Multiple-NICs-at-Startup-and-Configure-APN) +* [Automatically Activate Multiple NICs at Startup and Configure APN](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Automatically-Activate-Multiple-NICs-at-Startup-and-Configure-APN) -* [Manually Activate One NIC](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) +* [Manually Activate One NIC](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-One-NIC) -* [Manually Activate Multiple NICs](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) +* [Manually Activate Multiple NICs](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/application.html#Manually-Activate-Multiple-NICs) ### Confirm Which APN to Use @@ -72,17 +72,17 @@ For a UE, cells are divided into serving cells and neighboring cells. In cellular mobile networks, signal quality is determined by different measurement values, not a single value of a parameter. The parameters used to measure signal quality and their ranges generally vary in different network modes. Here are some common measurement values: -* [RSSI](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) +* [RSSI](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) -* [CSQ](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Signal-Strength) +* [CSQ](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Signal-Strength) -* [RSRP](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) +* [RSRP](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) -* [RSRQ](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) +* [RSRQ](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) -* [RSCP](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) +* [RSCP](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) -* [SINR](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) +* [SINR](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) ### Factors Affecting Signal Quality @@ -110,7 +110,7 @@ When measuring signal strength and signal quality, high signal strength values o ### RSSI -[RSSI](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Received Signal Strength Indicator) refers to the total power (in dBm) of all received signals, including pilot signals, data signals, neighboring interference signals, and background noise signals. The parameter range of RSSI varies in different network modes, but a larger value indicates better signal strength. +[RSSI](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Received Signal Strength Indicator) refers to the total power (in dBm) of all received signals, including pilot signals, data signals, neighboring interference signals, and background noise signals. The parameter range of RSSI varies in different network modes, but a larger value indicates better signal strength. RSSI is usually a relative value, and its measurement is highly dependent on the receiving device. Therefore, the measurement standards for RSSI may not be completely uniform for different devices. The RSSI measurement standards provided below are for reference only: @@ -128,7 +128,7 @@ RSSI is usually a relative value, and its measurement is highly dependent on the ### CSQ -[CSQ](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#%3Ccode%3Enet.csqQueryPoll%3C/code%3E) (Carrier Signal Quality) refers to the signal strength, used to indicate RSSI level. Range: 0 – 31. Larger values indicate better signal strength. If the CSQ value is less than 6, the terminal may have difficulty establishing network communication. There is a corresponding relationship between CSQ and RSSI: +[CSQ](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#%3Ccode%3Enet.csqQueryPoll%3C/code%3E) (Carrier Signal Quality) refers to the signal strength, used to indicate RSSI level. Range: 0 – 31. Larger values indicate better signal strength. If the CSQ value is less than 6, the terminal may have difficulty establishing network communication. There is a corresponding relationship between CSQ and RSSI: $$ CSQ = (RSSI + 113) / 2 $$ @@ -145,7 +145,7 @@ $$ ### RSRP -[RSRP](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Reference Signal Received Power) refers to the received power of reference signals. It is the average power of the signals received on all REs (resource elements) carrying reference signals in a symbol. It reflects the path loss intensity in the current channel and is used for cell coverage measurements, cell selection, and re-selection. Range: -140 dBm to -44 dBm. Larger values indicate better signal strength. +[RSRP](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Reference Signal Received Power) refers to the received power of reference signals. It is the average power of the signals received on all REs (resource elements) carrying reference signals in a symbol. It reflects the path loss intensity in the current channel and is used for cell coverage measurements, cell selection, and re-selection. Range: -140 dBm to -44 dBm. Larger values indicate better signal strength. Please note that RSRP is a concept introduced in LTE, so it is used to measure LTE network signal strength, equivalent to RSCP in WCDMA networks. The following RSRP standards are for reference only: @@ -162,7 +162,7 @@ Please note that RSRP is a concept introduced in LTE, so it is used to measure L ### RSRQ -[RSRQ](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Reference Signal Received Quality) refers to the quality of the received reference signals. It reflects the signal-to-noise ratio and interference levels of the current channel. Range: -20 dB to -3 dB. Larger values indicate better signal strength. RSRQ is a concept introduced in LTE, so it is used to measure LTE network signal strength +[RSRQ](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Reference Signal Received Quality) refers to the quality of the received reference signals. It reflects the signal-to-noise ratio and interference levels of the current channel. Range: -20 dB to -3 dB. Larger values indicate better signal strength. RSRQ is a concept introduced in LTE, so it is used to measure LTE network signal strength RSRQ is the ratio of RSRP to RSSI, but adjusted by a coefficient since their measurements may be based on different bandwidths, i.e. RSRQ = N*RSRP/RSSI. @@ -177,7 +177,7 @@ The following RSRQ standards are for reference only: ### RSCP -[RSCP](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Receive Signal Code Power) refers to the received power of the code signals. It is a concept in UMTS networks and represents the power measured on a specific physical channel by the receiver. It is used as an indication of signal strength, handover criteria, and path loss calculation in downlink power control. Range: -120 dBm to -25 dBm. Larger values indicate better signal strength. +[RSCP](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Receive Signal Code Power) refers to the received power of the code signals. It is a concept in UMTS networks and represents the power measured on a specific physical channel by the receiver. It is used as an indication of signal strength, handover criteria, and path loss calculation in downlink power control. Range: -120 dBm to -25 dBm. Larger values indicate better signal strength. The following RSCP standards are for reference only: @@ -193,7 +193,7 @@ The following RSCP standards are for reference only: ### SINR -[SINR](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Signal to Interference plus Noise Ratio) refers to the ratio of the received useful signal strength to the received interference signal strength. It is an important parameter for measuring signal quality in mobile network communication. Range: -10 dB to 40 dB. +[SINR](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Detailed-Signal-Strength) (Signal to Interference plus Noise Ratio) refers to the ratio of the received useful signal strength to the received interference signal strength. It is an important parameter for measuring signal quality in mobile network communication. Range: -10 dB to 40 dB. The following SINR standards are for reference only: @@ -211,13 +211,13 @@ The following SINR standards are for reference only: In mobile communication, a band refers to a frequency band, which is a specific range of frequencies in the radio spectrum. Each band consists of a certain frequency range and bandwidth. The radio spectrum is a limited and valuable resource that needs to be shared among various wireless communication services worldwide. To ensure harmonious coexistence and avoid interference between different services, the International Telecommunication Union (ITU) and telecom authorities divide the radio spectrum into multiple bands, each assigned to one or more specific services. These communication bands are usually numbered, such as Band 1, Band 2, Band 3, etc. -Different frequency bands have different transmission characteristics. For example, signals in lower frequency bands can penetrate buildings better, while signals in higher frequency bands are more suitable for transmission in open areas or line-of-sight conditions. Therefore, network operators need to balance and decide which bands to support in order to optimize network coverage and capacity. Users can refer to Part [Set and Get Band](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Set-and-Get-Band) of the QuecPython wiki documentation to set and query the band of the module. +Different frequency bands have different transmission characteristics. For example, signals in lower frequency bands can penetrate buildings better, while signals in higher frequency bands are more suitable for transmission in open areas or line-of-sight conditions. Therefore, network operators need to balance and decide which bands to support in order to optimize network coverage and capacity. Users can refer to Part [Set and Get Band](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Set-and-Get-Band) of the QuecPython wiki documentation to set and query the band of the module. ## Network Mode -Network mode, also called radio access technology (RAT), refers to the wireless technology for devices to connect to the network. Technologies like GSM, GPRS, WCDMA, CDMA2000 and LTE are network modes. Users can refer to Part [Network Mode and Roaming Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration) of the QuecPython wiki documentation to set and query the network mode of the module. +Network mode, also called radio access technology (RAT), refers to the wireless technology for devices to connect to the network. Technologies like GSM, GPRS, WCDMA, CDMA2000 and LTE are network modes. Users can refer to Part [Network Mode and Roaming Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Network-Mode-and-Roaming-Configuration) of the QuecPython wiki documentation to set and query the network mode of the module. @@ -229,7 +229,7 @@ For example: COMPACT is an optimization technology for GSM networks. It improves the spectrum efficiency and capacity of the network by changing the processing of control channels. Therefore, it is classified as a GSM network technology. -EMTC (Enhanced Machine-Type Communication) is an LTE technology aimed at improving network support for a large number of low-power devices. Therefore, it is classified as an LTE network technology. Users can refer to Part [Get Network Configuration Mode](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Configuration-Mode) of the QuecPython wiki documentation to query the network technology of the module. +EMTC (Enhanced Machine-Type Communication) is an LTE technology aimed at improving network support for a large number of low-power devices. Therefore, it is classified as an LTE network technology. Users can refer to Part [Get Network Configuration Mode](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Configuration-Mode) of the QuecPython wiki documentation to query the network technology of the module. @@ -249,4 +249,4 @@ In an LTE network, bearers are generally divided into default bearers and dedica Base station time usually refers to the internal clock of a wireless base station, which provides an accurate time reference for the mobile communication network. In a wireless communication system, sending and receiving data needs to be done within precise time windows. For example, data transmission needs to be synchronized with the base station's time accurately, otherwise, data loss or errors may occur. Therefore, base stations need a precise internal clock to control these time-sensitive operations. -In addition, base station time is commonly used for automatic time calibration of mobile devices, especially when devices move between different time zones. This process is achieved through Network Identity and Time Zone (NITZ). Users can refer to Part [Get Current Base Station Time](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Current-Base-Station-Time) of the QuecPython wiki documentation to query the base station time. \ No newline at end of file +In addition, base station time is commonly used for automatic time calibration of mobile devices, especially when devices move between different time zones. This process is achieved through Network Identity and Time Zone (NITZ). Users can refer to Part [Get Current Base Station Time](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Current-Base-Station-Time) of the QuecPython wiki documentation to query the base station time. \ No newline at end of file diff --git a/docs/Application_guide/en/network-comm/nic/cellular/initialization.md b/docs/Application_guide/en/network-comm/nic/cellular/initialization.md index 2824fa13fe336af3cadb86e1f55045e5fdfb3e3f..4fb3625bcc263eacb60f8af860a76860c4b0359e 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/initialization.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/initialization.md @@ -43,7 +43,7 @@ Step 3: Send the AT query command to check the network registration status. **Method 2: QuecPython API** -You can call `net.getState` to query the network registration status of the UE. Please refer to [Get Network Registration Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Registration-Information) in the "API Reference" on the QuecPython official website for details. +You can call `net.getState` to query the network registration status of the UE. Please refer to [Get Network Registration Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Registration-Information) in the "API Reference" on the QuecPython official website for details. Step 1: Connect the terminal device to the computer's USB port using a USB cable. @@ -64,13 +64,13 @@ When the parameter indicated by the red box in the figure in the return value of > If the module fails to register on a network, please refer to the following section in the "*Handle Network Exceptions*" chapter for troubleshooting: > -> * [Module Network Registration Failure](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) +> * [Module Network Registration Failure](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) ## NIC Activation The cellular NIC will be activated after the UE successfully registers on the network. Only when the cellular NIC is activated successfully can the UE obtain the IP address and other information allocated by the core network and create a virtual NIC for the TCP/IP protocol stack. Only when the virtual NIC is created and activated successfully can network services such as sockets, HTTP, and MQTT be performed. This step corresponds to the "Activate NIC" step in the above flowchart. -You can call `dataCall.getInfo()` of the `dataCall` feature to check whether the NIC is activated successfully. Please refer to [Cellular Network Channel Establishment Information](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Cellular-Network-Channel-Establishment-Information) in the "API Reference" on the QuecPython official website for details. +You can call `dataCall.getInfo()` of the `dataCall` feature to check whether the NIC is activated successfully. Please refer to [Cellular Network Channel Establishment Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Cellular-Network-Channel-Establishment-Information) in the "API Reference" on the QuecPython official website for details. Query method: @@ -86,4 +86,4 @@ When the return value of the `dataCall.getInfo()` method indicates that the NIC > If the module fails to activate the NIC, please refer to the following section in the "*Handle Network Exceptions*" chapter for troubleshooting: > -> * [Handle Network Exceptions](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Handle-Network-Exceptions) \ No newline at end of file +> * [Handle Network Exceptions](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Handle-Network-Exceptions) \ No newline at end of file diff --git a/docs/Application_guide/en/network-comm/nic/cellular/mechanism.md b/docs/Application_guide/en/network-comm/nic/cellular/mechanism.md index fd48c8f2370c4e1bc4551e104fb84ed017478662..aa1cfe8171078c86a01870d4a7a8ba64ba3a80f1 100644 --- a/docs/Application_guide/en/network-comm/nic/cellular/mechanism.md +++ b/docs/Application_guide/en/network-comm/nic/cellular/mechanism.md @@ -124,7 +124,7 @@ dataCall.setPDPContext(profileID, ipType, apn, username, password, authType) ## checkNet Mechanism -`checkNet` is a feature provided by QuecPython. This feature is mainly used to check whether the network is ready. Please refer to [checkNet - Network Detection](https://python.quectel.com/doc/API_reference/en/iotlib/checkNet.html) in the "API Reference" on the QuecPython official website for details. +`checkNet` is a feature provided by QuecPython. This feature is mainly used to check whether the network is ready. Please refer to [checkNet - Network Detection](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/checkNet.html) in the "API Reference" on the QuecPython official website for details. **Scenarios for Using `checkNet`** @@ -166,7 +166,7 @@ Call the following method to register the network status callback function. dataCall.setCallback(fun) ``` -Please refer to [Register Callback Function](https://python.quectel.com/doc/API_reference/en/iotlib/dataCall.html#Register-Callback-Function) in the "API Reference" on the QuecPython official website for details. +Please refer to [Register Callback Function](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/dataCall.html#Register-Callback-Function) in the "API Reference" on the QuecPython official website for details. Example of the callback function: @@ -224,7 +224,7 @@ if __name__ == '__main__': main() ``` -The above example aims to give you an intuitive understanding of QuecPython's network event listening feature. If you need to use this feature in actual projects, please refer to the [*Example of Handling Network Exception Events*](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Example-of-Handling-Network-Exception-Events). +The above example aims to give you an intuitive understanding of QuecPython's network event listening feature. If you need to use this feature in actual projects, please refer to the [*Example of Handling Network Exception Events*](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Example-of-Handling-Network-Exception-Events). diff --git a/docs/Application_guide/en/network-comm/nic/ethernet/README.md b/docs/Application_guide/en/network-comm/nic/ethernet/README.md index 8804bb87ebb0abb9e805afae625703090860e726..29393e4adc0245842c4b3bd82923aff30ff0ddce 100644 --- a/docs/Application_guide/en/network-comm/nic/ethernet/README.md +++ b/docs/Application_guide/en/network-comm/nic/ethernet/README.md @@ -118,7 +118,7 @@ When the working mode of the Ethernet NIC is configured to LAN mode, the NIC act ### Supported Interface on Module Models -The table below shows the support for SPI-Ethernet and RMII-PHY interfaces on different module models. The supported Ethernet NIC models vary with different platforms. Please refer to [ethernet-Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) in the "API Reference" on the QuecPython official website for details. +The table below shows the support for SPI-Ethernet and RMII-PHY interfaces on different module models. The supported Ethernet NIC models vary with different platforms. Please refer to [ethernet-Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) in the "API Reference" on the QuecPython official website for details. | Model\Interface Type | SPI-ETHERNET | RMII-PHY | | :-: | :-: | :-: | @@ -142,7 +142,7 @@ The Ethernet interface calling process is shown in the following diagram: ### Select an Ethernet NIC -Ethernet NICs are all included in the "Ethernet" feature. The loading methods of different types of NICs and the loading parameters of each module are different. Please refer to [ethernet-Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) in the "API Reference" on the QuecPython official website for details. +Ethernet NICs are all included in the "Ethernet" feature. The loading methods of different types of NICs and the loading parameters of each module are different. Please refer to [ethernet-Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) in the "API Reference" on the QuecPython official website for details. Loading methods of each Ethernet NIC: @@ -179,10 +179,10 @@ The loading rules for different models are the same, and only the parameters are | `ip` | The IP address of the Ethernet NIC. If the value is an empty string '', the default value `192.168.1.100` will be used. | All models | Used to initialize and configure the NIC IP information | | `subnet` | The subnet mask address of the Ethernet NIC. If the value is an empty string '', the default value `255.255.255.0` will be used. | All models | Used to initialize and configure the NIC IP information | | `gateway` | The gateway address of the Ethernet NIC. If the value is an empty string '', the last bit of the parameter **`ip`** will be replaced with `1` to form the gateway address. | All models | Used to initialize and configure the NIC IP information | -| `spi_port` | [SPI port](https://python.quectel.com/doc/API_reference/en/peripherals/machine.SPI.html) number. The default value is `-1`, which means the last configured value is used. The default configuration in the program is `SPI1` | W5500/DM9051/CH395 | The SPI port number can be configured for all SPI-Ethernet interfaces. The SPI port for RMII-PHY interfaces is fixed and does not need to be configured. | -| `spi_cs_pin` | SPI CS [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/DM9051/CH395 | The SPI CS GPIO pin can be configured for all SPI-Ethernet interfaces. The SPI CS GPIO pin for RMII-PHY interfaces is fixed and does not need to be configured. | -| `extint_pin` | External interrupt [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/CH395 | The external interrupt [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) cannot be configured for DM9051.
The external interrupt [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) is fixed for YT8512/SZ18201/JL1101 RMII-PHY interface and cannot be changed. | -| `reset_pin` | Reset [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/CH395 | The reset [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) cannot be configured for DM9051.

The reset [GPIO pin](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) is fixed for YT8512/SZ18201/JL1101 RMII-PHY interface and cannot be changed. | +| `spi_port` | [SPI port](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.SPI.html) number. The default value is `-1`, which means the last configured value is used. The default configuration in the program is `SPI1` | W5500/DM9051/CH395 | The SPI port number can be configured for all SPI-Ethernet interfaces. The SPI port for RMII-PHY interfaces is fixed and does not need to be configured. | +| `spi_cs_pin` | SPI CS [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/DM9051/CH395 | The SPI CS GPIO pin can be configured for all SPI-Ethernet interfaces. The SPI CS GPIO pin for RMII-PHY interfaces is fixed and does not need to be configured. | +| `extint_pin` | External interrupt [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/CH395 | The external interrupt [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) cannot be configured for DM9051.
The external interrupt [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) is fixed for YT8512/SZ18201/JL1101 RMII-PHY interface and cannot be changed. | +| `reset_pin` | Reset [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html). The default value is `-1`, which means the last configured value is used. Please refer to the corresponding model section in the [ethernet-Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) chapter for the default configuration in the program. | W5500/CH395 | The reset [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) cannot be configured for DM9051.

The reset [GPIO pin](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) is fixed for YT8512/SZ18201/JL1101 RMII-PHY interface and cannot be changed. | | `work_mode` | Ethernet NIC working mode. `0`: WAN mode. `1`: LAN mode. Default value: 0. In WAN mode, the module is connected to the network device as a terminal device for Internet access. In LAN mode, the module provides network access for external devices via `4G` as a gateway. | W5500/DM9051/CH395 | Ethernet NIC working mode cannot be configured for YT8512/SZ18201/JL1101. For these models, the default configuration for working mode is not limited. You can call the API to confirm the working mode. | ### Obtain Dynamic IP Address diff --git a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-lan-example.md b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-lan-example.md index 70ed4c96bf25b04834dff95b1673a62ab6535316..22358da8853116f87c74dc74f56afeaf43d1b692 100644 --- a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-lan-example.md +++ b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-lan-example.md @@ -6,7 +6,7 @@ When the W5500 NIC is configured as a gateway, it enables network forwarding to To use the external Ethernet feature, you need to prepare an external Ethernet NIC, cable, router, and DuPont wires. -Connect the module to the Ethernet NIC with DuPont wires according to your actual needs (Refer to [ethernet - Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) for specific interface configuration parameters), and then connect the Ethernet NIC to the router with a cable. +Connect the module to the Ethernet NIC with DuPont wires according to your actual needs (Refer to [ethernet - Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) for specific interface configuration parameters), and then connect the Ethernet NIC to the router with a cable. | Ethernet Chip Model | Ethernet Module Picture | Hardware Connection Picture | Chip Manual | Code Example | | ---- | ---- | ---- | ---- | ---- | diff --git a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md index a34e8956d8fb4fde7f017583e5eeae5ed1b8327a..ae2ae955db62b92ef8ac11be421260b6eca1b00e 100644 --- a/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md +++ b/docs/Application_guide/en/network-comm/nic/ethernet/ethernet-wan-example.md @@ -2,13 +2,13 @@ To connect the module to the network via the Ethernet NIC, you need to configure the Ethernet NIC working mode to WAN mode. For example, when the Ethernet NIC is connected to a router, the NIC can obtain IP information through DHCP and connect to the external network, enabling the module to connect to the network properly. -Please refer to [Getting Started](https://python.quectel.com/doc/Getting_started/en/) for setting up the development environment. This document introduces the use of Ethernet NIC. +Please refer to [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/) for setting up the development environment. This document introduces the use of Ethernet NIC. ## Hardware Preparation To use the external Ethernet feature, you need to prepare an external Ethernet NIC, cable, router, and DuPont wires. -Connect the module to the Ethernet NIC with DuPont wires according to your actual needs (Refer to [ethernet - Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html) for specific interface configuration parameters), and then connect the Ethernet NIC to the router with a cable. +Connect the module to the Ethernet NIC with DuPont wires according to your actual needs (Refer to [ethernet - Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html) for specific interface configuration parameters), and then connect the Ethernet NIC to the router with a cable. | Ethernet Chip Model | Ethernet Module Picture | Hardware Connection Picture | Chip Manual | Code Example | | ---- | ---- | ---- | ---- | ---- | @@ -26,7 +26,7 @@ Connect the module to the Ethernet NIC with DuPont wires according to your actua Ethernet NIC is not enabled by default and needs to be manually enabled. The following is the process of initializing the Ethernet NIC and obtaining IP information through DHCP for external communication. -The following example demonstrates the initialization process for the W5500 Ethernet NIC. For other Ethernet NICs, you can call the corresponding class in the [ethernet - Ethernet Driver](https://python.quectel.com/doc/API_reference/en/peripherals/ethernet.html). Please refer to the specific model class for parameter configuration. +The following example demonstrates the initialization process for the W5500 Ethernet NIC. For other Ethernet NICs, you can call the corresponding class in the [ethernet - Ethernet Driver](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/ethernet.html). Please refer to the specific model class for parameter configuration. ```python # First, import the ethernet package. @@ -181,4 +181,4 @@ if __name__ == '__main__': ## MQTT/HTTP Applications -To use an Ethernet NIC for MQTT/HTTP communication, it is necessary to configure the Ethernet NIC as the default NIC, as the built-in MQTT/HTTP module does not have the API for NIC binding. For specific MQTT/HTTP usage, please refer to [umqtt - MQTT Protocol](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html) and [request - HTTP Client](https://python.quectel.com/doc/API_reference/en/networklib/request.html) in the "API Reference" on the official website of QuecPython. \ No newline at end of file +To use an Ethernet NIC for MQTT/HTTP communication, it is necessary to configure the Ethernet NIC as the default NIC, as the built-in MQTT/HTTP module does not have the API for NIC binding. For specific MQTT/HTTP usage, please refer to [umqtt - MQTT Protocol](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html) and [request - HTTP Client](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/request.html) in the "API Reference" on the official website of QuecPython. \ No newline at end of file diff --git a/docs/Application_guide/en/network-comm/nic/usbnet/README.md b/docs/Application_guide/en/network-comm/nic/usbnet/README.md index 978321fb10bbd143ca2eea942cc33df9f32f36ec..2ec28a375a513ce93073f366c6924af8b40648da 100644 --- a/docs/Application_guide/en/network-comm/nic/usbnet/README.md +++ b/docs/Application_guide/en/network-comm/nic/usbnet/README.md @@ -164,11 +164,11 @@ USBNET.close() **2. When using the USB network adapter functionality on Unisoc 8910 modules, the computer cannot connect to the network after the first open in default ECM mode.** -> The USBNET of Unisoc 8910 modules requires NAT support. NAT is not enabled by default at boot and needs to be enabled before the USBNET can be used normally. Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki. For specific Unisoc 8910 modules, see [The Correspondence Between Platforms and Modules](https://python.quectel.com/doc/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). +> The USBNET of Unisoc 8910 modules requires NAT support. NAT is not enabled by default at boot and needs to be enabled before the USBNET can be used normally. Please refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki. For specific Unisoc 8910 modules, see [The Correspondence Between Platforms and Modules](https://developer.quectel.com/doc/quecpython/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). **3. For Unisoc 8850 modules, the module opens normally after the USB network adapter is set to RNDIS, but returns -1 when reopened.** -> NAT mode needs to be set. Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific usage. For specific Unisoc 8850 modules, see [The Correspondence Between Platforms and Modules](https://python.quectel.com/doc/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). +> NAT mode needs to be set. Please refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific usage. For specific Unisoc 8850 modules, see [The Correspondence Between Platforms and Modules](https://developer.quectel.com/doc/quecpython/Application_guide/en/background/hardware-platform.html#Unisoc-Platform). **4. Why doesn't my phone's status bar have the `<···>` icon, but the network can still be used?** diff --git a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-android-example.md b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-android-example.md index 0758603b6e160be2d39227cab7581f16e5d151c3..4431dd52690d79d0618422a27e31a35e6e2125ab 100644 --- a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-android-example.md +++ b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-android-example.md @@ -3,11 +3,11 @@ This section takes QuecPython EC200UEU_AB EVB as an example to demonstrate how to use a USB network adapter on an Android phone. > The ECM mode can be directly loaded and used in Linux, Android, or IOS without a driver. -> In ECM mode, the MAC address of some module models may not be recognized by the phone. In such cases, you can refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki and update the available MAC address with MAC configuration interface . +> In ECM mode, the MAC address of some module models may not be recognized by the phone. In such cases, you can refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki and update the available MAC address with MAC configuration interface . 1. Prepare the development environment - Please refer to the [Getting Started](https://python.quectel.com/doc/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. + Please refer to the [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. You will also need a mobile phone and a cable that can be converted into a mobile phone interface. 2. Open the QPYCOM tool and connect the device @@ -17,7 +17,7 @@ This section takes QuecPython EC200UEU_AB EVB as an example to demonstrate how t 3. Write a startup script for the USB network adapter - Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USB network adapter interface. + Please refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USB network adapter interface. Create a new file named `main.py` and enter the following content: ```python diff --git a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-linux-example.md b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-linux-example.md index 5d1360c6154db83cc4d8ba5f448bd3bd17cce2fc..fefbc418ef3cb24289d156e6af6982e58804f882 100644 --- a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-linux-example.md +++ b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-linux-example.md @@ -6,7 +6,7 @@ This section takes the QuecPython EC200UEU_AB EVB as an example to demonstrate t 1. Prepare the development environment - Please refer to the [Getting Started](https://python.quectel.com/doc/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. + Please refer to the [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. In this case, the Ubuntu version of the Linux system is used for testing. 2. Open the QPYCOM tool and connect the device @@ -16,7 +16,7 @@ This section takes the QuecPython EC200UEU_AB EVB as an example to demonstrate t 3. Write a startup script for the USB network adapter - Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USB network adapter interface. + Please refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USB network adapter interface. Create a new file named `main.py` and enter the following content: ```python diff --git a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-windows-example.md b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-windows-example.md index 0a133b7ee3494f8989ac24d337115fddc6cb8ba0..ebc586ce4f1d5474030794d79e871eb0ade5ce13 100644 --- a/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-windows-example.md +++ b/docs/Application_guide/en/network-comm/nic/usbnet/usbnet-windows-example.md @@ -6,7 +6,7 @@ This section takes the QuecPython EC200UEU_AB EVB as an example to demonstrate t 1. Prepare the development environment - Please refer to the [Getting Started](https://python.quectel.com/doc/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. + Please refer to the [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/) section (skip if you are already familiar) to set up the development environment. 2. Open the QPYCOM tool and connect the device @@ -15,7 +15,7 @@ This section takes the QuecPython EC200UEU_AB EVB as an example to demonstrate t 3. Enable the USB network adapter by entering interactive commands through the QPYCOM tool. - Please refer to the corresponding [USBNET](https://python.quectel.com/doc/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USBNET interfaces. + Please refer to the corresponding [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.USBNET.html) section on the Wiki for specific USBNET interfaces. In the interactive interface, enter the following commands: ```python diff --git a/docs/Application_guide/en/network-comm/nic/wifi/README.md b/docs/Application_guide/en/network-comm/nic/wifi/README.md index 0fd4fa92bdc42959b6e9ae38cbf7cd41ed4b88a7..2f19db9143461d695616f20c26f9f0f3f949998c 100644 --- a/docs/Application_guide/en/network-comm/nic/wifi/README.md +++ b/docs/Application_guide/en/network-comm/nic/wifi/README.md @@ -204,7 +204,7 @@ The following table shows the support for UART interface Wi-Fi and SDIO interfac ## Wi-Fi API Description -QuecPython supports various models of Wi-Fi, including external or built-in Wi-Fi. Due to historical reasons, currently, ESP8266/ESP8285 does not support the mpy interface. We will unify all Wi-Fi device interfaces in the future. For detailed interface descriptions of each model, please refer to the [WLAN](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html) section on the Wiki. +QuecPython supports various models of Wi-Fi, including external or built-in Wi-Fi. Due to historical reasons, currently, ESP8266/ESP8285 does not support the mpy interface. We will unify all Wi-Fi device interfaces in the future. For detailed interface descriptions of each model, please refer to the [WLAN](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html) section on the Wiki. @@ -212,7 +212,7 @@ QuecPython supports various models of Wi-Fi, including external or built-in Wi-F Since the ESP8266 is supported on the serial SLIP protocol, in order to facilitate docking and expansion, we only provide the `WLAN.py` script, which contains the built-in ESP8266 control class. This allows you to define and develop interfaces according to your own needs. -For detailed interface information, please refer to the [ESP8266](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.ESP8266.html) section on the Wiki. The content of the ESP8266 control script can be found in [WLAN.py](./WLAN.py). +For detailed interface information, please refer to the [ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.ESP8266.html) section on the Wiki. The content of the ESP8266 control script can be found in [WLAN.py](./WLAN.py). The interface call relationship is shown in the following figure: ![](../../../media/network-comm/nic/network_wifi_esp8266_api_process.png) @@ -323,7 +323,7 @@ esp8266.ota(url) This set of interfaces is developed and adapted according to the MicroPython official interface. It is suitable for SDIO external Wi-Fi NICs and built-in Wi-Fi NICs. -The information is only for the general Wi-Fi interface usage instructions. The implementation may vary for different models. For detailed interface information, please refer to the [Wi-Fi Communication](https://python.quectel.com/doc/API_reference/en/wifilib/index.html) section on the Wiki. +The information is only for the general Wi-Fi interface usage instructions. The implementation may vary for different models. For detailed interface information, please refer to the [Wi-Fi Communication](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/index.html) section on the Wiki. ![](../../../media/network-comm/nic/network_wifi_api_process.png) diff --git a/docs/Application_guide/en/network-comm/nic/wifi/wifi-ap-example.md b/docs/Application_guide/en/network-comm/nic/wifi/wifi-ap-example.md index 05a74e0cacbc83bd75eb3201a083aa59ad8b1811..86b05833585a595487dd6d623b704870ff250939 100644 --- a/docs/Application_guide/en/network-comm/nic/wifi/wifi-ap-example.md +++ b/docs/Application_guide/en/network-comm/nic/wifi/wifi-ap-example.md @@ -2,13 +2,13 @@ The Wi-Fi NIC connects to the hotspot to provide 4G network services to other devices. -Please refer to the [Getting Started](https://python.quectel.com/doc/Getting_started/en/index.html) section for development environment setup. This section introduces the usage of ESP8266/ESP8285. +Please refer to the [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/index.html) section for development environment setup. This section introduces the usage of ESP8266/ESP8285. ## Hardware Preparation To use the external Wi-Fi NIC functionality, you need to prepare an external Wi-Fi NIC, a router, and DuPont wires. -Connect the module to the Wi-Fi NIC with DuPont wires. The wiring between the module and the NIC can be configured according to actual requirements. For specific interface configuration parameters, please refer to the [ESP8266](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.ESP8266.html) section on Wiki. +Connect the module to the Wi-Fi NIC with DuPont wires. The wiring between the module and the NIC can be configured according to actual requirements. For specific interface configuration parameters, please refer to the [ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.ESP8266.html) section on Wiki. [ESP8266 Hardware Connection Photo](../../../media/network-comm/nic/network_wifi_esp8266_connection.png) [ASR5803 Hardware Connection Photo](../../../media/network-comm/nic/network_wifi_asr5803_connection.png) diff --git a/docs/Application_guide/en/network-comm/nic/wifi/wifi-station-example.md b/docs/Application_guide/en/network-comm/nic/wifi/wifi-station-example.md index 0619fc6ee98f3ed5f6ed47f1751b403502f6faee..e343424ae17cf4a3e110add6602ce48a04c7e0b7 100644 --- a/docs/Application_guide/en/network-comm/nic/wifi/wifi-station-example.md +++ b/docs/Application_guide/en/network-comm/nic/wifi/wifi-station-example.md @@ -2,13 +2,13 @@ The Wi-Fi NIC connects to the hotspot to provide network access to the module. -Please refer to the [Getting Started](https://python.quectel.com/doc/Getting_started/en/index.html) section for development environment setup. This section introduces the usage of ESP8266/ESP8285. +Please refer to the [Getting Started](https://developer.quectel.com/doc/quecpython/Getting_started/en/index.html) section for development environment setup. This section introduces the usage of ESP8266/ESP8285. ## Hardware Preparation To use the external Wi-Fi NIC functionality, you need to prepare an external Wi-Fi NIC, a router, and DuPont wires. -Connect the module to the Wi-Fi NIC with DuPont wires. The wiring between the module and the NIC can be configured according to actual requirements. For specific interface configuration parameters, please refer to the [ESP8266](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.ESP8266.html) section on Wiki. +Connect the module to the Wi-Fi NIC with DuPont wires. The wiring between the module and the NIC can be configured according to actual requirements. For specific interface configuration parameters, please refer to the [ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.ESP8266.html) section on Wiki. [ESP8266 Hardware Connection Photo](../../../media/network-comm/nic/network_wifi_esp8266_connection.png) [ASR5803 Hardware Connection Photo](../../../media/network-comm/nic/network_wifi_asr5803_connection.png) @@ -120,7 +120,7 @@ ESP8266/ESP8285 is a standalone device that includes independent network configu ``` -## TCP ([socket](https://python.quectel.com/doc/API_reference/en/stdlib/usocket.html)) Application Example +## TCP ([socket](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/usocket.html)) Application Example The following examples demonstrate two methods of TCP communication over Wi-Fi network. @@ -128,7 +128,7 @@ The following examples demonstrate two methods of TCP communication over Wi-Fi n In this example, TCP communication is performed with a Wi-Fi NIC. The `bind` interface of the socket module is used to specify sending through the Wi-Fi interface. ->In the example below, the `bind` interface binds to 172.16.1.2, which is the IP address of the Wi-Fi NIC. The IP address of the NIC can be queried through the `ipconfig` interface of the NIC object. For details, refer to the [Wi-Fi](https://python.quectel.com/doc/API_reference/en/wifilib/index.html) chapter in the Wiki. +>In the example below, the `bind` interface binds to 172.16.1.2, which is the IP address of the Wi-Fi NIC. The IP address of the NIC can be queried through the `ipconfig` interface of the NIC object. For details, refer to the [Wi-Fi](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/index.html) chapter in the Wiki. ```python # Import the usocket module @@ -187,4 +187,4 @@ if __name__ == '__main__': ## Application of MQTT/HTTP and Other Application Protocols -Note that the MQTT/HTTP application protocol is used over a Wi-Fi NIC. Because the built-in MQTT/HTTP communication module does not apply the binding NIC operation interface, you need to configure an Ethernet NIC as the default NIC. For specific MQTT/HTTP usage, refer to the [umqtt](https://python.quectel.com/doc/API_reference/en/networklib/umqtt.html) and [reqeust](https://python.quectel.com/doc/API_reference/en/networklib/request.html) sections in the Application Layer Protocol Wiki. \ No newline at end of file +Note that the MQTT/HTTP application protocol is used over a Wi-Fi NIC. Because the built-in MQTT/HTTP communication module does not apply the binding NIC operation interface, you need to configure an Ethernet NIC as the default NIC. For specific MQTT/HTTP usage, refer to the [umqtt](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/umqtt.html) and [reqeust](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/request.html) sections in the Application Layer Protocol Wiki. \ No newline at end of file diff --git a/docs/Application_guide/en/network-comm/phone.md b/docs/Application_guide/en/network-comm/phone.md index 28c68e6ea70f8df544d074a1ae56f21fbac38bc8..2d6feac48c6ce019dccb8b7068b0557274446617 100644 --- a/docs/Application_guide/en/network-comm/phone.md +++ b/docs/Application_guide/en/network-comm/phone.md @@ -208,7 +208,7 @@ voiceCall is the voice call feature of QuecPython, which refers to the ability t >* EC600M series module support voice call only when the firmware supports VOLTE. >* Only customized versions of other series modules support voice call features. -Please note that the above information may change with module updates and new releases. It is recommended to carefully read [wiki-Cellular communication-voiceCall](https://python.quectel.com/doc/API_reference/en/iotlib/voiceCall.html) and confirm with FAEs before using these features. +Please note that the above information may change with module updates and new releases. It is recommended to carefully read [wiki-Cellular communication-voiceCall](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/voiceCall.html) and confirm with FAEs before using these features. ## Voice Call Application @@ -707,7 +707,7 @@ In the callback messages for VoLTE calls, the number of callback function parame | 15 | 8 | Call outgoing, no answer (VoLTE) | `args[1] – args[7]`: Same explanations as above | | 16 | 8 | Waiting (VoLTE) | `args[1] – args[7]`: Same explanations as above | -For args[0] with values of 10-16, args[1]-args[8] are described in [WiKl](https://python.quectel.com/doc/API_reference/en/iotlib/voiceCall.html#%3Ccode%3EvoiceCall.setCallback%3C/code%3E): +For args[0] with values of 10-16, args[1]-args[8] are described in [WiKl](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/voiceCall.html#%3Ccode%3EvoiceCall.setCallback%3C/code%3E): ## Frequently Asked Questions diff --git a/docs/Application_guide/en/network-comm/sim/Common-exception-handling.md b/docs/Application_guide/en/network-comm/sim/Common-exception-handling.md index d2956050b77a529593719fe8368550af4c2b179b..1c1ace23568b3801a149b89547acf0c85070c12a 100644 --- a/docs/Application_guide/en/network-comm/sim/Common-exception-handling.md +++ b/docs/Application_guide/en/network-comm/sim/Common-exception-handling.md @@ -1,6 +1,6 @@ # Handle Common Exception -For SIM card status exceptions and network registration and dialing exceptions, please refer to the [Handle Network Exceptions](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki for cellular wireless network cards. +For SIM card status exceptions and network registration and dialing exceptions, please refer to the [Handle Network Exceptions](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki for cellular wireless network cards. ## Unable to send SMS * Check if the SIM card status is abnormal. @@ -20,8 +20,8 @@ For SIM card status exceptions and network registration and dialing exceptions, ## Successful network registration and dialing, but unable to access the URL * Check if the SIM card is overdue, causing the operator does not forward the response data or request message to the other end. If overdue, please recharge. -* For other exceptional cases, please refer to the [Handle Network Exceptions](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki. +* For other exceptional cases, please refer to the [Handle Network Exceptions](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki. ## Some protocol data cannot be exchanged properly * For SIM cards of this type, check if the operator has restricted certain protocols. For example, for the NTP protocol, some operators restrict it to be sent only to specific NTP service addresses, otherwise it cannot be exchanged. Verify with the operator and activate this type of service. -* For other exceptional cases, please refer to the [Handle Network Exceptions](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki. \ No newline at end of file +* For other exceptional cases, please refer to the [Handle Network Exceptions](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html) section of the QuecPython official website wiki. \ No newline at end of file diff --git a/docs/Application_guide/en/network-comm/sim/Quecpython-SIM-function-application-example.md b/docs/Application_guide/en/network-comm/sim/Quecpython-SIM-function-application-example.md index 4f8e166f404e23bc3f050c525cff61ea136b0a02..17b4afdcf19b39d82e684f45d217201386d6cdce 100644 --- a/docs/Application_guide/en/network-comm/sim/Quecpython-SIM-function-application-example.md +++ b/docs/Application_guide/en/network-comm/sim/Quecpython-SIM-function-application-example.md @@ -392,11 +392,11 @@ sim.unblockPin("12345678", "0000") ## Phone Book -In the actual project application process, if users need to save the phone number of the other party, they need to use the phonebook function. This interface provides the function of saving phone number information. Please refer to the QuecPython official website wiki [Phone Book](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#Phone-Book) for the support of this function interface. +In the actual project application process, if users need to save the phone number of the other party, they need to use the phonebook function. This interface provides the function of saving phone number information. Please refer to the QuecPython official website wiki [Phone Book](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#Phone-Book) for the support of this function interface. ### Read Phone Book -Users can use the following interface to read the phone book. The storage location of the phone number is described in the QuecPython official website wiki `sim.readPhonebook()` [Parameter](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#Phone-Book). Note that the difference between start and end needs to be less than or equal to 20. +Users can use the following interface to read the phone book. The storage location of the phone number is described in the QuecPython official website wiki `sim.readPhonebook()` [Parameter](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#Phone-Book). Note that the difference between start and end needs to be less than or equal to 20. The interface is as follows: @@ -483,7 +483,7 @@ if __name__ == '__main__': ## SIM Card Hot Swap -In the project, if the user needs to monitor the SIM card insertion and removal, they can register a callback function through the following interface. When the SIM card is inserted or removed, the system will call the registered callback function and pass the SIM card insertion or removal event to the application layer. Users can determine whether the SIM card is inserted or removed based on the notification event. For the support of this interface by QuecPython modules, please refer to the QuecPython official website wiki [Hot Swap](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#Hot-Swap). +In the project, if the user needs to monitor the SIM card insertion and removal, they can register a callback function through the following interface. When the SIM card is inserted or removed, the system will call the registered callback function and pass the SIM card insertion or removal event to the application layer. Users can determine whether the SIM card is inserted or removed based on the notification event. For the support of this interface by QuecPython modules, please refer to the QuecPython official website wiki [Hot Swap](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#Hot-Swap). ### Register Hot Swap Callback @@ -613,7 +613,7 @@ if __name__ == '__main__': ## Switch SIM Card -In the process of project application, in order to ensure network stability and meet various network scenarios, it is necessary to have the ability to switch between two different SIM cards at any time to cope with various network abnormal situations. For the support of this function by QuecPython module, please refer to the [Switch SIM Card](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#Switch-SIM-Card) in the QuecPython official website wiki. +In the process of project application, in order to ensure network stability and meet various network scenarios, it is necessary to have the ability to switch between two different SIM cards at any time to cope with various network abnormal situations. For the support of this function by QuecPython module, please refer to the [Switch SIM Card](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#Switch-SIM-Card) in the QuecPython official website wiki. ### Register Switch Card Callback Function diff --git a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/README.md b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/README.md index 0cb35eacc7813208a8f9605c631fd016d71311d9..6a402382e79b00f816127079d71ca5cf06437c25 100644 --- a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/README.md +++ b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/README.md @@ -15,7 +15,7 @@ This AI chatbot solution is developed based on the Doubao Volcano RTC engine and --- -- [development_resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development_resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md index e1274864a942e4dee3ead2bc3343b8a4bcd95dd0..9b9444b26aad5383af030f10519f31ae46441bac 100644 --- a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md +++ b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md @@ -3,11 +3,11 @@ ## Development board - EC800MCNTE/EC800MCNGB QuecDuino development board (including antenna, Type-C data cable, etc.) - - [Click here to purchase the development board kit](https://www.quecmall.com/goods-detail/2c90800c94028da20194824724370127) + - [Click here to purchase the development board kit](https://www.quecmall.com/goods-detail/2c90800b8cb50925018e5a696d0104f7) - Windows PC（Windows 7、Windows 10 or Windows 11） - speaker - Any 2-5W power speaker is sufficient - - [Mall Purchase Link](https://www.quecmall.com/goods-detail/2c90800c94028da201948249e9f4012d) + - [Mall Purchase Link](https://www.quecmall.com/goods-detail/2c90800c9488358b01956aa656680239) ## Software documentation diff --git a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/quick_start.md b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/quick_start.md index 5923a8edd70c462a38dcc8fd0302f9d5b49b11d8..2bfaf529a2e6b23cf973968d5bc8a4a7568b4376 100644 --- a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/quick_start.md +++ b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/quick_start.md @@ -47,17 +47,17 @@ After completing the hardware connection work, long press the button labeled 'PW ### Burn firmware package -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6) Burn the corresponding firmware package to the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6) Burn the corresponding firmware package to the development board. ### Script import and execution -1. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93) Import all files from the 'code' folder in the source code directory into the module file system, as shown in the following figure: +1. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93) Import all files from the 'code' folder in the source code directory into the module file system, as shown in the following figure: -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6) Execute the main program file `ai_main.py`. -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C) Stop the program from running. +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6) Execute the main program file `ai_main.py`. +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C) Stop the program from running. ## Debugging @@ -86,7 +86,7 @@ ai task running rtc_queue key event 1 start rtc TIKTOK_RTC_EVENT_START -TIKTOK_RTC_EVENT_TTS_TEXT 你 +TIKTOK_RTC_EVENT_TTS_TEXT you TIKTOK_RTC_EVENT_TTS_TEXT 你好 TIKTOK_RTC_EVENT_TTS_TEXT 你好有 TIKTOK_RTC_EVENT_TTS_TEXT 你好有什 diff --git a/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/test.py b/docs/Application_guide/en/solutions/AIChatBot-Volcengine-webRTC/test.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/README.md b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/README.md index 3bc80cee46d9f9ed22bee45a6a1ec8a0e099ec36..3f9927d0fe1f9de048306ce451429e2c730b5700 100644 --- a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/README.md +++ b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/README.md @@ -13,7 +13,7 @@ The smart agriculture control panel solution is based on the U-235 standard deve -- [development resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/dev_resources.md b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/dev_resources.md index 5590ff5f0c59f2252a391933fb1f839e5300acf6..c656cd301476ea69a8eab2a566b21b12a36344c9 100644 --- a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/dev_resources.md +++ b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/dev_resources.md @@ -4,16 +4,16 @@ ## Development board -- model：[QuecPython U-235 EVB](https://python.quectel.com/doc/Getting_started/en/evb/ec600u-235.html) +- model：[QuecPython U-235 EVB](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/ec600u-235.html) - [Purchase link](https://detail.tmall.com/item.htm?abbucket=8&id=676710608367&pisk=gUaZxiwjTNQwcl4NnX02YOhqIW3trVX7IrMjiSVm1ADMfl_Do-wBGmM1Dkl0d-ujlSXT3rk3Ml1tcOd4YRFof-PA6jD0n-kbfM_7653xoT_VPaN9kRvQOR8DjpfmwfxcOc0MonwjoT65uHOnXOg0CuF6pHxnwvciifmcTXcsaqciiFfEKjl-nF2mo65EwjJDof0mtDcosqxDSjvn-jhSnKDiipfEMvDmoqckF5VD8biGgYh9Msd9nqMusv8DzQhZjCN6cE8qcfmaoWDEOXaE_ckovdBTpP2QiPatvMxEkWZz3o2ldhMg4byEVlWy78ytiSl0QadrKPP48cEBwEVE0Ar3SDRDo20I30q4QO-tIlwE2XmHgahQFvVTSk5vK52SQVcnAafztmqQW0U1KFuu25g_m8XBfAqrigkyHXVm9rEwnnoi9Xk5T6rc31Ew7XN5nnKxx4hEF1G6Dnni9Xk5T6-vDDDKTY1s1&rn=42a4e96745c13cd9400765e39c24c67e&spm=a1z10.3-b-s.w4011-23773493585.71.221c5886KuaZIg&skuId=4865603973616) - EVB docs - - [specification](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) + - [specification](https://images.quectel.com/python/sites/2/2023/08/Quectel_QuecPython_U-235_EVB_User_Guide_V1.0.pdf) - [schematic](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - [screen printing](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [user guidance](https://python.quectel.com/doc/Getting_started/zh/evb/ec600u-235.html) + - [user guidance](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/ec600u-235.html) @@ -48,9 +48,7 @@ ## Firmware - version：EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107 -- download [firmware](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) - - +- download [firmware](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC600U_EUAB_FW.zip) ## Source code diff --git a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/quick_start.md b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/quick_start.md index 451a14cf1c9f7c6a351601287652ec262ea9b184..5ea0a6c9c16144abc20c55adc6299077f49fab8c 100644 --- a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/quick_start.md +++ b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/quick_start.md @@ -6,7 +6,7 @@ - A Windows computer, recommended for the `Win10` system. -- A [QuecPython U-235 development board](https://python.quectel.com/doc/Getting_started/en/evb/ec600u-235.html) +- A [QuecPython U-235 development board](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/ec600u-235.html) - A TypeC data cable @@ -18,7 +18,7 @@ - Download and install EC600U series module driver: [QuecPython_USB_DriverU_V1.0.19](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) - Download and install [VSCode](https://code.visualstudio.com/) - Download and install [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) -- Download [Firmware](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) +- Download [Firmware](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC600U_EUAB_FW.zip) - Download [Source Code](https://codeload.github.com/QuecPython/solution-Agriculture-Control-Panel/zip/refs/tags/v1.0.1) @@ -48,20 +48,20 @@ After completing the hardware connection, long press the button labeled 'PWR' on ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package EC600UEUAB_R03A01M8_SCPU_QPYBETA10107 to the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package EC600UEUAB_R03A01M8_SCPU_QPYBETA10107 to the development board. ### Script import and execution -1. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: +1. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: · -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#) Execute the script file and execute the main program file `main.py`. (During normal startup, the module will automatically execute the `main.py` file) +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#) Execute the script file and execute the main program file `main.py`. (During normal startup, the module will automatically execute the `main.py` file) -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), stop program running. +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), stop program running. diff --git a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/software_design.md b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/software_design.md index 0c5c41000b42a23582c494f8a0cce274d20c2227..2772dc930b324de3a2df42b302156617049b95da 100644 --- a/docs/Application_guide/en/solutions/Agriculture-Control-Panel/software_design.md +++ b/docs/Application_guide/en/solutions/Agriculture-Control-Panel/software_design.md @@ -242,8 +242,8 @@ The`start()` method in the above code is used to launch the graphical interface - Call the `EventMesh. subscribe()` method to subscribe to an event named `load_screen`. When the event occurs, call the `__route()` method to process it. - > The `route()` method matches the corresponding interface object based on the message carried when publishing the event, that is, the name of the screen interface, and calls lvgl's `lv. scr_load() `method to load the new interface. - > Observant readers will notice that in every class implemented in the screen interface script file, there will be statements similar to `self. name=" MainScreen"` in its object initialization method `__init__()`. This statement records the name of the screen interface. + > The `__route()` method matches the corresponding interface object based on the message carried when publishing the event, that is, the name of the screen interface, and calls lvgl's `lv.scr_load() `method to load the new interface. + > Observant readers will notice that in every class implemented in the screen interface script file, there will be statements similar to `self.name=" MainScreen"` in its object initialization method `__init__()`. This statement records the name of the screen interface. - The `EventMesh.publish("load_screen", "WelcomeScreen")` statement is used to trigger the first interface display, which is the welcome interface. Then wait for the welcome interface to display for 2 seconds, creating a good visual experience. @@ -257,7 +257,7 @@ In summary`Agri_ui.py` performs all initialization work for the smart agricultur ## Graphic interface design -As mentioned earlier, QuecPython uses NXP's GUI Guider as a graphical interface design tool, GUIDER not only enables interface layout design, but also automatically generates QuecPython code. [Click here](https://python.quectel.com/doc/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.html) to view the tutorial on using the GUI Guider tool. +As mentioned earlier, QuecPython uses NXP's [GUI Guider](https://www.nxp.com/design/software/development-software/gui-guider:GUI-GUIDER) as a graphical interface design tool, GUIDER not only enables interface layout design, but also automatically generates QuecPython code. [Click here](https://developer.quectel.com/doc/quecpython/Application_guide/en/multi-media/lvgl/lvgl_ui_tool.html) to view the tutorial on using the GUI Guider tool. ### Layout and background settings diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/README.md b/docs/Application_guide/en/solutions/DTU-EG912U/README.md index 6ace0d164c643205b2bf17b33ec6e178c6fe7dde..97226febfb6e0ff014a2b3abe04886821bcc4072 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/README.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/README.md @@ -15,7 +15,7 @@ Based on EG912U core version DTU, it supports 4G and can achieve data exchange b ------ -- [development resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/dev_resources.md b/docs/Application_guide/en/solutions/DTU-EG912U/dev_resources.md index 9d16c65a1dfc2d082609c629350b659de79af5cc..331771902a578724379675639c2921165567c8c9 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/dev_resources.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/dev_resources.md @@ -2,18 +2,13 @@ This document lists required hardware resources and related documents for Quectel_EG912U. -## Development board data +## Development board and module model number -Mode：[EG912U Core Board](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) +Mode：[EG912U Core Board](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/bg-eg-core-evb.html) -- Development board documentation： - - [EG912U core board product specifications and user guide](https://python.quectel.com/wp-content/uploads/2024/11/EG912U%E6%A0%B8%E5%BF%83%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) +- Development board documentation：[EG912U core board product specifications and user guide](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG912U_Core_Board_Specification_and_User_Guide.pdf) -## Module data - -Mode：[EG912U Core Board](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) - -- Specification： [Quectel EG912U Series LTE Standard Module Product Specification Book](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_EG912U-GL_LTE_Standard_%E6%A8%A1%E5%9D%97%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E4%B9%A6_V1.2.pdf) +- Specification： [Quectel EG912U Series LTE Standard Module Product Specification Book](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/Quectel_EG912U-GL_LTE_Standard_Specification_V1.2.pdf) - Drive download：[QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) ## Accessories data diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/mqtt_demo.md b/docs/Application_guide/en/solutions/DTU-EG912U/mqtt_demo.md index 16bf2ce83e42f429b8305e66675df4369b421d9d..cb9a71075daaf8cea910640e1461754272fcf17a 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/mqtt_demo.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/mqtt_demo.md @@ -105,7 +105,7 @@ Download and install the **QPYCom** tool and use it to download scripts to the Q > 💡 **Tips** > -> [QPYCom installation and use tutorial](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html) +> [QPYCom installation and use tutorial](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html) ## Service debugging diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/quick_start.md b/docs/Application_guide/en/solutions/DTU-EG912U/quick_start.md index 2ec9e1ff256afb7e466c57071ead91f7741b29ee..b66278babe9c4d9b598a550f060f8063d710f07f 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/quick_start.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/quick_start.md @@ -3,7 +3,7 @@ ## Hardware preparation - A Windows computer, Win10 system is recommended. -- One set [EG912U Core Board](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) +- One set [EG912U Core Board](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/bg-eg-core-evb.html) - One usable Nano Sim card. - An antenna. - A Mini USB cable. @@ -14,7 +14,7 @@ - Download and install the EC912U series module driver：[QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip)。 - Download and install [VSCode](https://code.visualstudio.com/)。 - Download and extract the [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) tool to a suitable location on your computer. -- Download and install the firmware package[QPY_OCPU_BETA0002_EG912U_GLAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip)。（For firmware package burning, please refer to [Using QPYcom for Firmware Burning](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） +- Download and install the firmware package[QPY_OCPU_BETA0002_EG912U_GLAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip)。（For firmware package burning, please refer to [Using QPYcom for Firmware Burning](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） - [Download experimental source code](https://github.com/QuecPython/solution-simple-DTU)。 ## hardware connection diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/software_design.md b/docs/Application_guide/en/solutions/DTU-EG912U/software_design.md index 902370936247cd3104405437bf3dff3fb42da59b..287a7416cab1d8bacfcad13bd2ec3c16a75373bb 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/software_design.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/software_design.md @@ -1,4 +1,4 @@ -# software design +# Software design ## Application flow chart @@ -19,17 +19,18 @@ The overall business can be summarized as the following process： ## directory structure ```markdown -- code - - common.py common tools - - dtu.py DTU application class implementation - - dtu_config.json Template configuration file - - error.py Error code and description - - logging.py log - - main2.py Application master script(demo) - - mqttIot.py mqtt Client implementation - - serial.py Serial read and write implementation - - settings.py Configuration file read and write implementation - - socketIot.py tcp client implementation +- usr + _main.py: Main script + dtu_config.json: Configuration file + dtu.py : DTU model object + logging.py: Log module + cloud_abc.py: Cloud Object Model Abstract base class + mqttIot.py: Mqtt Cloud Object Model implementation + network.py: Network + serial.py: Serial port model object implementation + socketIot.py: socket Cloud object model implementation + nThreading.py: Threads and queues and mutex locks + utils.py: Utility class ``` ## API Description diff --git a/docs/Application_guide/en/solutions/DTU-EG912U/tcp_demo.md b/docs/Application_guide/en/solutions/DTU-EG912U/tcp_demo.md index d1694b537bc6681604bb3fc7b95154f3e3958163..bc311f204123fdc557c6fe58b7da43dcb5e1b2f8 100644 --- a/docs/Application_guide/en/solutions/DTU-EG912U/tcp_demo.md +++ b/docs/Application_guide/en/solutions/DTU-EG912U/tcp_demo.md @@ -95,7 +95,7 @@ After downloading and installing the **QPYCom** tool, use it to download the scr > 💡 **Tips** > -> QPYCom Installation and use tutorials：https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html +> QPYCom Installation and use tutorials：https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html ## Service debugging diff --git a/docs/Application_guide/en/solutions/DTU/README.md b/docs/Application_guide/en/solutions/DTU/README.md index 78685e034301b79cda5c784a0791d9193d5d3534..7e980720c933698124fe36ff5068878a5c7b960c 100644 --- a/docs/Application_guide/en/solutions/DTU/README.md +++ b/docs/Application_guide/en/solutions/DTU/README.md @@ -18,9 +18,9 @@ The Hua series DTU products are equipped with the Mobile EC800G-CN module, which ------ -- [development resources](./dev_resources.md) +- [Development resources](./dev_resources.md) -- [quick start](./quick_start.md) +- [Quick start](./quick_start.md) -- [software design](./software_design.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/DTU/dev_resources.md b/docs/Application_guide/en/solutions/DTU/dev_resources.md index d732d27ae7f99326e409d73407175f64342f44b7..e8b9e974c25d44327bcc8cc8f9af623d2a6a59fb 100644 --- a/docs/Application_guide/en/solutions/DTU/dev_resources.md +++ b/docs/Application_guide/en/solutions/DTU/dev_resources.md @@ -4,7 +4,7 @@ This document collects and lists the required hardware resource list and related ## Development board -- model：[EC800GCN Hua serial DTU EVB](https://python.quectel.com/doc/Getting_started/zh/evb/ec800g_hua_dtu.html) +- model：[EC800GCN Hua serial DTU EVB](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec800g_hua_dtu.html) - Purchase link：[click](https://www.quecmall.com/goods-detail/2c9080168ef07110018f1853d4050002) - EVB docs - [user guidance](https://python.quectel.com/wp-content/uploads/2024/09/EC800G_华-DTU系列开发板产品规格及用户指导.pdf) diff --git a/docs/Application_guide/en/solutions/DTU/mqtt_demo.md b/docs/Application_guide/en/solutions/DTU/mqtt_demo.md index bf38200f50b1bcfb67635cbaaec5b58b8367947d..342c249d511742eb673dfae09b9c3d7eb1afaad6 100644 --- a/docs/Application_guide/en/solutions/DTU/mqtt_demo.md +++ b/docs/Application_guide/en/solutions/DTU/mqtt_demo.md @@ -96,7 +96,7 @@ The complete configuration file template is as follows: Parameter description: -- ` systemconfig. config `: Specify the type of private cloud currently in use. Currently supports TCP and MQTT. +- ` systemconfig.config `: Specify the type of private cloud currently in use. Currently supports TCP and MQTT. - `mqtt_private_cloud_config`: MQTT private cloud configuration. - `socket_private_cloud_config`: TCP private cloud configuration. @@ -108,7 +108,7 @@ After downloading and installing the QPYCom tool, use the tool to download the s > 💡 **Tips** > -> QPYCom Installation and usage tutorial: https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html +> QPYCom Installation and usage tutorial: https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html ## Debugging diff --git a/docs/Application_guide/en/solutions/DTU/quick_start.md b/docs/Application_guide/en/solutions/DTU/quick_start.md index 8dfac701cc11d02cda6a8ab5df3ee27bc3325a94..aebb053264db091a89242352d8067eb1f0458914 100644 --- a/docs/Application_guide/en/solutions/DTU/quick_start.md +++ b/docs/Application_guide/en/solutions/DTU/quick_start.md @@ -3,7 +3,7 @@ ## Hardware preparation - One Windows computer, recommended Win10 system. -- A set of [EC800GCN Hua series DTU development board](https://python.quectel.com/doc/Getting_started/zh/evb/ec800g_hua_dtu.html). +- A set of [EC800GCN Hua series DTU development board](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec800g_hua_dtu.html). - A usable Nano Sim card. - A rubber stick antenna. - A Mini USB data cable. @@ -14,7 +14,7 @@ - Download and install EC800G series module driver: [QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip). - Download and install [VSCode](https://code.visualstudio.com/). - Download and unzip [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) Tool to the appropriate location on the computer. -- Download and install the firmware package [QPy_OCPU_SETA0002-EC800G_CNLD_SW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EC800G_CNLD_FW.zip). Please refer to [Using QPYcom to Burn Firmware](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html ) for firmware package burning +- Download and install the firmware package [QPy_OCPU_SETA0002-EC800G_CNLD_SW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EC800G_CNLD_FW.zip). Please refer to [Using QPYcom to Burn Firmware](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html ) for firmware package burning - Download the experimental source code. ## Hardware connection diff --git a/docs/Application_guide/en/solutions/DTU/software_design.md b/docs/Application_guide/en/solutions/DTU/software_design.md index e32447707fba6b96d84d0450d093f18f83c70d01..46aa414cfd2acd2dfb1a7d844b08c57225f5eb39 100644 --- a/docs/Application_guide/en/solutions/DTU/software_design.md +++ b/docs/Application_guide/en/solutions/DTU/software_design.md @@ -35,13 +35,13 @@ Overall, the business can be summarized as follows: ### Manager Class -In the main script ` _main. py ` of the example program, we define a ` Manager ` class to manage various associated objects initialized. +In the main script `_main. py ` of the example program, we define a ` Manager ` class to manage various associated objects initialized. Main methods: - `__init__`: Management class initialization method - - Watchdog: Due to the hardware watchdog (GPO12) configuration of the Hua series 4G DTU, the main script program needs to initialize a 'self. dog_pin' object and feed the watchdog periodically using 'osTimer'. - - DTU model object: `Self. dtu` is a DTU object that reads relevant configurations from a file using the object method `self.dtu.config. read_from.json("/var/dtuconfig.json")` The start method is the main entry of the program. Start the dog feeding timer every 3s, check the sim card and network status, and finally call `self.dtu.run()` to start the DTU routine. + - Watchdog: Due to the hardware watchdog (GPO12) configuration of the Hua series 4G DTU, the main script program needs to initialize a `self. dog_pin` object and feed the watchdog periodically using `osTimer`. + - DTU model object: `self.dtu` is a DTU object that reads relevant configurations from a file using the object method `self.dtu.config.read_from.json("/var/dtuconfig.json")` The start method is the main entry of the program. Start the dog feeding timer every 3s, check the sim card and network status, and finally call `self.dtu.run()` to start the DTU routine. - `start`: Start method - Activate the dog feeding timer - Check the status of the SIM card @@ -115,7 +115,7 @@ dtu.config.read_from_json('/usr/dtu_config.json') Among them, it supports storing relevant configurations from JSON files, and the operation method is similar to the built-in dictionary type. The following methods can be used to read and write configurations (taking the example of reading the `system_comfig` configuration item). - Import configuration from specified JSON file: ` dtu.config.read_from_json('/usr/dtu_config.json')` -- Use the 'get' method to read configuration items: ` dtu.config.get("system_config")` +- Use the `get` method to read configuration items: ` dtu.config.get("system_config")` - Use the operator ` [] ` to read configuration items: ` dtu.config["system_config"]` - Save and update configuration: ` dtu.config.save()` @@ -178,7 +178,7 @@ def __create_cloud(self): #### Serial object model -Define the serial model class' Serial 'in the' serial. py 'module, mainly for users to implement read and write operations on the serial port. The main interfaces are: +Define the serial model class `Serial` in the `serial. py`module, mainly for users to implement read and write operations on the serial port. The main interfaces are: - `Serial`: - `__init__`: Serial port initialization. - `open`: Open the serial port. @@ -252,7 +252,7 @@ The above are the main methods and properties of the Cloud object model, includi - `recv`: Retrieve downlink messages. - `send`: Send an upstream message and receive several location parameters that users can customize. -## 业务代码讲解 +## Explanation of business code The data transmission service is mainly implemented in the DTU class (dtu.py), which is mainly used to manage the upstream and downstream services of serial ports, cloud, and data. The DTU object starts the entire DTU business in the main script by calling the `run` method, which is mainly used to create and run two threads, namely the upstream data processing thread (whose job function is `up_transactions_handler`) and the downstream data processing thread (whose job function is `down_transactions_handler`). Obtain the corresponding serial port object and cloud object through two property attributes in the thread function. The serial object property is `serial`, and when the thread calls this property, it immediately creates and opens the configured serial object to provide a read-write interface. The cloud object attribute is `cloud`, and when the thread calls this attribute, it immediately creates and connects with the cloud object to provide receiving and sending interfaces. @@ -304,7 +304,7 @@ class DTU(object): # ... ``` -The `up_transactions_handler` function reads serial data from a 1KB buffer (users can adjust the buffer size themselves), formats the message, and sends the data to the cloud through the CloudABC. send interface. After inheriting 'CloudABC' and customizing cloud objects and implementing the `CloudABC.send` method, users can process and send data according to the custom message format. +The `up_transactions_handler` function reads serial data from a 1KB buffer (users can adjust the buffer size themselves), formats the message, and sends the data to the cloud through the CloudABC. send interface. After inheriting `CloudABC` and customizing cloud objects and implementing the `CloudABC.send` method, users can process and send data according to the custom message format. The implementation of the downlink data processing thread function `down_transaction_handler` is as follows: ```python diff --git a/docs/Application_guide/en/solutions/DTU/tcp_demo.md b/docs/Application_guide/en/solutions/DTU/tcp_demo.md index cf2126af10ce1aedbd13af4afb4dba0b402e2336..5a0e77e4a123dd6d50fbc5ae65c75e5dc0f4da5e 100644 --- a/docs/Application_guide/en/solutions/DTU/tcp_demo.md +++ b/docs/Application_guide/en/solutions/DTU/tcp_demo.md @@ -101,7 +101,7 @@ After downloading and installing the QPYCom tool, use the tool to download the s > 💡 **Tips** > -> QPYCom Installation and Usage Tutorial: https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html +> QPYCom Installation and Usage Tutorial: https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html ## Debugging diff --git a/docs/Application_guide/en/solutions/SensorHub/README.md b/docs/Application_guide/en/solutions/SensorHub/README.md index 4027dc78ebaa5fa96f8c7bb5f0b906042e68f5ab..83d1f07d3e0d60069dc4dc6876e1eb0f8840206f 100644 --- a/docs/Application_guide/en/solutions/SensorHub/README.md +++ b/docs/Application_guide/en/solutions/SensorHub/README.md @@ -10,6 +10,6 @@ This solution is based on the EC200U-EU QuecPython standard development board an ------ -- [development resource](./dev_resources.md) -- [quick start](quick_start.md) -- [software design](./software_design) +- [Development resource](./dev_resources.md) +- [Quick start](quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/SensorHub/dev_resources.md b/docs/Application_guide/en/solutions/SensorHub/dev_resources.md index 9c05fcf481932b592fdfeb40b7c67235fc9b3a08..de790d6c41eb40bc3756b43cda65f51bdf3b84ee 100644 --- a/docs/Application_guide/en/solutions/SensorHub/dev_resources.md +++ b/docs/Application_guide/en/solutions/SensorHub/dev_resources.md @@ -2,13 +2,13 @@ ## Development board -- model：[EC200U-EU Quecpython standard EVB](https://python.quectel.com/doc/Getting_started/en/evb/ec200x-evb.html) +- model：[EC200U-EU Quecpython standard EVB](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/ec200x-evb.html) - Purchase link：[click](https://www.waveshare.com/ec200u-au-c4-p01.htm) -- 开发板文档 - - [specification](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_EC200U%E7%B3%BB%E5%88%97_LTE_Standard_%E6%A8%A1%E5%9D%97%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E4%B9%A6_V1.4.pdf) - - [schematic](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - - [screen printing](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [user guidance](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html) +- Development Board Documentation + - [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/Quectel_EC200U_Series_LTE_Standard_Specification_V1.4.pdf) + - [schematic](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EC200U_A_C4-P01-Series-EVB_SCH.pdf) + - [screen printing](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EC200U_A_C4-P01-Series-EVB_Silkscreen.pdf) + - [user guidance](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/ec200x-evb.html) diff --git a/docs/Application_guide/en/solutions/SensorHub/quick_start.md b/docs/Application_guide/en/solutions/SensorHub/quick_start.md index 537a9f2f5312a90c0e0a65d273e41cc66bab0ef1..ef7f0182ac099376cfaef0e45336a0fcf290a758 100644 --- a/docs/Application_guide/en/solutions/SensorHub/quick_start.md +++ b/docs/Application_guide/en/solutions/SensorHub/quick_start.md @@ -4,7 +4,7 @@ A Windows computer, recommended for the 'Win10' system. -One set [EC200U-EU Quecpython standard EVB](https://python.quectel.com/doc/Getting_started/en/evb/ec200x-evb.html) +One set [EC200U-EU Quecpython standard EVB](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/ec200x-evb.html) One SIM card @@ -46,17 +46,17 @@ After completing the hardware connection work, when PWR, SCK1 light up or a COM - ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html) Download the firmware and burn the firmware to the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html) Download the firmware and burn the firmware to the development board. - ### Script import and execution -1.Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#PC) to transfer files between modules, import all files from the code folder in the source code directory into the module file system according to the original directory structure, as shown in the following figure +1.Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#PC) to transfer files between modules, import all files from the code folder in the source code directory into the module file system according to the original directory structure, as shown in the following figure -2.Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), execute the main program file `_main.py` +2.Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), execute the main program file `_main.py` -3.Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), stop program running +3.Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), stop program running ## Debugging diff --git a/docs/Application_guide/en/solutions/SensorHub/software_design.md b/docs/Application_guide/en/solutions/SensorHub/software_design.md index 1ed2017b60ecc59c1b3fac31d860654f8f3ef820..3d0cb3ec56a6097a5f95fcf8f4ab122f54a33431 100644 --- a/docs/Application_guide/en/solutions/SensorHub/software_design.md +++ b/docs/Application_guide/en/solutions/SensorHub/software_design.md @@ -183,7 +183,7 @@ class SensorService(object): prev_b = prev_rgb888 & 0xFF db = abs(b - prev_b) - # 色差超过 150 即认为颜色有变化 + # If the color difference exceeds 150, it is considered that the color has changed if pow(sum((dr*dr, dg*dg, db*db)), 0.5) >= 150: data.update({7: {1: r, 2: g, 3: b}}) prev_rgb888 = rgb888 diff --git a/docs/Application_guide/en/solutions/Wear/dev_resources.md b/docs/Application_guide/en/solutions/Wear/dev_resources.md index 7497bec79c3cdc1d7150cfd5bf6b72eabf2074a0..5174d66d76e991ef26b14b5f8b91ba70149725ed 100644 --- a/docs/Application_guide/en/solutions/Wear/dev_resources.md +++ b/docs/Application_guide/en/solutions/Wear/dev_resources.md @@ -7,9 +7,9 @@ - model: QuecPython_EG810X C1-P03 - EVB docs - - [specification](https://python.quectel.com/wp-content/uploads/2024/09/EG810M_EC800Z_C1-P03%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - - [schematic](https://python.quectel.com/wp-content/uploads/2024/09/EG810M_EC800Z_C1-P03%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - - [screen printing](https://python.quectel.com/wp-content/uploads/2024/09/EG810M_EC800Z_C1-P03%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) + - [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG810M_C1-P03-Series-EVB_Specification_and_User_Guide.pdf) + - [schematic](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG810M_C1-P03-Series-EVB_SCH.pdf) + - [screen printing](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG810M_C1-P03-Series-EVB_Silkscreen.pdf) diff --git a/docs/Application_guide/en/solutions/Wear/quick_start.md b/docs/Application_guide/en/solutions/Wear/quick_start.md index 0f14ba9850808a0149d6fb4adc9f6cf7e19a778f..9a61ce1c5ec580934ac4fe7645ca71b840af92b9 100644 --- a/docs/Application_guide/en/solutions/Wear/quick_start.md +++ b/docs/Application_guide/en/solutions/Wear/quick_start.md @@ -47,18 +47,18 @@ After completing the hardware connection work, long press the button labeled 'PW ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package [EG810MCNGAR06A01M08_VOEXT_SCPU_QPYBETA0222. zip](https://raw.githubusercontent.com/QuecPython/solution-wearable/refs/heads/master/EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222_20250317-1147_20250317-1152.zip) To the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package [EG810MCNGAR06A01M08_VOEXT_SCPU_QPYBETA0222. zip](https://raw.githubusercontent.com/QuecPython/solution-wearable/refs/heads/master/EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222_20250317-1147_20250317-1152.zip) To the development board. ### Script import and execution -1. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files ending in '. py' from the 'code' folder in the source code directory into the module file system, as shown in the following figure: +1. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files ending in '. py' from the 'code' folder in the source code directory into the module file system, as shown in the following figure: -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), execute the main program file ` main_t.py` +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), execute the main program file ` main_t.py` -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), stop program running +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), stop program running @@ -68,7 +68,7 @@ The wearing plan provides homepage, dial screen, application screen, standby scr ### watch dial -image-20231124093958921 + component: @@ -89,7 +89,7 @@ component: ### App screens -image-20231124094455949 + 1. **Heart rate monitoring:** - Click to jump to the heart rate detection page. @@ -105,12 +105,12 @@ component: ### Phone screen -image-20231124095320999 + Provides modes and displays for making phone calls, going/calling/calling, etc. ### Detection screen -image-20231124095012079 + The detection interface includes temperature/blood oxygen/heart rate detection, as well as display of detection status and historical detection. diff --git a/docs/Application_guide/en/solutions/Wear/readme.md b/docs/Application_guide/en/solutions/Wear/readme.md index 2560792d56e008d5f381604e9ecd913cc5e25d2b..10bd1667ae02b76464837a37e42672b29432718c 100644 --- a/docs/Application_guide/en/solutions/Wear/readme.md +++ b/docs/Application_guide/en/solutions/Wear/readme.md @@ -13,7 +13,7 @@ The wearable solution is based on the QuecPython EG810M C1-P03 development board ------ -- [development resource](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development resource](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/electricity-meter/README.md b/docs/Application_guide/en/solutions/electricity-meter/README.md index 8a5ab449bf029f8472b85eaf6f3fbf50c0ab0d96..f43375f49ab7ebb16d43d20e0d2724223636191f 100644 --- a/docs/Application_guide/en/solutions/electricity-meter/README.md +++ b/docs/Application_guide/en/solutions/electricity-meter/README.md @@ -12,7 +12,7 @@ Meter solution based on QuecPython_EG91X C1-P02 EVB, Has the following character ------ -- [development resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/electricity-meter/dev_resources.md b/docs/Application_guide/en/solutions/electricity-meter/dev_resources.md index 1f565be7a19e5ed6d5e3e6f32961c5100b62f647..77747b6a63b2cbe69db69dfc5dba298deae98dbc 100644 --- a/docs/Application_guide/en/solutions/electricity-meter/dev_resources.md +++ b/docs/Application_guide/en/solutions/electricity-meter/dev_resources.md @@ -4,20 +4,20 @@ ## Development board -- model: [QuecPython_EG91X Evaluation Board](https://python.quectel.com/doc/Getting_started/en/evb/eg91x-evb.html) +- model: [QuecPython_EG91X Evaluation Board](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/eg91x-evb.html) - EVB docs - - [specification](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - - [schematic](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - - [screen priting](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [user guidance](https://python.quectel.com/doc/Getting_started/zh/evb/eg91x-evb.html) + - [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG91X_C1-P02-Series-EVB_Specification_and_User_Guide.pdf) + - [schematic](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG91X_C1-P02-Series-EVB_SCH.pdf) + - [screen priting](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG91X_C1-P02-Series-EVB_Silkscreen.pdf) + - [user guidance](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/eg91x-evb.html) ## Module infomation -- model: [EG912UGL_AA](https://python.quectel.com/modules-cat/eg912u-series) - - [specification](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_EG912U-GL_LTE_Standard_%E6%A8%A1%E5%9D%97%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E4%B9%A6_V1.2.pdf) +- model: [EG912UGL_AA](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EG91X_C1-P02-Series-EVB_Silkscreen.pdf) + - [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/Quectel_EG912U-GL_LTE_Standard_Specification_V1.2.pdf) - [download drivers](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) diff --git a/docs/Application_guide/en/solutions/electricity-meter/quick_start.md b/docs/Application_guide/en/solutions/electricity-meter/quick_start.md index aca0bbce43d0bafc1da4e94c22b5d3f296f855b4..bcb2db4ba6c8f33f08f9be6f0cd954c2524ba7e8 100644 --- a/docs/Application_guide/en/solutions/electricity-meter/quick_start.md +++ b/docs/Application_guide/en/solutions/electricity-meter/quick_start.md @@ -7,7 +7,7 @@ - A Windows computer, recommended for the 'Win10' system. - A TypeC data cable - A SIM card -- One [EG91X Evaluation Board](https://python.quectel.com/doc/Getting_started/en/evb/eg91x-evb.html) +- One [EG91X Evaluation Board](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/eg91x-evb.html) - A CP2102 module - One antenna @@ -24,9 +24,9 @@ -## 硬件连接 +## hardware connection -按照下图进行硬件连接： +Connect the hardware as shown in the following diagram: @@ -44,7 +44,7 @@ ### Power on -完成硬件连接的工作后，长按开发板上标识为`PWk`的按键，直到网络灯`net`闪烁，或电脑设备管理器的端口列表中出现包含`Quectel USB` 字样的 COM 口，表示开机成功。(EG91X系列C1-P02开发板上电自动开机) +After completing the hardware connection work, long press the button labeled as `PWk` on the development board until the network light `net` flashes, or a COM port containing `Quectel USB` appears in the port list of the computer device manager, indicating successful boot-up. (The EG91X series C1-P02 development board automatically boots up upon power-on) ![](../../media/solutions/electricity-meter/comport.png) @@ -52,23 +52,23 @@ ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html) Burn firmware package [QPy_OCPU_SETA0002REG912U_GLAA_FW. zip](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip) To EG912U module development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html) Burn firmware package [QPy_OCPU_SETA0002REG912U_GLAA_FW. zip](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip) To EG912U module development board. ​ -### 脚本导入与运行 +### Script import and execution 1. Configure the specific parameters of the TCP server and UART used in `dev.json` -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#PC) To transfer files between modules, import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), execute the main program file ` demo.py` +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), execute the main program file ` demo.py` -4. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), stop program running +4. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), stop program running diff --git a/docs/Application_guide/en/solutions/poc/README.md b/docs/Application_guide/en/solutions/poc/README.md index 1aaeddb2e97f3ac494cdc4f4427b2d34e889438c..efbfc2cd1b236cca247b0d4d32f67c63274b84a0 100644 --- a/docs/Application_guide/en/solutions/poc/README.md +++ b/docs/Application_guide/en/solutions/poc/README.md @@ -11,7 +11,7 @@ This public network intercom solution is based on the EC600MCNTE QuecPython stan --- -- [development resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) +- [Development resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) diff --git a/docs/Application_guide/en/solutions/poc/dev_resources.md b/docs/Application_guide/en/solutions/poc/dev_resources.md index 56a73986221f190357719ab12535ddf5d6177349..328d108574a511db4ca56a17b364839c1118ac24 100644 --- a/docs/Application_guide/en/solutions/poc/dev_resources.md +++ b/docs/Application_guide/en/solutions/poc/dev_resources.md @@ -2,18 +2,18 @@ ## Development board -- model: [EC600MCNLE QuecPython Standard EVB](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) +- model: [EC600MCNLE QuecPython Standard EVB](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) - Purchase link：[click](http://e.tb.cn/h.gAlSKya8NvMC9UY?tk=7APD3KXufyq) - EVB docs - [specification](https://python.quectel.com/wp-content/uploads/2024/10/EC600X系列开发板产品规格及用户指导.pdf) - - [schematic](https://python.quectel.com/wp-content/uploads/2024/09/EC600X_EVB_V3.2-SCH.pdf) - - [screen priting](https://python.quectel.com/wp-content/uploads/2024/09/EC600X_EVB_V3.2-丝印.pdf) - - [user guidance](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) + - [schematic](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/12/EC600X_Series_EVB_SCH.pdf) + - [screen priting](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/12/EC600X_Series_EVB_SilkScreen.pdf) + - [user guidance](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) ## Module information -- model: [EC600MCN_LE](https://python.quectel.com/modules-cat/ec600m-series) -- [specification](https://images.quectel.com/python/2023/04/Quectel_EC600M-CN_LTE_Standard_模块产品规格书_V1.2.pdf) +- model: [EC600MCN_LE](https://python.quectel.com/en/modules-cat/ec600m-series) +- [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/Quectel_EC600M_Series_LTE_Standard_Specification_V1.0.pdf) - [download drivers](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip) ## Accessories Information diff --git a/docs/Application_guide/en/solutions/poc/quick_start.md b/docs/Application_guide/en/solutions/poc/quick_start.md index affa210d52177b5d80d31b172540a8e8ea696eaf..defce3cc8434019d1fa10c7eb19ff990d2d3a787 100644 --- a/docs/Application_guide/en/solutions/poc/quick_start.md +++ b/docs/Application_guide/en/solutions/poc/quick_start.md @@ -2,8 +2,8 @@ ## Hardware preparation -- A Windows computer, recommended for the 'Win10' system. -- Two sets of [EC600MCNTE QuecPython standard development boards](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) (Each set includes an antenna, Type-C data cable, etc.). +- A Windows computer, recommended for the `Win10` system. +- Two sets of [EC600MCNTE QuecPython standard development boards](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) (Each set includes an antenna, Type-C data cable, etc.). > 💡 **Tips** > One set is used for the demonstration of the calling device, and the other set is used for the demonstration of the called device. @@ -35,10 +35,10 @@ Connect the hardware according to the following diagram: -1. Connect the horn to the pins labeled 'SPK+' and 'SPK -' in the diagram. -2. Connect the LCD screen to the pin bank labeled with the word 'LCD'. +1. Connect the horn to the pins labeled `SPK+` and `SPK -` in the diagram. +2. Connect the LCD screen to the pin bank labeled with the word `LCD`. 3. Insert an available Nano SIM card into the position shown in the diagram. -4. Connect the antenna to the antenna connector marked with the word 'LTE'. +4. Connect the antenna to the antenna connector marked with the word `LTE`. 5. Connect the development board and computer using a Type-C data cable. ## Equipment development @@ -51,16 +51,16 @@ After completing the hardware connection work, long press the button labeled `PW ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6) Burn firmware package [EC600MCNLER06A01M08-POC_XBND_SCPU_QPYBETA0117. zip](https://github.com/QuecPython/solution-POC/releases/download/v2.0.1/EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip) To the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6) Burn firmware package [EC600MCNLER06A01M08-POC_XBND_SCPU_QPYBETA0117. zip](https://github.com/QuecPython/solution-POC/releases/download/v2.0.1/EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip) To the development board. ### Script import and execution -1. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93) Import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: +1. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93) Import all files from the `code` folder in the source code directory into the module file system, as shown in the following figure: -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)Execute the main program file `poc_main.py`. -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C) Stop the program from running. +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)Execute the main program file `poc_main.py`. +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C) Stop the program from running. ## Debugging @@ -78,9 +78,9 @@ After executing the ` poc_main.py ` script, the program starts running and enter The main interface contains multiple option lists, and each option corresponds to a new interface. -- Click the 'key2' key to scroll down the checkbox. -- Double click the 'key2' key to enter the selected interface. -- Long press the 'key2' key to return to the previous interface. +- Click the `key2` key to scroll down the checkbox. +- Double click the `key2` key to enter the selected interface. +- Long press the `key2` key to return to the previous interface. @@ -98,10 +98,10 @@ By entering the member list interface, all members of the current group can be q ### Intercom -- Long press the 'key1' key to communicate with members in the same group, and the menu bar will display the 'microphone' icon. -- After speaking, release the 'key1' key to end the intercom function. +- Long press the `key1` key to communicate with members in the same group, and the menu bar will display the `microphone` icon. +- After speaking, release the `key1` key to end the intercom function. - When actively calling or being called by the other party, there will be a message pop-up prompt. -- When the other party is speaking, the menu bar displays the 'earpiece' icon. +- When the other party is speaking, the menu bar displays the `earpiece` icon. **Active call icon:** diff --git a/docs/Application_guide/en/solutions/poc/software_design.md b/docs/Application_guide/en/solutions/poc/software_design.md index 379fbc563f3fc547eb40980bbf9a4ff99e90f63a..4220bf2a97865f018f1044f8842c0ba0506f2937 100644 --- a/docs/Application_guide/en/solutions/poc/software_design.md +++ b/docs/Application_guide/en/solutions/poc/software_design.md @@ -29,7 +29,7 @@ ### Core Business Module (POC) -> For API functions related to the POC library, please refer to [POC Public Network Radio](https://python.quectel.com/doc/API_reference/zh/industry/poc.html) Explanation document. +> For API functions related to the POC library, please refer to [POC Public Network Radio](https://developer.quectel.com/doc/quecpython/API_reference/zh/industry/poc.html) Explanation document. - #### Login diff --git a/docs/Application_guide/en/solutions/tracker/README.md b/docs/Application_guide/en/solutions/tracker/README.md index 3f6d55632407d7479617bfe2a04a4ca34c8010dc..0b8ecea01ee6c09646e4a690556b8a238ee33b5e 100644 --- a/docs/Application_guide/en/solutions/tracker/README.md +++ b/docs/Application_guide/en/solutions/tracker/README.md @@ -18,6 +18,6 @@ This intelligent locator solution is based on the EC200UEUAA QuecPython standard ------ -- [development resources](./dev_resources.md) -- [quick start](./quick_start.md) -- [software design](./software_design.md) \ No newline at end of file +- [Development resources](./dev_resources.md) +- [Quick start](./quick_start.md) +- [Software design](./software_design.md) \ No newline at end of file diff --git a/docs/Application_guide/en/solutions/tracker/dev_resources.md b/docs/Application_guide/en/solutions/tracker/dev_resources.md index 1fd41a68487b841412ef975d99a319f0c80b4d65..66abf57329409ee619c01bbdff036f9adc0caae5 100644 --- a/docs/Application_guide/en/solutions/tracker/dev_resources.md +++ b/docs/Application_guide/en/solutions/tracker/dev_resources.md @@ -5,15 +5,15 @@ - model：EC200UEUAA QuecPython standard borad - Purchase link：[click](https://www.waveshare.com/ec200u-au-c4-p01.htm) - docs: - - [specification](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - - [schematic](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - - [Screen printing](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [User guidance](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html) + - [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EC200U_A_C4-P01-Series-EVB_Specification_and_User_Guide.pdf) + - [schematic](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EC200U_A_C4-P01-Series-EVB_SCH.pdf) + - [Screen printing](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/EC200U_A_C4-P01-Series-EVB_Silkscreen.pdf) + - [User guidance](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/ec200x-evb.html) ## module information -- model：[EC200UEUAA](https://python.quectel.com/modules-cat/ec200u-series) -- [specification](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_EC200U%E7%B3%BB%E5%88%97_LTE_Standard_%E6%A8%A1%E5%9D%97%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E4%B9%A6_V1.4.pdf) +- model：[EC200UEUAA](https://python.quectel.com/en/modules-cat/ec200u-series) +- [specification](https://python.quectel.com/en/wp-content/uploads/sites/2/2024/11/Quectel_EC200U_Series_LTE_Standard_Specification_V1.4.pdf) - [driver download](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) ## Accessories Information @@ -27,7 +27,7 @@ - QuecPython debug tool - QPYcom - version：V3.6.0 - download [QPYcom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) - - [User Guidance](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html) + - [User Guidance](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html) - Editor - VSCode - download [VSCode](https://code.visualstudio.com/) diff --git a/docs/Application_guide/en/solutions/tracker/quick_start.md b/docs/Application_guide/en/solutions/tracker/quick_start.md index 89238c6d35a1e92be81b718196eda360fb6ab11f..9b8fb94bd4fdee8bce54f1098f259326109c2131 100644 --- a/docs/Application_guide/en/solutions/tracker/quick_start.md +++ b/docs/Application_guide/en/solutions/tracker/quick_start.md @@ -3,7 +3,7 @@ ## Hardware preparation - A Windows computer, recommended for the 'Win10' system -- A set of [EC200UEUAA QuecPython standard development board ](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html)(including LTE antenna, Type-C data cable, etc.) +- A set of [EC200UEUAA QuecPython standard development board ](https://python.quectel.com/doc/quecpython/Dev_board_guide/en/ec200x-evb.html)(including LTE antenna, Type-C data cable, etc.) - One [GNSS antenna](https://e.tb.cn/h.TpAFyEz02BnCHRD?tk=fznae6ITVEX) - A pin and jumper cap - A functional Nano SIM card @@ -182,16 +182,16 @@ After completing the hardware connection work, the development board will automa ### Download firmware -Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package [QPy_OCPU_SETA0001_EC200U_SUAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC200U_EUAA_FW.zip) To the development board. +Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html), burn firmware package [QPy_OCPU_SETA0001_EC200U_SUAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC200U_EUAA_FW.zip) To the development board. ### Script import and execution -1. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html) To transfer files between modules, import all files from the 'code' folder in the source code directory into the module file system, as shown in the following figure: +1. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html) To transfer files between modules, import all files from the 'code' folder in the source code directory into the module file system, as shown in the following figure: ![](../../media/solutions/tracker/code.png) -2. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), Execute the script file and execute the main program file ` _main. py `. -3. Refer to [this chapter](https://python.quectel.com/doc/Getting_started/en/first_python.html), stop program running. +2. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), Execute the script file and execute the main program file ` _main. py `. +3. Refer to [this chapter](https://developer.quectel.com/doc/quecpython/Getting_started/en/first_python.html), stop program running. ## Debugging @@ -199,7 +199,7 @@ Refer to [this chapter](https://python.quectel.com/doc/Application_guide/en/dev- After executing the ` _main.py ` script, the program starts running and the project running status can be viewed on the interactive page: -> The program needs to run for a period of time to obtain GNSS positioning information, please refer to the [relevant document for details](https://python.quectel.com/doc/FAQ/zh/hardware/gnss.html#%3Cstrong%3E%E4%BB%80%E4%B9%88%E6%98%AFGNSS%E7%9A%84%E5%86%B7%E5%90%AF%E5%8A%A8%E3%80%81%E6%B8%A9%E5%90%AF%E5%8A%A8%E5%92%8C%E7%83%AD%E5%90%AF%E5%8A%A8%3C/strong%3E ). +> The program needs to run for a period of time to obtain GNSS positioning information, please refer to the [relevant document for details](https://developer.quectel.com/doc/quecpython/FAQ/en/hardware/gnss.html ). ![tracker_running](../../media/solutions/tracker/tracker_running.png) diff --git a/docs/Application_guide/en/solutions/tracker/software_design.md b/docs/Application_guide/en/solutions/tracker/software_design.md index d94f4fb8c2210e600cf4f7d7dab73627d7e617ba..3a2169c50678815541e92df5c487a2cd0b242aad 100644 --- a/docs/Application_guide/en/solutions/tracker/software_design.md +++ b/docs/Application_guide/en/solutions/tracker/software_design.md @@ -126,18 +126,18 @@ The introduction and description of the software system framework are as follows if self.__running_tag == 1: return self.__running_tag = 1 - # 禁用设备休眠 + # Disable device sleep mode self.__pm.autosleep(0) self.__pm.set_psm(mode=0) - # 启动业务事件消息队列监听子线程 + # Start the listener thread for the business event message queue self.__business_start() - # 发送OTA版本刷新指令到事件队列中进行执行 + # Send the OTA version refresh instruction to the event queue for execution. self.__business_queue.put((0, "ota_refresh")) - # 发送上报定位数据事件(包含网络的连接，设备数据的采集，设备数据的上报) + # Send the event for reporting location data (including network connection, data collection of the device, and reporting of device data) self.__business_queue.put((0, "loc_report")) - # 发送OTA升级查询指令事件 + # Event of sending OTA upgrade query instruction self.__business_queue.put((0, "check_ota")) - # 发送设备休眠事件 + # Send device sleep event self.__business_queue.put((0, "into_sleep")) self.__running_tag = 0 ``` @@ -149,7 +149,7 @@ The introduction and description of the software system framework are as follows ... def server_callback(self, args): - # 服务端下行消息传入业务事件消息队列中进行处理 + # Downstream messages from the server are received and processed in the business event message queue. self.__business_queue.put((1, args)) ``` @@ -163,7 +163,7 @@ The introduction and description of the software system framework are as follows with self.__business_lock: self.__business_tag = 1 ... - # 处理IoT 平台下行指令功能 + # Handling the function of downlink instructions for IoT platforms if data[0] == 1: self.__server_option(*data[1]) self.__business_tag = 0 @@ -175,24 +175,24 @@ The introduction and description of the software system framework are as follows def __server_option(self, topic, data): if topic.endswith("/property/set"): - # 处理属性设置的下行消息 + # Downstream message for handling attribute settings self.__server_property_set(data) elif topic.find("/rrpc/request/") != -1: - # 处理透传数据的下行消息 + # Downlink messages for handling transparent data transmission msg_id = topic.split("/")[-1] self.__server_rrpc_response(msg_id, data) elif topic.find("/thing/service/") != -1: - # 处理服务数据的下行消息 + # Downstream messages for processing service data service = topic.split("/")[-1] self.__server_service_response(service, data) elif topic.startswith("/ota/device/upgrade/") or topic.endswith("/ota/firmware/get_reply"): - # 处理OTA升级的下行消息 + # Handle the downlink messages related to OTA upgrade user_cfg = self.__settings.read("user") if self.__server_ota_flag == 0: if user_cfg["sw_ota"] == 1: self.__server_ota_flag = 1 if user_cfg["sw_ota_auto_upgrade"] == 1 or user_cfg["user_ota_action"] == 1: - # 满足OTA升级条件，执行OTA升级流程 + # Satisfy the conditions for OTA upgrade and execute the OTA upgrade process. self.__server_ota_process(data) else: self.__server_ota_flag = 0 @@ -217,16 +217,16 @@ The introduction and description of the software system framework are as follows break utime.sleep_ms(500) user_cfg = self.__settings.read("user") - # 根据休眠时长自动调整休眠模式，autosleep或者psm + # Adjust the sleep mode automatically according to the duration of sleep. Autosleep or PSM. if user_cfg["work_cycle_period"] < user_cfg["work_mode_timeline"]: self.__pm.autosleep(1) else: self.__pm.set_psm(mode=1, tau=user_cfg["work_cycle_period"], act=5) - # 启动RTC定时唤醒设备 + # Activate the RTC for timed wake-up of the device. self.__set_rtc(user_cfg["work_cycle_period"], self.running) def __set_rtc(self, period, callback): - # 设置RTC唤醒时钟，唤醒设备 + # Set the RTC wake-up clock and wake up the device. self.__business_rtc.enable_alarm(0) if callback and callable(callback): self.__business_rtc.register_callback(callback) @@ -241,39 +241,39 @@ The introduction and description of the software system framework are as follows ```python def main(): - # 初始化网络功能模块 + # Initialize the network function module net_manage = NetManage(PROJECT_NAME, PROJECT_VERSION) - # 初始化配置参数功能模块 + # Initialization configuration parameter function module settings = Settings() - # 初始化电池检测功能模块 + # Initialize the battery detection function module battery = Battery() - # 初始化历史数据功能模块 + # Initialize the historical data function module history = History() - # 初始化IoT 平台(阿里Iot)功能模块 + # Initialize the functional modules of the IoT platform (Alibaba IoT) server_cfg = settings.read("server") server = AliIot(**server_cfg) - # 初始化IoT 平台(阿里Iot)OTA功能模块 + # Initialize the OTA (Over-The-Air) function module of the IoT platform (Alibaba IoT) server_ota = AliIotOTA(PROJECT_NAME, FIRMWARE_NAME) server_ota.set_server(server) - # 初始化低功耗功能模块 + # Initialize the low-power function module power_manage = PowerManage() - # 初始化温湿度传感器功能模块 + # Initialize the function module of the temperature and humidity sensor temp_sensor = TempHumiditySensor(i2cn=I2C.I2C1, mode=I2C.FAST_MODE) loc_cfg = settings.read("loc") - # 初始化GNSS定位功能模块 + # Initialize the GNSS positioning function module gnss = GNSS(**loc_cfg["gps_cfg"]) - # 初始化基站定位功能模块 + # Initialize the base station positioning function module cell = CellLocator(**loc_cfg["cell_cfg"]) - # 初始化Wifi定位功能模块 + # Initialize the Wifi positioning function module wifi = WiFiLocator(**loc_cfg["wifi_cfg"]) - # 初始化GNSS定位数据解析功能模块 + # Initialize the GNSS positioning data parsing function module nmea_parse = NMEAParse() - # 初始化WGS84与GCJ02坐标系转换功能模块 + # Initialize the function module for coordinate system conversion between WGS84 and GCJ02 cyc = CoordinateSystemConvert() - # 初始化Tracker业务功能模块 + # Initialize the Tracker business function module tracker = Tracker() - # 将基础功能模块注册到Tracker类中进行控制 + # Register the basic functional modules into the Tracker class for control. tracker.add_module(settings) tracker.add_module(battery) tracker.add_module(history) @@ -288,22 +288,22 @@ The introduction and description of the software system framework are as follows tracker.add_module(nmea_parse) tracker.add_module(cyc) - # 将基础事件添加到事件列表中 + # Add the basic event to the event list. server.add_event("over_speed_alert") server.add_event("sim_abnormal_alert") server.add_event("low_power_alert") server.add_event("fault_alert") - # 设置网络模块的回调, 当网络断开，进行业务处理 + # Set the callback function of the network module. When the network connection is lost, carry out business processing. net_manage.set_callback(tracker.net_callback) - # 设置服务端下行数据接收的回调，当服务端下发指令时，进行业务处理 + # Set the callback for the downlink data reception on the server side. When the server issues an instruction, carry out the business processing. server.set_callback(tracker.server_callback) - # 启动Tracker项目业务功能. + # Initiate the business functions of the Tracker project. tracker.running() if __name__ == "__main__": - # 主文件启动 + # Main file startup main() ``` @@ -323,10 +323,10 @@ The introduction and description of the software system framework are as follows def __internal_read(self): log.debug("__internal_read start.") - # 开启GNSS + # Activate GNSS self.__internal_open() - # 清除串口缓存的GNSS历史数据 + # Clear the GNSS historical data cached in the serial port while self.__break == 0: gnss_data = quecgnss.read(1024) if gnss_data[0] == 0: @@ -336,7 +336,7 @@ The introduction and description of the software system framework are as follows self.__gps_nmea_data_clean() self.__gps_data_check_timer.start(2000, 1, self.__gps_data_check_callback) cycle = 0 - # 读取GNSS原始数据 + # Read the raw data of GNSS (Global Navigation Satellite System) while self.__break == 0: gnss_data = quecgnss.read(1024) if gnss_data and gnss_data[1]: @@ -354,7 +354,7 @@ The introduction and description of the software system framework are as follows self.__break = 0 self.__gps_data_check_callback(None) - # 关闭GNSS + # Disable GNSS self.__internal_close() log.debug("__internal_read %s." % ("success" if self.__get_gps_data() else "failed")) return self.__get_gps_data() @@ -367,11 +367,11 @@ The introduction and description of the software system framework are as follows ... def __external_read(self): - # 开启GNSS UART串口 + # Enable GNSS UART serial port self.__external_open() log.debug("__external_read start") - # 清除串口缓存的GNSS历史数据 + # Clear the GNSS historical data cached in the serial port while self.__break == 0: self.__gps_timer.start(50, 0, self.__gps_timer_callback) signal = self.__external_retrieve_queue.get() @@ -387,7 +387,7 @@ The introduction and description of the software system framework are as follows self.__gps_nmea_data_clean() self.__gps_data_check_timer.start(2000, 1, self.__gps_data_check_callback) cycle = 0 - # 读取GNSS原始数据 + # Read the raw data of GNSS (Global Navigation Satellite System) while self.__break == 0: self.__gps_timer.start(1500, 0, self.__gps_timer_callback) signal = self.__external_retrieve_queue.get() @@ -411,7 +411,7 @@ The introduction and description of the software system framework are as follows # To check GPS data is usable or not. self.__gps_data_check_callback(None) - # 关闭GNSS串口 + # Disable the GNSS serial port self.__external_close() log.debug("__external_read %s." % ("success" if self.__get_gps_data() else "failed")) return self.__get_gps_data() @@ -426,7 +426,7 @@ The introduction and description of the software system framework are as follows def __read_thread(self): loc_data = () try: - # 读取基站定位信息 + # Read the base station positioning information loc_data = cellLocator.getLocation( self.__serverAddr, self.__port, @@ -451,7 +451,7 @@ The introduction and description of the software system framework are as follows def __read_thread(self): loc_data = () try: - # 读取Wifi定位信息 + # Read Wifi positioning information loc_data = self.__wifilocator_obj.getwifilocator() loc_data = loc_data if isinstance(loc_data, tuple) and loc_data[0] and loc_data[1] else () except Exception as e: @@ -477,12 +477,12 @@ The introduction and description of the software system framework are as follows def __get_power_vbatt(self): """Get vbatt from power""" - # 通过Power模块获取电源电压 + # Obtain the power supply voltage through the Power module return int(sum([Power.getVbatt() for i in range(100)]) / 100) def __get_adc_vbatt(self): """Get vbatt from adc""" - # 通过ADC获取电压进行计算 + # Calculate by obtaining voltage through ADC self.__adc.open() utime.sleep_ms(self.__adc_period) adc_list = list() @@ -696,7 +696,7 @@ The introduction and description of the software system framework are as follows ... def properties_report(self, data):. - # 属性上报 + # Reporting of attributes _timestamp = self.__timestamp _id = self.__id params = {key: {"value": val, "time": _timestamp} for key, val in data.items()} @@ -713,7 +713,7 @@ The introduction and description of the software system framework are as follows return self.__get_post_res(_id) if pub_res is True else False def event_report(self, event, data): - # 事件上报 + # Reporting of the incident _timestamp = self.__timestamp _id = self.__id params = {"value": data, "time": _timestamp} @@ -751,7 +751,7 @@ The introduction and description of the software system framework are as follows self.__put_post_res(data["id"], True if int(data["code"]) == 200 else False) if self.__callback and callable(self.__callback): - # 传入Tracker.server_callback中进行处理 + # It will be processed in Tracker.server_callback. self.__callback((topic, data)) ``` @@ -762,7 +762,7 @@ The introduction and description of the software system framework are as follows ... def start(self): - # 开始OTA升级 + # Start OTA upgrade if self.__module == self.__project_name: self.__start_sota() elif self.__module == self.__firmware_name: diff --git a/docs/Application_guide/en/system/fs.md b/docs/Application_guide/en/system/fs.md index 6fc3659a0ac40181d3aa459d401925aafb582cc4..2d6d4a2f3757c71db578992ef233f0084e9b9e34 100644 --- a/docs/Application_guide/en/system/fs.md +++ b/docs/Application_guide/en/system/fs.md @@ -23,11 +23,11 @@ Virtual File System. It is an abstract file system built on top of the aforement #### Initialize Physical File System -This step mainly involves initializing the storage media hardware, mounting the physical file system, and obtaining the handle and file operation interface of the physical file system. Each physical file system has its own independent hardware initialization and mounting interface. The initialization interface for littleFS is uos.VfsLfs1() ([refer to the wiki for specific description](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsLfs1%3C/code%3E)), the initialization interface for SPI SD card FATFS is uos.VfsFat() ([refer to the wiki for specific description](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsFat%3C/code%3E)), and the initialization interface for SDIO SD card FATFS is uos.VfsSd() ([refer to the wiki for specific description](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsSd%3C/code%3E)). If the initialization is successful, these interfaces will eventually return objects of the physical file system, which contain information such as the handle and file operation interface of the physical file system. +This step mainly involves initializing the storage media hardware, mounting the physical file system, and obtaining the handle and file operation interface of the physical file system. Each physical file system has its own independent hardware initialization and mounting interface. The initialization interface for littleFS is uos.VfsLfs1() ([refer to the wiki for specific description](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsLfs1%3C/code%3E)), the initialization interface for SPI SD card FATFS is uos.VfsFat() ([refer to the wiki for specific description](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsFat%3C/code%3E)), and the initialization interface for SDIO SD card FATFS is uos.VfsSd() ([refer to the wiki for specific description](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.VfsSd%3C/code%3E)). If the initialization is successful, these interfaces will eventually return objects of the physical file system, which contain information such as the handle and file operation interface of the physical file system. #### Mount Virtual File System -This step binds the interface of the physical file system to the interface of the virtual file system. The specific interface is [uos.mount(vfs_obj, path)](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.mount%3C/code%3E). The parameter vfs_obj is the object returned by the initialization of the physical file system in the previous step, and the parameter path is the root directory of the virtual file system. The virtual file system distinguishes different physical file systems based on the root directory, so each physical file system is bound to a different root directory. Depending on the application scenario, the root directory of the file system can be divided into several areas: built-in NOR flash user area */usr*, built-in NOR flash backup area */bak*, external NOR flash area */ext*, SD card area */sd*, and EMMC area */emmc*. In this way, different storage areas can use the same set of software interfaces by passing different root directories for access. +This step binds the interface of the physical file system to the interface of the virtual file system. The specific interface is [uos.mount(vfs_obj, path)](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#%3Ccode%3Euos.mount%3C/code%3E). The parameter vfs_obj is the object returned by the initialization of the physical file system in the previous step, and the parameter path is the root directory of the virtual file system. The virtual file system distinguishes different physical file systems based on the root directory, so each physical file system is bound to a different root directory. Depending on the application scenario, the root directory of the file system can be divided into several areas: built-in NOR flash user area */usr*, built-in NOR flash backup area */bak*, external NOR flash area */ext*, SD card area */sd*, and EMMC area */emmc*. In this way, different storage areas can use the same set of software interfaces by passing different root directories for access. #### Unmount Virtual File System @@ -240,7 +240,7 @@ if __name__ == "__main__": ### Advanced File Operations -[See ql_fs - Advanced Operations of Files](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html). +[See ql_fs - Advanced Operations of Files](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html). ### Backup and Restore diff --git a/docs/Application_guide/en/system/info.md b/docs/Application_guide/en/system/info.md index 4bbaf9286f844fdfeb16d9e441190b9fa195d57f..d47a70ae78e526ea21bff8485a195997358ef027 100644 --- a/docs/Application_guide/en/system/info.md +++ b/docs/Application_guide/en/system/info.md @@ -25,7 +25,7 @@ Beacause in the development process, you may encounter some problems and need to # (sysname='EC600U-CNLB', nodename='EC600U', release='1.13.0', version='v1.12 on Sat_Nov_19_2022_5:29:48_PM', machine='EC600U with QUECTEL', qpyver='V0002') ``` -As shown above, this interface returns the same information as *uos.uname()*, but the return value is compatible with the usage of microPython, making it more convenient for users to access the information on the right side of "=" in the return value in the script. For specific usage, please refer to [uos - Basic System Services](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html). +As shown above, this interface returns the same information as *uos.uname()*, but the return value is compatible with the usage of microPython, making it more convenient for users to access the information on the right side of "=" in the return value in the script. For specific usage, please refer to [uos - Basic System Services](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html). In addition, we can also use the following methods to obtain the firmware version information: @@ -76,9 +76,9 @@ mem = gc.mem_free() print('Remaining available RAM space: {} KB'.format(mem / 1024)) ``` -As shown above, use the *uos.statvfs* function to query the status information of the *usr* and *bak* folders in the root directory, and obtain the remaining space size of the folders. Here is a brief introduction to the root directory and these two folders. Root directory: It is not allowed for users to operate, so any operation on the root directory will result in an OSerror exception. The *usr* directory: This directory allows customers to read and write files. Usually, customer code and other files are mainly stored here. For expansion, please refer to [External Storage](./memory-device.html#External-Storage). The *bak* directory: This directory is used to store key files that customers need to back up during mass production. It is readable but not writable. For storing key files, please refer to [Use of Backup Partition and Data Security Area](https://python.quectel.com/doc/API_reference/en/syslib/securedata.html). +As shown above, use the *uos.statvfs* function to query the status information of the *usr* and *bak* folders in the root directory, and obtain the remaining space size of the folders. Here is a brief introduction to the root directory and these two folders. Root directory: It is not allowed for users to operate, so any operation on the root directory will result in an OSerror exception. The *usr* directory: This directory allows customers to read and write files. Usually, customer code and other files are mainly stored here. For expansion, please refer to [External Storage](./memory-device.html#External-Storage). The *bak* directory: This directory is used to store key files that customers need to back up during mass production. It is readable but not writable. For storing key files, please refer to [Use of Backup Partition and Data Security Area](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/securedata.html). -For other uos-related usage, please refer to [uos - Basic System Services](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html). +For other uos-related usage, please refer to [uos - Basic System Services](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html). ## Query MicroPython Virtual Machine Version ```python @@ -126,7 +126,7 @@ The IMEI of an IoT module stands for International Mobile Equipment Identity. It In summary, IMEI is a very important identifier for IoT devices, which can be used for device management, security, remote management, and data analysis. -The details of querying other device information with the modem library is not repeated here. Please refer to [modem](https://python.quectel.com/doc/API_reference/en/syslib/modem.html). +The details of querying other device information with the modem library is not repeated here. Please refer to [modem](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/modem.html). ## Conclusion diff --git a/docs/Application_guide/en/system/memory-device.md b/docs/Application_guide/en/system/memory-device.md index 79bcd785deaf1d18e78299a26ee63ba8b9ca14e0..f56a94d2d8a156354f7c1d654a165458c3cd40de 100644 --- a/docs/Application_guide/en/system/memory-device.md +++ b/docs/Application_guide/en/system/memory-device.md @@ -223,7 +223,7 @@ A specified partition is used to store the font content required for GUI display #### Raw Partition Operations -For example, use a specified partition to store user secure data so that the data can be saved after power-off. The data comes from the content generated by the user during the device operation in real-time. Therefore, this partition does not need to flash specific content to the specified partition in advance, and the partition is not erased during the flashing process. This method is suitable for storing small amounts of data that are not frequently modified and are critical. For usage details, please refer to [SecureData - Secure Data Partition](https://python.quectel.com/doc/API_reference/en/syslib/securedata.html) for API usage. +For example, use a specified partition to store user secure data so that the data can be saved after power-off. The data comes from the content generated by the user during the device operation in real-time. Therefore, this partition does not need to flash specific content to the specified partition in advance, and the partition is not erased during the flashing process. This method is suitable for storing small amounts of data that are not frequently modified and are critical. For usage details, please refer to [SecureData - Secure Data Partition](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/securedata.html) for API usage. ## External Storage @@ -261,7 +261,7 @@ Currently only EG912N, EG915N , EC200U, EG912U and EG915U series modules support The SPI NOR flash uses the SPI communication bus. It depends on hardware resource availability and user requirement to select the specific SPI pin. -For a 4-wire SPI NOR flash setup, please refer to the details of the SPI pin correspondence in [SPI – Serial Peripheral Interface Bus Protocol](https://python.quectel.com/doc/API_reference/en/peripherals/machine.SPI.html#Constructor). Since other peripherals like an LCD may also need to use SPI to communicate, it is essential for users to allocate hardware resources in advance and ensure that each device uses a different SPI channel to avoid conflicts with the NOR flash. +For a 4-wire SPI NOR flash setup, please refer to the details of the SPI pin correspondence in [SPI – Serial Peripheral Interface Bus Protocol](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.SPI.html#Constructor). Since other peripherals like an LCD may also need to use SPI to communicate, it is essential for users to allocate hardware resources in advance and ensure that each device uses a different SPI channel to avoid conflicts with the NOR flash. Currently only the EC200U and EG915U series modules support the 6-wire SPI NOR flash scheme. The pin usage is as follows: @@ -303,7 +303,7 @@ The process of creating mass production firmware with external flash functionali ##### Software Interface -For the file system partition scenario, the file system can be used after it is mounted. For the initialization of the external flash file system, refer to [uos -Registering the Storage Device littleFS - SPI NOR FLASH](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device-littleFS---SPI-NOR-FLASH). +For the file system partition scenario, the file system can be used after it is mounted. For the initialization of the external flash file system, refer to [uos -Registering the Storage Device littleFS - SPI NOR FLASH](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device-littleFS---SPI-NOR-FLASH). ##### Read/Write Speed @@ -327,7 +327,7 @@ The SPI interface uses a generic SPI bus to communicate with the SD card, includ ##### Hardware Connection -Refer to the hardware design manual for the SD card interface-related chapters for the hardware pin connections of the SDIO interface. Refer to [SPI – Serial Peripheral Interface Bus Protocol](https://python.quectel.com/doc/API_reference/en/peripherals/machine.SPI.html#Constructor) for hardware pin connections of the SPI interface in the detail introduction of SPI pin correspondence . +Refer to the hardware design manual for the SD card interface-related chapters for the hardware pin connections of the SDIO interface. Refer to [SPI – Serial Peripheral Interface Bus Protocol](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.SPI.html#Constructor) for hardware pin connections of the SPI interface in the detail introduction of SPI pin correspondence . ##### File System Type @@ -335,11 +335,11 @@ The SD card function uses the FATFS file system, which supports FAT32 format com ##### Software Interface -The SD card function can be used after file system is mountedg. Refer to [Registering the Storage Device - SPI - SD Card](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device---SPI---SD-Card) for specific code examples. Refer to [Registering the Storage Device - SDIO - SD Card](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device---SDIO---SD-Card) for detailed usage of SDIO SD card interfaces. +The SD card function can be used after file system is mountedg. Refer to [Registering the Storage Device - SPI - SD Card](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device---SPI---SD-Card) for specific code examples. Refer to [Registering the Storage Device - SDIO - SD Card](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#Registering-the-Storage-Device---SDIO---SD-Card) for detailed usage of SDIO SD card interfaces. ##### Hot Plug -Currently, only SDIO SD cards support card insertion and removal detection, and specific code needs to be used in conjunction. Refer to [Setting the Pin for SD Card Detection](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#Setting-the-Pin-for-SD-Card-Detection) for specific code examples. +Currently, only SDIO SD cards support card insertion and removal detection, and specific code needs to be used in conjunction. Refer to [Setting the Pin for SD Card Detection](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#Setting-the-Pin-for-SD-Card-Detection) for specific code examples. ##### Read/Write Speed @@ -361,7 +361,7 @@ If the file system mounting fails, it means that the hardware communication is n ##### Formatting -If there are file system abnormalities or the file system space is full, you can use the formatting interface to format the SD card. Refer to [Mounting the File System](https://python.quectel.com/doc/API_reference/en/stdlib/uos.html#Mounting-the-File-System) for specific interface examples. +If there are file system abnormalities or the file system space is full, you can use the formatting interface to format the SD card. Refer to [Mounting the File System](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/uos.html#Mounting-the-File-System) for specific interface examples. ### Common Issues diff --git a/docs/Application_guide/en/system/memory-management.md b/docs/Application_guide/en/system/memory-management.md index a22fff713d4ee7e3536fd24da28536d568998ec3..46250908960a1454790aa2f00cf475e658346b7b 100644 --- a/docs/Application_guide/en/system/memory-management.md +++ b/docs/Application_guide/en/system/memory-management.md @@ -188,7 +188,7 @@ Memory management algorithms can help reduce memory fragmentation, but it cannot #### Heap Safety Margin -Although heap space is dynamically allocated and deallocated, it is important to ensure that there is enough remaining heap space to meet the memory requirements of complex operations. The total heap space is determined by the underlying system, and this value is fixed after firmware generation. The function `_thread.get_heap_size` can be used to check the current remaining heap space. For more information on how to use this function, refer to the [thread- Multi-threading](https://python.quectel.com/doc/API_reference/en/stdlib/_thread.html). +Although heap space is dynamically allocated and deallocated, it is important to ensure that there is enough remaining heap space to meet the memory requirements of complex operations. The total heap space is determined by the underlying system, and this value is fixed after firmware generation. The function `_thread.get_heap_size` can be used to check the current remaining heap space. For more information on how to use this function, refer to the [thread- Multi-threading](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/_thread.html). #### Memory Leaks @@ -353,13 +353,13 @@ The GC collection will be triggered in the following situations: #### How to trigger the GC collection? -Call the `gc.collect()` function. For specific usage of this function, refer to the [gc- Control the Garbage Collector](https://python.quectel.com/doc/API_reference/en/stdlib/gc.html#%3Ccode%3Egc.collect%3C/code%3E). +Call the `gc.collect()` function. For specific usage of this function, refer to the [gc- Control the Garbage Collector](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/gc.html#%3Ccode%3Egc.collect%3C/code%3E). ## Python Programming Considerations ### Stack Overflow, Thread Stack Too Small -If the stack space size is smaller than what is required by the business logic, it may cause data operations during the business process to go beyond the boundaries of other memory spaces, leading to data corruption and system program exceptions. Therefore, it is necessary to allocate an appropriate stack space size based on the complexity of the business logic. This can be done by calling the `_thread.stack_size()` function before creating a thread. For specific usage of this function, refer to the [thread- Multi-threading](https://python.quectel.com/doc/API_reference/en/stdlib/_thread.html#%3Ccode%3E_thread.stack_size%3C/code%3E). +If the stack space size is smaller than what is required by the business logic, it may cause data operations during the business process to go beyond the boundaries of other memory spaces, leading to data corruption and system program exceptions. Therefore, it is necessary to allocate an appropriate stack space size based on the complexity of the business logic. This can be done by calling the `_thread.stack_size()` function before creating a thread. For specific usage of this function, refer to the [thread- Multi-threading](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/_thread.html#%3Ccode%3E_thread.stack_size%3C/code%3E). ### Using Variables After They Have Been Garbage Collected diff --git a/docs/Application_guide/en/system/power-consumption.md b/docs/Application_guide/en/system/power-consumption.md index 176b4e8dc57bf738bcf56f57c03946a894e420ce..d109db1b5adf057643c2ea9f834dc378a48ef800 100644 --- a/docs/Application_guide/en/system/power-consumption.md +++ b/docs/Application_guide/en/system/power-consumption.md @@ -65,14 +65,14 @@ The reason is that some peripherals need to be continuously refreshed (such as L Autosleep is essentially a flag that operates in the sleep detection mechanism of RTOS. When autosleep is not enabled, the detection mechanism instructs the module to remain in IDLE state. When autosleep is enabled, the detection mechanism considers that the module is allowed to be in sleep state, and enter sleep. -Please refer to [Set Automatic Sleep Mode](https://python.quectel.com/doc/API_reference/en/syslib/pm.html#Set-Automatic-Sleep-Mode) +Please refer to [Set Automatic Sleep Mode](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/pm.html#Set-Automatic-Sleep-Mode) #### Wakelock Mechanism In certain scenarios, we need the module to enter a sleep mode while also ensuring the normal operation of specific peripherals within certain code segments. In such cases, we introduce a sleep lock mechanism. The wakelock is essentially a flag and allows for the creation of multiple wakelocks. The operating principle is as follows: as long as any wakelock is in locked state, the module will not enter sleep mode. -Please refer to [Create Wakelock](https://python.quectel.com/doc/API_reference/en/syslib/pm.html#Create-Wakelock). +Please refer to [Create Wakelock](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/pm.html#Create-Wakelock). #### Factors Affecting Cellular Communication Module Sleep @@ -442,7 +442,7 @@ PSM_INT is the pin that wakes up PSM, which is generally led out from the PMIC. The RTC alarm can wake up the module from PSM. Its usage is the same as that of the shutdown RTC alarm when module shutdown . -Refer to: [RTC API Reference Manual](https://python.quectel.com/doc/API_reference/en/peripherals/machine.RTC.html#Constructor) +Refer to: [RTC API Reference Manual](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.RTC.html#Constructor) #### Powerkey @@ -538,7 +538,7 @@ psm_failed_handle(psm_failed_delay_time) # Run error handling. If the module can PSM can be used when the module is connected to the network and the operator supports PSM. The ACT and TAU periods can be set through API according to the business requirements: -Please refer to [PSM API Documentation](https://python.quectel.com/doc/API_reference/en/syslib/pm.html#Set-PSM-Time) +Please refer to [PSM API Documentation](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/pm.html#Set-PSM-Time) #### PSM_INT Application @@ -657,7 +657,7 @@ After the hardware connection of the device under test is completed, do not powe ### Measuring Module Sleep Current -After measuring the shutdown current value, press and hold the power key to power on the module. The default power consumption mode of the module when it is powered on is IDLE. Please call the interface related to sleep to make the module enter sleep when it is idle. The operation method can be found in the [Autosleep API](https://python.quectel.com/doc/API_reference/en/syslib/pm.html#Set-Automatic-Sleep-Mode). After setting to sleep, disconnect the USB. The module cannot enter sleep when the USB is connected. +After measuring the shutdown current value, press and hold the power key to power on the module. The default power consumption mode of the module when it is powered on is IDLE. Please call the interface related to sleep to make the module enter sleep when it is idle. The operation method can be found in the [Autosleep API](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/pm.html#Set-Automatic-Sleep-Mode). After setting to sleep, disconnect the USB. The module cannot enter sleep when the USB is connected. After entering sleep mode, the module should have a periodic and stable current consumption waveform, which is the DRX period mentioned above, as shown in the following figure: @@ -667,7 +667,7 @@ Because the power consumption of a single DRX period has a certain randomness, t ### Measuring the Idle Current of the Module When It Is Powered On -After completing the current consumption test under network connection, reconnect the USB. Give command to the module to disable the RF, the interfaces can be found at [net - Work Mode Configuration](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Work-Mode-Configuration). After the configuration is completed, disconnect the USB and observe the current consumption. At this time, the module is idle and the RF is disabled, and the current consumed is the lowest level that the module can achieve when it is in sleep mode. The current consumption at this time is generally referred to as the idle current: +After completing the current consumption test under network connection, reconnect the USB. Give command to the module to disable the RF, the interfaces can be found at [net - Work Mode Configuration](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Work-Mode-Configuration). After the configuration is completed, disconnect the USB and observe the current consumption. At this time, the module is idle and the RF is disabled, and the current consumed is the lowest level that the module can achieve when it is in sleep mode. The current consumption at this time is generally referred to as the idle current: ![](../media/system/power-consumption/Current_test_CFUN0_sleep.png) diff --git a/docs/Application_guide/en/system/power-manager.md b/docs/Application_guide/en/system/power-manager.md index f0b9cbac46b5f27746b6115567ad6116c59efd13..dd079ba478b6c77b47e9a089151ca47c59bc6ebb 100644 --- a/docs/Application_guide/en/system/power-manager.md +++ b/docs/Application_guide/en/system/power-manager.md @@ -140,7 +140,7 @@ Unlike the powerkey, RESET is generally directly connected to the CPU, and its t Customizing the short press and long press functions of the powerkey is actually button detection. The implementation method is to start a timer in the interrupt when the button is pressed, and stop the timer in the interrupt when the button is released. If the timer has not expired and is stopped by the interrupt triggered by the powerkey release, it is judged as a short press. If there is no interrupt triggered by the release until timeout, it is judged as a long press. The timeout of the timer is the threshold that defines the short press and long press. -Usage of configuring custom powerkey functions: [class PowerKey - PowerKey Callback and Registration](https://python.quectel.com/doc/API_reference/en/peripherals/misc.PowerKey.html) +Usage of configuring custom powerkey functions: [class PowerKey - PowerKey Callback and Registration](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.PowerKey.html) Example code for customizing short press/long press of powerkey: @@ -325,14 +325,14 @@ Most PMICs in cellular modules have multiple ADC channels. Typically, one channe ### Typical Applications 1. **Monitoring Module VBAT Voltage** - - **Usage:** [Get Battery Voltage](https://python.quectel.com/doc/API_reference/en/peripherals/misc.Power.html#Get-Battery-Voltage) + - **Usage:** [Get Battery Voltage](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.Power.html#Get-Battery-Voltage) - This ADC channel is fixed to monitor the VBAT voltage of the module. When powering the module using a battery, this interface can be used to manage the battery. Aside from voltage measurement, when this ADC channel detects that the VBAT voltage is too high or too low, it triggers overvoltage/undervoltage interrupts on the PMIC. In this case, to protect the module hardware, the PMIC will actively change the power state, instructing the module to shut down. 2. **ADC Usage** - - **Usage:** [ADC - Voltage Collection](https://python.quectel.com/doc/API_reference/en/peripherals/misc.ADC.html) + - **Usage:** [ADC - Voltage Collection](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/misc.ADC.html) - Connect a device that outputs an analog signal to an ADC channel, allowing you to read the voltage value that the device outputs. In this scenario, you can use the device's voltage value to calculate sensor data in the application. Different PMICs have varying detection ranges for matching ADCs, which is determined based on the hardware design manual. If the output range of an analog device does not match the detected range of the ADC, voltage division may need to be designed in the hardware to match the output voltage with the ADC's effective range. In the application layer, the detected voltage can then be used to calculate the actual output value of the analog device. diff --git a/docs/Application_guide/en/system/sys-time.md b/docs/Application_guide/en/system/sys-time.md index f5e02fce54ae08148d871ab55711ecc598673e26..5e5889a2a38edc17828bf8be70a960d5d500d5a8 100644 --- a/docs/Application_guide/en/system/sys-time.md +++ b/docs/Application_guide/en/system/sys-time.md @@ -16,7 +16,7 @@ The Real-Time Clock (RTC) is an integrated circuit that can be used to establish The RTC can provide independent timekeeping services that are not dependent on the operating system. It can maintain time accuracy even when the device is powered off. -QuecPython has a built-in RTC, which can be accessed using the `machine` module. For all the usages of the RTC, please refer to the [RTC – Real Time Clock ](https://python.quectel.com/doc/API_reference/en/peripherals/machine.RTC.html)section. The following mainly introduces common operations and precautions. +QuecPython has a built-in RTC, which can be accessed using the `machine` module. For all the usages of the RTC, please refer to the [RTC – Real Time Clock ](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.RTC.html)section. The following mainly introduces common operations and precautions. > QuecPython supports multiple module models, and the RTC time accuracy may vary depending on the module model. For applications that require high time accuracy, you can choose according to the hardware manual of each chip. > Configuring the RTC time and ALARM in QuecPython modules will erase the FLASH, so it is not recommended to call them frequently. @@ -74,7 +74,7 @@ rtc.enable_alarm(1) Time is a scale, which is a scalar in physical definition. With time, the sequence of events can be determined in terms of past-present-future (time points/moments), and the duration of events and the intervals between events can be measured (time intervals). -In QuecPython, the utime module provides functions for obtaining the current time and date (UTC time), measuring time intervals, and delays. utime is a software-level time. For all the usages of utime, please refer to the standard library [utime - Time-related functions](https://python.quectel.com/doc/API_reference/en/stdlib/utime.html) section. +In QuecPython, the utime module provides functions for obtaining the current time and date (UTC time), measuring time intervals, and delays. utime is a software-level time. For all the usages of utime, please refer to the standard library [utime - Time-related functions](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/utime.html) section. #### System Tick @@ -172,7 +172,7 @@ NITZ (Network Identity and Time Zone) is a mechanism used to automatically confi NTP (Network Time Protocol) is a time synchronization protocol defined by RFC 1305. It is used for time synchronization between distributed time servers and clients. NTP uses UDP packets for transmission and uses UDP port number 123. -The packet format is shown in the following figure. Based on the content of the protocol packet, we can compare the reported time with the server time and calculate the link transmission time to calibrate the current device to keep it consistent with the server time. For all usages of NTP on QuecPython devices, refer to the [ntptime - Network Time Protocol](https://python.quectel.com/doc/API_reference/en/networklib/ntptime.html)section. +The packet format is shown in the following figure. Based on the content of the protocol packet, we can compare the reported time with the server time and calculate the link transmission time to calibrate the current device to keep it consistent with the server time. For all usages of NTP on QuecPython devices, refer to the [ntptime - Network Time Protocol](https://developer.quectel.com/doc/quecpython/API_reference/en/networklib/ntptime.html)section. ![](../media/system/sys-time/time-ntp-proto.png) @@ -274,7 +274,7 @@ utime.sleep_us(1000*1000) ### System Timer -The system timer is used to perform a certain task at a scheduled or periodic time. The timer is implemented based on the hardware timer function and can generally create up to 4 timers. For all usages of the system timer on QuecPython devices, refer to the [Timer - Control Hardware Timers](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Timer.html)section. +The system timer is used to perform a certain task at a scheduled or periodic time. The timer is implemented based on the hardware timer function and can generally create up to 4 timers. For all usages of the system timer on QuecPython devices, refer to the [Timer - Control Hardware Timers](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Timer.html)section. ```python from machine import Timer diff --git a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.md b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.md index 7d30c94f795018c40996bb9e493a3c4997ad9d8a..413a72542f4f91d82dc9dcbbc0493965ba50e94c 100644 --- a/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.md +++ b/docs/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.md @@ -42,7 +42,7 @@ QuecPython的 REPL调试需要通过串口来交互，连接QuecPython模组的 >>> uart1 = UART(UART.UART3, 115200, 8, 0, 1, 0) ``` -完成初始化后，此时通过 **USB CDC PORT** 输入的数据将不再被REPL解析，通过该方式可以达到关闭交互口的效果，此时通过交互口输入的数据将作为串口数据被解析，使用教程参考[UART API使用手册](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html) +完成初始化后，此时通过 **USB CDC PORT** 输入的数据将不再被REPL解析，通过该方式可以达到关闭交互口的效果，此时通过交互口输入的数据将作为串口数据被解析，使用教程参考[UART API使用手册](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html) 如果有关闭再重新打开的需求，使用`close`接口关闭上文创建的uart对象即可恢复REPL调试串口，以上方法通常用在产测流程中，需要在串口数据解析中增加对特定数据格式的数据进行解析，已达到指定方式可以重新打开REPL调试的串口的需求 @@ -56,7 +56,7 @@ system.replSetEnable(flag，**kw_args) 开启后可以通过启动时设置的密码来关闭交互保护 -详细使用教程参考 [system API使用手册](https://python.quectel.com/doc/API_reference/zh/syslib/system.html) +详细使用教程参考 [system API使用手册](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/system.html) ## REPL原理 diff --git a/docs/Application_guide/zh/dev-tools/VSCode-Plugin-quecpython/README.md b/docs/Application_guide/zh/dev-tools/VSCode-Plugin-quecpython/README.md index ad1a153357a941b63bf5c4377ea3d1652658ff75..ff61cabf972c0058080a2358975b99594f7c62b7 100644 --- a/docs/Application_guide/zh/dev-tools/VSCode-Plugin-quecpython/README.md +++ b/docs/Application_guide/zh/dev-tools/VSCode-Plugin-quecpython/README.md @@ -27,7 +27,7 @@ > 开始前，用户需要下载适合自己模组型号的 QuecPython 固件包，[点此查看固件包下载方式](../../media/dev-tools/VSCode-Plugin-quecpython/download-fw-pkg.png)。 -以下内容基于 [U-235 开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600u-235.html)演示。 +以下内容基于 [U-235 开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600u-235.html)演示。 ### 固件烧录 diff --git a/docs/Application_guide/zh/firmware-upgrade/firmware-burning.md b/docs/Application_guide/zh/firmware-upgrade/firmware-burning.md index fea7af00264a42727de1e5f2f27299926061c5d5..50ab645ea431299dc57e7d7f82aa120e663db337 100644 --- a/docs/Application_guide/zh/firmware-upgrade/firmware-burning.md +++ b/docs/Application_guide/zh/firmware-upgrade/firmware-burning.md @@ -8,7 +8,7 @@ 给模组烧录固件之前，需要给模组一个触发条件，让其进入一段特殊的程序，这段程序用来接收上位机发送的固件数据，并将固件数据写入到模组的 flash 中。这种过程，我们称之为进入烧录模式。 -不同系列的模组（[点此查看模组型号与平台的对应关系](https://python.quectel.com/doc/Application_guide/zh/background/hardware-platform.html#模组型号与平台的对应关系))，进入烧录模式的方法不尽相同。整体来说有三类： +不同系列的模组（[点此查看模组型号与平台的对应关系](https://developer.quectel.com/doc/quecpython/Application_guide/zh/background/hardware-platform.html#模组型号与平台的对应关系))，进入烧录模式的方法不尽相同。整体来说有三类： ### 将模组 boot 引脚接地 diff --git a/docs/Application_guide/zh/firmware-upgrade/firmware-ota.md b/docs/Application_guide/zh/firmware-upgrade/firmware-ota.md index 44b2a3ab60212e28306ef92cf98df749240c9ac6..2fb0d47b25a539dc03dc702c534d8fd6f76f676d 100644 --- a/docs/Application_guide/zh/firmware-upgrade/firmware-ota.md +++ b/docs/Application_guide/zh/firmware-upgrade/firmware-ota.md @@ -81,7 +81,7 @@ OTA云平台的作用是： ​ c. 升级状态管理，如升级成功或者失败。 -借助于OTA云平台可实现网页控制OTA自动升级。使用前需要先初始化云平台相关的功能。API细节参考[QuecPython IoT 平台](https://python.quectel.com/doc/API_reference/zh/cloudlib/index.html)。 +借助于OTA云平台可实现网页控制OTA自动升级。使用前需要先初始化云平台相关的功能。API细节参考[QuecPython IoT 平台](https://developer.quectel.com/doc/quecpython/API_reference/zh/cloudlib/index.html)。 ###### 2. 接收云平台升级消息 @@ -89,7 +89,7 @@ OTA云平台的作用是： ###### 3. 下载升级包 -获取到升级包URL后，设备则调用固件升级相关API进行升级包下载、写入及校验。API细节参考[fota - 固件升级相关功能](https://python.quectel.com/doc/API_reference/zh/syslib/fota.html)。 +获取到升级包URL后，设备则调用固件升级相关API进行升级包下载、写入及校验。API细节参考[fota - 固件升级相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/fota.html)。 ###### 4. 重启 @@ -103,7 +103,7 @@ OTA云平台的作用是： ##### 阿里云 -如果使用阿里云平台的OTA功能，首先需要接入阿里云，设备如何接入阿里云可以参考[aLiYun - 阿里 IoT 平台](https://python.quectel.com/doc/API_reference/zh/cloudlib/aLiYun.html)。接入阿里云之后如何使用云平台OTA功能可以参见[阿里云物联网平台OTA升级操作相关文档](https://help.aliyun.com/document_detail/130990.html?spm=a2c4g.130990.0.0.28722110xYe5Td)。 +如果使用阿里云平台的OTA功能，首先需要接入阿里云，设备如何接入阿里云可以参考[aLiYun - 阿里 IoT 平台](https://developer.quectel.com/doc/quecpython/API_reference/zh/cloudlib/aLiYun.html)。接入阿里云之后如何使用云平台OTA功能可以参见[阿里云物联网平台OTA升级操作相关文档](https://help.aliyun.com/document_detail/130990.html?spm=a2c4g.130990.0.0.28722110xYe5Td)。 这里以阿里云为例展示OTA平台使用操作步骤： @@ -125,7 +125,7 @@ OTA云平台的作用是： ##### 腾讯云 -如果使用腾讯云平台的OTA功能，首先需要接入腾讯云，设备如何接入腾讯云可以参考[TenCentYun- 腾讯 IoT 平台](https://python.quectel.com/doc/API_reference/zh/cloudlib/TenCentYun.html)。接入腾讯云之后如何使用云平台OTA功能可以参见[腾讯云物联网开发平台固件升级协议](https://cloud.tencent.com/document/product/1081/39359)、[腾讯云物联网开发平台固件升级操作](https://cloud.tencent.com/document/product/1081/40296)。 +如果使用腾讯云平台的OTA功能，首先需要接入腾讯云，设备如何接入腾讯云可以参考[TenCentYun- 腾讯 IoT 平台](https://developer.quectel.com/doc/quecpython/API_reference/zh/cloudlib/TenCentYun.html)。接入腾讯云之后如何使用云平台OTA功能可以参见[腾讯云物联网开发平台固件升级协议](https://cloud.tencent.com/document/product/1081/39359)、[腾讯云物联网开发平台固件升级操作](https://cloud.tencent.com/document/product/1081/40296)。 ### APP升级使用步骤 @@ -141,7 +141,7 @@ OTA云平台的作用是： ###### 1. 初始化云平台功能 -借助于OTA云平台可实现网页控制OTA自动升级。使用前需要先初始化云平台相关的功能。API细节参考 [QuecPython IoT 平台](https://python.quectel.com/doc/API_reference/zh/cloudlib/index.html)。 +借助于OTA云平台可实现网页控制OTA自动升级。使用前需要先初始化云平台相关的功能。API细节参考 [QuecPython IoT 平台](https://developer.quectel.com/doc/quecpython/API_reference/zh/cloudlib/index.html)。 ###### 2. 接收云平台升级消息 @@ -149,7 +149,7 @@ OTA云平台的作用是： ###### 3. 下载升级包 -获取到升级包URL后，设备根据URL下载待升级的目标文件到文件系统中。支持单文件下载和多文件批量下载方式。API细节参考[app_fota - 用户文件升级相关功能](https://python.quectel.com/doc/API_reference/zh/syslib/app_fota.html)。 +获取到升级包URL后，设备根据URL下载待升级的目标文件到文件系统中。支持单文件下载和多文件批量下载方式。API细节参考[app_fota - 用户文件升级相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/app_fota.html)。 ###### 4. 设置升级标志 diff --git a/docs/Application_guide/zh/hardware/USB-interfaces.md b/docs/Application_guide/zh/hardware/USB-interfaces.md index b52d416c30fa2f922fc8ad270344453c1dec9b4e..20b241f02af2a787fe0e814c8ec76e50768d5164 100644 --- a/docs/Application_guide/zh/hardware/USB-interfaces.md +++ b/docs/Application_guide/zh/hardware/USB-interfaces.md @@ -90,7 +90,7 @@ Type-A 接口的 USB 电气属性如下： 驱动程序（device driver）是一种可以使计算机和设备通信的特殊程序，操作系统只能通过这个接口，才能控制硬件设备的工作。 -详细安装请参考[快速入门文档](https://python.quectel.com/doc/Getting_started/zh/index.html) +详细安装请参考[快速入门文档](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html) **目前QuecPython主要生成如下类型的串口和设备类型（以EC600M为例，其它平台类似）：** @@ -185,7 +185,7 @@ REPL，全称 Read-Eval-Print Loop（读取-评估-打印循环），是一种 总的来说，USB模拟REPL的原理是通过USB接口，提供一种实时的交互式编程和调试环境，它的主要应用是在实时编程和测试、设备配置和管理，以及故障排查和调试等方面。 -> 在QuecPython系列部分模组中REPL口也可以通过[machine.UART](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E)初始化UART3来实现普通串口功能。当我们使用UART3时，该REPL口为普通串口功能，关闭UART3时，该口自动恢复为REPL。 +> 在QuecPython系列部分模组中REPL口也可以通过[machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E)初始化UART3来实现普通串口功能。当我们使用UART3时，该REPL口为普通串口功能，关闭UART3时，该口自动恢复为REPL。 @@ -221,19 +221,19 @@ Modem 是Modulator（调制器）与Demodulator（解调器）的简称，原本 综上，蜂窝通信模组的USB模拟ECM和RNDIS接口，提供了一种高效的方式，实现设备间的网络通信和设备的远程管理。 -具体使用请参考 **[网络应用文档-USB网卡](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html)**。 +具体使用请参考 **[网络应用文档-USB网卡](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html)**。 ## 固件下载 -固件下载示例请参考[QPYcom](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)工具使用,或参考[快速入门文档](https://python.quectel.com/doc/Getting_started/zh/index.html) +固件下载示例请参考[QPYcom](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)工具使用,或参考[快速入门文档](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html) 模组的USB固件下载主要涉及以下几个步骤 : 1. **驱动安装**：参考[驱动安装](#驱动安装)章节安装，若已安装则跳过。 2. **模组识别**：连接模组到计算机的USB接口，你的操作系统应该能识别并成功加载驱动。在Windows上，你可以在设备管理器中查看模组的状态；在Linux上，你可以使用dmesg命令查看系统日志，确认模组已被系统识别。 -3. **进入下载模式**：你需要将模组置于固件下载模式。这通常需要发送特定的AT命令或通过某种特殊的操作。具体的方法应参考模组的[用户手册或开发指南](https://python.quectel.com/doc/Application_guide/zh/firmware-upgrade/firmware-burning.html)。 +3. **进入下载模式**：你需要将模组置于固件下载模式。这通常需要发送特定的AT命令或通过某种特殊的操作。具体的方法应参考模组的[用户手册或开发指南](https://developer.quectel.com/doc/quecpython/Application_guide/zh/firmware-upgrade/firmware-burning.html)。 4. **固件下载**：在模组进入固件下载模式后，你可以通过USB接口将新的固件数据发送给模组。在某些情况下，可能需要使用特殊的下载工具或者协议。完成下载后，通常需要重启模组以应用新的固件。 @@ -244,7 +244,7 @@ Modem 是Modulator（调制器）与Demodulator（解调器）的简称，原本 ### 插拔检测 -USB拔插检测接口请参考[misc.USB](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USB.html) +USB拔插检测接口请参考[misc.USB](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USB.html) 蜂窝通信模组作为一个USB设备（或称为USB从设备，USB Device），可以通过USB接口连接到主机（比如PC或嵌入式主控板）。在这种情况下，插拔检测通常由主机端进行，但模组自身也应能够识别这些连接和断开事件。 diff --git a/docs/Application_guide/zh/hardware/audio-driver.md b/docs/Application_guide/zh/hardware/audio-driver.md index 8f455f5df33ccf4eb415cc6e09095db44de20520..a9f416d403195d7a39b88839e7cbf2d231ecabc9 100644 --- a/docs/Application_guide/zh/hardware/audio-driver.md +++ b/docs/Application_guide/zh/hardware/audio-driver.md @@ -114,10 +114,10 @@ PA(Power Amplifier)音频功率放大器的作用是把来自音源或前级放 - 音频播放需要创建一个Audio对象，指定输出通道，如aud = audio.Audio(0)表示使用听筒输出。 - 音频播放可以使用aud.play(priority, breakin, filename)方法，指定播放优先级、打断模式和文件名称。支持mp3、amr和wav格式的文件播放。 - 使用aud.playStream(format, buf)方法，指定音频流格式和内容。支持mp3、amr和wav格式的音频流播放。 -音频播放的更多接口和详细使用方法见[class Audio - 音频播放](https://python.quectel.com/doc/API_reference/zh/medialib/audio.Audio.html)。 +音频播放的更多接口和详细使用方法见[class Audio - 音频播放](https://developer.quectel.com/doc/quecpython/API_reference/zh/medialib/audio.Audio.html)。 ## 语音电话 语音电话是指使用语音编解码器将语音信号转换为数字信号，通过网络传输到对方，再由对方的语音编解码器还原为语音信号的过程。 -语音电话的更多接口和详细使用方法见[voiceCall - 电话功能](https://python.quectel.com/doc/API_reference/zh/iotlib/voiceCall.html)。 +语音电话的更多接口和详细使用方法见[voiceCall - 电话功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/voiceCall.html)。 ## 录音 外部传入的声音通过麦克风的输入设备转化为电信号后，再通过Codec转化为数字信号传递给模组，模组将数字信号转化为不同格式（如AMR、WAV）的音频文件存储到Flash上。 @@ -125,7 +125,7 @@ PA(Power Amplifier)音频功率放大器的作用是把来自音源或前级放 - 录音需要创建一个Record对象，指定输入通道，如record = audio.Record(0)表示使用听筒输出。 - 使用record.start(file_name,seconds)方法，指定录音文件名称和录音长度。 -语音电话的更多接口和详细使用方法见[class Record - 录音](https://python.quectel.com/doc/API_reference/zh/medialib/audio.Record.html)。 +语音电话的更多接口和详细使用方法见[class Record - 录音](https://developer.quectel.com/doc/quecpython/API_reference/zh/medialib/audio.Record.html)。 ## TTS TTS是Text To Speech的缩写，即文本转语音，是一种能把文字内容转换为语音输出的技术。当前TTS模块主要包含如下接口： - **初始化**：使用audio.TTS()创建一个TTS对象，指定输出通道。 @@ -134,7 +134,7 @@ TTS是Text To Speech的缩写，即文本转语音，是一种能把文字内容 - **暂停**：使用TTS对象的pause()方法，可以暂停当前正在播放的语音。 - **恢复**：使用TTS对象的resume()方法，可以恢复暂停的语音。 - **设置**：使用TTS对象的set_volume()、set_speed()等方法，可以设置音量、语速等参数。 -语音电话的更多接口和详细使用方法见[class TTS - 文本到语音播放](https://python.quectel.com/doc/API_reference/zh/medialib/audio.TTS.html)。 +语音电话的更多接口和详细使用方法见[class TTS - 文本到语音播放](https://developer.quectel.com/doc/quecpython/API_reference/zh/medialib/audio.TTS.html)。 *使用注意事项：* - **数字和数值**：数字：数字之间添加空格。如“1 2 3”，会播报成 “一二三”； 数值：“123” 会 播报成 “一百二十三” diff --git a/docs/Application_guide/zh/hardware/display/display.md b/docs/Application_guide/zh/hardware/display/display.md index 6ed0e88e2065ba1e8b094018b8ae3dfa3bd3de33..c9bf6c458013630a64e858a0fbe24f8702cf734b 100644 --- a/docs/Application_guide/zh/hardware/display/display.md +++ b/docs/Application_guide/zh/hardware/display/display.md @@ -184,7 +184,7 @@ BPP < 8 时，一个字节映射到了多个像素，因此无法直接地控制 ### API 说明 -详细的接口说明请参考 [class LCD - LCD显示屏](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html) +详细的接口说明请参考 [class LCD - LCD显示屏](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html) **注意：**该部分为 QuecPython LCD 驱动的相关 API，请驱动屏幕前，详细阅读 @@ -208,9 +208,9 @@ SPI LCD 显示屏是使用 SPI 接口进行通信的 LCD 显示屏。这种显 **注意：** 原厂提供的初始化参数非常重要，后面 SPI LCD 初始化时，实际为将该参数替换成 lcd.lcd_init 所需要格式的参数。 -了解[QuecPython LCD接口](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E)，才能更好是利用它点亮屏幕 。 +了解[QuecPython LCD接口](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E)，才能更好是利用它点亮屏幕 。 -**注意：**目前 QuecPython SPI 驱动分为两种，LCM( Liquid Crystal Module )和通用 SPI( Serial Peripheral Interface )。两者的初始化接口有差异，具体详细可参考[QuecPython LCD接口](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) +**注意：**目前 QuecPython SPI 驱动分为两种，LCM( Liquid Crystal Module )和通用 SPI( Serial Peripheral Interface )。两者的初始化接口有差异，具体详细可参考[QuecPython LCD接口](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_init%3C/code%3E) **了解 LCD.lcd_init 中的参数，对于 QuecPython 驱动 LCD 至关重要，请仔细阅读如下内容。** @@ -359,7 +359,7 @@ mipi_lcd = LCD() ###### SPI LCD 初始化接口介绍 -请参考[LCM 接口 API](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Cstrong%3E%E6%8E%A5%E5%8F%A31%EF%BC%9A%E8%AE%BE%E5%A4%87%E6%8E%A5%E6%A8%A1%E5%9D%97LCM%E6%8E%A5%E5%8F%A3%3C/strong%3E) 和 [SPI LCD 接口 API](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Cstrong%3E%E6%8E%A5%E5%8F%A32%EF%BC%9A%E8%AE%BE%E5%A4%87%E6%8E%A5%E6%A8%A1%E5%9D%97SPI%E6%8E%A5%E5%8F%A3%3C/strong%3E)。 +请参考[LCM 接口 API](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Cstrong%3E%E6%8E%A5%E5%8F%A31%EF%BC%9A%E8%AE%BE%E5%A4%87%E6%8E%A5%E6%A8%A1%E5%9D%97LCM%E6%8E%A5%E5%8F%A3%3C/strong%3E) 和 [SPI LCD 接口 API](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Cstrong%3E%E6%8E%A5%E5%8F%A32%EF%BC%9A%E8%AE%BE%E5%A4%87%E6%8E%A5%E6%A8%A1%E5%9D%97SPI%E6%8E%A5%E5%8F%A3%3C/strong%3E)。 ###### 编写初始化参数 @@ -495,7 +495,7 @@ spilcd.lcd_init(init_st7789_240X320_p, 240,320,52000,1,4,0,invalid_st7789_240X32 该接口 十分重要，UI 就是基于该接口对屏幕进行 UI 绘制。 -[lcd.lcd_write 接口原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[lcd.lcd_write 接口原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) 注意： @@ -514,7 +514,7 @@ spilcd.lcd_write(buf,110,150,130,170) ###### 清屏 -[lcd.lcd_clear 接口原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[lcd.lcd_clear 接口原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **示例如下（ST7789V）：** @@ -528,7 +528,7 @@ spilcd.lcd_clear(0xf800) #0xf800 is represented in red in RGB565 ###### 图片显示 -[lcd.lcd_show_jpg 原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[lcd.lcd_show_jpg 原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) 注意 ：该接口并非所有模组都支持，具体支持情况请咨询移远通信技术支持。 @@ -548,7 +548,7 @@ MIPI 协议实际上是一系列接口的协议，包含液晶、摄像头等等 本章节将基于 QuecPython 铀 235 开发板驱动 ST7701S（480\*854）屏幕，介绍 MIPI LCD 的调试。 -由于 QuecPython 下 LCD 的相关**[API](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)**已经开发好，用户可以直接依照[API](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)格式，编写 MIPI 屏幕驱动。 +由于 QuecPython 下 LCD 的相关**[API](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)**已经开发好，用户可以直接依照[API](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E)格式，编写 MIPI 屏幕驱动。 **注意：** 目前 QuecPython 支持 mipi 的平台仅支持 RGB565 格式. @@ -575,7 +575,7 @@ mipi_lcd = LCD() ###### MIPI 初始化接口介绍 -[lcd.mipi_init 接口原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) +[lcd.mipi_init 接口原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.mipi_init%3C/code%3E) ```python lcd.mipi_init(initbuf, **kwargs) @@ -679,7 +679,7 @@ mipilcd.mipi_init(initbuf=bytearray(init_480X854), TransMode=1) 该接口 十分重要 ，UI 就是基于该接口对屏幕进行 UI 绘制。 -[lcd.lcd_write 接口原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) +[lcd.lcd_write 接口原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_write%3C/code%3E) 注意： @@ -718,7 +718,7 @@ mipilcd.lcd_write(test_buf1,10,10,20,20) ###### 清屏 -[lcd.lcd_clear 接口原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) +[lcd.lcd_clear 接口原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_clear%3C/code%3E) **示例如下（st7701s）：** @@ -732,7 +732,7 @@ mipilcd.lcd_clear(0xf800) #0xf800 is represented in red in RGB565 ###### 图片显示 -[lcd.lcd_show_jpg 原型](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) +[lcd.lcd_show_jpg 原型](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html#%3Ccode%3Elcd.lcd_show_jpg%3C/code%3E) 注意 ：该接口并非所有模组都支持，具体支持情况请参考 WIKI. diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO.md index f634f061f10cf205e9b21c12b997242807635051..41032f6611fa61e1a2a0bfc6b3633079c25c59b1 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO.md @@ -396,7 +396,7 @@ QuecPython系列模组支持情况如下： 主要介绍QuecPython GPIO使用以及注意事项。 -QuecPython具体GPIO相关API使用介绍:[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html) +QuecPython具体GPIO相关API使用介绍:[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html) #### 创建对象 @@ -406,7 +406,7 @@ GPIO的输入输出，上下拉，默认电平等均可在这一步骤种实现 class machine.Pin(GPIOn, [dir], [pull], [value]) ``` -参数介绍以及GPIO引脚编号与物理映射关系请参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) +参数介绍以及GPIO引脚编号与物理映射关系请参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) @@ -432,7 +432,7 @@ class machine.Pin(GPIOn, [dir], [pull], [value]) Pin.read() ``` -方法详细使用请参考[Pin.read](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.read%3C/code%3E) +方法详细使用请参考[Pin.read](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.read%3C/code%3E) 当GPIO被配置为输入时，其内部结构允许它检测并反应于施加于其上的电压。你可以查询微控制器的内部寄存器或使用提供的Pin.read方法来读取该状态。 @@ -458,7 +458,7 @@ Pin.read() Pin.write(value) ``` -方法详细使用请参考[Pin.write](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.write%3C/code%3E) +方法详细使用请参考[Pin.write](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.write%3C/code%3E) 当GPIO被配置为输出模式时，它可以输出高电平或低电平 @@ -486,7 +486,7 @@ Pin.write(value) Pin.set_dir(value) ``` -方法详细使用请参考[Pin.set_dir](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.set_dir%3C/code%3E) +方法详细使用请参考[Pin.set_dir](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3EPin.set_dir%3C/code%3E) 方向选择： @@ -513,7 +513,7 @@ Pin.set_dir(value) class machine.ExtInt(GPIOn, mode, pull, callback) ``` -方法详细使用请参考[machine.ExtInt](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html) +方法详细使用请参考[machine.ExtInt](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html) 中断触发类型： @@ -548,7 +548,7 @@ extint.enable() extint.disable() ``` -方法详细使用请参考[Eextint.enable](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.enable%3C/code%3E)和[Extint.disable](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.disable%3C/code%3E) +方法详细使用请参考[Eextint.enable](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.enable%3C/code%3E)和[Extint.disable](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html#%3Ccode%3Eextint.disable%3C/code%3E) 使能： @@ -568,7 +568,7 @@ extint.disable() 2. **全局与局部**：在一些系统中，你可以选择失能所有中断（全局失能）或仅失能特定的中断源（局部失能）。 3. **安全性**：在失能中断后，务必记得在适当的时候再次使能它，否则可能会导致系统无法响应某些关键事件。 -其它方法使用请详细参考WiKi [machine.ExtInt](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html) +其它方法使用请详细参考WiKi [machine.ExtInt](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html) @@ -693,7 +693,7 @@ QuecPython除了BG95的模组外，所有的GPIO都支持中断功能。 BG95系列可通过查看[GPIO复用表](https://python.quectel.com/resource-download?cid=19)获取支持中断功能的GPIO。 -除了EC600E/EC800E外，其他平台支持触发中断的GPIO都支持双边沿触发中断。EC600E/EC800E平台仅支持单边沿触发中断，且设置中断时，上拉和下拉状态仅支持其中一种，具体情况可以参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)模块。 +除了EC600E/EC800E外，其他平台支持触发中断的GPIO都支持双边沿触发中断。EC600E/EC800E平台仅支持单边沿触发中断，且设置中断时，上拉和下拉状态仅支持其中一种，具体情况可以参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)模块。 ### 唤醒中断 diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_Button.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_Button.md index 3fe0c7e42d0beddfcdc473f08f1566c8bc9d8d25..c6cceb63f63f7fea6af470493d3ad1520072e533 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_Button.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_Button.md @@ -96,7 +96,7 @@ class Button(gpio,timer_id) - 功能：创建Button对象 - 返回：Button对象 - Button：Button类 -- gpio：控制LED的GPIO编号。 详细请参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)。 +- gpio：控制LED的GPIO编号。 详细请参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)。 ```python import machine diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_LED.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_LED.md index 6a37e78c5530bbaa3b9f7eba0e9f454b5dd6d8cc..d6dbedefd7152a6042a897d297eeac670210d47f 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_LED.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_LED.md @@ -21,7 +21,7 @@ LED(gpio) - 功能：创建LED对象 - 返回：LED对象 - LED：LED类 -- gpio：控制LED的GPIO编号。 详细请参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html) +- gpio：控制LED的GPIO编号。 详细请参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html) ```python LED.on() @@ -130,7 +130,7 @@ multi_led.all_on() # 打开所有LED ![image-20230705163113093](../../media/hardware/peripheral-interfaces/GPIO/GPIO_EVB_1.png) -> NET_STATUS 默认作为网络指示灯使用，我们需要先通过API关闭网络灯功能。禁止网络灯功能相关API介绍:[misc](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.html) +> NET_STATUS 默认作为网络指示灯使用，我们需要先通过API关闭网络灯功能。禁止网络灯功能相关API介绍:[misc](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.html) > > 可以直接在EC600U模组上运行以下代码关闭网络灯 > @@ -144,7 +144,7 @@ multi_led.all_on() # 打开所有LED 网络灯功能关闭后，按照以下几个步骤执行。 1. 通过的[硬件设计手册](https://python.quectel.com/resource-download?cid=20)找到 EC600U 模组控制网络灯的引脚，查找后可以得知EC600U的 NET_STATUS 由引脚号54控制。 -2. 获取到引脚号之后，你可以通过 [machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html) 模块**GPIO引脚编号与物理引脚的映射关系**找到EC600U 模组引脚号54对应的GPIO号为GPIO14。 +2. 获取到引脚号之后，你可以通过 [machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html) 模块**GPIO引脚编号与物理引脚的映射关系**找到EC600U 模组引脚号54对应的GPIO号为GPIO14。 3. 编写控制LED灯脚本并运行。 使用QPYcom运行以上代码后，我们就可以观察到 NET_STATUS 在以1秒的时间间隔不断闪烁。 diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_One_wire.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_One_wire.md index 288296c42cd513683174307f9f14335fe49fab70..0a6cd55920bd139366479a87e1c0f30b91300f04 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_One_wire.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_One_wire.md @@ -81,7 +81,7 @@ ## 功能概述 -在QuecPython系列模组中，目前 EC200U/EC600U/EG912U/EG915U 支持该功能。具体单总线相关API使用介绍：[machine.OneWire](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.OneWire.html) +在QuecPython系列模组中，目前 EC200U/EC600U/EG912U/EG915U 支持该功能。具体单总线相关API使用介绍：[machine.OneWire](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.OneWire.html) ### 对象创建 @@ -89,7 +89,7 @@ class machine.OneWire(GPIOn) ``` -GPIO引脚编号与物理映射关系请参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html) +GPIO引脚编号与物理映射关系请参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html) 在通信模组系列中可用，因此请确保先导入它。然后您可以使用以下方法创建一个one-wire： diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_sif.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_sif.md index 487dde7f1cdbb7acc3970ec910d9fb79d3f65187..ed9c7c4c35a70c4042c3dae08d68db5bbbd5fa59 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_sif.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/GPIO_sif.md @@ -65,7 +65,7 @@ import sif sif.init(gpio, cb) ``` -GPIO引脚编号与物理映射关系请参考[machine.Pin](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) +GPIO引脚编号与物理映射关系请参考[machine.Pin](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html#%3Ccode%3Emachine.Pin%3C/code%3E) 在通信模组系列中可用，因此请确保先导入它。然后您可以使用以下方法使用sif从机功能： diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/IIC.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/IIC.md index 1e96ff7dc436d5fe43a1b22ca412f1719755ab9f..0507cf91c5be9a9909b3eafed047ad1c376c156e 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/IIC.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/IIC.md @@ -34,7 +34,7 @@ IIC拓扑结构如下： 软件模拟IIC是一种使用普通的GPIO引脚，通过软件控制引脚的电平变化，来模拟IIC协议的通信方式。 当芯片自带的IIC个数无法满足需求或者所用引脚被其他功能占用时，可以使用软件模拟IIC接口来实现功能。 -当前部分模组可支持模拟IIC，频率可在1~100k范围内设置，具体设置频率方法见[WIKI-I2C_simulation](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.I2C_simulation.html)。 +当前部分模组可支持模拟IIC，频率可在1~100k范围内设置，具体设置频率方法见[WIKI-I2C_simulation](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.I2C_simulation.html)。 支持模拟IIC模组如下： - EC600M-CN系列 - EC800M-CN系列 @@ -60,7 +60,7 @@ IIC拓扑结构如下： 2. [发送数据](#发送数据) 3. [接收数据](#接收数据) -详细API介绍请参考[machine.IIC](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.I2C.html) +详细API介绍请参考[machine.IIC](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.I2C.html) ### 创建对象 @@ -70,7 +70,7 @@ IIC拓扑结构如下： class machine.I2C(I2Cn, MODE) ``` -参数介绍以及引脚对应关系请参考[machine.IIC](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.I2C.html) +参数介绍以及引脚对应关系请参考[machine.IIC](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.I2C.html) 创建对象时，需注意以下几点： @@ -88,7 +88,7 @@ I2C.write(slaveaddress, addr, addr_len, data, datalen) - addr_len为寄存器地址长度，寄存器地址长度可从外设芯片数据手册中确认，目前经常用到的IIC外设芯片的寄存器地址长度一般是一个字节，如QMA7981三轴传感器芯片。 -API介绍请参考[machine.UART.write](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) +API介绍请参考[machine.UART.write](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) ### 接收数据 ```python @@ -101,7 +101,7 @@ I2C.read(slaveaddress, addr, addr_len, r_data, datalen, delay) **2. delay参数设置：** 由于部分IIC外设芯片收到主机写数据指令后需要延时才能正常返回数据，所以在模组（主机）发送完写指令后延时一段时间再读取IIC外设芯片数据，如图： -API及参数含义介绍请参考[machine.UART.read](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) +API及参数含义介绍请参考[machine.UART.read](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) ## 应用案例 diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/SPI.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/SPI.md index c62573c90802e2f7585edeafb19d9f76a7b0d9f8..bd72c914e23cf298717dad3d468e8d9b7b90142d 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/SPI.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/SPI.md @@ -116,7 +116,7 @@ lcd.lcd_init(lcd_init_data, lcd_width, lcd_hight, lcd_clk, data_line, line_num, ``` 和LCD SPI引脚相比，初始化参数中增加了SPI模式、SPI口以及CS、DC、RST引脚。 -具体示例可参考[WIKI-LCD](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html)中的参考代码。 +具体示例可参考[WIKI-LCD](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html)中的参考代码。 ### MCP2515 CAN控制器 diff --git a/docs/Application_guide/zh/hardware/peripheral-interfaces/UART.md b/docs/Application_guide/zh/hardware/peripheral-interfaces/UART.md index 64c85c730f9baa6c4c3c0e4e6d8826531c2077c0..5491cc6b289f03b7744a9a2518ff5439e427d603 100644 --- a/docs/Application_guide/zh/hardware/peripheral-interfaces/UART.md +++ b/docs/Application_guide/zh/hardware/peripheral-interfaces/UART.md @@ -230,7 +230,7 @@ DMA传输本身并不会中断程序，但它会占用系统资源：比如IO或 ## 支持情况 -QuecPython各模组支持情况见[machine.UART](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E) +QuecPython各模组支持情况见[machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E) ## 数据流 @@ -270,7 +270,7 @@ RX通信：接收数据满64字节或超时->触发中断->触发回调函数发 4. [中断](#中断) 5. [RS485控制](#RS485控制) -详细API介绍请参考[machine.UART](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html) +详细API介绍请参考[machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html) ### 创建对象 @@ -280,7 +280,7 @@ UART通信参数在这一步骤中配置。包括波特率、数据位、奇偶 class machine.UART(UART.UARTn, baudrate, databits, parity, stopbits, flowctl) ``` -参数介绍以及引脚对应关系请参考[machine.UART](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E) +参数介绍以及引脚对应关系请参考[machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Emachine.UART%3C/code%3E) 创建对象时，需注意以下几点： @@ -303,7 +303,7 @@ msg = "This is a test string" uart.write(msg) ``` -API介绍请参考[machine.UART.write](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) +API介绍请参考[machine.UART.write](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.write%3C/code%3E) ### 接收数据 @@ -322,7 +322,7 @@ msg = uart.read(msg_len) **3. 数据格式：** 接收的数据格式必须符合发送端的设置。这包括数据的编码方式（例如ASCII、UTF-8、二进制等）、数据位的数量、起始位、停止位和奇偶校验位等。 -API介绍请参考[machine.UART.read](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) +API介绍请参考[machine.UART.read](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.read%3C/code%3E) ### 中断 @@ -339,7 +339,7 @@ def uart_call(para): uart1.set_callback(uart_call) ``` -API介绍请参考[machine.UART.setCallback](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.set_callback%3C/code%3E) +API介绍请参考[machine.UART.setCallback](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.set_callback%3C/code%3E) > 未避免中断长时间执行，请在回调函数中以发送信号量等方式，告知其它线程读取串口数据 @@ -347,7 +347,7 @@ API介绍请参考[machine.UART.setCallback](https://python.quectel.com/doc/API_ 控制485通信方向，串口发送数据之前和之后进行拉高拉低指定GPIO，用来指示485通信的方向。 -API介绍请参考[machine.UART.control_485](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E) +API介绍请参考[machine.UART.control_485](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E) ## 应用示例 @@ -365,7 +365,7 @@ API介绍请参考[machine.UART.control_485](https://python.quectel.com/doc/API_ QuecPython提供了简化的方法来在通信模组上使用 Python 进行 UART 通信。对于实时应用或需要高效处理 UART 信息的场景，使用回调函数（基于中断）进行 UART 读取是一种非常有效的方法。 - 实验前需了解UART QuecPython接口，请参考[machine.UART](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html) + 实验前需了解UART QuecPython接口，请参考[machine.UART](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html) 实验步骤： @@ -455,7 +455,7 @@ if __name__ == "__main__": 使用 UART 连接 GNSS (Global Navigation Satellite System) 接收器是嵌入式系统中一个常见的应用场景。GNSS 包括 GPS (Global Positioning System)、GLONASS、Galileo、BeiDou 等全球定位系统。这种连接允许系统读取 GNSS 数据，以获取当前位置、速度、时间和其他相关信息。 -QuecPython部分模组目前已集成外置GNSS功能，并提供了一系列接口，详细请参考[gnss_wiki](https://python.quectel.com/doc/API_reference/zh/gnsslib/gnss.html)。用户可直接使用GNSS系列接口对数据进行获取，可以得到模块定位是否成功，定位的经纬度数据，UTC授时时间，获取GPS模块的定位模式，获取GPS模块定位使用卫星数量，获取GPS模块定位可见卫星数量，获取定位方位角，GPS模块对地速度，模块定位大地高等数据信息。目前，该模块提供的功能接口，所获取的数据都来源于从串口读出的原始GNSS数据包中的GNGGA、GNRMC和GPGSV语句。 +QuecPython部分模组目前已集成外置GNSS功能，并提供了一系列接口，详细请参考[gnss_wiki](https://developer.quectel.com/doc/quecpython/API_reference/zh/gnsslib/gnss.html)。用户可直接使用GNSS系列接口对数据进行获取，可以得到模块定位是否成功，定位的经纬度数据，UTC授时时间，获取GPS模块的定位模式，获取GPS模块定位使用卫星数量，获取GPS模块定位可见卫星数量，获取定位方位角，GPS模块对地速度，模块定位大地高等数据信息。目前，该模块提供的功能接口，所获取的数据都来源于从串口读出的原始GNSS数据包中的GNGGA、GNRMC和GPGSV语句。 本章节基于L76K定位芯片为例展开介绍 @@ -575,7 +575,7 @@ RS-485 可以在半双工模式下工作，这意味着它可以在同一时间 在发送数据之前，GPIO 被设置为 "高"，然后发送数据。数据发送完毕后，GPIO 被设置为 "低"，从而切换到接收模式。 -QuecPython支持在UART中加入GPIO控制方向的传输。[uart.control_485](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E) 可以控制485通信方向，串口发送数据之前和之后进行拉高拉低指定GPIO，用来指示485通信的方向。 +QuecPython支持在UART中加入GPIO控制方向的传输。[uart.control_485](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.UART.html#%3Ccode%3Euart.control_485%3C/code%3E) 可以控制485通信方向，串口发送数据之前和之后进行拉高拉低指定GPIO，用来指示485通信的方向。 当方向设置为1时表示： 串口发送数据之前由低拉高、发送数据之后再由高拉低 diff --git a/docs/Application_guide/zh/hardware/sensors/accelerometer/README.md b/docs/Application_guide/zh/hardware/sensors/accelerometer/README.md index 215c5790e5be99d7a46c2409e3a1e333de95ff77..7a60f14470445bef896d555b165833cb1e9eb7ea 100644 --- a/docs/Application_guide/zh/hardware/sensors/accelerometer/README.md +++ b/docs/Application_guide/zh/hardware/sensors/accelerometer/README.md @@ -383,7 +383,7 @@ class lis2dh12(object): > > - 中断使能接口`int_enable`的参数需结合规格书和具体应用场景决定，比如希望中断不会经常误触发，则阈值参数`int_ths`和持续时间参数`duration`需要稍微设置较大，数值随具体测试效果而定。 > - 三轴传感器在z轴竖直向上放置且没有外力作用的时候，`x`,`y`,`z`轴的加速度基本是(0,0,1)，单位`G`。据此可以判断传感器读取计算加速度是否正常。 -> - 开发的时候尽量用[外部中断](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html)的方式来处理中断，而非轮询传感器中断寄存器的方式，后者会导致进不了低功耗模式。 +> - 开发的时候尽量用[外部中断](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html)的方式来处理中断，而非轮询传感器中断寄存器的方式，后者会导致进不了低功耗模式。 主程序代码设计如下： diff --git a/docs/Application_guide/zh/helios-sdk/junior.md b/docs/Application_guide/zh/helios-sdk/junior.md index df9660385ce65e4e6134b858b3840070d0fb4c73..c9937621c86b38fb46b297d77ce181e3bcdef0f8 100644 --- a/docs/Application_guide/zh/helios-sdk/junior.md +++ b/docs/Application_guide/zh/helios-sdk/junior.md @@ -166,5 +166,5 @@ print ('Hello, QuecPython!') 此时，我们已经使用QuecPython做了第一个最简单的应用开发。 -QuecPython更多的功能探索和接口使用，请访问 [API 参考手册](https://python.quectel.com/doc/API_reference/zh/index.html)。 +QuecPython更多的功能探索和接口使用，请访问 [API 参考手册](https://developer.quectel.com/doc/quecpython/API_reference/zh/index.html)。 diff --git a/docs/Application_guide/zh/multi-media/lvgl/lvgl_demo.md b/docs/Application_guide/zh/multi-media/lvgl/lvgl_demo.md index c58d02c038aa781ef7bd1042c69d97ad942557f1..713eee7ac5b059c803e89e0816a2f09304ce3327 100644 --- a/docs/Application_guide/zh/multi-media/lvgl/lvgl_demo.md +++ b/docs/Application_guide/zh/multi-media/lvgl/lvgl_demo.md @@ -38,7 +38,7 @@ ### LCD初始化 -LCD的初始化部分参见wiki：[machine LCD](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html) +LCD的初始化部分参见wiki：[machine LCD](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html) 本示例使用的是分辨率240*320的ST7789屏。以下为LCD初始化部分代码： diff --git a/docs/Application_guide/zh/multi-media/lvgl/lvgl_flow.md b/docs/Application_guide/zh/multi-media/lvgl/lvgl_flow.md index d967d212e9b3e276c4ecc5fbcd6bfd8ab40e1807..75953f08421a5636ec89c52e6d0617f50665ee84 100644 --- a/docs/Application_guide/zh/multi-media/lvgl/lvgl_flow.md +++ b/docs/Application_guide/zh/multi-media/lvgl/lvgl_flow.md @@ -20,7 +20,7 @@ LVGL通过注册的LCD显示驱动对象，将绘制的图形数据刷新到LCD LVGL初始化流程如下： -1. 正确初始化LCD显示屏，参照[class LCD - LCD显示屏](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html)。 +1. 正确初始化LCD显示屏，参照[class LCD - LCD显示屏](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html)。 2. 初始化显示负载。 3. 初始化显示驱动，指定刷新接口为LCD对象的写屏接口 4. 如果有TP等输入设备，初始化TP对象。 @@ -94,7 +94,7 @@ lv.task_handler() > **注意：** > -> - LCD初始化部分参照[class LCD - LCD显示屏](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html)。 +> - LCD初始化部分参照[class LCD - LCD显示屏](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html)。 > > - LVGL需要LCD对象提供lcd_write接口来刷新屏幕。 > - LVGL需要TP对象提供read接口来进行触摸输入。 diff --git a/docs/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.md b/docs/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.md index a7b86f5317105f20997e8b6209f9bf29547feb4d..3e58b4f39e94c300dc163f97977033b78f0d6b33 100644 --- a/docs/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.md +++ b/docs/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.md @@ -101,7 +101,7 @@ GUI guider生成的脚本与实际应用的脚本还有些轻微差异。稍微 ### 添加LCD的初始化 -在gui guider生成的py文件开始添加LCD显示屏初始化代码，参照[wiki](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.LCD.html)。 +在gui guider生成的py文件开始添加LCD显示屏初始化代码，参照[wiki](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.LCD.html)。 ### 修改生成的代码 diff --git a/docs/Application_guide/zh/network-comm/esim/README.md b/docs/Application_guide/zh/network-comm/esim/README.md index c2a38920efdea52f4653247aaf7e3f1004df2e60..1b324503f752e5d3c0b4277535c69dff7a8e57f2 100644 --- a/docs/Application_guide/zh/network-comm/esim/README.md +++ b/docs/Application_guide/zh/network-comm/esim/README.md @@ -545,5 +545,5 @@ if __name__ == '__main__': ### 提示eSIM卡未插卡 -请参考QuecPtyhon官网wik蜂窝无线网卡[网络异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#开机时网络异常处理)。 +请参考QuecPtyhon官网wik蜂窝无线网卡[网络异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#开机时网络异常处理)。 diff --git a/docs/Application_guide/zh/network-comm/net-protocols/ftp.md b/docs/Application_guide/zh/network-comm/net-protocols/ftp.md index aced553cd08159a1c17e2f42109891365500f518..de8748b4433a485063c064d621eaf5fabc437e9d 100644 --- a/docs/Application_guide/zh/network-comm/net-protocols/ftp.md +++ b/docs/Application_guide/zh/network-comm/net-protocols/ftp.md @@ -115,14 +115,14 @@ QuecPython 提供了`ftplib`模块，用于FTP客户端连接使用，本节分 2. 连接到网络：确保您的设备能连接到网络。 3. QuecPython固件中包含ftplib模块。 -完成固件烧录后需要检测当前固件是否包含`ftplib`模块以及找网状态，可使用[Qpycom工具](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html)进行调试，本文演示均使用该工具。在工具交互页面通过导入模块的方式来确认是否包含和使用API检测网络情况，python语法通过`import xxx`或`from xx import xxx`的方式导入API。 +完成固件烧录后需要检测当前固件是否包含`ftplib`模块以及找网状态，可使用[Qpycom工具](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html)进行调试，本文演示均使用该工具。在工具交互页面通过导入模块的方式来确认是否包含和使用API检测网络情况，python语法通过`import xxx`或`from xx import xxx`的方式导入API。 ```python # 未抛出异常则包含 from ftplib import FTP ``` -通过导入API`checkNet`来进行查询设备网络情况，状态值请查看[wiki](https://python.quectel.com/doc/API_reference/zh/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E)。 +通过导入API`checkNet`来进行查询设备网络情况，状态值请查看[wiki](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E)。 ```python import checkNet diff --git a/docs/Application_guide/zh/network-comm/net-protocols/mqtt.md b/docs/Application_guide/zh/network-comm/net-protocols/mqtt.md index b256ed6653096b180ce74f4c893ba7af2ae1635c..d3d6c75ba397ff3e52f7eafff2e813fcd5ead3ba 100644 --- a/docs/Application_guide/zh/network-comm/net-protocols/mqtt.md +++ b/docs/Application_guide/zh/network-comm/net-protocols/mqtt.md @@ -41,7 +41,7 @@ MQTT还支持保留消息（Retained Message），即发布者可以发布保留 ![image-20230701163911290](../../media/network-comm/net-protocols/mqtt/mqtt_1.png) -- MQTT客户端：MQTT客户端是连接到MQTT服务端的设备或应用程序，每个客户端都具有唯一的客户端标识符（Client Identifier），用于在服务端中识别和区分不同的客户端。在QuecPython中我们通过`umqtt`实现MQTT客户端，通过传入初始化连接参数创建连接对象，[点击查看详情](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3Eumqtt.MQTTClient%3C/code%3E)。 +- MQTT客户端：MQTT客户端是连接到MQTT服务端的设备或应用程序，每个客户端都具有唯一的客户端标识符（Client Identifier），用于在服务端中识别和区分不同的客户端。在QuecPython中我们通过`umqtt`实现MQTT客户端，通过传入初始化连接参数创建连接对象，[点击查看详情](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3Eumqtt.MQTTClient%3C/code%3E)。 ```python from umqtt import MQTTClient @@ -65,7 +65,7 @@ MQTT还支持保留消息（Retained Message），即发布者可以发布保留 ### 发布-订阅 -- 发布者（Publisher）：发布者是MQTT中的消息发送方，发布者将消息发布到特定的主题（Topic），并通过MQTT服务端将消息传递给订阅该主题的所有订阅者，基于`umqtt`创建客户端对象后可使用[publish](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.publish%3C/code%3E)方法进行消息发布： +- 发布者（Publisher）：发布者是MQTT中的消息发送方，发布者将消息发布到特定的主题（Topic），并通过MQTT服务端将消息传递给订阅该主题的所有订阅者，基于`umqtt`创建客户端对象后可使用[publish](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.publish%3C/code%3E)方法进行消息发布： ```python MQTTClient.publish(topic, msg, retain=False, qos=0) @@ -82,7 +82,7 @@ MQTT还支持保留消息（Retained Message），即发布者可以发布保留 - 订阅者（Subscriber）：订阅者是MQTT中的消息接收方，订阅者可以订阅感兴趣的主题，以接收与该主题相关的消息。一旦订阅者订阅了某个主题，它将接收到该主题下的所有发布消息,项目中一般以不同的事件来定义Topic，设备订阅事件主题后即可接收到该主题的推送消息。 - [点击查看示例API详情](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) + [点击查看示例API详情](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E) ```python MQTTClient.subscribe(topic,qos) @@ -111,7 +111,7 @@ MQTT定义了三个不同的QoS级别，用于控制消息传递的可靠性和 - QoS 1（最少一次）：消息发布者发布消息，确保至少传递一次，但可能导致重复传递。使用发布和确认机制实现可靠传递，适用于需要至少一次传递保证的场景。 - QoS 2（恰好一次）：消息发布者发布消息，确保恰好传递一次，通过两次握手和四次握手确认机制实现。此级别提供了最高的传递可靠性，适用于对传递准确性要求很高的场景。 -QuecPython中设置QoS等级，[详情点击查看](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E)。 +QuecPython中设置QoS等级，[详情点击查看](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.subscribe%3C/code%3E)。 ```python """ @@ -130,7 +130,7 @@ MQTTClient.publish("Quectel/Python/demo","Hello", qos=1) MQTT允许客户端在连接时设置遗嘱消息（LWT），在建立连接的过程中，客户端可以设置遗嘱消息的相关参数，包括遗嘱消息的主题（Topic），遗嘱消息的内容和QoS级别。当服务端检测到客户端未在保活时间内上报心跳包，且未发送关闭连接请求，则认为客户端为异常断开，会根据客户端设置的遗嘱消息，将遗嘱消息发布到设置的遗嘱主题，这样其他订阅了该主题的订阅者就可以接收到该遗嘱消息，以得知该客户端的离线状态。 -下面`set_last_will`为QuecPython设置遗嘱消息的API介绍，详情请[点击](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.set_last_will%3C/code%3E)： +下面`set_last_will`为QuecPython设置遗嘱消息的API介绍，详情请[点击](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.set_last_will%3C/code%3E)： ```python MQTTClient.set_last_will(topic,msg,retain=False,qos=0) @@ -157,7 +157,7 @@ MQTT通过使用长连接（Long Connection）来保持客户端和服务端之 - 断开连接检测：如果服务端在一段时间内没有收到客户端的心跳请求或其他消息，它会认为客户端断开连接，并终止连接。同样地，客户端也可以检测到服务端的断开连接，并尝试重新连接。 -MQTT初始化时配置Keep Alive不为0时默认开启保活机制，QuecPython会主动在心跳间隔时间内发送心跳包，使用的是`umqtt.ping()`方法，[点击查看详情](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.ping%3C/code%3E)： +MQTT初始化时配置Keep Alive不为0时默认开启保活机制，QuecPython会主动在心跳间隔时间内发送心跳包，使用的是`umqtt.ping()`方法，[点击查看详情](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html#%3Ccode%3EMQTTClient.ping%3C/code%3E)： ```python MQTTClient.ping() @@ -165,7 +165,7 @@ MQTTClient.ping() ## MQTT应用 -QuecPython 提供了`umqtt`模块，用于MQTT协议的客户端连接。关于`umqtt`模块接口的用法，[点此查看](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html)。 +QuecPython 提供了`umqtt`模块，用于MQTT协议的客户端连接。关于`umqtt`模块接口的用法，[点此查看](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html)。 本章节将搭建两个MQTT客户端进行演示，为方便演示效果，客户端A在PC端使用MQTT.fx工具完成搭建并连接到服务端，客户端B使用QuecPython的`umqtt`搭建。当两个客户端连接到同一服务端后，相互向对方推送主题消息，经服务端将消息转发至对方设备。在开始介绍MQTT应用演示之前，我们先通过下图初步了解下基于QuecPython完成MQTT客户端的应用流程： @@ -223,14 +223,14 @@ QuecPython 提供了`umqtt`模块，用于MQTT协议的客户端连接。关于` 1. **烧录Quecpython 固件**：请根据您的模组型号，将 Quecpython 固件烧录到您的设备上。 2. **连接到网络**：确保您的设备已正确连接到网络。 -完成固件烧录后需要检测当前固件是否包含`umqtt`模块以及找网状态，可使用[Qpycom工具](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.html)进行调试，本文演示均使用该工具。在工具交互页面通过导入模块的方式来确认是否包含和使用API检测网络情况，python语法通过`import xxx`或`from xx import xxx`的方式导入API。 +完成固件烧录后需要检测当前固件是否包含`umqtt`模块以及找网状态，可使用[Qpycom工具](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-repl.html)进行调试，本文演示均使用该工具。在工具交互页面通过导入模块的方式来确认是否包含和使用API检测网络情况，python语法通过`import xxx`或`from xx import xxx`的方式导入API。 ```python # 未抛出异常则包含 import umqtt ``` -通过导入API`checkNet`来进行查询设备网络情况，状态值请查看[wiki](https://python.quectel.com/doc/API_reference/zh/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E)。 +通过导入API`checkNet`来进行查询设备网络情况，状态值请查看[wiki](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/checkNet.html#%3Ccode%3EcheckNet.waitNetworkReady%3C/code%3E)。 ```python import checkNet diff --git a/docs/Application_guide/zh/network-comm/net-protocols/tcp-udp.md b/docs/Application_guide/zh/network-comm/net-protocols/tcp-udp.md index 5fd09d33f0afa581f254831c5801b29f82508d62..9cb872f17381614b07b2102a5ac9b7f72d22b7d7 100644 --- a/docs/Application_guide/zh/network-comm/net-protocols/tcp-udp.md +++ b/docs/Application_guide/zh/network-comm/net-protocols/tcp-udp.md @@ -98,7 +98,7 @@ TCP 协议具有以下特点： ## socket 编程 -QuecPython 提供了`usocket`模块，用于网络通信的 socket 编程。关于`usocket`模块接口的用法，[点此查看](https://python.quectel.com/doc/API_reference/zh/stdlib/usocket.html)。 +QuecPython 提供了`usocket`模块，用于网络通信的 socket 编程。关于`usocket`模块接口的用法，[点此查看](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/usocket.html)。 本节分为 TCP 网络编程、UDP 网络编程和多网卡网络编程三部分。 @@ -484,7 +484,7 @@ if __name__ == '__main__': 代码中的`server_addr = dataCall.getInfo(1, 0)[2][2]`表示获取第 1 路连接的 IPv4 协议的 IP 地址，将其作为本地服务器的 IP 地址。 > - 支持了 QuecPython 的蜂窝通信模组在上电后会自动进行第一路的蜂窝数据连接。 -> - [点此查看](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html)更多与蜂窝数据连接相关的接口用法。 +> - [点此查看](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html)更多与蜂窝数据连接相关的接口用法。 > - [点此在 github 中下载上述完整代码。](https://github.com/QuecPython/examples/blob/main/network-comm/net-protocols/tcp-udp/example_tcp_server_and_client.py) 该实验代码的运行结果如下： @@ -725,7 +725,7 @@ eth.set_up() print('Ethernet nic enabled.') ``` -> - [点此查看](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html)以太网相关的接口用法。 +> - [点此查看](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html)以太网相关的接口用法。 > - 关于以太网卡更多的编程应用指导，请查看相关文档。 #### Wi-Fi 网卡 @@ -822,7 +822,7 @@ wifi.set_default_NIC(ip_conf[0]) print('Wi-Fi is set as default NIC.') ``` -> - [点此查看 ](https://python.quectel.com/doc/API_reference/zh/wifilib/index.html)Wi-Fi 网卡相关的接口用法。 +> - [点此查看 ](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/index.html)Wi-Fi 网卡相关的接口用法。 > - 关于 Wi-Fi 网卡更多的编程应用指导，请查看相关文档。 ## 常见问题 diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/FAQ.md b/docs/Application_guide/zh/network-comm/nic/cellular/FAQ.md index 61b69dba803c1efef4793267e7c20af1b4bf9ee5..4f6a4f7525b14b5899b290741f0d498ec30f7c78 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/FAQ.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/FAQ.md @@ -62,7 +62,7 @@ APN是终端入网时必须配置的一个参数，因为他决定了设备如 * 如何配置注网APN - 通过`dataCall.setPDPContext`接口配置，并且`profileID`参数必须为1。具体的接口使用说明请参考QuecPython官网WIKI说明部分的[APN配置与获取功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)。 + 通过`dataCall.setPDPContext`接口配置，并且`profileID`参数必须为1。具体的接口使用说明请参考QuecPython官网WIKI说明部分的[APN配置与获取功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)。 * 配置后是否需要重启 @@ -84,7 +84,7 @@ APN是终端入网时必须配置的一个参数，因为他决定了设备如 **9、SIM卡可以识别，但是无法注网是什么原因？** -这种情况相对比较复杂，参考前面一个章节《网络异常处理》中的[模组网络注册失败](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5)部分，这里仅列出比较常见的几种原因： +这种情况相对比较复杂，参考前面一个章节《网络异常处理》中的[模组网络注册失败](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5)部分，这里仅列出比较常见的几种原因： * 没接射频天线或者射频天线性能差。 * 该SIM卡需要配置APN才能注册到网络，但是用户没有配置APN。 diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/api-instruction.md b/docs/Application_guide/zh/network-comm/nic/cellular/api-instruction.md index 6292a5a7c571d061744906903de68ef9592ceca2..3fb81d30491c9fa8f7300f4572201518e18a4cba 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/api-instruction.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/api-instruction.md @@ -4,7 +4,7 @@ ## 查询/设置模组工作模式 -设备工作模式是指移动终端的功能模式，即我们常说的CFUN状态。QuecPython支持设置和查询模组的工作模式，相关方法的详细说明，请参考QuecPython官网wiki说明的[工作模式配置](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F%E9%85%8D%E7%BD%AE)。 +设备工作模式是指移动终端的功能模式，即我们常说的CFUN状态。QuecPython支持设置和查询模组的工作模式，相关方法的详细说明，请参考QuecPython官网wiki说明的[工作模式配置](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F%E9%85%8D%E7%BD%AE)。 ### 查询模组工作模式 @@ -12,7 +12,7 @@ net.getModemFun() ``` -结合蜂窝网络基础概念介绍中的[CFUN](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/common-concepts.html#CFUN)部分说明，模组有3种工作模式，只有处于模式1（全功能模式）时，模组才能与蜂窝网络进行通信。 +结合蜂窝网络基础概念介绍中的[CFUN](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/common-concepts.html#CFUN)部分说明，模组有3种工作模式，只有处于模式1（全功能模式）时，模组才能与蜂窝网络进行通信。 ### 设置模组工作模式 @@ -37,7 +37,7 @@ net.setModemFun(fun [, rst]) ## 查询/设置网卡参数 -网卡参数的设置，主要包括IP协议类型、APN、用户名、密码以及加密方式。QuecPython支持设置和查询蜂窝无线网卡的参数，相关方法的详细说明，请参考QuecPython官网wiki说明的[APN配置与获取功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)。 +网卡参数的设置，主要包括IP协议类型、APN、用户名、密码以及加密方式。QuecPython支持设置和查询蜂窝无线网卡的参数，相关方法的详细说明，请参考QuecPython官网wiki说明的[APN配置与获取功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)。 ### 查询网卡参数 @@ -63,19 +63,19 @@ dataCall.setPDPContext(profileID, ipType, apn, username, password, authType) 关于如何配置APN，可以参考《场景使用说明》章节中的下面几个部分，这几部分都提供了详细的APN配置示例： -* [开机自动激活一路网卡且配置APN](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E6%B2%A1%E6%9C%89%E9%85%8D%E7%BD%AEAPN) +* [开机自动激活一路网卡且配置APN](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E6%B2%A1%E6%9C%89%E9%85%8D%E7%BD%AEAPN) -* [开机自动激活多路网卡且配置APN](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E9%85%8D%E7%BD%AEAPN) +* [开机自动激活多路网卡且配置APN](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E9%85%8D%E7%BD%AEAPN) -* [手动激活一路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活一路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) -* [手动激活多路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活多路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) ## 激活/去激活网卡 -QuecPython支持用户手动进行蜂窝无线网卡的激活与去激活，相关方法的详细说明，请参考QuecPython官网wiki说明的[激活与去激活功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E6%BF%80%E6%B4%BB%E4%B8%8E%E5%8E%BB%E6%BF%80%E6%B4%BB%E5%8A%9F%E8%83%BD)。 +QuecPython支持用户手动进行蜂窝无线网卡的激活与去激活，相关方法的详细说明，请参考QuecPython官网wiki说明的[激活与去激活功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E6%BF%80%E6%B4%BB%E4%B8%8E%E5%8E%BB%E6%BF%80%E6%B4%BB%E5%8A%9F%E8%83%BD)。 ### 激活网卡 @@ -97,15 +97,15 @@ QuecPython的模组默认开机都会自动激活蜂窝无线网卡，因此大 关于如何手动激活无线网卡，可以参考《场景使用说明》章节中的下面几个部分，这几部分都提供了详细的APN配置示例： -* [手动激活一路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活一路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) -* [手动激活多路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活多路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) ## DNS配置 -模组在进行蜂窝无线网卡激活的时候，如果激活成功，核心网是会自动分配好DNS服务器地址给模组的。也就是说正常情况下，用户是不需要手动去配置DNS服务器地址的。但是有时候会遇到核心网分配的DNS服务器地址无法使用的情况，此时就需要用户手动去配置DNS服务器地址了。QuecPython支持用户手动进行DNS配置，相关方法的详细说明，请参考QuecPython官网wiki说明的[DNS配置功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#DNS%E9%85%8D%E7%BD%AE%E5%8A%9F%E8%83%BD)。 +模组在进行蜂窝无线网卡激活的时候，如果激活成功，核心网是会自动分配好DNS服务器地址给模组的。也就是说正常情况下，用户是不需要手动去配置DNS服务器地址的。但是有时候会遇到核心网分配的DNS服务器地址无法使用的情况，此时就需要用户手动去配置DNS服务器地址了。QuecPython支持用户手动进行DNS配置，相关方法的详细说明，请参考QuecPython官网wiki说明的[DNS配置功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#DNS%E9%85%8D%E7%BD%AE%E5%8A%9F%E8%83%BD)。 ### 配置DNS @@ -121,7 +121,7 @@ dataCall.setDNSServer(profileID, simID, priDNS, secDNS) ## 获取网卡状态信息 -QuecPython支持网卡状态信息的查询，比如网卡激活状态、IP地址、DNS服务器地址等。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取拨号信息功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E8%8E%B7%E5%8F%96%E6%8B%A8%E5%8F%B7%E4%BF%A1%E6%81%AF%E5%8A%9F%E8%83%BD)。 +QuecPython支持网卡状态信息的查询，比如网卡激活状态、IP地址、DNS服务器地址等。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取拨号信息功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E8%8E%B7%E5%8F%96%E6%8B%A8%E5%8F%B7%E4%BF%A1%E6%81%AF%E5%8A%9F%E8%83%BD)。 ### 获取网卡状态信息 @@ -145,7 +145,7 @@ dataCall.getInfo(profileID, ipType) ## 设置网卡开机自动激活 -QuecPython的模组默认开机都会自动激活第一路蜂窝无线网卡，并且使用的IP协议类型是IPv4，APN/用户名/密码默认都为空。用户可以通过API来配置激活任意一路或者多路蜂窝无线网卡开机自动激活。相关方法的详细说明，请参考QuecPython官网wiki说明的[开机自动拨号功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%8B%A8%E5%8F%B7%E5%8A%9F%E8%83%BD)。 +QuecPython的模组默认开机都会自动激活第一路蜂窝无线网卡，并且使用的IP协议类型是IPv4，APN/用户名/密码默认都为空。用户可以通过API来配置激活任意一路或者多路蜂窝无线网卡开机自动激活。相关方法的详细说明，请参考QuecPython官网wiki说明的[开机自动拨号功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%8B%A8%E5%8F%B7%E5%8A%9F%E8%83%BD)。 ### 设置网卡是否开机自动激活 @@ -172,7 +172,7 @@ dataCall.setAutoActivate(profileID, enable) ## 设置网卡自动重连 -QuecPython的模组默认开机都会使能第一路蜂窝无线网卡的自动重连功能。用户可以通过API来配置任意一路或者多路蜂窝无线网卡的自动重连功能。相关方法的详细说明，请参考QuecPython官网wiki说明的[拨号自动重连功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E6%8B%A8%E5%8F%B7%E8%87%AA%E5%8A%A8%E9%87%8D%E8%BF%9E%E5%8A%9F%E8%83%BD)。 +QuecPython的模组默认开机都会使能第一路蜂窝无线网卡的自动重连功能。用户可以通过API来配置任意一路或者多路蜂窝无线网卡的自动重连功能。相关方法的详细说明，请参考QuecPython官网wiki说明的[拨号自动重连功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E6%8B%A8%E5%8F%B7%E8%87%AA%E5%8A%A8%E9%87%8D%E8%BF%9E%E5%8A%9F%E8%83%BD)。 建议如果没有特殊需求，不要关闭网卡的自动重连功能。 @@ -196,7 +196,7 @@ dataCall.setAutoConnect(profileID, enable) ## 网络事件监听 -QuecPython提供了方法让用户监听网络状态变化事件。具体方案是让用户注册回调函数，当蜂窝无线网卡与网络的连接状态发生变化时，系统会通过用户注册的回调函数来通知当前网络连接状态。相关方法的详细说明，请参考QuecPython官网wiki说明的[回调注册功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E5%9B%9E%E8%B0%83%E6%B3%A8%E5%86%8C%E5%8A%9F%E8%83%BD)。 +QuecPython提供了方法让用户监听网络状态变化事件。具体方案是让用户注册回调函数，当蜂窝无线网卡与网络的连接状态发生变化时，系统会通过用户注册的回调函数来通知当前网络连接状态。相关方法的详细说明，请参考QuecPython官网wiki说明的[回调注册功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E5%9B%9E%E8%B0%83%E6%B3%A8%E5%86%8C%E5%8A%9F%E8%83%BD)。 ### 注册回调函数 @@ -210,13 +210,13 @@ dataCall.setCallback(fun) 关于网络事件监听具体如何使用，可以参考《网络异常处理》章节中的如下部分： -* [网络异常事件处理示例](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E4%BA%8B%E4%BB%B6%E5%A4%84%E7%90%86%E7%A4%BA%E4%BE%8B) +* [网络异常事件处理示例](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E4%BA%8B%E4%BB%B6%E5%A4%84%E7%90%86%E7%A4%BA%E4%BE%8B) ## 获取信号强度 -QuecPython提供了相关API用来获取信号强度和信号质量等参数。这些参数可以帮助用户确定当前设备所处环境的信号强度和信号质量。用户常用的几个参数有CSQ、RSSI、SINR、RSRP以及RSRQ。建议用户结合前面的蜂窝网络基础概念章节中的[信号质量](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/common-concepts.html#%E4%BF%A1%E5%8F%B7%E8%B4%A8%E9%87%8F)部分一起看看。下面这些方法的详细说明，请请参考QuecPython官网wiki说明的[获取CSQ信号强度](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)和[获取详细信号强度](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)。 +QuecPython提供了相关API用来获取信号强度和信号质量等参数。这些参数可以帮助用户确定当前设备所处环境的信号强度和信号质量。用户常用的几个参数有CSQ、RSSI、SINR、RSRP以及RSRQ。建议用户结合前面的蜂窝网络基础概念章节中的[信号质量](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/common-concepts.html#%E4%BF%A1%E5%8F%B7%E8%B4%A8%E9%87%8F)部分一起看看。下面这些方法的详细说明，请请参考QuecPython官网wiki说明的[获取CSQ信号强度](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)和[获取详细信号强度](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)。 ### 查询信号强度与质量 @@ -254,7 +254,7 @@ RSRQ表示当前信道质量的信噪比和干扰水平。RSRQ是随着网络负 ## 获取小区信息 -QuecPython提供了相关API用来获取小区的相关信息，包括当前服务小区和邻区。小区信息主要包括：小区类型（服务小区、邻区）、Cid、MCC/MNC、无线频道编号、物理小区标识号等。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取小区信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E5%B0%8F%E5%8C%BA%E4%BF%A1%E6%81%AF)。 +QuecPython提供了相关API用来获取小区的相关信息，包括当前服务小区和邻区。小区信息主要包括：小区类型（服务小区、邻区）、Cid、MCC/MNC、无线频道编号、物理小区标识号等。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取小区信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E5%B0%8F%E5%8C%BA%E4%BF%A1%E6%81%AF)。 ### 查询小区小区 @@ -276,7 +276,7 @@ net.getCellInfo() ## 蜂窝网络制式 -QuecPython支持的模组中，有的模组仅支持LTE，有的支持GSM和LTE，也有的支持GSM、WCDMA和LTE。用户可以通过相关API来查询和配置模组的网络制式。相关方法的详细说明，请参考QuecPython官网wiki说明的[网络制式及漫游配置](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)。 +QuecPython支持的模组中，有的模组仅支持LTE，有的支持GSM和LTE，也有的支持GSM、WCDMA和LTE。用户可以通过相关API来查询和配置模组的网络制式。相关方法的详细说明，请参考QuecPython官网wiki说明的[网络制式及漫游配置](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)。 ### 查询网络制式 @@ -292,7 +292,7 @@ net.setConfig(mode [, roaming]) 该方法的第一个参数，就是用户需要设置的网络制式。第二个参数为是否开启漫游功能，可选参数，一般不需要设置。 -通过[网络制式及漫游配置](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)章节中`net.getConfig`的返回值说明，可以看出，可以配置的网络制式比较多，有配置成单一的某一种网络制式，也有配置成几种网络制式组合模式的。这里有如下几点需要说明清楚： +通过[网络制式及漫游配置](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)章节中`net.getConfig`的返回值说明，可以看出，可以配置的网络制式比较多，有配置成单一的某一种网络制式，也有配置成几种网络制式组合模式的。这里有如下几点需要说明清楚： * `net.getConfig`的返回值说明中虽然列举了很多模式，但是并不是所有模组都支持这些模式。每一个型号的模组具体支持哪些网络制式，需要用户查阅对应模组的模块产品规格书来确定。 @@ -313,7 +313,7 @@ net.setConfig(mode [, roaming]) ## 蜂窝网络技术 -前面我们提到有的模组支持多种网络制式，那么当模组配置为多种网络制式组合的情况下，如果模组网络注册成功了，那么它到底注册的是哪一种网络呢？此时就涉及到网络技术了，通过查询模组当前网络技术就可以判断出当前接入的是哪一种网络制式。QuecPython提供了相关API用来查询模组当前的网络技术，相关方法的详细说明，请参考QuecPython官网wiki说明的[获取网络配置模式](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E9%85%8D%E7%BD%AE%E6%A8%A1%E5%BC%8F)。 +前面我们提到有的模组支持多种网络制式，那么当模组配置为多种网络制式组合的情况下，如果模组网络注册成功了，那么它到底注册的是哪一种网络呢？此时就涉及到网络技术了，通过查询模组当前网络技术就可以判断出当前接入的是哪一种网络制式。QuecPython提供了相关API用来查询模组当前的网络技术，相关方法的详细说明，请参考QuecPython官网wiki说明的[获取网络配置模式](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E9%85%8D%E7%BD%AE%E6%A8%A1%E5%BC%8F)。 ### 查询网络技术 @@ -329,7 +329,7 @@ net.getNetMode() ## 获取运营商信息 -运营商信息是指模组当前接入的小区所属的运营商信息，包括运营商名称、MCC和MNC。QuecPython提供了相关API用来查询这些运营商信息，相关方法的详细说明，请参考QuecPython官网wiki说明的[获取运营商信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%BF%90%E8%90%A5%E5%95%86%E4%BF%A1%E6%81%AF)。 +运营商信息是指模组当前接入的小区所属的运营商信息，包括运营商名称、MCC和MNC。QuecPython提供了相关API用来查询这些运营商信息，相关方法的详细说明，请参考QuecPython官网wiki说明的[获取运营商信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%BF%90%E8%90%A5%E5%95%86%E4%BF%A1%E6%81%AF)。 ### 查询运营商信息 @@ -347,7 +347,7 @@ net.operatorName() ## 获取设备网络注册状态 -设备的蜂窝无线网络注册状态是非常重要的参数。成功激活蜂窝无线网卡的前提，就是设备必须先注网成功。QuecPython提供了相关API用来查询设备的注网状态。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取网络注册信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)。 +设备的蜂窝无线网络注册状态是非常重要的参数。成功激活蜂窝无线网卡的前提，就是设备必须先注网成功。QuecPython提供了相关API用来查询设备的注网状态。相关方法的详细说明，请参考QuecPython官网wiki说明的[获取网络注册信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)。 ### 查询设备注网状态 @@ -365,7 +365,7 @@ net.getState() ## BAND设置 -模组一般都支持多个BAND，并且默认所有支持的BAND都是开启状态。QuecPython提供了相关方法来查询和设置模组当前支持的BAND。相关方法的详细说明，请参考QuecPython官网wiki说明的[band设置与获取](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#band%E8%AE%BE%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96)。 +模组一般都支持多个BAND，并且默认所有支持的BAND都是开启状态。QuecPython提供了相关方法来查询和设置模组当前支持的BAND。相关方法的详细说明，请参考QuecPython官网wiki说明的[band设置与获取](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#band%E8%AE%BE%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96)。 > QuecPython中目前支持BAND查询和设置的API模组较少，仅BG95系列和EG912NENAA支持。 diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/application.md b/docs/Application_guide/zh/network-comm/nic/cellular/application.md index cb8b2f6e7ff59efa6d3e6fb1675a1aa4dd3bdcf9..9e080379b130bd517223bd32c525ad861d08e754 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/application.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/application.md @@ -682,7 +682,7 @@ if __name__ == '__main__': dataCall.setDNSServer(profileID, simID, priDNS, secDNS) ``` -关于该方法的详细描述，可以参考QuecPython官方网站中wiki文档的[DNS配置](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#DNS%E9%85%8D%E7%BD%AE%E5%8A%9F%E8%83%BD)部分。这里说明一下`profileID`和`simID`参数的确定。 +关于该方法的详细描述，可以参考QuecPython官方网站中wiki文档的[DNS配置](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#DNS%E9%85%8D%E7%BD%AE%E5%8A%9F%E8%83%BD)部分。这里说明一下`profileID`和`simID`参数的确定。 * `profileID` diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/common-concepts.md b/docs/Application_guide/zh/network-comm/nic/cellular/common-concepts.md index 6b5b370b8e15c19a152bd536a758b935d85fed62..7ce5f54da9a66ea8239479bc31fa44fb5d52c9ad 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/common-concepts.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/common-concepts.md @@ -10,15 +10,15 @@ APN（Access Point Name，接入点名称）指一种网络接入技术，是终 所有运营商都使用特定的APN（Access Point Name，接入点名称）。这通常是您的SIM卡预先配置的，但必要时，您需手动进行调整。 -关于APN的配置接口说明，可以参考QuecPython官方网站Wiki说明的[APN配置与获取功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)部分，具体的配置使用示例，可以参考如下几个部分： +关于APN的配置接口说明，可以参考QuecPython官方网站Wiki说明的[APN配置与获取功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#APN%E9%85%8D%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD)部分，具体的配置使用示例，可以参考如下几个部分： -* [开机自动激活一路网卡且配置APN](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E6%B2%A1%E6%9C%89%E9%85%8D%E7%BD%AEAPN) +* [开机自动激活一路网卡且配置APN](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E6%B2%A1%E6%9C%89%E9%85%8D%E7%BD%AEAPN) -* [开机自动激活多路网卡且配置APN](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E9%85%8D%E7%BD%AEAPN) +* [开机自动激活多路网卡且配置APN](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E5%BC%80%E6%9C%BA%E8%87%AA%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1%E4%B8%94%E9%85%8D%E7%BD%AEAPN) -* [手动激活一路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活一路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E4%B8%80%E8%B7%AF%E7%BD%91%E5%8D%A1) -* [手动激活多路网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) +* [手动激活多路网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/application.html#%E6%89%8B%E5%8A%A8%E6%BF%80%E6%B4%BB%E5%A4%9A%E8%B7%AF%E7%BD%91%E5%8D%A1) ### 确认用什么APN @@ -28,7 +28,7 @@ APN（Access Point Name，接入点名称）指一种网络接入技术，是终 ## CFUN -CFUN（Cellular Functionality，蜂窝功能）指移动终端的功能模式。我们在提到CFUN时，一般都是指使用`net`模块的相关方法或者`AT+CFUN`这个AT命令，来设置或者查询移动终端的功能模式。关于如何查询和设置CFUN，请参考《蜂窝网络API说明》章节的[设备工作模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/api-instruction.html#%E8%AE%BE%E5%A4%87%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F)部分。移动终端通常有如下几种功能模式： +CFUN（Cellular Functionality，蜂窝功能）指移动终端的功能模式。我们在提到CFUN时，一般都是指使用`net`模块的相关方法或者`AT+CFUN`这个AT命令，来设置或者查询移动终端的功能模式。关于如何查询和设置CFUN，请参考《蜂窝网络API说明》章节的[设备工作模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/api-instruction.html#%E8%AE%BE%E5%A4%87%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F)部分。移动终端通常有如下几种功能模式： * 最小功能模式：该模式下，整个射频网络协议栈全部关闭，SIM卡模块停止供电。这种模式下，终端设备功耗是不关机情况下最低的。 @@ -68,17 +68,17 @@ MCC（Mobile Country Code）和 MNC（Mobile Network Code）是在移动通信 在蜂窝移动网络中，信号质量是由不同的测量值来确定的，并不是只看某个参数的测量值。在不同的网络制式中，用来衡量信号质量的参数以及参数范围一般也都不同。下面是一些常见的测量值： -* [RSSI](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [RSSI](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) -* [CSQ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [CSQ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) -* [RSRP](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [RSRP](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) -* [RSRQ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [RSRQ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) -* [RSCP](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [RSCP](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) -* [SINR](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) +* [SINR](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6) ### 影响信号质量的因素 @@ -105,7 +105,7 @@ MCC（Mobile Country Code）和 MNC（Mobile Network Code）是在移动通信 ### RSSI -[RSSI](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Received Signal Strength Indicator）指接收的所有信号的总功率（单位dBm），包括导频信号、数据信号、邻区干扰信号和底噪信号等。RSSI的参数范围在不同的网络制式中有所不同，但是值越大，表示信号强度越好。 +[RSSI](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Received Signal Strength Indicator）指接收的所有信号的总功率（单位dBm），包括导频信号、数据信号、邻区干扰信号和底噪信号等。RSSI的参数范围在不同的网络制式中有所不同，但是值越大，表示信号强度越好。 RSSI通常是一个相对值，它的测量和接收设备有很大的关系。因此对于不同设备，其RSSI的衡量标准并不是完全统一的，因此下面我们提供的RSSI衡量标准仅作为一个参考： @@ -125,7 +125,7 @@ RSSI通常是一个相对值，它的测量和接收设备有很大的关系。 ### CSQ -[CSQ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)表示信号强度，是用来指示RSSI强度的参数，取值范围是0~31，数值越大表示信号强度越好。若CSQ值小于6，终端基本无法进行网络通信。CSQ和RSSI之间是有对应关系的，其对应关系如下： +[CSQ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96CSQ%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)表示信号强度，是用来指示RSSI强度的参数，取值范围是0~31，数值越大表示信号强度越好。若CSQ值小于6，终端基本无法进行网络通信。CSQ和RSSI之间是有对应关系的，其对应关系如下： $$ CSQ=(RSSI+113)/2 $$ @@ -143,7 +143,7 @@ $$ ### RSRP -[RSRP](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Reference Signal Received Power）指参考信号接收功率。是在某个符号内承载参考信号的所有RE(资源粒子)上接收到的信号功率的平均值。反应的是当前信道的路径损耗强度，用于小区覆盖的测量和小区的选择以及重选。RSRP的取值范围是-140dBm ~ -44dBm，值越大越好。 +[RSRP](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Reference Signal Received Power）指参考信号接收功率。是在某个符号内承载参考信号的所有RE(资源粒子)上接收到的信号功率的平均值。反应的是当前信道的路径损耗强度，用于小区覆盖的测量和小区的选择以及重选。RSRP的取值范围是-140dBm ~ -44dBm，值越大越好。 需要注意的是，RSRP是在LTE中才引入的概念，也就是说RSRP是用来衡量LTE网络信号强度的参数。相当于WCDMA网络中的RSCP参数。下面提供的RSRP参数衡量标准仅作为一个参考： @@ -162,7 +162,7 @@ $$ ### RSRQ -[RSRQ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Reference Signal Received Quality）指参考信号接收质量。表示当前信道质量的信噪比和干扰水平。其取值范围是-20 dB ~ -3 dB，值越大越好。RSRQ是在LTE中才引入的概念，也就是说RSRQ是用来衡量LTE网络信号强度的参数。 +[RSRQ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Reference Signal Received Quality）指参考信号接收质量。表示当前信道质量的信噪比和干扰水平。其取值范围是-20 dB ~ -3 dB，值越大越好。RSRQ是在LTE中才引入的概念，也就是说RSRQ是用来衡量LTE网络信号强度的参数。 RSRQ是RSRP和RSSI的比值，但是因为两者测量所基于的带宽可能不同，会用一个系数来调整，即 RSRQ = N*RSRP/RSSI。 @@ -181,7 +181,7 @@ RSRQ是RSRP和RSSI的比值，但是因为两者测量所基于的带宽可能 ### RSCP -[RSCP](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Receive Signal CodePower）指接收信号码功率。它是UMTS网络系统中的概念，表示接收器在特定物理信道上测量的功率。它在下行链路功率控制中用作信号强度的指示、切换标准以及计算路径损耗。RSCP的取值范围通常在-120 dBm到-25 dBm之间。 +[RSCP](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Receive Signal CodePower）指接收信号码功率。它是UMTS网络系统中的概念，表示接收器在特定物理信道上测量的功率。它在下行链路功率控制中用作信号强度的指示、切换标准以及计算路径损耗。RSCP的取值范围通常在-120 dBm到-25 dBm之间。 下面提供的RSCP参数衡量标准仅作为一个参考： @@ -197,7 +197,7 @@ RSRQ是RSRP和RSSI的比值，但是因为两者测量所基于的带宽可能 ### SINR -[SINR](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Signal to Interference plus Noise Ratio）指信号与干扰加噪声比，即接收到的有用信号的强度和接收到的干扰信号强度的比值。它是用来表示移动网络通信中信号质量的重要参数。SINR的单位是dB，范围一般是-10dB到40dB。 +[SINR](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E8%AF%A6%E7%BB%86%E4%BF%A1%E5%8F%B7%E5%BC%BA%E5%BA%A6)（Signal to Interference plus Noise Ratio）指信号与干扰加噪声比，即接收到的有用信号的强度和接收到的干扰信号强度的比值。它是用来表示移动网络通信中信号质量的重要参数。SINR的单位是dB，范围一般是-10dB到40dB。 下面提供的SINR参数衡量标准仅作为一个参考： @@ -215,13 +215,13 @@ RSRQ是RSRP和RSSI的比值，但是因为两者测量所基于的带宽可能 在移动通信中，BAND表示频段，是指无线电频谱中特定的频率范围，每个频段由一定的频率范围和带宽（频宽）组成。无线电频谱是一种有限的宝贵资源，全球的各种无线电通信服务都必须共享这一资源。为了确保各种服务之间能够和谐共存，避免相互干扰，国际电信联盟（ITU）和各国的电信管理机构会将无线电频谱划分为多个频段，每个频段被指定给一种或多种特定的服务使用。同时为了方便使用和管理，这些通信频段通常会被编号，比如Band1、Band2、Band3等。 -不同的频段有着不同的传播特性，例如，低频段的信号能够更好地穿透建筑物，而高频段的信号更适合在开阔地区或直线视距内传播。因此运营商在获取和使用频段时需要做出平衡，决定支持哪些频段，以实现网络覆盖和容量的最优化。QuecPython支持的模组中，部分模组支持band设置和查询，可参考QuecPython官方网站wiki中的[band设置与获取](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#band%E8%AE%BE%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96)部分。 +不同的频段有着不同的传播特性，例如，低频段的信号能够更好地穿透建筑物，而高频段的信号更适合在开阔地区或直线视距内传播。因此运营商在获取和使用频段时需要做出平衡，决定支持哪些频段，以实现网络覆盖和容量的最优化。QuecPython支持的模组中，部分模组支持band设置和查询，可参考QuecPython官方网站wiki中的[band设置与获取](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#band%E8%AE%BE%E7%BD%AE%E4%B8%8E%E8%8E%B7%E5%8F%96)部分。 ## 网络制式 -网络制式（Radio Access Technology，简称RAT），也叫无线接入技术，是指移动设备如何通过无线电信号连接到网络的技术。比如我们通常说的GSM、GPRS、WCDMA、CDMA2000、LTE等都是网络制式。可参考QuecPython官方网站wiki中的[网络制式及漫游配置](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)部分来设置和获取网络制式。 +网络制式（Radio Access Technology，简称RAT），也叫无线接入技术，是指移动设备如何通过无线电信号连接到网络的技术。比如我们通常说的GSM、GPRS、WCDMA、CDMA2000、LTE等都是网络制式。可参考QuecPython官方网站wiki中的[网络制式及漫游配置](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E7%BD%91%E7%BB%9C%E5%88%B6%E5%BC%8F%E5%8F%8A%E6%BC%AB%E6%B8%B8%E9%85%8D%E7%BD%AE)部分来设置和获取网络制式。 @@ -233,7 +233,7 @@ RSRQ是RSRP和RSSI的比值，但是因为两者测量所基于的带宽可能 COMPACT是一种针对GSM网络的优化技术，它通过改变控制通道的处理方式，来提高网络的频谱效率和容量。因此我们也将其归类为GSM网络技术的一种。 -EMTC（Enhanced Machine-Type Communication）是指增强型机器类通信。这是一种LTE技术，旨在提高网络对大量低功耗设备的支持。因此我们也将其归类为LTE网络技术的一种。用户可参考QuecPython官方网站wiki中的[获取网络配置模式](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E9%85%8D%E7%BD%AE%E6%A8%A1%E5%BC%8F)部分来获取设备当前使用的网络技术。 +EMTC（Enhanced Machine-Type Communication）是指增强型机器类通信。这是一种LTE技术，旨在提高网络对大量低功耗设备的支持。因此我们也将其归类为LTE网络技术的一种。用户可参考QuecPython官方网站wiki中的[获取网络配置模式](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E9%85%8D%E7%BD%AE%E6%A8%A1%E5%BC%8F)部分来获取设备当前使用的网络技术。 @@ -254,6 +254,6 @@ EMTC（Enhanced Machine-Type Communication）是指增强型机器类通信。 基站时间通常指的是无线基站的内部时钟，这个时钟为移动通信网络提供了一个精确的时间参考。在无线通信系统中，发送和接收数据需要在准确的时间窗口内进行。例如，数据传输需要准确地与基站的时间同步，否则可能会导致数据丢失或错误。因此，基站需要有一个精确的内部时钟，以便控制这些时间敏感的操作。 -此外，基站时间还有一个很常见的用处，即一些移动设备可能会通过基站时间来自动校准它们的本地时间，尤其是当移动设备在不同的时区之间移动时。而这个过程就是通过NITZ（Network Identity and Time Zone）来实现的。用户可参考QuecPython官方网站wiki中的[获取当前基站时间](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E5%BD%93%E5%89%8D%E5%9F%BA%E7%AB%99%E6%97%B6%E9%97%B4)部分来获取基站时间。 +此外，基站时间还有一个很常见的用处，即一些移动设备可能会通过基站时间来自动校准它们的本地时间，尤其是当移动设备在不同的时区之间移动时。而这个过程就是通过NITZ（Network Identity and Time Zone）来实现的。用户可参考QuecPython官方网站wiki中的[获取当前基站时间](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E5%BD%93%E5%89%8D%E5%9F%BA%E7%AB%99%E6%97%B6%E9%97%B4)部分来获取基站时间。 diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/initialization.md b/docs/Application_guide/zh/network-comm/nic/cellular/initialization.md index 4379470b8e3edfc3534b2ed00f0e5fc45793d829..e9734b723d2d835dd8452805f4e9875ee421c244 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/initialization.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/initialization.md @@ -47,7 +47,7 @@ OK **方法2：使用QuecPython的API查询** -用户可以使用QuecPython的`net.getState`方法来查询UE的网络注册状态。有关该方法的详细说明，请参考QuecPython官方网站API参考手册内[获取网络注册信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)部分。 +用户可以使用QuecPython的`net.getState`方法来查询UE的网络注册状态。有关该方法的详细说明，请参考QuecPython官方网站API参考手册内[获取网络注册信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)部分。 步骤1：将终端设备通过USB数据线连接到电脑的USB端口上。 @@ -68,7 +68,7 @@ net.getState() > 如果模组网络注册失败，请参考《网络异常处理》章节中如下部分进行排查： > -> * [模组网络注册失败](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) +> * [模组网络注册失败](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) @@ -76,7 +76,7 @@ net.getState() 当UE网络注册成功后，就会进行蜂窝无线网卡的激活操作。只有蜂窝无线网卡激活成功，UE才能获取到由核心网分配的IP地址等信息，并为系统的TCP/IP协议栈创建一路虚拟网卡。只有网卡创建并激活成功才能进行socket、http、mqtt等网络业务。该步骤对应上述流程图中的`Activate NIC`。 -用户可以通过`dataCall`模块的`dataCall.getInfo`方法来确定网卡是否激活成功，有关该方法的详细说明，请参考QuecPython官方网站API参考手册内[获取拨号信息功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E8%8E%B7%E5%8F%96%E6%8B%A8%E5%8F%B7%E4%BF%A1%E6%81%AF%E5%8A%9F%E8%83%BD)部分。 +用户可以通过`dataCall`模块的`dataCall.getInfo`方法来确定网卡是否激活成功，有关该方法的详细说明，请参考QuecPython官方网站API参考手册内[获取拨号信息功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E8%8E%B7%E5%8F%96%E6%8B%A8%E5%8F%B7%E4%BF%A1%E6%81%AF%E5%8A%9F%E8%83%BD)部分。 查询方法： @@ -94,5 +94,5 @@ dataCall.getInfo(profileID, ipType) > 如果模组无线网卡激活失败，请先请参考《网络异常处理》章节中如下部分进行排查： > -> * [网络异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E5%A4%84%E7%90%86) +> * [网络异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E5%A4%84%E7%90%86) diff --git a/docs/Application_guide/zh/network-comm/nic/cellular/mechanism.md b/docs/Application_guide/zh/network-comm/nic/cellular/mechanism.md index e7584137186acaa1f06ebfca528a5d42748bb547..23e308afa80c6139f9ba9662b1967e351490c0fa 100644 --- a/docs/Application_guide/zh/network-comm/nic/cellular/mechanism.md +++ b/docs/Application_guide/zh/network-comm/nic/cellular/mechanism.md @@ -130,7 +130,7 @@ dataCall.setPDPContext(profileID, ipType, apn, username, password, authType) ## checkNet机制 -`checkNet`是QuecPython提供的一个功能模块。该模块主要用于检查网络是否已经就绪。关于该`checkNet`模块API的使用说明，请参考QuecPython官网API参考手册内[checkNet](https://python.quectel.com/doc/API_reference/zh/iotlib/checkNet.html)部分。 +`checkNet`是QuecPython提供的一个功能模块。该模块主要用于检查网络是否已经就绪。关于该`checkNet`模块API的使用说明，请参考QuecPython官网API参考手册内[checkNet](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/checkNet.html)部分。 **`checkNet`使用场景** @@ -178,7 +178,7 @@ checkNet.waitNetworkReady(timeout) dataCall.setCallback(fun) ``` -关于该方法的详细说明，请参考QuecPython官网API参考手册内`dataCall`模块的[回调注册功能](https://python.quectel.com/doc/API_reference/zh/iotlib/dataCall.html#%E5%9B%9E%E8%B0%83%E6%B3%A8%E5%86%8C%E5%8A%9F%E8%83%BD)部分，这里主要说明如何使用。 +关于该方法的详细说明，请参考QuecPython官网API参考手册内`dataCall`模块的[回调注册功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/dataCall.html#%E5%9B%9E%E8%B0%83%E6%B3%A8%E5%86%8C%E5%8A%9F%E8%83%BD)部分，这里主要说明如何使用。 回调函数的示例如下： @@ -236,7 +236,7 @@ if __name__ == '__main__': main() ``` -上面的示例仅仅是为了让用户直观的感受一下QuecPython的网络事件监控功能。如果用户需要在实际项目中使用，请参考后续《网络异常处理》章节中[网络异常事件处理示例](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E4%BA%8B%E4%BB%B6%E5%A4%84%E7%90%86%E7%A4%BA%E4%BE%8B)部分。 +上面的示例仅仅是为了让用户直观的感受一下QuecPython的网络事件监控功能。如果用户需要在实际项目中使用，请参考后续《网络异常处理》章节中[网络异常事件处理示例](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E7%BD%91%E7%BB%9C%E5%BC%82%E5%B8%B8%E4%BA%8B%E4%BB%B6%E5%A4%84%E7%90%86%E7%A4%BA%E4%BE%8B)部分。 diff --git a/docs/Application_guide/zh/network-comm/nic/ethernet/README.md b/docs/Application_guide/zh/network-comm/nic/ethernet/README.md index 81af3d035c90abe10afdf6a82b80c0bdb32bf8ca..6dc9583f37de34f7aba2beac861434cbdc73405f 100644 --- a/docs/Application_guide/zh/network-comm/nic/ethernet/README.md +++ b/docs/Application_guide/zh/network-comm/nic/ethernet/README.md @@ -29,7 +29,7 @@ #### SPI 接口 ->[SPI](https://python.quectel.com/doc/Application_guide/zh/hardware/peripheral-interfaces/SPI.html) 是串行外设接口（Serial Peripheral Interface）的缩写，是美国摩托罗拉公司最先推出的一种同步串行传输规范，也是一种单片机外设芯片串行扩展接口，是一种高速、全双工、同步通信总线，所以可以在同一时间发送和接收数据，通常能达到甚至超过 10M/bps。 +>[SPI](https://developer.quectel.com/doc/quecpython/Application_guide/zh/hardware/peripheral-interfaces/SPI.html) 是串行外设接口（Serial Peripheral Interface）的缩写，是美国摩托罗拉公司最先推出的一种同步串行传输规范，也是一种单片机外设芯片串行扩展接口，是一种高速、全双工、同步通信总线，所以可以在同一时间发送和接收数据，通常能达到甚至超过 10M/bps。 对于不支持 MAC 层的 QuecPython 模组，可以通过 SPI 硬件接口外挂支持 MAC + PHY 的芯片。当前已支持多种型号，如 W5500/DM9051/CH395。 @@ -102,7 +102,7 @@ QuecPython 支持对以太网口的工作方式进行配置，根据工作环境 ### 数据流 -QuecPython 下以太网卡配置不同的工作方式，具有不同的工作流程，[终端模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（WAN）主要是将模块通过以太网，连接外部设备接入外网，[网关模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（LAN）主要为局域网设备提供 4G 网络。 +QuecPython 下以太网卡配置不同的工作方式，具有不同的工作流程，[终端模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（WAN）主要是将模块通过以太网，连接外部设备接入外网，[网关模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（LAN）主要为局域网设备提供 4G 网络。 1. 终端模式（WAN） @@ -120,7 +120,7 @@ QuecPython 下以太网卡配置不同的工作方式，具有不同的工作流 ### 各平台接口支持情况 -下表是各平台型号对于 SPI 接口以太网及 RMII 接口 PHY 适配支持情况。不同平台对于支持以太网卡型号目前不一致，请参考[ethernet - 以太网相关功能](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html)，进行以太网卡选型。 +下表是各平台型号对于 SPI 接口以太网及 RMII 接口 PHY 适配支持情况。不同平台对于支持以太网卡型号目前不一致，请参考[ethernet - 以太网相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html)，进行以太网卡选型。 | 型号\接口类型 | SPI-ETHERNET | RMII-PHY | | :-: | :-: | :-: | @@ -144,7 +144,7 @@ QuecPython 对于外挂 RMII 接口 PHY 设备或者外挂 SPI 接口太网卡 ### 选择以太网卡 -以太网均被包含在 ethernet 模块中，不同类型网卡加载有所区别，各模块加载参数也有所差异，请参考[ethernet - 以太网相关功能](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html) 查看各网卡初始化传参含义。各以太网卡加载方式如下所示： +以太网均被包含在 ethernet 模块中，不同类型网卡加载有所区别，各模块加载参数也有所差异，请参考[ethernet - 以太网相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html) 查看各网卡初始化传参含义。各以太网卡加载方式如下所示： **加载 W5500** 为了方便W5500适配，对于W5500接口设置较多自定义参数，方便灵活对接。 @@ -177,10 +177,10 @@ nic = ethernet.YT8512H(mac, ip='', subnet='', gateway='') | `ip` | 以太网卡的 `ip` 地址，若值为空字符串''，表示使用默认值`192.168.1.100`。 | 均适配该参数 | 用于初始化配置网卡 ip 相关信息 | | `subnet` | 以太网卡的子网掩码地址，若值为空字符串''，表示使用默认值`255.255.255.0`。 | 均适配该参数 | 用于初始化配置网卡 ip 相关信息 | | `gateway` | 以太网卡的网关地址，若值为空字符串''，表示将 `ip` 地址的最后一位替换成`1`作为网关。 | 均适配该参数 | 用于初始化配置网卡 ip 相关信息 | -| `spi_port` | [SPI端口](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.SPI.html)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为 `SPI1` 端口。 | W5500/DM9051/CH395均适配 | SPI-ETHERNET 外挂设备均适配 SPI 可选接口。RMII 接口使用接口是固定的，无需适配。 | -| `spi_cs_pin` | SPI 片选[GPIO管脚](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`，表示使用上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/DM9051/CH395已适配 | SPI-ETHERNET 外挂设备均适配 SPI CS 可选PIN脚。RMII 使用接口是固定的，无需适配。 | -| `extint_pin` | 外部中断[GPIO管脚](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`，表示上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/CH395已适配 | DM9051尚未适配中断方式数据处理。
YT8512/SZ18201/JL1101 RMII 接口内部固定中断脚，不可更改。| -| `reset_pin` | 重置[GPIO管脚](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`, 表示上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/CH395 已适配 | DM9051 尚未适配。
YT8512/SZ18201/JL1101 RMII 接口内部固定 RST 脚，不可更改。 | +| `spi_port` | [SPI端口](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.SPI.html)，默认值为`-1`，表示使用上次配置的值，程序中默认配置为 `SPI1` 端口。 | W5500/DM9051/CH395均适配 | SPI-ETHERNET 外挂设备均适配 SPI 可选接口。RMII 接口使用接口是固定的，无需适配。 | +| `spi_cs_pin` | SPI 片选[GPIO管脚](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`，表示使用上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/DM9051/CH395已适配 | SPI-ETHERNET 外挂设备均适配 SPI CS 可选PIN脚。RMII 使用接口是固定的，无需适配。 | +| `extint_pin` | 外部中断[GPIO管脚](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`，表示上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/CH395已适配 | DM9051尚未适配中断方式数据处理。
YT8512/SZ18201/JL1101 RMII 接口内部固定中断脚，不可更改。| +| `reset_pin` | 重置[GPIO管脚](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)，默认值为`-1`, 表示上次配置的值，程序中默认配置参考 API参考手册内具体型号。 | W5500/CH395 已适配 | DM9051 尚未适配。
YT8512/SZ18201/JL1101 RMII 接口内部固定 RST 脚，不可更改。 | | `work_mode` | 以太网工作模式配置，默认为终端模式，`0`/`1` 分别表示终端模式/网关模式。终端模式表示该模块作为终端设备连接供网设备上网。网关模式表示该模块作为网关，为外部设备提供网络访问，通过`4G`上网。 | W5500/DM9051/CH395 均适配 | YT8512/SZ18201/JL1101 尚未适配，不限制工作默认配置，自行调用接口确认工作模式。 | ### 获取动态 IP 地址 diff --git a/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.md b/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.md index df71d90e8b1a876ab3b934e7d726211fd1d11474..9e871624b85c679c58eed4714a10f00b1107061f 100644 --- a/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.md +++ b/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.md @@ -7,7 +7,7 @@ W5500作为网关使用配置时，通过网络转发，使得以太网卡局域 使用外挂以太网功能，需要额外准备外挂的以太网卡、网线、路由器、杜邦线。 -通过杜邦线将模块与以太网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考[ethernet - 以太网相关功能](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html)章节，然后通过网线将网卡与路由器连接。 +通过杜邦线将模块与以太网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考[ethernet - 以太网相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html)章节，然后通过网线将网卡与路由器连接。 | 以太网芯片型号 | 以太网模块实物图 | 硬件连接实物图 | 芯片手册 | 代码示例 | | ---- | ---- | ---- | ---- | ---- | diff --git a/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.md b/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.md index 130dbc52f9152a9218069b7e16bbf0f36d099b73..85f6484d6fae6359fb1efd86105a53ffd727647c 100644 --- a/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.md +++ b/docs/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.md @@ -2,13 +2,13 @@ 模块通过以太网卡上外网，需要将以太网卡配置到终端模式（WAN）。比如以太网卡连接路由器，通过DHCP协议获取 IP信息，从而通过以太网卡连接外部网络，使得模块能够正常连接网络。 -开发环境搭建请参考[快速入门](https://python.quectel.com/doc/Getting_started/zh/index.html)，本章节主要是对以太网卡使用介绍。 +开发环境搭建请参考[快速入门](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)，本章节主要是对以太网卡使用介绍。 ## 硬件准备工作 使用外挂以太网功能，需要额外准备外挂的以太网卡、网线、路由器、杜邦线。 -通过杜邦线将模块与以太网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考[ethernet - 以太网相关功能](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html)章节，然后通过网线将网卡与路由器连接。 +通过杜邦线将模块与以太网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考[ethernet - 以太网相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html)章节，然后通过网线将网卡与路由器连接。 | 以太网芯片型号 | 以太网模块实物图 | 硬件连接实物图 | 芯片手册 | 代码示例 | | ---- | ---- | ---- | ---- | ---- | @@ -25,7 +25,7 @@ **网卡初始化** 默认以太网卡不开启，需要手动进行打开，以下是加载以太网卡的过程，通过DHCP的方式获取IP信息与外部通信。 -以下示例介绍针对 W5500 以太网卡进行介绍，其他网卡在初始化时，调用该型号类即可，具体参数配置请参考 [ethernet - 以太网相关功能](https://python.quectel.com/doc/API_reference/zh/peripherals/ethernet.html)下具体型号类。 +以下示例介绍针对 W5500 以太网卡进行介绍，其他网卡在初始化时，调用该型号类即可，具体参数配置请参考 [ethernet - 以太网相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/ethernet.html)下具体型号类。 ```python # 首先导入ethernet包 @@ -111,7 +111,7 @@ ``` -## TCP（[socket](https://python.quectel.com/doc/Application_guide/zh/network-comm/net-protocols/tcp-udp.html)）应用示例 +## TCP（[socket](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/net-protocols/tcp-udp.html)）应用示例 以下示例展示 TCP 通信时，通过以太网卡进行通信时的两种方法。 @@ -178,4 +178,4 @@ if __name__ == '__main__': ## MQTT/HTTP 等应用协议应用 -使用以太网卡进行 MQTT/HTTP 应用协议通信，需要注意由于内置的 MQTT/HTTP 通信模块没有使用绑定网卡操作接口，需要配置以太网卡作为默认网卡即可。具体 MQTT/HTTP 使用，请参考QuecPython官网文档中心API参考手册下 [umqtt - MQTT客户端](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html) 以及 [request - HTTP客户端](https://python.quectel.com/doc/API_reference/zh/networklib/request.html) 章节。 +使用以太网卡进行 MQTT/HTTP 应用协议通信，需要注意由于内置的 MQTT/HTTP 通信模块没有使用绑定网卡操作接口，需要配置以太网卡作为默认网卡即可。具体 MQTT/HTTP 使用，请参考QuecPython官网文档中心API参考手册下 [umqtt - MQTT客户端](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html) 以及 [request - HTTP客户端](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/request.html) 章节。 diff --git a/docs/Application_guide/zh/network-comm/nic/network-config.md b/docs/Application_guide/zh/network-comm/nic/network-config.md index 4bc5fce10e9d91176f14b22dafd25c13afaa8c3b..01c0c25d51b7bdfe1bbdb368a8d3565f4c9f5616 100644 --- a/docs/Application_guide/zh/network-comm/nic/network-config.md +++ b/docs/Application_guide/zh/network-comm/nic/network-config.md @@ -22,7 +22,7 @@ QuecPython 提供了两种网卡配置方式： ### 蜂窝无线网卡 -[蜂窝无线网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/index.html)依赖于运营商，需要模组连接运营商的SIM卡，并且在运营商基站信号覆盖范围内，方可进行网络连接。支持 QuecPython 的蜂窝通信模组在开机后会自动进行蜂窝数据网络连接。 +[蜂窝无线网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/index.html)依赖于运营商，需要模组连接运营商的SIM卡，并且在运营商基站信号覆盖范围内，方可进行网络连接。支持 QuecPython 的蜂窝通信模组在开机后会自动进行蜂窝数据网络连接。 ![](../../media/network-comm/nic/network_4g_single.png) @@ -44,7 +44,7 @@ QuecPython 提供了两种网卡配置方式： ### Wi-Fi 无线网卡 -[Wi-Fi 无线网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/index.html)不同的工作模式下具有不同的应用场景，对于 [station](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html) 模式下，需要连接Wi-Fi 热点（比如路由器），通过 Wi-Fi 热点给模块提供网络。对于 [ap](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html) 工作模式下，Wi-Fi 无线网卡作为热点，接受其它 Wi-Fi 站点设备连接，并为其提供网络服务。 +[Wi-Fi 无线网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/index.html)不同的工作模式下具有不同的应用场景，对于 [station](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html) 模式下，需要连接Wi-Fi 热点（比如路由器），通过 Wi-Fi 热点给模块提供网络。对于 [ap](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html) 工作模式下，Wi-Fi 无线网卡作为热点，接受其它 Wi-Fi 站点设备连接，并为其提供网络服务。 Wi-Fi 无线网卡的网络配置有多种方式，如直接输入热点名称和密码、一键配网、AP 配网、web 页面配置等，但最终的目的就是为了成功获取热点名称和密码。本文着重说明 Wi-Fi 网卡的加载，并通过直接访问热点的方式进行网络连接。其余的配网方式请参考 [Wi-Fi 网卡](../nic/WIFI/README.md) 章节。 @@ -95,7 +95,7 @@ Wi-Fi 无线网卡的网络配置有多种方式，如直接输入热点名称 ### 以太网卡 -在不同的应用场景下，[以太网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/index.html)有不同的工作模式：[终端模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（WAN）、[网关模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（LAN）。 +在不同的应用场景下，[以太网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/index.html)有不同的工作模式：[终端模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（WAN）、[网关模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（LAN）。 **终端模式** @@ -164,7 +164,7 @@ Wi-Fi 无线网卡的网络配置有多种方式，如直接输入热点名称 ### USB 网卡 -当前 [USB 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/index.html)主要应用是使用USB网口作为 LAN 口，通过 4G 网卡进行数据转发进行网络访问。USB 网卡协议支持 ECM/RNDIS 协议，请根据需要进行选择，在 PC 下 RNDIS 可以直接加载，在 Linux/Android/IOS 系统中 ECM 可以直接加载。 +当前 [USB 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/index.html)主要应用是使用USB网口作为 LAN 口，通过 4G 网卡进行数据转发进行网络访问。USB 网卡协议支持 ECM/RNDIS 协议，请根据需要进行选择，在 PC 下 RNDIS 可以直接加载，在 Linux/Android/IOS 系统中 ECM 可以直接加载。 支持 USB 网卡的蜂窝通信模组通过 USB 口连接至支持 ECM 或 RNDIS 协议的主机设备，借助 4G 网络为其提供外网访问能力。模型如下图所示: @@ -173,8 +173,8 @@ Wi-Fi 无线网卡的网络配置有多种方式，如直接输入热点名称 QuecPython 模组通过 set_worktype(USBNET_Type) 方法设置 USB 网卡的协议类型后，调用 open()方法即可使能 USB 网卡功能。 USBNET_Type 参数取值说明: -- USBNET.Type_RNDIS : 指定 RNDIS 协议; [Windows](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.html) 操作系统默认支持 RNDIS 协议。 -- USBNET.Type_ECM: 指定 ECM 协议; [Linux](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)、[Android](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.html)、[IOS](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)、[MACOS](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)等操作系统默认支持 ECM 协议。 +- USBNET.Type_RNDIS : 指定 RNDIS 协议; [Windows](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.html) 操作系统默认支持 RNDIS 协议。 +- USBNET.Type_ECM: 指定 ECM 协议; [Linux](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)、[Android](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.html)、[IOS](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)、[MACOS](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)等操作系统默认支持 ECM 协议。 示例代码如下: @@ -194,7 +194,7 @@ USBNET_Type 参数取值说明: ## 简单场景 -主要介绍如何在各种网卡状态下进行网络通信。以下场景数据通信将使用 [socket tcp](https://python.quectel.com/doc/Application_guide/zh/network-comm/net-protocols/tcp-udp.html) 通信为例进行说明。 +主要介绍如何在各种网卡状态下进行网络通信。以下场景数据通信将使用 [socket tcp](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/net-protocols/tcp-udp.html) 通信为例进行说明。 @@ -443,7 +443,7 @@ if __name__ == '__main__': ## 多网卡下网络配置 -如下图所示，模块集成了多种网卡设备，不同的网卡配置不同的工作模式，提供了不同的网络服务。 其中可以通过 [4G 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/index.html)、[Wi-Fi 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/index.html) [AP 模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html)、[以太网](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/index.html)[终端模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（ WAN ）访问外部网络，Wi-Fi 网卡 [STATION 模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html)、以太网[网关模式](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（ LAN ）、[USB 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/index.html)均提供了局域网络，那么该如何选择网卡使用，以及如何配置网络转发，按照自己想要的方式进行网络通信？ +如下图所示，模块集成了多种网卡设备，不同的网卡配置不同的工作模式，提供了不同的网络服务。 其中可以通过 [4G 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/index.html)、[Wi-Fi 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/index.html) [AP 模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html)、[以太网](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/index.html)[终端模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-wan-example.html)（ WAN ）访问外部网络，Wi-Fi 网卡 [STATION 模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html)、以太网[网关模式](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/ethernet-lan-example.html)（ LAN ）、[USB 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/index.html)均提供了局域网络，那么该如何选择网卡使用，以及如何配置网络转发，按照自己想要的方式进行网络通信？ ![](../../media/network-comm/nic/network_multi_nic_connection.png) diff --git a/docs/Application_guide/zh/network-comm/nic/support/README.md b/docs/Application_guide/zh/network-comm/nic/support/README.md index d2dd9b6c9de6146ca16c6f8d5ced92ebec1dc298..1192a779a7eeffe74ce05428304c3cc41696416c 100644 --- a/docs/Application_guide/zh/network-comm/nic/support/README.md +++ b/docs/Application_guide/zh/network-comm/nic/support/README.md @@ -1,7 +1,7 @@ # QuecPython 支持网卡介绍 -本章节主要针对当前 QuecPython 下支持的网卡（[蜂窝无线网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/index.html)、[Wi-Fi 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/index.html)、[以太网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/ethernet/index.html)、[USB 网卡](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/index.html)）进行简单介绍。 +本章节主要针对当前 QuecPython 下支持的网卡（[蜂窝无线网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/index.html)、[Wi-Fi 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/index.html)、[以太网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/ethernet/index.html)、[USB 网卡](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/index.html)）进行简单介绍。 ## 支持网卡简介 @@ -18,7 +18,7 @@ QuecPython 提供了 Wi-Fi 设备管理功能，通过硬件接口外挂 Wi-Fi QuecPython 提供了以太网卡/PHY芯片管理功能，QuecPython 内置 lwIP 协议栈以及 EMAC 层，使得能够驱动以太网 / PHY 芯片。现已支持多种 SPI/RMII 接口以太网芯片。 ### USB 网卡 -QuecPython 提供了 USB 网卡管理功能，QuecPython 在 USB 接口集成 RNDIS/ECM/MBIM 协议，能够在不同系统下（如 [Windows](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.html)/[Linux](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)/[Android](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.html)/[IOS](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)等）识别成网卡设备，直接进行网络连接。 +QuecPython 提供了 USB 网卡管理功能，QuecPython 在 USB 接口集成 RNDIS/ECM/MBIM 协议，能够在不同系统下（如 [Windows](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.html)/[Linux](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)/[Android](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.html)/[IOS](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.html)等）识别成网卡设备，直接进行网络连接。 ## 网卡支持列表 diff --git a/docs/Application_guide/zh/network-comm/nic/usbnet/README.md b/docs/Application_guide/zh/network-comm/nic/usbnet/README.md index e374101d62bc3cf35f26c77eeb071d446d85b240..506fcc76e913dd774d8851d2badf51214e046202 100644 --- a/docs/Application_guide/zh/network-comm/nic/usbnet/README.md +++ b/docs/Application_guide/zh/network-comm/nic/usbnet/README.md @@ -140,11 +140,11 @@ USBNET.close() **2. 使用展锐 8910 的 USB 网卡功能，首次以默认 ECM 模式 open 后，电脑连接不上网络？** -> 展锐 8910 的 USB 网卡功能需要NAT功能支持，默认开机不启动NAT，需要启动NAT后才能正常使用 USB 网卡功能。请参考 Wiki 上对应 [USBNET](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html) 章节。展锐8910具体模块型号，可参考[模组型号与平台的对应关系](https://python.quectel.com/doc/Application_guide/zh/background/hardware-platform.html#展锐平台)。 +> 展锐 8910 的 USB 网卡功能需要NAT功能支持，默认开机不启动NAT，需要启动NAT后才能正常使用 USB 网卡功能。请参考 Wiki 上对应 [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html) 章节。展锐8910具体模块型号，可参考[模组型号与平台的对应关系](https://developer.quectel.com/doc/quecpython/Application_guide/zh/background/hardware-platform.html#展锐平台)。 **3. 展锐8850使用 USB 网卡设置 RNDIS 后打开正常，关闭后再打开返回 -1。** -> 需要进行 NAT 模式的设置，具体用法请参考 Wiki 上对应 [USBNET](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html) 章节。展锐8850具体模块型号，可参考[模组型号与平台的对应关系](https://python.quectel.com/doc/Application_guide/zh/background/hardware-platform.html#展锐平台)。 +> 需要进行 NAT 模式的设置，具体用法请参考 Wiki 上对应 [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html) 章节。展锐8850具体模块型号，可参考[模组型号与平台的对应关系](https://developer.quectel.com/doc/quecpython/Application_guide/zh/background/hardware-platform.html#展锐平台)。 **4. 为什么我的手机状态栏没有`<···>`样图标，但网络可以使用？** diff --git a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.md b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.md index 5578b0c898c35bb81c19d828195754d42130cce3..c24c7c1ff312141f215d7cde7e19acfbccdf60b7 100644 --- a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.md +++ b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-android-example.md @@ -3,11 +3,11 @@ 下面以 QuecPython EC200UEU_AB 开发板为例，在 Android 手机环境下使用 USB 网卡功能进行演示。 > 1. ECM 模式在 Linux/Android/IOS 系统中无需驱动，可以直接加载使用。 -> 2. ECM 模式下部分型号模块 MAC 地址手机无法识别，请根据 Wiki 上对应 [USBNET](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html) 章节，使用 MAC 配置接口更新可用 MAC 即可。 +> 2. ECM 模式下部分型号模块 MAC 地址手机无法识别，请根据 Wiki 上对应 [USBNET](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html) 章节，使用 MAC 配置接口更新可用 MAC 即可。 1. 开发环境准备 - 请参考[快速入门章节](https://python.quectel.com/doc/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 + 请参考[快速入门章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 另需要手机一部，以及能够转换成手机接口的转换线。 2. 打开 QPYCOM 工具连接设备 @@ -17,7 +17,7 @@ 3. 编写 USB 网卡开机启动脚本 - 具体 USB 网卡功能接口请参考 Wiki 上对应的 [USBNET章节](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html)。 + 具体 USB 网卡功能接口请参考 Wiki 上对应的 [USBNET章节](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html)。 新建一个 main.py 文件，输入以下内容： ```python # 导入所需包 diff --git a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.md b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.md index 347b05f0e6202d9bee0cbf8d1868ed38bd1605b7..626225ee7b330241249c2a2cdaf08f672148ff7a 100644 --- a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.md +++ b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-linux-example.md @@ -6,7 +6,7 @@ 1. 开发环境准备 - 请参考[快速入门章节](https://python.quectel.com/doc/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 + 请参考[快速入门章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 此处 Linux 系统使用的是 Ubuntu 版本，在电脑下搭建 Linux 环境测试。 2. 打开 QPYCOM 工具连接设备 @@ -16,7 +16,7 @@ 3. 编写 USB 网卡开机启动脚本 - 具体 USB 网卡功能接口请参考 Wiki上对应的 [USBNET章节](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html)。 + 具体 USB 网卡功能接口请参考 Wiki上对应的 [USBNET章节](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html)。 新建一个 main.py 文件，输入以下内容： ```python diff --git a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.md b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.md index 17da9e2ee6cf38efb1e8f6da622746088ff04917..ef11928091e5e6f2902ca6594da753d46ba4e07f 100644 --- a/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.md +++ b/docs/Application_guide/zh/network-comm/nic/usbnet/usbnet-windows-example.md @@ -6,7 +6,7 @@ 1. 开发环境准备 - 请参考[快速入门章节](https://python.quectel.com/doc/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 + 请参考[快速入门章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)（如已熟悉请跳过此步骤），搭建开发使用环境。 2. 打开 QPYCOM 工具连接设备 @@ -15,7 +15,7 @@ 3. 通过 QPYCOM 工具输入交互命令开启 USB 网卡 - 具体USBNET功能接口请参考 Wiki 上对应的 [USBNET章节](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.USBNET.html)。 + 具体USBNET功能接口请参考 Wiki 上对应的 [USBNET章节](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.USBNET.html)。 交互口输入以下命令。 ```python diff --git a/docs/Application_guide/zh/network-comm/nic/wifi/README.md b/docs/Application_guide/zh/network-comm/nic/wifi/README.md index 61c0a597f0d28434ba47def166ee181499e18c3e..857e5d10d5e70614f47611716a3cf1b28bc12197 100644 --- a/docs/Application_guide/zh/network-comm/nic/wifi/README.md +++ b/docs/Application_guide/zh/network-comm/nic/wifi/README.md @@ -21,7 +21,7 @@ Wi-Fi 无线网卡是一种用于连接终端设备到无线局域网（Wireless ### QuecPython 支持的 Wi-Fi 网卡硬件接口 -QuecPython 支持的 Wi-Fi 网卡有多种硬件连接方式：蜂窝无线通信模组通过 [UART](https://python.quectel.com/doc/Application_guide/zh/hardware/peripheral-interfaces/UART.html) 或 SDIO 接口外接 Wi-Fi 网卡，或者在移远的 Wi-Fi 芯片中移植 QuecPython。 +QuecPython 支持的 Wi-Fi 网卡有多种硬件连接方式：蜂窝无线通信模组通过 [UART](https://developer.quectel.com/doc/quecpython/Application_guide/zh/hardware/peripheral-interfaces/UART.html) 或 SDIO 接口外接 Wi-Fi 网卡，或者在移远的 Wi-Fi 芯片中移植 QuecPython。 @@ -101,7 +101,7 @@ QuecPython 内置 Wi-Fi，是指直接将 QuecPython 移植到 Wi-Fi 芯片上 ### 工作模式介绍 -Wi-Fi 支持多种工作模式，当前 QuecPython 主要支持基础功能 [AP](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html) 和 [Station](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html) 模式，即 Wi-Fi 作为终端连接到其他接入点入网（如路由器），或者 Wi-Fi 本身作为接入点给其他设备入网。 +Wi-Fi 支持多种工作模式，当前 QuecPython 主要支持基础功能 [AP](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.html) 和 [Station](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.html) 模式，即 Wi-Fi 作为终端连接到其他接入点入网（如路由器），或者 Wi-Fi 本身作为接入点给其他设备入网。 >AP 模式（Access Point Mode）： - AP 模式也被称为热点模式或基础设施模式。 @@ -181,7 +181,7 @@ QuecPython 下 Wi-Fi 配置不同的工作方式，具有不同的工作流程 ## Wi-Fi API 说明 -QuecPython 支持多种型号 Wi-Fi，其中包括外挂或者内置 Wi-Fi，由于历史原因，当前 ESP8266/ESP8285 尚未支持mpy接口，我们后续将对所有 Wi-Fi 设备接口进行统一。详细各型号接口说明请参考 Wiki下 [WLAN](https://python.quectel.com/doc/API_reference/zh/wifilib/index.html) 章节。 +QuecPython 支持多种型号 Wi-Fi，其中包括外挂或者内置 Wi-Fi，由于历史原因，当前 ESP8266/ESP8285 尚未支持mpy接口，我们后续将对所有 Wi-Fi 设备接口进行统一。详细各型号接口说明请参考 Wiki下 [WLAN](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/index.html) 章节。 @@ -189,7 +189,7 @@ QuecPython 支持多种型号 Wi-Fi，其中包括外挂或者内置 Wi-Fi，由 由于 ESP8266 是在串口 SLIP 协议上进行支持的，为了方便对接使用拓展，我们只是提供了 WLAN.py 脚本，内置 ESP8266 控制类，方便用户根据自己需求进行接口定义并开发。 -详细接口信息请参考 WIKI 下[ESP8266](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.ESP8266.html)章节介绍。 +详细接口信息请参考 WIKI 下[ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.ESP8266.html)章节介绍。 > [点此在 github 中下载 WLAN.py 代码。](https://github.com/QuecPython/examples/tree/main/network-comm/nic/wifi) @@ -317,7 +317,7 @@ esp8266.ota(url) 此套接口是完全按照 MicroPython 官方接口进行开发适配。适用于 SDIO 外挂 Wi-Fi 网卡以及内置 Wi-Fi 网卡。 -当前信息只是对于通用 Wi-Fi 接口使用说明，部分型号适配根据实际情况实现有所差异，详细接口信息请参考 Wiki 下 [Wi-Fi通信](https://python.quectel.com/doc/API_reference/zh/wifilib/index.html) 章节介绍。 +当前信息只是对于通用 Wi-Fi 接口使用说明，部分型号适配根据实际情况实现有所差异，详细接口信息请参考 Wiki 下 [Wi-Fi通信](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/index.html) 章节介绍。 ![](../../../media/network-comm/nic/network_wifi_api_process.png) diff --git a/docs/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.md b/docs/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.md index da615bf56fe35fb285a3ae1cd35c1101eaeee910..9b92d744d90a83f271159ca4202f8cb1d7baddf5 100644 --- a/docs/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.md +++ b/docs/Application_guide/zh/network-comm/nic/wifi/wifi-ap-example.md @@ -2,13 +2,13 @@ Wi-Fi 网卡通过建立热点，为其他设备提供 4G 网络服务。 -开发环境搭建请参考[快速入门章节](https://python.quectel.com/doc/Getting_started/zh/index.html)，本章节主要是以 ESP8266/ESP8285 为例，进行使用介绍。 +开发环境搭建请参考[快速入门章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)，本章节主要是以 ESP8266/ESP8285 为例，进行使用介绍。 ## 硬件准备工作 使用外挂 Wi-Fi 网卡功能，需要额外准备外挂的 Wi-Fi 网卡、路由器、杜邦线。 -通过杜邦线将模块与 Wi-Fi 网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考 Wiki 下[ESP8266](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.ESP8266.html)章节。 +通过杜邦线将模块与 Wi-Fi 网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考 Wiki 下[ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.ESP8266.html)章节。 [ESP8266硬件连接实物图](../../../media/network-comm/nic/network_wifi_esp8266_connection.png) [ASR5803硬件连接实物图](../../../media/network-comm/nic/network_wifi_asr5803_connection.png) diff --git a/docs/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.md b/docs/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.md index 2bf5556f52c45b4db0635ba22b7beaf40277065e..9c111c8c4ffe8c49523c2603da8fc1e9c922497b 100644 --- a/docs/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.md +++ b/docs/Application_guide/zh/network-comm/nic/wifi/wifi-station-example.md @@ -2,13 +2,13 @@ Wi-Fi 网卡通过连接热点，为模块提供网络。 -开发环境搭建请参考[快速入门章节](https://python.quectel.com/doc/Getting_started/zh/index.html)，本章节主要是以 ESP8266/ESP8285 为例，进行使用介绍。 +开发环境搭建请参考[快速入门章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/index.html)，本章节主要是以 ESP8266/ESP8285 为例，进行使用介绍。 ## 硬件准备工作 使用外挂 Wi-Fi 网卡功能，需要额外准备外挂的 Wi-Fi 网卡、路由器、杜邦线。 -通过杜邦线将模块与 Wi-Fi 网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考 WIKI 下 [ESP8266](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.ESP8266.html) 章节。 +通过杜邦线将模块与 Wi-Fi 网卡连接，模块与网卡接线可以根据实际需求配置，具体接口配置参数请参考 WIKI 下 [ESP8266](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.ESP8266.html) 章节。 [ESP8266硬件连接实物图](../../../media/network-comm/nic/network_wifi_esp8266_connection.png) [ASR5803硬件连接实物图](../../../media/network-comm/nic/network_wifi_asr5803_connection.png) @@ -121,7 +121,7 @@ ESP8266/ESP8285 是一个独立完整的设备，内部包括独立的配网方 ``` -## TCP（[socket](https://python.quectel.com/doc/API_reference/zh/stdlib/usocket.html)）应用示例 +## TCP（[socket](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/usocket.html)）应用示例 以下示例展示 TCP 通信时，通过 Wi-Fi 网络进行通信时的两种方法。 @@ -129,7 +129,7 @@ ESP8266/ESP8285 是一个独立完整的设备，内部包括独立的配网方 此例中通过 Wi-Fi 网卡进行 TCP 通信，通过 socket 模块内 bind 接口，指定通过 Wi-Fi 网口进行发送。 -> 下例中 bind 绑定网卡接口参数 172.16.1.2 指 Wi-Fi 网卡的 ip 地址。网卡 ip 地址通过网卡对象下 ipconfig 接口进行查询，详细见 [Wi-Fi](https://python.quectel.com/doc/API_reference/en/wifilib/index.html) 接口 WIKI。 +> 下例中 bind 绑定网卡接口参数 172.16.1.2 指 Wi-Fi 网卡的 ip 地址。网卡 ip 地址通过网卡对象下 ipconfig 接口进行查询，详细见 [Wi-Fi](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/index.html) 接口 WIKI。 ```python # 导入usocket模块 @@ -188,4 +188,4 @@ if __name__ == '__main__': ## MQTT/HTTP 等应用协议应用 -使用 Wi-Fi 网卡进行 MQTT/HTTP 应用协议通信，需要注意由于内置的 MQTT/HTTP 通信模块没有使用绑定网卡操作接口，需要配置以太网卡作为默认网卡即可。具体 MQTT/HTTP 使用请参考应用层协议 WIKI 下 [umqtt](https://python.quectel.com/doc/API_reference/zh/networklib/umqtt.html) 以及 [reqeust](https://python.quectel.com/doc/API_reference/zh/networklib/request.html) 章节。 +使用 Wi-Fi 网卡进行 MQTT/HTTP 应用协议通信，需要注意由于内置的 MQTT/HTTP 通信模块没有使用绑定网卡操作接口，需要配置以太网卡作为默认网卡即可。具体 MQTT/HTTP 使用请参考应用层协议 WIKI 下 [umqtt](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/umqtt.html) 以及 [reqeust](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/request.html) 章节。 diff --git a/docs/Application_guide/zh/network-comm/phone.md b/docs/Application_guide/zh/network-comm/phone.md index d45698b56ca24b8d581b3ada2ae31d57f2b27b1f..a7fa6601a8a7e886c821184fd7ac63b386129c83 100644 --- a/docs/Application_guide/zh/network-comm/phone.md +++ b/docs/Application_guide/zh/network-comm/phone.md @@ -217,7 +217,7 @@ VoLTE 最主要的功能就是实现基于 IMS 架构的高清晰度语音通话 >* EC600M/EC800M/EG810M系列模组需要支持VOLTE功能固件才支持voiceCall功能。 >* 其他系列模组需要定制版本才能支持voiceCall功能。 -请注意，以上信息可能会随着模组的更新和新版本的发布而变化。建议在使用这些功能之前，仔细查看[官网wiki文档](https://python.quectel.com/doc/API_reference/zh/iotlib/voiceCall.html)并与FAE进行确认。 +请注意，以上信息可能会随着模组的更新和新版本的发布而变化。建议在使用这些功能之前，仔细查看[官网wiki文档](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/voiceCall.html)并与FAE进行确认。 ## voiceCall功能应用 @@ -708,7 +708,7 @@ if __name__ == '__main__': | 15 | 8 | 呼出中，对方未响铃（volte通话） | `args[1] ~ args[7]`：具体说明同上 | | 16 | 8 | 等待（volte通话） | `args[1] ~ args[7]`：具体说明同上 | -关于`args[0]`的值为10-16时，`args[1]`-`args[8]`的[详细说明见WiKI](https://python.quectel.com/doc/API_reference/zh/iotlib/voiceCall.html#%3Ccode%3EvoiceCall.setCallback%3C/code%3E)： +关于`args[0]`的值为10-16时，`args[1]`-`args[8]`的[详细说明见WiKI](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/voiceCall.html#%3Ccode%3EvoiceCall.setCallback%3C/code%3E)： ## 常见问题解答 diff --git a/docs/Application_guide/zh/network-comm/sim/Common-exception-handling.md b/docs/Application_guide/zh/network-comm/sim/Common-exception-handling.md index e5f4a867e58638c8a8060fae12939dfa3a5692bd..66307be2dcb907b9e3f43cfb6b023120c90a2db3 100644 --- a/docs/Application_guide/zh/network-comm/sim/Common-exception-handling.md +++ b/docs/Application_guide/zh/network-comm/sim/Common-exception-handling.md @@ -1,5 +1,5 @@ # 常见异常处理 -SIM卡状态异常以及注网、拨号异常，请参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分 +SIM卡状态异常以及注网、拨号异常，请参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分 ## 无法发短信 * 检查SIM卡状态是否异常。 @@ -19,9 +19,9 @@ SIM卡状态异常以及注网、拨号异常，请参考QuecPython官网wiki蜂 ## 注网拨号成功URL无法访问 * SIM卡是否欠费，运营商不转发对端回复数据或不转发请求报文到对端。如欠费请充费。 -* 其他异常情况参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分。 +* 其他异常情况参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分。 ## 某些协议数据不能正常交互 * 对于此类SIM卡运营商是否对指定的某些协议做了限制，例如NTP协议，某些运营商对NTP协议限制只能发送到指定的NTP服务地址，否则无法交互。和运营商核实，开通此类业务。 -* 其他异常情况参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分。 +* 其他异常情况参考QuecPython官网wiki蜂窝无线网卡[网络异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html)部分。 diff --git a/docs/Application_guide/zh/network-comm/sim/Quecpython-SIM-function-application-example.md b/docs/Application_guide/zh/network-comm/sim/Quecpython-SIM-function-application-example.md index a078535aa999ec3125bbf4b4b2b6c196edf145ae..4677a7f22a1fdee28e6f715b48e242cfbf4e99ad 100644 --- a/docs/Application_guide/zh/network-comm/sim/Quecpython-SIM-function-application-example.md +++ b/docs/Application_guide/zh/network-comm/sim/Quecpython-SIM-function-application-example.md @@ -405,11 +405,11 @@ sim.unblockPin("12345678", "0000") ## 电话薄功能 -用户在实际项目应用过程中，如需保存对端电话号码，需要用到电话薄功能。此接口可以提供保存电话号码信息的功能。此功能接口支持情况请参考QuecPython官网wiki[电话薄功能](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%E7%94%B5%E8%AF%9D%E7%B0%BF%E5%8A%9F%E8%83%BD) +用户在实际项目应用过程中，如需保存对端电话号码，需要用到电话薄功能。此接口可以提供保存电话号码信息的功能。此功能接口支持情况请参考QuecPython官网wiki[电话薄功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%E7%94%B5%E8%AF%9D%E7%B0%BF%E5%8A%9F%E8%83%BD) ### 读取电话薄 -用户可通过如下接口读取电话薄。其中电话号码存储位置参考QuecPython官网wiki中`sim.readPhonebook()`[接口参数描述](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.readPhonebook%3C/code%3E)。需注意start-end差值需要小于等于20。 +用户可通过如下接口读取电话薄。其中电话号码存储位置参考QuecPython官网wiki中`sim.readPhonebook()`[接口参数描述](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.readPhonebook%3C/code%3E)。需注意start-end差值需要小于等于20。 接口如下： @@ -501,7 +501,7 @@ if __name__ == '__main__': ## SIM卡热插拔 -在项目中，用户如需监测SIM卡插拔情况，可以用如下接口注册回调函数。当SIM卡插入或者拔出时，系统将会调用如下接口注册的回调函数，回调函数会上送SIM卡插入或者拔出的事件给应用层。用户可以根据通知事件来判断SIM卡是插入还是拔出。QuecPython模组对此接口支持情况请参考QuecPython官网wiki[热插拔功能](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%E7%83%AD%E6%8F%92%E6%8B%94%E5%8A%9F%E8%83%BD) +在项目中，用户如需监测SIM卡插拔情况，可以用如下接口注册回调函数。当SIM卡插入或者拔出时，系统将会调用如下接口注册的回调函数，回调函数会上送SIM卡插入或者拔出的事件给应用层。用户可以根据通知事件来判断SIM卡是插入还是拔出。QuecPython模组对此接口支持情况请参考QuecPython官网wiki[热插拔功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%E7%83%AD%E6%8F%92%E6%8B%94%E5%8A%9F%E8%83%BD) ### 注册热插拔回调 @@ -639,7 +639,7 @@ if __name__ == '__main__': ## 双卡切换 -用户在项目应用过程中，为了网络稳定，满足多种网络场景，需要两张不同SIM卡可以随时切换的功能，以应对各种网络异常情况。QuecPython模组对于此功能支持情况请参考QuecPython官网wiki中[SIM卡切卡功能](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#SIM%E5%8D%A1%E5%88%87%E5%8D%A1%E5%8A%9F%E8%83%BD)。 +用户在项目应用过程中，为了网络稳定，满足多种网络场景，需要两张不同SIM卡可以随时切换的功能，以应对各种网络异常情况。QuecPython模组对于此功能支持情况请参考QuecPython官网wiki中[SIM卡切卡功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#SIM%E5%8D%A1%E5%88%87%E5%8D%A1%E5%8A%9F%E8%83%BD)。 ### 注册切卡回调函数 diff --git a/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md b/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md index e273105b11539a3d14bb9fc0895d0f3f6bbc7ca4..f648b82c6e3e6825a547d967b557667db4b35ef4 100644 --- a/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md +++ b/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/dev_resources.md @@ -3,11 +3,11 @@ ## 硬件资料 - EC800MCNLE / EC800MCNGB QuecDuino 开发板（含天线、Type-C 数据线等） - > - [点此购买开发板套件](https://www.quecmall.com/goods-detail/2c90800c94028da20194824724370127) + > - [点此购买开发板套件](https://www.quecmall.com/goods-detail/2c90800b8cb50925018e5a696d0104f7) - 电脑（Windows 7、Windows 10 或 Windows 11） - 喇叭 - 任意 2-5W 功率的喇叭即可 - - [移远商城购买链接](https://www.quecmall.com/goods-detail/2c90800c94028da201948249e9f4012d) + - [移远商城购买链接](https://www.quecmall.com/goods-detail/2c90800c9488358b01956aa656680239) ## 软件资料 diff --git a/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/quick_start.md b/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/quick_start.md index 746dad19890efde0b3b056061bb25f5e22427803..393c27a05e8aab4b66d40f394498c632dbd2e92a 100644 --- a/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/quick_start.md +++ b/docs/Application_guide/zh/solutions/AIChatBot-Volcengine-webRTC/quick_start.md @@ -48,17 +48,17 @@ ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6)，烧录对应型号固件包至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6)，烧录对应型号固件包至开发板。 ### 脚本导入与运行 -1. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： +1. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)，执行主程序文件 `ai_main.py`。 -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C)，停止程序运行。 +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)，执行主程序文件 `ai_main.py`。 +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C)，停止程序运行。 ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/dev_resources.md b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/dev_resources.md index 10248baa06b51d01c0f0a9cecd5d94691454775a..05f51c105ab3cb2bf263d2131679d1bd8499c83c 100644 --- a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/dev_resources.md +++ b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/dev_resources.md @@ -4,7 +4,7 @@ ## 开发板资料 -- 型号：[QuecPython 铀-235 开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600u-235.html) +- 型号：[QuecPython 铀-235 开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600u-235.html) - [购买链接](https://detail.tmall.com/item.htm?abbucket=8&id=676710608367&pisk=gUaZxiwjTNQwcl4NnX02YOhqIW3trVX7IrMjiSVm1ADMfl_Do-wBGmM1Dkl0d-ujlSXT3rk3Ml1tcOd4YRFof-PA6jD0n-kbfM_7653xoT_VPaN9kRvQOR8DjpfmwfxcOc0MonwjoT65uHOnXOg0CuF6pHxnwvciifmcTXcsaqciiFfEKjl-nF2mo65EwjJDof0mtDcosqxDSjvn-jhSnKDiipfEMvDmoqckF5VD8biGgYh9Msd9nqMusv8DzQhZjCN6cE8qcfmaoWDEOXaE_ckovdBTpP2QiPatvMxEkWZz3o2ldhMg4byEVlWy78ytiSl0QadrKPP48cEBwEVE0Ar3SDRDo20I30q4QO-tIlwE2XmHgahQFvVTSk5vK52SQVcnAafztmqQW0U1KFuu25g_m8XBfAqrigkyHXVm9rEwnnoi9Xk5T6rc31Ew7XN5nnKxx4hEF1G6Dnni9Xk5T6-vDDDKTY1s1&rn=42a4e96745c13cd9400765e39c24c67e&spm=a1z10.3-b-s.w4011-23773493585.71.221c5886KuaZIg&skuId=4865603973616) @@ -13,7 +13,7 @@ - [规格书](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - [原理图](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - [丝印图](https://python.quectel.com/wp-content/uploads/2024/10/%E9%93%80235%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [资源介绍与使用指导](https://python.quectel.com/doc/Getting_started/zh/evb/ec600u-235.html) + - [资源介绍与使用指导](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600u-235.html) @@ -48,7 +48,7 @@ ## 固件包 - 版本：EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107 -- 下载[固件](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) +- 下载[固件](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC600U_EUAB_FW.zip) diff --git a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/quick_start.md b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/quick_start.md index 5fd8b69b16a7095f489d36d6f11a94c69f1ea94c..71a3063dbee398eba466dcbcb1bee9b5d448f193 100644 --- a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/quick_start.md +++ b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/quick_start.md @@ -6,7 +6,7 @@ - Windows 电脑一台，建议 `Win10` 系统。 -- 一块 [QuecPython U-235 开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600u-235.html) +- 一块 [QuecPython U-235 开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600u-235.html) - 一根TypeC数据线 @@ -18,7 +18,7 @@ - 下载并安装 EC600U 系列模组驱动：[QuecPython_USB_DriverU_V1.0.19](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) - 下载并安装[VSCode](https://code.visualstudio.com/) - 下载并解压 [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) 工具到电脑的合适位置。 -- 下载[固件包](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) +- 下载[固件包](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC600U_EUAB_FW.zip) - 下载[实验源码](https://codeload.github.com/QuecPython/solution-Agriculture-Control-Panel/zip/refs/tags/v1.0.1) @@ -48,20 +48,20 @@ ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107.zip](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) 至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107.zip](https://objects.githubusercontent.com/github-production-release-asset-2e65be/718904250/839d5c8d-81fb-49d5-982f-73c45ceb5f9b?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250220%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250220T034410Z&X-Amz-Expires=300&X-Amz-Signature=ba55b3e1f47a0e7b842d315dc04b1e20b975a9f6a2fe76239989ffbbf24e42d5&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3D8915DM_cat1_open_EC600UEUAB_R03A01M8_OCPU_QPY_BETA1107_merge_20241108-1415_20250205-1611.zip&response-content-type=application%2Foctet-stream) 至开发板。 ### 脚本导入与运行 -1. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有文件导入到模组文件系统，如下图所示： +1. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有文件导入到模组文件系统，如下图所示： · -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`main.py`。(正常开机时，模组会自动执行`main.py`文件) +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`main.py`。(正常开机时，模组会自动执行`main.py`文件) -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 diff --git a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/software_design.md b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/software_design.md index 0beb324a0dfe71e48bcc82deaf376f35647056c6..ece27d755ea0ef229e078ee3716238da1081eabf 100644 --- a/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/software_design.md +++ b/docs/Application_guide/zh/solutions/Agriculture-Control-Panel/software_design.md @@ -259,7 +259,7 @@ class AgriUi(object): ## 图形化界面设计 -上文提到，QuecPython 使用 NXP 公司的 [GUI Guider](https://www.nxp.com/design/software/development-software/gui-guider:GUI-GUIDER) 作为图形化界面设计工具，该工具不仅能够进行界面布局设计，还能自动生成 QuecPython 代码。[点此查看 GUI Guider 工具的使用教程](https://python.quectel.com/doc/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.html)。 +上文提到，QuecPython 使用 NXP 公司的 [GUI Guider](https://www.nxp.com/design/software/development-software/gui-guider:GUI-GUIDER) 作为图形化界面设计工具，该工具不仅能够进行界面布局设计，还能自动生成 QuecPython 代码。[点此查看 GUI Guider 工具的使用教程](https://developer.quectel.com/doc/quecpython/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.html)。 下文以智慧农业中控面板的首页为例，来介绍图形化界面的设计过程。 diff --git a/docs/Application_guide/zh/solutions/DTU-EG912U/dev_resources.md b/docs/Application_guide/zh/solutions/DTU-EG912U/dev_resources.md index 39c2e17df6d38aa5905088ebba375960a61df876..f9bf9b17fd544d8b91227f110cedf7fe79beff04 100644 --- a/docs/Application_guide/zh/solutions/DTU-EG912U/dev_resources.md +++ b/docs/Application_guide/zh/solutions/DTU-EG912U/dev_resources.md @@ -2,16 +2,12 @@ 本文档列出了 EG912U DTU 所需的硬件资源和相关文档。 -## 开发板资源 +## 开发板和模组型号的介绍 -型号：[EG912U 核心板](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) +型号：[EG912U 核心板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/bg-eg-core-evb.html) -- 开发板文档 - - [EG912U core board product specifications and user guide](https://python.quectel.com/wp-content/uploads/2024/11/EG912U%E6%A0%B8%E5%BF%83%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) +- 开发板文档： [EG912U core board product specifications and user guide](https://python.quectel.com/wp-content/uploads/2024/11/EG912U%E6%A0%B8%E5%BF%83%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) -## 模块资源 - -型号：[EG912U 核心板](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) - 规格书： [Quectel EG912U Series LTE Standard Module Product Specification Book](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_EG912U-GL_LTE_Standard_%E6%A8%A1%E5%9D%97%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E4%B9%A6_V1.2.pdf) - 驱动：[QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) diff --git a/docs/Application_guide/zh/solutions/DTU-EG912U/mqtt_demo.md b/docs/Application_guide/zh/solutions/DTU-EG912U/mqtt_demo.md index 28dacf790960c348b6d01aa05d476789f73637e0..85ce1ced9d59ee01ea047b30ad0c0352b5fb5a17 100644 --- a/docs/Application_guide/zh/solutions/DTU-EG912U/mqtt_demo.md +++ b/docs/Application_guide/zh/solutions/DTU-EG912U/mqtt_demo.md @@ -105,7 +105,7 @@ > 💡 **Tips** > -> QPYCom 安装和使用教程：https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html +> QPYCom 安装和使用教程：https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/DTU-EG912U/quick_start.md b/docs/Application_guide/zh/solutions/DTU-EG912U/quick_start.md index ac4bb8f9c5bf8c7e29f6ef430b76678e12fe7fbc..95e3f292b6863837465defce552fcf71510d9ee9 100644 --- a/docs/Application_guide/zh/solutions/DTU-EG912U/quick_start.md +++ b/docs/Application_guide/zh/solutions/DTU-EG912U/quick_start.md @@ -3,7 +3,7 @@ ## 硬件准备 - 一台windows电脑，推荐使用win10系统 -- 一套 [EG912U Core Board](https://python.quectel.com/doc/Getting_started/zh/evb/bg-eg-core-evb.html) 开发板 +- 一套 [EG912U Core Board](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/bg-eg-core-evb.html) 开发板 - 一张 Nano sim 卡 - 一根 天线 - 一根 Mini USB 数据线 @@ -14,7 +14,7 @@ - 下载并安装驱动：[QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip) - 下载并安装 [VSCode](https://code.visualstudio.com/) - 下载 [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) 并解压 -- 下载固件包 [QPY_OCPU_BETA0002_EG912U_GLAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip)。（[使用 QPYcom 烧录固件](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） +- 下载固件包 [QPY_OCPU_BETA0002_EG912U_GLAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip)。（[使用 QPYcom 烧录固件](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） - [下载源码](https://github.com/QuecPython/solution-simple-DTU)。 ## 硬件连接 diff --git a/docs/Application_guide/zh/solutions/DTU-EG912U/tcp_demo.md b/docs/Application_guide/zh/solutions/DTU-EG912U/tcp_demo.md index 4913e07a0fc60ad2275e81cf65a4d17ba35c7cd0..c9bfe8cec137dcc1b7a00056f1d4c71ea1679ba3 100644 --- a/docs/Application_guide/zh/solutions/DTU-EG912U/tcp_demo.md +++ b/docs/Application_guide/zh/solutions/DTU-EG912U/tcp_demo.md @@ -95,7 +95,7 @@ > 💡 **Tips** > -> QPYCom 安装和使用教程 ：https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html +> QPYCom 安装和使用教程 ：https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/DTU/dev_resources.md b/docs/Application_guide/zh/solutions/DTU/dev_resources.md index 84094db82f483b094fabbdb747a667eb07f30d49..d2f84bb2479f823ea9e07988620d149a48f18164 100644 --- a/docs/Application_guide/zh/solutions/DTU/dev_resources.md +++ b/docs/Application_guide/zh/solutions/DTU/dev_resources.md @@ -4,7 +4,7 @@ ## 开发板资料 -- 型号：[EC800GCN 华系列 DTU 开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec800g_hua_dtu.html) +- 型号：[EC800GCN 华系列 DTU 开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec800g_hua_dtu.html) - 购买链接：[点此跳转](https://www.quecmall.com/goods-detail/2c9080168ef07110018f1853d4050002) - 开发板文档： - [EC800G_华-DTU系列开发板产品规格及用户指导](https://python.quectel.com/wp-content/uploads/2024/09/EC800G_华-DTU系列开发板产品规格及用户指导.pdf) diff --git a/docs/Application_guide/zh/solutions/DTU/mqtt_demo.md b/docs/Application_guide/zh/solutions/DTU/mqtt_demo.md index 2841ece7297694dab0957e7e0d44ec2e48b976e7..aab911af9d6467e0c5eae02d7a18250e9dd86f6c 100644 --- a/docs/Application_guide/zh/solutions/DTU/mqtt_demo.md +++ b/docs/Application_guide/zh/solutions/DTU/mqtt_demo.md @@ -107,7 +107,7 @@ > 💡 **Tips** > -> QPYCom 安装和使用教程：https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html +> QPYCom 安装和使用教程：https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/DTU/quick_start.md b/docs/Application_guide/zh/solutions/DTU/quick_start.md index 87b996d90937b846d9ff0520c11e548b39ac7128..74fa6edaa73a414fdaedc3a082288b06a4d8ad50 100644 --- a/docs/Application_guide/zh/solutions/DTU/quick_start.md +++ b/docs/Application_guide/zh/solutions/DTU/quick_start.md @@ -3,7 +3,7 @@ ## 硬件准备 - Windows 电脑一台，建议 Win10 系统。 -- 一套 [EC800GCN 华系列 DTU 开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec800g_hua_dtu.html)。 +- 一套 [EC800GCN 华系列 DTU 开发板](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/ec2x-evb.html)。 - 一张可用的 Nano Sim 卡。 - 一根胶棒天线。 - 一根 Mini USB 数据线。 @@ -14,7 +14,7 @@ - 下载并安装 EC800G 系列模组驱动：[QuecPython_USB_Driver_Win10_U_G](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverU_V1.0.19.zip)。 - 下载并安装 [VSCode](https://code.visualstudio.com/)。 - 下载并解压 [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) 工具到电脑的合适位置。 -- 下载并安装固件包[QPY_OCPU_BETA0002_EC800G_CNLD_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EC800G_CNLD_FW.zip)。（固件包烧录请参阅 [使用 QPYcom 烧录固件](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） +- 下载并安装固件包[QPY_OCPU_BETA0002_EC800G_CNLD_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EC800G_CNLD_FW.zip)。（固件包烧录请参阅 [使用 QPYcom 烧录固件](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)） - 下载实验源码。 ## 硬件连接 diff --git a/docs/Application_guide/zh/solutions/DTU/tcp_demo.md b/docs/Application_guide/zh/solutions/DTU/tcp_demo.md index 9b8d81b8ea26521f875df77c7072aebe2e132f97..6dd10ec6df937f7376a71a63f133d9dfa093a1e8 100644 --- a/docs/Application_guide/zh/solutions/DTU/tcp_demo.md +++ b/docs/Application_guide/zh/solutions/DTU/tcp_demo.md @@ -101,7 +101,7 @@ > 💡 **Tips** > -> QPYCom 安装和使用教程：https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html +> QPYCom 安装和使用教程：https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/SensorHub/README.md b/docs/Application_guide/zh/solutions/SensorHub/README.md index d1922acc13154752b7f08b44465eb5f744b4a5a7..6a7f00d138dfb1c39a9d5fb0de608be7a7b242c0 100644 --- a/docs/Application_guide/zh/solutions/SensorHub/README.md +++ b/docs/Application_guide/zh/solutions/SensorHub/README.md @@ -12,4 +12,4 @@ - [开发资源汇总](./dev_resources.md) - [快速上手](quick_start.md) -- [软件设计讲解](./software_design) +- [软件设计讲解](./software_design.md) diff --git a/docs/Application_guide/zh/solutions/SensorHub/dev_resources.md b/docs/Application_guide/zh/solutions/SensorHub/dev_resources.md index e757da57243e28cfe7aee7e6088f0a1e9dff40e3..31d443720ea01a76d41972810fbf393ae942deb6 100644 --- a/docs/Application_guide/zh/solutions/SensorHub/dev_resources.md +++ b/docs/Application_guide/zh/solutions/SensorHub/dev_resources.md @@ -2,7 +2,7 @@ ## 开发板资料 -- 型号：[EC200U-EU Quecpython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html) +- 型号：[EC200U-EU Quecpython 标准开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec200x-evb.html) - 购买链接：[点击跳转](https://www.waveshare.com/ec200u-au-c4-p01.htm) **·** 开发板文档 @@ -13,7 +13,7 @@ ​ ° [丝印图](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) -​ ° [资源介绍与使用指导](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html) +​ ° [资源介绍与使用指导](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec200x-evb.html) diff --git a/docs/Application_guide/zh/solutions/SensorHub/quick_start.md b/docs/Application_guide/zh/solutions/SensorHub/quick_start.md index 643a02948ae66ba170e5883fe27448f1fb7a1712..4467fc1913ea37ece47ede094caef5d205824216 100644 --- a/docs/Application_guide/zh/solutions/SensorHub/quick_start.md +++ b/docs/Application_guide/zh/solutions/SensorHub/quick_start.md @@ -4,7 +4,7 @@ Windows电脑一台，建议 `Win10` 系统。 -一套[EC200U-EU Quecpython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html)（含天线，Type-C数据线） +一套[EC200U-EU Quecpython 标准开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec200x-evb.html)（含天线，Type-C数据线） 一张能够正常使用的SIM卡 @@ -46,17 +46,17 @@ Windows电脑一台，建议 `Win10` 系统。 - ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录[固件包](../../solutions/Sensorhub/EC200UEUAAR05A01M08_TEST0222.zip )至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录[固件包](../../solutions/Sensorhub/EC200UEUAAR05A01M08_TEST0222.zip )至开发板。 - ### 脚本导入与运行 -1.参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下的code文件夹中的所有文件按原目录结构导入到模组文件系统中，如下图所示 +1.参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下的code文件夹中的所有文件按原目录结构导入到模组文件系统中，如下图所示 -2.参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件_main.py +2.参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件_main.py -3.参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 +3.参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/Wear/dev_resources.md b/docs/Application_guide/zh/solutions/Wear/dev_resources.md index 9759d187253a517842e2514ebd0cdc2c6202d5f7..7337b0c9f81f0a9af91c6ce7344eca3624d56d0b 100644 --- a/docs/Application_guide/zh/solutions/Wear/dev_resources.md +++ b/docs/Application_guide/zh/solutions/Wear/dev_resources.md @@ -43,7 +43,7 @@ ## 固件包 - 版本：EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222.zip -- 下载[固件](https://raw.githubusercontent.com/QuecPython/solution-wearable/refs/heads/master/EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222_20250317-1147_20250317-1152.zip) +- 下载[固件](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG810M_CNGA_VOEXT_FW.zip) diff --git a/docs/Application_guide/zh/solutions/Wear/quick_start.md b/docs/Application_guide/zh/solutions/Wear/quick_start.md index 43d2c30113da0aa72cd41e296b9fbe53ce30b44e..f9a77a3bbc67a5428e100bf5c94876e033d712be 100644 --- a/docs/Application_guide/zh/solutions/Wear/quick_start.md +++ b/docs/Application_guide/zh/solutions/Wear/quick_start.md @@ -16,7 +16,7 @@ - 下载并安装 EG810M模组驱动：[QuecPython_USB_Driver_Win10_ASR](https://python.quectel.com/wp-content/uploads/2024/09/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip) - 下载并安装[VSCode](https://code.visualstudio.com/) - 下载并解压 [QPYCom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) 工具到电脑的合适位置。 -- 下载[固件包](https://raw.githubusercontent.com/QuecPython/solution-wearable/refs/heads/master/EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222_20250317-1147_20250317-1152.zip) +- 下载[固件包](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG810M_CNGA_VOEXT_FW.zip) - 下载[实验源码](https://codeload.github.com/QuecPython/solution-wearable/zip/refs/tags/v1.0.1) @@ -47,20 +47,20 @@ ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222.zip](https://raw.githubusercontent.com/QuecPython/solution-wearable/refs/heads/master/EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222_20250317-1147_20250317-1152.zip) 至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [EG810MCNGAR06A01M08_VOEXT_OCPU_QPY_BETA0222.zip](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG810M_CNGA_VOEXT_FW.zip) 至开发板。 ### 脚本导入与运行 -1. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有以`.py`结尾文件导入到模组文件系统，如下图所示： +1. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有以`.py`结尾文件导入到模组文件系统，如下图所示： -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`main_t.py +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`main_t.py -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行 +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行 diff --git a/docs/Application_guide/zh/solutions/Wear/software_design.md b/docs/Application_guide/zh/solutions/Wear/software_design.md index def53f6b69cbd53ab7b6f40befc5dc498eb48675..afac538b03b4695c67692829f70782ae490885a7 100644 --- a/docs/Application_guide/zh/solutions/Wear/software_design.md +++ b/docs/Application_guide/zh/solutions/Wear/software_design.md @@ -337,7 +337,7 @@ class UI(Abstract): ### 图形化界面设计 -上文提到，QuecPython 使用 NXP 公司的 [GUI Guider](https://www.nxp.com/design/software/development-software/gui-guider:GUI-GUIDER) 作为图形化界面设计工具，该工具不仅能够进行界面布局设计，还能自动生成 QuecPython 代码。[点此查看 GUI Guider 工具的使用教程](https://python.quectel.com/doc/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.html)。 +上文提到，QuecPython 使用 NXP 公司的 [GUI Guider](https://www.nxp.com/design/software/development-software/gui-guider:GUI-GUIDER) 作为图形化界面设计工具，该工具不仅能够进行界面布局设计，还能自动生成 QuecPython 代码。[点此查看 GUI Guider 工具的使用教程](https://developer.quectel.com/doc/quecpython/Application_guide/zh/multi-media/lvgl/lvgl_ui_tool.html)。 下文以穿戴方案的应用为例，来介绍图形化界面的设计过程。 diff --git a/docs/Application_guide/zh/solutions/electricity-meter/README.md b/docs/Application_guide/zh/solutions/electricity-meter/README.md index 7d4753c2d84a2cfb1ee1ddeb43f5371a51b061c1..026e9a1db6ddd973e4a3d67d042174e73afb006a 100644 --- a/docs/Application_guide/zh/solutions/electricity-meter/README.md +++ b/docs/Application_guide/zh/solutions/electricity-meter/README.md @@ -2,7 +2,7 @@ -智能电表解决方案基于 [QuecPython_EG91X系列C1-P02开发板](https://python.quectel.com/doc/Getting_started/zh/evb/eg91x-evb.html)实现，具有以下特性： +智能电表解决方案基于 [QuecPython_EG91X系列C1-P02开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/eg91x-evb.html)实现，具有以下特性： - 包含了串口通信模块、TCP 客户端、RFC1662 协议、DLMS 协议（开发中）等电表行业常用功能组件 - 拥有基础的应用框架，用户可基于该框架完善应用程序开发 diff --git a/docs/Application_guide/zh/solutions/electricity-meter/dev_resources.md b/docs/Application_guide/zh/solutions/electricity-meter/dev_resources.md index 896c65daaf60184b3200476717f1f6d7d8b17743..57f3dda306862b1d7807fbebe7af04213e7a487c 100644 --- a/docs/Application_guide/zh/solutions/electricity-meter/dev_resources.md +++ b/docs/Application_guide/zh/solutions/electricity-meter/dev_resources.md @@ -4,13 +4,13 @@ ## 开发板资料 -- 型号：[QuecPython_EG91X系列C1-P02开发板](https://python.quectel.com/doc/Getting_started/zh/evb/eg91x-evb.html) +- 型号：[QuecPython_EG91X系列C1-P02开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/eg91x-evb.html) - 开发板文档 - [规格书](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - [原理图](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - [丝印图](https://python.quectel.com/wp-content/uploads/2024/09/EG91X_C1-P02%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [资源介绍与使用指导](https://python.quectel.com/doc/Getting_started/zh/evb/eg91x-evb.html) + - [资源介绍与使用指导](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/eg91x-evb.html) diff --git a/docs/Application_guide/zh/solutions/electricity-meter/quick_start.md b/docs/Application_guide/zh/solutions/electricity-meter/quick_start.md index 17b3b0cfaa18d2ce1613d4782dc7634e3560face..f3065d7ba9b8211fa2b0bf7deb89bd71159aeed3 100644 --- a/docs/Application_guide/zh/solutions/electricity-meter/quick_start.md +++ b/docs/Application_guide/zh/solutions/electricity-meter/quick_start.md @@ -7,7 +7,7 @@ - Windows 电脑一台，建议 `Win10` 系统。 - 一根TypeC数据线 - 一张SIM卡 -- 一块[QuecPython_EG91X系列C1-P02开发板](https://python.quectel.com/doc/Getting_started/zh/evb/eg91x-evb.html) +- 一块[QuecPython_EG91X系列C1-P02开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/eg91x-evb.html) - 一个CP2102模块 - 一根天线 @@ -52,7 +52,7 @@ ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)烧录固件包 [QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip) 至EG912U模组开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)烧录固件包 [QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0002_EG912U_GLAA_FW.zip) 至EG912U模组开发板。 ​ @@ -62,13 +62,13 @@ -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有文件导入到模组文件系统，如下图所示： +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code`文件夹中的所有文件导入到模组文件系统，如下图所示： -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`demo.py` +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件`demo.py` -4. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行 +4. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行 diff --git a/docs/Application_guide/zh/solutions/poc/dev_resources.md b/docs/Application_guide/zh/solutions/poc/dev_resources.md index c391b5497a1f92a3489a9fd1fdf81721c85be789..7135130deef937d8d61b226b57c0cf3158749696 100644 --- a/docs/Application_guide/zh/solutions/poc/dev_resources.md +++ b/docs/Application_guide/zh/solutions/poc/dev_resources.md @@ -2,13 +2,13 @@ ## 开发板资料 -- 型号：[EC600MCNLE QuecPython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) +- 型号：[EC600MCNLE QuecPython 标准开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) - 购买链接：[点此跳转](http://e.tb.cn/h.gAlSKya8NvMC9UY?tk=7APD3KXufyq) - 开发板文档 - [规格书](https://python.quectel.com/wp-content/uploads/2024/10/EC600X系列开发板产品规格及用户指导.pdf) - [原理图](https://python.quectel.com/wp-content/uploads/2024/09/EC600X_EVB_V3.2-SCH.pdf) - [丝印图](https://python.quectel.com/wp-content/uploads/2024/09/EC600X_EVB_V3.2-丝印.pdf) - - [资源介绍与使用指导](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) + - [资源介绍与使用指导](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) ## 模组资料 diff --git a/docs/Application_guide/zh/solutions/poc/quick_start.md b/docs/Application_guide/zh/solutions/poc/quick_start.md index 0b656c53ade960a7688fcca4a4b0f13b95b46644..eecf884441449def590d1366ffc4e78a1c01b879 100644 --- a/docs/Application_guide/zh/solutions/poc/quick_start.md +++ b/docs/Application_guide/zh/solutions/poc/quick_start.md @@ -3,7 +3,7 @@ ## 硬件准备 - Windows 电脑一台，建议 `Win10` 系统。 -- 两套 [EC600MCNLE QuecPython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) （每一套均含天线、Type-C 数据线等）。 +- 两套 [EC600MCNLE QuecPython 标准开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec600x-evb.html) （每一套均含天线、Type-C 数据线等）。 > 💡 **Tips** > 一套用于主叫设备演示，一套用于被叫设备演示。 @@ -56,16 +56,16 @@ ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6)，烧录固件包 [EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip](https://github.com/QuecPython/solution-POC/releases/download/v2.0.1/EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip) 至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6)，烧录固件包 [EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip](https://github.com/QuecPython/solution-POC/releases/download/v2.0.1/EC600MCNLER06A01M08_POC_XBND_OCPU_QPY_BETA0117.zip) 至开发板。 ### 脚本导入与运行 -1. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： +1. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC%E4%B8%8E%E6%A8%A1%E7%BB%84%E9%97%B4%E7%9A%84%E6%96%87%E4%BB%B6%E4%BC%A0%E8%BE%93)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)，执行主程序文件 `poc_main.py`。 -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C)，停止程序运行。 +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#%E6%89%A7%E8%A1%8C%E8%84%9A%E6%9C%AC%E6%96%87%E4%BB%B6)，执行主程序文件 `poc_main.py`。 +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#%E5%81%9C%E6%AD%A2%E7%A8%8B%E5%BA%8F%E8%BF%90%E8%A1%8C)，停止程序运行。 ## 业务调试 diff --git a/docs/Application_guide/zh/solutions/poc/software_design.md b/docs/Application_guide/zh/solutions/poc/software_design.md index f03c0c978280d1d18d18743313f7d8463aeecb9b..f73c319cf97773cf561a63981aced63510adf274 100644 --- a/docs/Application_guide/zh/solutions/poc/software_design.md +++ b/docs/Application_guide/zh/solutions/poc/software_design.md @@ -29,7 +29,7 @@ ### 核心业务模块(POC) -> 有关 poc 库的 API 函数可参考[POC-公网对讲机](https://python.quectel.com/doc/API_reference/zh/industry/poc.html)说明文档。 +> 有关 poc 库的 API 函数可参考[POC-公网对讲机](https://developer.quectel.com/doc/quecpython/API_reference/zh/industry/poc.html)说明文档。 - #### 账户登录 diff --git a/docs/Application_guide/zh/solutions/tracker/dev_resources.md b/docs/Application_guide/zh/solutions/tracker/dev_resources.md index fb25cb642d3b40d9f8b9caaf037b0d002ddf31bc..050536f82361c9090e620b57db78c4e1291bef57 100644 --- a/docs/Application_guide/zh/solutions/tracker/dev_resources.md +++ b/docs/Application_guide/zh/solutions/tracker/dev_resources.md @@ -8,7 +8,7 @@ - [规格书](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%BA%A7%E5%93%81%E8%A7%84%E6%A0%BC%E5%8F%8A%E7%94%A8%E6%88%B7%E6%8C%87%E5%AF%BC.pdf) - [原理图](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E5%8E%9F%E7%90%86%E5%9B%BE.pdf) - [丝印图](https://python.quectel.com/wp-content/uploads/2024/09/EC200UA_C4-P01%E7%B3%BB%E5%88%97%E5%BC%80%E5%8F%91%E6%9D%BF%E4%B8%9D%E5%8D%B0.pdf) - - [资源介绍与使用指导](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html) + - [资源介绍与使用指导](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec200x-evb.html) ## 模组资料 @@ -27,7 +27,7 @@ - QuecPython 调试工具 - QPYcom - 版本：V3.6.0 - 下载 [QPYcom](https://python.quectel.com/wp-content/uploads/2024/09/QPYcom_V3.6.0.zip) - - [使用教程](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html) + - [使用教程](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html) - 代码编辑器 - VSCode - 下载 [VSCode](https://code.visualstudio.com/) diff --git a/docs/Application_guide/zh/solutions/tracker/quick_start.md b/docs/Application_guide/zh/solutions/tracker/quick_start.md index bfd5d705d54cce047ec81673538439e2194afe28..c585bb4efe4d464dc851d2654a5e8c525f75352d 100644 --- a/docs/Application_guide/zh/solutions/tracker/quick_start.md +++ b/docs/Application_guide/zh/solutions/tracker/quick_start.md @@ -3,7 +3,7 @@ ## 硬件准备 - Windows 电脑一台，建议 `Win10` 系统 -- 一套 [EC200UEUAA QuecPython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec200x-evb.html)（含 LTE 天线、 Type-C 数据线等） +- 一套 [EC200UEUAA QuecPython 标准开发板](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/ec200x-evb.html)（含 LTE 天线、 Type-C 数据线等） - 一根 [GNSS天线](https://e.tb.cn/h.TpAFyEz02BnCHRD?tk=fznae6ITVEX) - 一个排针跳线帽 - 一张可正常使用的 Nano SIM 卡 @@ -185,16 +185,16 @@ ota_status = { ### 烧录固件包 -参考[此章节](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [QPY_OCPU_BETA0001_EC200U_EUAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC200U_EUAA_FW.zip) 至开发板。 +参考[此章节](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#下载固件)，烧录固件包 [QPY_OCPU_BETA0001_EC200U_EUAA_FW](https://python.quectel.com/wp-content/uploads/2024/09/QPY_OCPU_BETA0001_EC200U_EUAA_FW.zip) 至开发板。 ### 脚本导入与运行 -1. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： +1. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#PC与模组间的文件传输)，将源码目录下 `code` 文件夹中的所有文件导入到模组文件系统，如下图所示： ![](../../media/solutions/tracker/code.png) -2. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件 `_main.py`。 -3. 参考[此章节](https://python.quectel.com/doc/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 +2. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#执行脚本文件)，执行主程序文件 `_main.py`。 +3. 参考[此章节](https://developer.quectel.com/doc/quecpython/Getting_started/zh/first_python.html#停止程序运行)，停止程序运行。 ## 业务调试 @@ -202,7 +202,7 @@ ota_status = { 执行 `_main.py` 脚本后，程序开始运行，在交互页面即可查看项目运行状态： -> 程序要运行一段时间后才能获取到 GNSS 定位信息，具体可参考相关[文档说明](https://python.quectel.com/doc/FAQ/zh/hardware/gnss.html#%3Cstrong%3E%E4%BB%80%E4%B9%88%E6%98%AFGNSS%E7%9A%84%E5%86%B7%E5%90%AF%E5%8A%A8%E3%80%81%E6%B8%A9%E5%90%AF%E5%8A%A8%E5%92%8C%E7%83%AD%E5%90%AF%E5%8A%A8%3C/strong%3E)。 +> 程序要运行一段时间后才能获取到 GNSS 定位信息，具体可参考相关[文档说明](https://developer.quectel.com/doc/quecpython/FAQ/zh/hardware/gnss.html#%3Cstrong%3E%E4%BB%80%E4%B9%88%E6%98%AFGNSS%E7%9A%84%E5%86%B7%E5%90%AF%E5%8A%A8%E3%80%81%E6%B8%A9%E5%90%AF%E5%8A%A8%E5%92%8C%E7%83%AD%E5%90%AF%E5%8A%A8%3C/strong%3E)。 ![tracker_running](../../media/solutions/tracker/tracker_running.png) diff --git a/docs/Application_guide/zh/system/fs.md b/docs/Application_guide/zh/system/fs.md index b5e19b6950b4869733475aeeb140fba09798a225..c0bf5217a55541d2f8988901f8a7d18fb736321b 100644 --- a/docs/Application_guide/zh/system/fs.md +++ b/docs/Application_guide/zh/system/fs.md @@ -25,13 +25,13 @@ 该步主要进行存储介质硬件初始化，然后挂载实体文件系统，最后获取到实体文件系统的句柄和文件操作接口。每个实体文件系统有各自独立的硬件初始化和挂载接口。如果初始化成功，这些接口最终返回实体文件系统的对象，对象中包含有实体文件系统句柄和文件操作接口等信息。 -- littleFS对应初始化接口为uos.VfsLfs1()（接口用法参考[注册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)） -- SPI SD卡FATFS对应初始化接口为uos.VfsFat()（接口用法参考[注册存储设备 - SPI - SD卡](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI---SD%E5%8D%A1)） -- SDIO SD卡FATFS对应初始化接口为uos.VfsSd()（接口用法参考[注册存储设备 - SDIO - SD卡](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SDIO---SD%E5%8D%A1)） +- littleFS对应初始化接口为uos.VfsLfs1()（接口用法参考[注册littleFS存储设备 - SPI NOR FLASH](https://developer.quectel.com/doc/quecpython/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)） +- SPI SD卡FATFS对应初始化接口为uos.VfsFat()（接口用法参考[注册存储设备 - SPI - SD卡](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI---SD%E5%8D%A1)） +- SDIO SD卡FATFS对应初始化接口为uos.VfsSd()（接口用法参考[注册存储设备 - SDIO - SD卡](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SDIO---SD%E5%8D%A1)） #### 挂载虚拟文件系统 -该步将实体文件系统接口绑定到虚拟文件系统接口。具体接口为uos.mount(vfs_obj, path)。其中参数vfs_obj为上一步初始化实体文件系统返回的对象，参数path为虚拟文件系统的根目录，虚拟文件系统正是以根目录来区分不同的实体文件系统，即每一个实体文件系统绑定一个不同的根目录。根据应用场景，文件系统根目录可以分为：内置NOR flash用户区usr、内置NOR flash备份区bak、外置NOR flash区ext、SD卡区sd、EMMC区emmc。这样不同的存储区域可以使用同一套软件接口传入不同的根目录进行访问。接口用法参考[挂载文件系统](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%8C%82%E8%BD%BD%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F)。 +该步将实体文件系统接口绑定到虚拟文件系统接口。具体接口为uos.mount(vfs_obj, path)。其中参数vfs_obj为上一步初始化实体文件系统返回的对象，参数path为虚拟文件系统的根目录，虚拟文件系统正是以根目录来区分不同的实体文件系统，即每一个实体文件系统绑定一个不同的根目录。根据应用场景，文件系统根目录可以分为：内置NOR flash用户区usr、内置NOR flash备份区bak、外置NOR flash区ext、SD卡区sd、EMMC区emmc。这样不同的存储区域可以使用同一套软件接口传入不同的根目录进行访问。接口用法参考[挂载文件系统](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%8C%82%E8%BD%BD%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F)。 #### 卸载虚拟文件系统 @@ -168,7 +168,7 @@ test end #### uos API -当进行目录等操作的时候，需要调用uos库进行操作，接口用法参考[uos - 基本系统服务](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html)。 +当进行目录等操作的时候，需要调用uos库进行操作，接口用法参考[uos - 基本系统服务](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html)。 ##### 综合示例 @@ -265,7 +265,7 @@ remove test dir, usr files:['system_config.json', 'example_fs_basic_operation_uo ### 高级文件操作 -ql_fs - 高级文件操作，接口用法参考[ql_fs - 高级文件操作](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html)。 +ql_fs - 高级文件操作，接口用法参考[ql_fs - 高级文件操作](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html)。 ##### 综合示例 diff --git a/docs/Application_guide/zh/system/info.md b/docs/Application_guide/zh/system/info.md index d8165ce8f2bc022c12f8fd8fda8fda84b6e39647..b28f440d01d2cc820006bfc25d3f282e9b827447 100644 --- a/docs/Application_guide/zh/system/info.md +++ b/docs/Application_guide/zh/system/info.md @@ -25,7 +25,7 @@ # (sysname='EC600U-CNLB', nodename='EC600U', release='1.13.0', version='v1.12 on Sat_Nov_19_2022_5:29:48_PM', machine='EC600U with QUECTEL', qpyver='V0002') ``` -如上所示，此接口和 uos.uname()返回的信息是一样的，只是返回值兼容了 microPython 的用法，更方便用户在脚本中访问返回值中“=”右边的信息，具体用法参考 [uos - 基本系统服务](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html)。 +如上所示，此接口和 uos.uname()返回的信息是一样的，只是返回值兼容了 microPython 的用法，更方便用户在脚本中访问返回值中“=”右边的信息，具体用法参考 [uos - 基本系统服务](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html)。 除此之外我们还可以使用如下方法获取固件版本信息： @@ -76,9 +76,9 @@ mem = gc.mem_free() print('剩余可用RAM空间:{}KB'.format(mem / 1024)) ``` -如上所示我们使用 uos.statvfs 这个函数查询了根目录下'usr'和'bak'两个文件夹的状态信息，可以获取到文件夹的剩余空间大小。关于根目录和这两个文件夹做如下简介，根目录：对于用户来说是不允许操作的，所以对根目录做的任何操作都会导致报 OSerror 异常。'usr'目录：此目录是允许客户做文件读写操作的，通常客户代码等文件均是主要存放在这里，如需扩展请看 [外扩存储](./memory-device.html#外置存储) 章节。'bak'目录：此目录是用于量产时存放客户需要备份的重要文件，可读不可写，存放重要文件请看 [备份分区和数据安全区的使用](https://python.quectel.com/doc/API_reference/zh/syslib/securedata.html) 。 +如上所示我们使用 uos.statvfs 这个函数查询了根目录下'usr'和'bak'两个文件夹的状态信息，可以获取到文件夹的剩余空间大小。关于根目录和这两个文件夹做如下简介，根目录：对于用户来说是不允许操作的，所以对根目录做的任何操作都会导致报 OSerror 异常。'usr'目录：此目录是允许客户做文件读写操作的，通常客户代码等文件均是主要存放在这里，如需扩展请看 [外扩存储](./memory-device.html#外置存储) 章节。'bak'目录：此目录是用于量产时存放客户需要备份的重要文件，可读不可写，存放重要文件请看 [备份分区和数据安全区的使用](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/securedata.html) 。 -其他 uos 相关使用请查看 [uos - 基本系统服务](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html)。 +其他 uos 相关使用请查看 [uos - 基本系统服务](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html)。 ## 查询 microPython 虚拟机版本 @@ -127,7 +127,7 @@ print('剩余可用RAM空间:{}KB'.format(mem / 1024)) 总之，IMEI 是物联网设备非常重要的标识符，可以用于设备管理、安全性、远程管理和数据分析等方面。 -使用 modem 库查询其他设备信息不再赘述，请查看 [modem - 设备相关](https://python.quectel.com/doc/API_reference/zh/syslib/modem.html)。 +使用 modem 库查询其他设备信息不再赘述，请查看 [modem - 设备相关](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/modem.html)。 ## 总结 diff --git a/docs/Application_guide/zh/system/memory-device.md b/docs/Application_guide/zh/system/memory-device.md index 7103c86ef5c9a42fea0dc697c6bc633cbbb32dfa..8053b3ede408ec329c985ebb8f5c6306e872eb25 100644 --- a/docs/Application_guide/zh/system/memory-device.md +++ b/docs/Application_guide/zh/system/memory-device.md @@ -248,7 +248,7 @@ d）烧录完成，重启设备运行已烧录的固件。 #### 裸分区操作 -如安全数据分区，将指定分区用来存储用户安全数据，以达到数据掉电保存的目的。数据来源为设备运行过程中用户实时产生的内容。所以，该分区不需要事先烧录特定内容到指定分区，且烧录时不擦除该分区。这种方式适合数据量小，不经常修改且关键数据的存储。接口用法参考[SecureData - 安全数据区](https://python.quectel.com/doc/API_reference/zh/syslib/securedata.html)。 +如安全数据分区，将指定分区用来存储用户安全数据，以达到数据掉电保存的目的。数据来源为设备运行过程中用户实时产生的内容。所以，该分区不需要事先烧录特定内容到指定分区，且烧录时不擦除该分区。这种方式适合数据量小，不经常修改且关键数据的存储。接口用法参考[SecureData - 安全数据区](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/securedata.html)。 ## 外置存储 @@ -286,7 +286,7 @@ d）烧录完成，重启设备运行已烧录的固件。 采用的是SPI通信总线，具体选用哪一路SPI引脚需要根据硬件资源支持和用户使用情况决定。 -针对4线SPI NOR flash方案，引脚细节可以参考[class SPI – SPI通信](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.SPI.html)中关于SPI引脚对应关系的介绍。由于可能会有其他外设如LCD也需要使用SPI通信，这时需要用户提前分配好硬件资源，各自使用不同的SPI通道，避免和NOR flash冲突的情况。 +针对4线SPI NOR flash方案，引脚细节可以参考[class SPI – SPI通信](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.SPI.html)中关于SPI引脚对应关系的介绍。由于可能会有其他外设如LCD也需要使用SPI通信，这时需要用户提前分配好硬件资源，各自使用不同的SPI通道，避免和NOR flash冲突的情况。 针对6线SPI NOR flash方案，当前仅ECx00U & EGx00U & ECx00G系列支持，引脚使用情况，需要参考如下表格： @@ -328,7 +328,7 @@ d）烧录完成，重启设备运行已烧录的固件。 ##### 软件接口 -其中文件系统分区使用的场景，文件系统需要执行挂载操作后才能使用，外置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仅特定型号特定固件支持，且不支持用户进行挂载操作，仅作内部使用。 +其中文件系统分区使用的场景，文件系统需要执行挂载操作后才能使用，外置4线spi nor flash文件系统初始化接口用法参考[注册littleFS存储设备 - SPI NOR FLASH](https://developer.quectel.com/doc/quecpython/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仅特定型号特定固件支持，且不支持用户进行挂载操作，仅作内部使用。 ##### 读写速率 @@ -352,7 +352,7 @@ SPI接口方式，使用通用的SPI总线与SD卡进行通信，包括初始化 ##### 硬件连接 -SDIO接口的硬件引脚使用参考硬件设计手册SD卡接口相关章节。SPI接口的硬件引脚使用参考[class SPI – SPI通信](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.SPI.html)中关于SPI引脚对应关系的介绍。 +SDIO接口的硬件引脚使用参考硬件设计手册SD卡接口相关章节。SPI接口的硬件引脚使用参考[class SPI – SPI通信](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.SPI.html)中关于SPI引脚对应关系的介绍。 ##### 文件系统类型 @@ -360,11 +360,11 @@ SD卡功能采用的文件系统是FATFS，支持Windows兼容的FAT32格式。 ##### 软件接口 -SD卡功能需要执行文件系统挂载操作后才能使用，SPI SD卡具体接口用法参考[注册存储设备 - SPI - SD卡](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI---SD%E5%8D%A1)，SDIO SD卡具体接口用法参考[注册存储设备 - SDIO - SD卡](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SDIO---SD%E5%8D%A1)。 +SD卡功能需要执行文件系统挂载操作后才能使用，SPI SD卡具体接口用法参考[注册存储设备 - SPI - SD卡](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SPI---SD%E5%8D%A1)，SDIO SD卡具体接口用法参考[注册存储设备 - SDIO - SD卡](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%B3%A8%E5%86%8C%E5%AD%98%E5%82%A8%E8%AE%BE%E5%A4%87---SDIO---SD%E5%8D%A1)。 ##### 热插拔 -当前仅SDIO SD卡支持卡插拔检测功能，而且需要搭配特定代码使用，具体接口用法参考[设置SD卡检测管脚](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E8%AE%BE%E7%BD%AESD%E5%8D%A1%E6%A3%80%E6%B5%8B%E7%AE%A1%E8%84%9A)。 +当前仅SDIO SD卡支持卡插拔检测功能，而且需要搭配特定代码使用，具体接口用法参考[设置SD卡检测管脚](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E8%AE%BE%E7%BD%AESD%E5%8D%A1%E6%A3%80%E6%B5%8B%E7%AE%A1%E8%84%9A)。 ##### 读写速率 @@ -386,7 +386,7 @@ SDIO SD卡功能仅ECx00U & EGx00U系列支持。SPI SD卡功能仅ECx00N & EGx0 ##### 格式化 -如果使用过程中出现文件系统异常，或者文件系统空间存满的情况，可以调用格式化接口对SD卡进行格式化。具体接口用法参考[挂载文件系统](https://python.quectel.com/doc/API_reference/zh/stdlib/uos.html#%E6%8C%82%E8%BD%BD%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F)。 +如果使用过程中出现文件系统异常，或者文件系统空间存满的情况，可以调用格式化接口对SD卡进行格式化。具体接口用法参考[挂载文件系统](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/uos.html#%E6%8C%82%E8%BD%BD%E6%96%87%E4%BB%B6%E7%B3%BB%E7%BB%9F)。 ### EMMC应用 diff --git a/docs/Application_guide/zh/system/memory-management.md b/docs/Application_guide/zh/system/memory-management.md index c04a88c9b0dbf5cdb375357dd715bb2dda1ce7bd..f54f3229d2b64cecfa2641a2e4d1c939d67cf900 100644 --- a/docs/Application_guide/zh/system/memory-management.md +++ b/docs/Application_guide/zh/system/memory-management.md @@ -188,7 +188,7 @@ typedef struct A_BLOCK_LINK #### 堆安全剩余量 -虽然堆空间是动态分配释放的，但是需要保证堆空间有足够的剩余以保证复杂业务时的申请需求。堆空间的总量是由底层决定的，固件生成后该值就确定了。调用接口`_thread.get_heap_size`可以查看当前堆空间剩余量，具体接口用法参考[wiki描述](https://python.quectel.com/doc/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.get_heap_size%3C/code%3E)。 +虽然堆空间是动态分配释放的，但是需要保证堆空间有足够的剩余以保证复杂业务时的申请需求。堆空间的总量是由底层决定的，固件生成后该值就确定了。调用接口`_thread.get_heap_size`可以查看当前堆空间剩余量，具体接口用法参考[wiki描述](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.get_heap_size%3C/code%3E)。 #### 内存泄露 @@ -350,13 +350,13 @@ GC: total: 320128, used: 13136, free: 306992 #### 如何主动触发GC回收 -调用接口`gc.collect()`，具体接口用法参考[wiki描述](https://python.quectel.com/doc/API_reference/zh/stdlib/gc.html#%3Ccode%3Egc.collect%3C/code%3E)。 +调用接口`gc.collect()`，具体接口用法参考[wiki描述](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/gc.html#%3Ccode%3Egc.collect%3C/code%3E)。 ## Python 编程注意项 ### 栈溢出，线程栈太小 -如果栈空间大小小于业务实际运行需要的空间，可能导致业务运行过程的数据操作越界到其他内存空间，将其他内存空间的数据破坏导致系统程序异常。所以需要根据业务复杂度适当分配线程栈空间大小，可以在创建线程之前调用接口`_thread.stack_size()`设置栈大小。具体接口用法参考[wiki描述](https://python.quectel.com/doc/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.stack_size%3C/code%3E)。 +如果栈空间大小小于业务实际运行需要的空间，可能导致业务运行过程的数据操作越界到其他内存空间，将其他内存空间的数据破坏导致系统程序异常。所以需要根据业务复杂度适当分配线程栈空间大小，可以在创建线程之前调用接口`_thread.stack_size()`设置栈大小。具体接口用法参考[wiki描述](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.stack_size%3C/code%3E)。 ### 变量被GC回收后继续使用 diff --git a/docs/Application_guide/zh/system/power-consumption.md b/docs/Application_guide/zh/system/power-consumption.md index 5371c0df3614bad5a65818007d5159a989d28d0e..46014c8cfee36ba53aa2b05b878fcdcb970ecf69 100644 --- a/docs/Application_guide/zh/system/power-consumption.md +++ b/docs/Application_guide/zh/system/power-consumption.md @@ -64,14 +64,14 @@ Quecpython支持的蜂窝通信模组要进入休眠，需要先使能休眠模 autosleep本质上是操作RTOS休眠检测机制中的一个flag，不使能autosleep时，模组的检测机制就会指令模组保持在IDLE状态。autosleep被使能时，检测机制才认为模组处于允许休眠的状态，从而进入休眠的逻辑。 -使用方法参见：[自动休眠模式控制](https://python.quectel.com/doc/API_reference/zh/syslib/pm.html#自动休眠模式控制) +使用方法参见：[自动休眠模式控制](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#自动休眠模式控制) #### 休眠锁机制 在某些场景下，我们既要使模组能够进入休眠，又需要在特定代码段保护某些外设的正常工作，这时，我们就要引入休眠锁机制。 休眠锁本质上也是一个flag，允许创建多个。生效机制是：只要有任意一个休眠锁处于lock状态，模组就不会进入休眠。 -使用方法参见：[创建wake_lock锁](https://python.quectel.com/doc/API_reference/zh/syslib/pm.html#创建wake_lock锁) +使用方法参见：[创建wake_lock锁](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#创建wake_lock锁) #### 影响蜂窝通信模组休眠的因素 @@ -448,7 +448,7 @@ PSM_INT是唤醒PSM的引脚，此引脚一般都引出自PMIC。PSM_INT的功 RTC闹钟能将模块从PSM模式下唤醒。其使用方法与模块关机时RTC闹钟的使用方法相同。 -参见：[RTC相关API说明](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.RTC.html) +参见：[RTC相关API说明](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.RTC.html) #### Powerkey @@ -544,7 +544,7 @@ if __name__ == '__main__': 需要在联网，且确认运营商支持PSM的前提下使用。根据业务需求决定ACT和TAU的周期，通过API设置即可： -参见：[PSM相关API说明](https://python.quectel.com/doc/API_reference/zh/syslib/pm.html#设置PSM模式的控制时间) +参见：[PSM相关API说明](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#设置PSM模式的控制时间) #### PSM_INT 应用 @@ -669,7 +669,7 @@ mA级耗流：全平台支持autosleep，根据其它需求评估适合型号 ### 测量模组休眠电流 -完成关机电流测量后，长按powerkey开机，模组开机默认的功耗模式是IDLE，我们需要调用休眠相关的接口，让模组在空闲时进入休眠，操作方法参见[autosleep相关API说明](https://python.quectel.com/doc/API_reference/zh/syslib/pm.html#自动休眠模式控制)。设置完休眠后，注意断开USB，USB连接时模组无法进入休眠。 +完成关机电流测量后，长按powerkey开机，模组开机默认的功耗模式是IDLE，我们需要调用休眠相关的接口，让模组在空闲时进入休眠，操作方法参见[autosleep相关API说明](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/pm.html#自动休眠模式控制)。设置完休眠后，注意断开USB，USB连接时模组无法进入休眠。 进入休眠模式后，模组应有的耗流波形会有周期稳定的凸起，这就是上文所述的DRX周期，如下图： @@ -679,7 +679,7 @@ mA级耗流：全平台支持autosleep，根据其它需求评估适合型号 ### 测量开机时模组的底电流 -完成联网情况下耗流测试后，重新连接USB，指令模组将射频关闭，接口见此处[net - 网络工作模式配置 ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F%E9%85%8D%E7%BD%AE)。配置完成后，断开USB，观察耗流，此时模组空闲且射频被关闭，所耗的电流是模组休眠时可达的最低水平，这时候的电流一般可称之为底电流： +完成联网情况下耗流测试后，重新连接USB，指令模组将射频关闭，接口见此处[net - 网络工作模式配置 ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E5%B7%A5%E4%BD%9C%E6%A8%A1%E5%BC%8F%E9%85%8D%E7%BD%AE)。配置完成后，断开USB，观察耗流，此时模组空闲且射频被关闭，所耗的电流是模组休眠时可达的最低水平，这时候的电流一般可称之为底电流： ![](../media/system/power-consumption/Current_test_CFUN0_sleep.png) diff --git a/docs/Application_guide/zh/system/power-manager.md b/docs/Application_guide/zh/system/power-manager.md index f28616709ae244f8044cb30bad73532c3ea39e73..8dcc0a06097dbfae546c6c742cfc5e44801dd682 100644 --- a/docs/Application_guide/zh/system/power-manager.md +++ b/docs/Application_guide/zh/system/power-manager.md @@ -138,7 +138,7 @@ Powerkey，即电源键，用来控制模组开关机。该按键连接至 PMIC 自定义Powerkey的短按长按功能实际上就是按键检测，实现方法是在按下时的中断里启动一个定时器，在抬起的中断里关闭这个定时器。如果定时器尚未到期，就被powerkey抬起的中断关闭，则判定为短按。如果直到超时都没有抬起的中断触发，则判定为长按。定时器的超时时间就是界定短按和长按的阈值。 -配置powerkey自定义功能用法：[class PowerKey - power key按键回调注册功能 ](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.PowerKey.html) +配置powerkey自定义功能用法：[class PowerKey - power key按键回调注册功能 ](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.PowerKey.html) 配置powerkey自定义短按/长按示例代码： @@ -256,7 +256,7 @@ RTC单元上除了存储实时时间的寄存器，还有一组（部分型号 RTC单元时间刷新的时候，会和alarm中所设的时间进行比较。一旦实时时间与alarm值相等，就会触发RTC alarm超时中断。当CPU处于关机状态时，该中断能指令PMIC触发CPU开机。而CPU处于开机状态时，能够触发CPU的中断（类似硬件定时器）。 -应用方法参考：[class RTC – 实时时钟 ](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.RTC.html) +应用方法参考：[class RTC – 实时时钟 ](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.RTC.html) **关机闹钟示例代码：** @@ -318,12 +318,12 @@ if __name__ == '__main__': #### 典型应用-ADC **1.检测模组VBAT电压** -**使用方法：**[获取电池电压](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.Power.html#%E8%8E%B7%E5%8F%96%E7%94%B5%E6%B1%A0%E7%94%B5%E5%8E%8B) +**使用方法：**[获取电池电压](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.Power.html#%E8%8E%B7%E5%8F%96%E7%94%B5%E6%B1%A0%E7%94%B5%E5%8E%8B) 这一路ADC固定连接在模组的VBAT上，我们可以在应用层监控模组VBAT的电压，在使用电池给模组供电时，此接口可以实现对电池的管理。 除了获取电压之外，当此路ADC探测到VBAT电压过高或过低时，会在PMIC上触发超压/低压的中断。此时为了保护模组硬件，PMIC会主动改变电源状态，指令整个模组下电关机。 **2.ADC的使用** -**使用方法：**[class ADC - 模数转换](https://python.quectel.com/doc/API_reference/zh/peripherals/misc.ADC.html) +**使用方法：**[class ADC - 模数转换](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/misc.ADC.html) 将输出模拟量的设备连接到ADC上，可以读取到设备输出的电压幅值。此时我们在业务中利用这个设备的电压幅值来计算传感数据。 > 不同的PMIC，搭载ADC的有效检测范围也是不同的，需要根据硬件手册来确定。如果模拟设备的输出范围和ADC的检测范围不符，就需要在硬件上设计分压，将输出电压和ADC的有效范围做匹配。业务里再通过检测到的电压来反推模拟设备的真实输出值。 diff --git a/docs/Application_guide/zh/system/sys-time.md b/docs/Application_guide/zh/system/sys-time.md index 86828f1d1a4e1ad48b9d2921caefb57f228cd673..b4bba906090abefd5896774433335affff8c7314 100644 --- a/docs/Application_guide/zh/system/sys-time.md +++ b/docs/Application_guide/zh/system/sys-time.md @@ -16,7 +16,7 @@ QuecPython 设备时间功能应用如下图所示： RTC 可以提供独立于操作系统的时间计时服务，即使设备关机（不断电）也能保持时间的准确性。 -在 QuecPython 中内置 RTC 实时时钟，可以使用 `machine` 模块访问 RTC 实时时钟。对于 RTC 的所有用法参见 [class RTC – 实时时钟](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.RTC.html)章节，下面主要介绍常用操作与注意事项。 +在 QuecPython 中内置 RTC 实时时钟，可以使用 `machine` 模块访问 RTC 实时时钟。对于 RTC 的所有用法参见 [class RTC – 实时时钟](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.RTC.html)章节，下面主要介绍常用操作与注意事项。 > QuecPython 支持多种型号模组，不同模组 RTC 时间精度有所差异，对于时间精度要求较高的，可以根据各芯片硬件手册进行选择。 > QuecPython 模组 RTC 时间配置以及 ALARM 配置会擦写 FLASH，不宜频繁调用。 @@ -74,7 +74,7 @@ rtc.enable_alarm(1) 时间是一种尺度，在物理定义是标量，借着时间，事件发生之先后可以按过去-现在-未来之序列得以确定（时间点/时刻），也可以衡量事件持续的期间以及事件之间和间隔长短（时间段）。 -QuecPython 下 utime 模块提供获取当前时间和日期（UTC 时间）、测量时间间隔和延迟的函数。utime 是软件层面的时间。对于 utime 的所有用法参见标准库 [utime - 时间相关功能](https://python.quectel.com/doc/API_reference/zh/stdlib/utime.html) 章节。 +QuecPython 下 utime 模块提供获取当前时间和日期（UTC 时间）、测量时间间隔和延迟的函数。utime 是软件层面的时间。对于 utime 的所有用法参见标准库 [utime - 时间相关功能](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/utime.html) 章节。 #### System Tick @@ -172,7 +172,7 @@ NITZ（Network Identity and Time Zone，网络标识和时区），是一种用 NTP（Network Time Protocol， 网络时间协议），是由 RFC 1305 定义的时间同步协议，用来在分布式时间服务器和客户端之间进行时间同步，NTP 基于 UDP 报文进行传输，使用 UDP 端口号为 123。 -报文格式如下图所示，我们可以根据协议的报文内容，通过上报时间与服务器的时间比较，以及链路传输时间计算，校准当前设备与服务器时间保持一致。QuecPython 设备对于 NTP 的所有用法参见 [ntptime - 网络时间同步](https://python.quectel.com/doc/API_reference/zh/networklib/ntptime.html) 章节。 +报文格式如下图所示，我们可以根据协议的报文内容，通过上报时间与服务器的时间比较，以及链路传输时间计算，校准当前设备与服务器时间保持一致。QuecPython 设备对于 NTP 的所有用法参见 [ntptime - 网络时间同步](https://developer.quectel.com/doc/quecpython/API_reference/zh/networklib/ntptime.html) 章节。 ![](../media/system/sys-time/time-ntp-proto.png) @@ -274,7 +274,7 @@ utime.sleep_us(1000*1000) ### 系统定时器(Timer) -系统定时器用于定时或者周期性执行某任务，该定时器基于硬件定时器功能实现，一般最多可以创建4个定时器。QuecPython 设备对于系统定时器的所有用法参见 [class Timer - 硬件定时器](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Timer.html) 章节。 +系统定时器用于定时或者周期性执行某任务，该定时器基于硬件定时器功能实现，一般最多可以创建4个定时器。QuecPython 设备对于系统定时器的所有用法参见 [class Timer - 硬件定时器](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Timer.html) 章节。 ```python from machine import Timer diff --git a/docs/FAQ/en/hardware/bsp.md b/docs/FAQ/en/hardware/bsp.md index e60cba856bcd107d9473d24b3d7d8ad2ecfc8f11..633887cc6bbf90790fab89756453ee4e90ccbeab 100644 --- a/docs/FAQ/en/hardware/bsp.md +++ b/docs/FAQ/en/hardware/bsp.md @@ -18,15 +18,15 @@ GPIO output current capability: 4mA For specific pins that can be used as GPIO, please refer to the Section machine.Pin on the wiki. -> Specific link: [GPIO pin description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html) +> Specific link: [GPIO pin description](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html) ### **Which pins can be used as external interrupts?** The external interrupt number will go along with the number of GPIO pins. For details, please refer to machine.Pin and machine.Extlnt on the GPIO pin wiki. -> Specific link: [GPIO pin description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.Pin.html); +> Specific link: [GPIO pin description](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.Pin.html); > -> [Extlnt-External Interrupt Description](https://python.quectel.com/doc/API_reference/en/peripherals/machine.ExtInt.html) +> [Extlnt-External Interrupt Description](https://developer.quectel.com/doc/quecpython/API_reference/en/peripherals/machine.ExtInt.html) ### **Which pins can be used as wake-up interrupts?** diff --git a/docs/FAQ/en/hardware/gnss.md b/docs/FAQ/en/hardware/gnss.md index fdf2ae55f96e5235fef56ad8335d97a9d2a12d92..115fc483ca2ce5fc829928db508b0735d7d622ca 100644 --- a/docs/FAQ/en/hardware/gnss.md +++ b/docs/FAQ/en/hardware/gnss.md @@ -43,7 +43,7 @@ ### **How does the module output raw NMEA data?** -The built-in GNSS calls quecgnss.read(size), and the log output by the QPYcom is the raw NMEA data. For details, see [quecgnss](https://python.quectel.com/doc/API_reference/en/gnsslib/quecgnss.html). +The built-in GNSS calls quecgnss.read(size), and the log output by the QPYcom is the raw NMEA data. For details, see [quecgnss](https://developer.quectel.com/doc/quecpython/API_reference/en/gnsslib/quecgnss.html). ### **How to interpret the meaning of each field in NMEA messages?** diff --git a/docs/FAQ/en/network/cloud-platforms.md b/docs/FAQ/en/network/cloud-platforms.md index 98109e68de06203f756968fbe251fe66e5d1448a..b35106c5236aeba7ce7df81d0714d9daa5776675 100644 --- a/docs/FAQ/en/network/cloud-platforms.md +++ b/docs/FAQ/en/network/cloud-platforms.md @@ -12,7 +12,7 @@ The module with umqtt provides basic connection and publication and subscription ### **How to connect to Alibaba IoT platform, Tencent IoT platform, etc. via MQTT?** -For details to connect to the Alibaba IoT platform and Tencent IoT platform via MQTT, please refer to the QuecPython IoT platform in [wiki community](https://python.quectel.com/doc/API_reference/en/index.html) on the official website. +For details to connect to the Alibaba IoT platform and Tencent IoT platform via MQTT, please refer to the QuecPython IoT platform in [wiki community](https://developer.quectel.com/doc/quecpython/API_reference/en/index.html) on the official website. ### **When the IoT platform runs the demo, it occurs "Not subscribed"** diff --git a/docs/FAQ/en/network/fota.md b/docs/FAQ/en/network/fota.md index d1abdba9cc2ed3a08d229a59caae38d8193cee5b..93a164c7111cc7333239fbdb31a11ec66da81cec 100644 --- a/docs/FAQ/en/network/fota.md +++ b/docs/FAQ/en/network/fota.md @@ -15,7 +15,7 @@ Script upgrade: app_fota upgrade, whole package upgrade, full upgrade 4. After verifying the upgrade package, please reboot the module. The system will automatically perform the OTA upgrade after the device restarts. 5. After the upgrade is completed, you can check the firmware version through modem.getDevFwVersion(). -> For specific, please refer to [fota]([fota - Firmware upgrade related functions - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/en/syslib/fota.html) ): +> For specific, please refer to [fota]([fota - Firmware upgrade related functions - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/fota.html) ): > ### **How to upgrade the business?** @@ -26,7 +26,7 @@ Script upgrade: app_fota upgrade, whole package upgrade, full upgrade 4. Reboot the module. After that, upgrade and delete relevant flag at the same time. 5. After the upgrade is completed, it is available to view the upgraded target files in the file system partition. -> For specific, please refer to [app_fota]([app_fota - User file upgrade related functions - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/en/syslib/app_fota.html)). +> For specific, please refer to [app_fota]([app_fota - User file upgrade related functions - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/app_fota.html)). ### **What is the mechanism of fota upgrade? Can it be guaranteed that it will not become bricked after the upgrade fails? Can the upgrade be continued after powering off and on again?** diff --git a/docs/FAQ/en/network/net.md b/docs/FAQ/en/network/net.md index fea4f42fcbb066fa5f0f7d86f52be12758c45f1c..8dda34ad7aef5fb3e1756917e5e70239e24e44cb 100644 --- a/docs/FAQ/en/network/net.md +++ b/docs/FAQ/en/network/net.md @@ -51,7 +51,7 @@ The logic of cell reselection is as follows: ### **Investigation on failed or slow network registration and network attachment. ** -- Call the [`sim.getStatus()`](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E) to check whether the SIM card is identified. +- Call the [`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E) to check whether the SIM card is identified. - Check whether the SIM card is in debt and whether the flow runs out [The 4G module will be registered to 2G network instead of 4G network]. [For other situations, please consult the SIM card operator] - Confirm that the antenna is matched. - Check whether the antenna is connected, whether the interface of the antenna socket is correct, and whether the antenna is damaged [confirm by replacing the antenna]. diff --git a/docs/FAQ/en/network/signal.md b/docs/FAQ/en/network/signal.md index fc558eec5aadbb169fc0e9eb709d7e58d2a964b5..76943696b3f2017585b26e0cf27daca886fabb68 100644 --- a/docs/FAQ/en/network/signal.md +++ b/docs/FAQ/en/network/signal.md @@ -7,7 +7,7 @@ Two methods are available to query: - CSQ signal strength: net.csqQueryPoll() - RSRP signal strength: net.getSignal() -> For specific, see the link: [CSQ](https://python.quectel.com/doc/API_reference/en/iotlib/net.html?highlight=signal) +> For specific, see the link: [CSQ](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html?highlight=signal) ### **The relationship between signal strength and the stability of network data services ** diff --git a/docs/FAQ/en/network/sim.md b/docs/FAQ/en/network/sim.md index d77c665a3b4cee1b4cb12a489af9f97063821776..8ae5c1969f06dd14fe7e4a4dc0bb6ea9fea8754e 100644 --- a/docs/FAQ/en/network/sim.md +++ b/docs/FAQ/en/network/sim.md @@ -15,7 +15,7 @@ - In addition to the official website API method, you can also detect SIM card plug-in/out through interrupts and switch between CFUN0/1. ### **How to investigate and solve the problem of invisible SIM card?** -- Use API to detect the status of the SIM card: If it returns 1 after calling sim.getStatus(), which means it is normal. For other situations, please refer to [sim](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html) in detail. +- Use API to detect the status of the SIM card: If it returns 1 after calling sim.getStatus(), which means it is normal. For other situations, please refer to [sim](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html) in detail. - Check whether the SIM card is inserted backwards, damaged or poor contact. - Remove the capacitors and ESD components from the SIM card circuit to prevent the SIM card from not being recognized due to incorrect welding capacitance values or incorrect welding of ESD components. - Test the pin impedance via the diode stall in multimeter with the red probe connected to ground and the black probe connected to the pin. diff --git a/docs/FAQ/en/software/fs.md b/docs/FAQ/en/software/fs.md index 06b6860796b76c8af67ad0d3cdc075866241038c..974094534e629b564d2a8abc995524483e132232 100644 --- a/docs/FAQ/en/software/fs.md +++ b/docs/FAQ/en/software/fs.md @@ -1,21 +1,21 @@ # FAQ on File System ### **What is the function of ql_fs?** -- Provide [`path_exists`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_exists%3C/code%3E) to determine the existence of file. +- Provide [`path_exists`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_exists%3C/code%3E) to determine the existence of file. -- Provide [`file_copy`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.file_copy%3C/code%3E) to copy files quickly . +- Provide [`file_copy`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.file_copy%3C/code%3E) to copy files quickly . -- Provide [`path_dirname`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_dirname%3C/code%3E) to obtain the prefix pathname of last level. +- Provide [`path_dirname`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_dirname%3C/code%3E) to obtain the prefix pathname of last level. -- Provide [`path_getsize`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_getsize%3C/code%3E) to obtain the file size. +- Provide [`path_getsize`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_getsize%3C/code%3E) to obtain the file size. -- Provide [`mkdirs`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.mkdirs%3C/code%3E) to create nested folders . +- Provide [`mkdirs`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.mkdirs%3C/code%3E) to create nested folders . -- Provide [`rmdirs`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.rmdirs%3C/code%3E) to delete nested folders . +- Provide [`rmdirs`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.rmdirs%3C/code%3E) to delete nested folders . -- Provides [`touch`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.touch%3C/code%3E) to create files quickly. +- Provides [`touch`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.touch%3C/code%3E) to create files quickly. -- Provide `write_json` and [`read_json`](https://python.quectel.com/doc/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.read_json%3C/code%3E ) to read and write json files quickly. +- Provide `write_json` and [`read_json`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/ql_fs.html#%3Ccode%3Eql_fs.read_json%3C/code%3E ) to read and write json files quickly. ### **Why does it fail to delete files using uos.remove()?** Please check whether the file is closed. Files that have been opened cannot be deleted and must be closed before they can be deleted. diff --git a/docs/FAQ/en/software/threads.md b/docs/FAQ/en/software/threads.md index d0770925c0d952be2a583a245a280fe897a843e0..d64103e31250954372ccd6607c7879cfa7e92aa5 100644 --- a/docs/FAQ/en/software/threads.md +++ b/docs/FAQ/en/software/threads.md @@ -15,7 +15,7 @@ When programming multiple threads, it is recommended to monitor other sub-thread ### **When there is no semaphore related interface in the multi-thread function, how to implement the semaphore function?** The implementation of QuecPython's multi-thread module is originated from the thread of standard Python. As a result, the semaphore-related interfaces are not provided. -If is is needed to implement a semaphore-like function, the mutex ([`_thread.allocate_lock`](https://python.quectel.com/doc/API_reference/en/stdlib/_thread.html#Mutex) method) or message queue ([`queue.Queue`](https://python.quectel.com/doc/API_reference/en/syslib/Queue.html) method) can be applied. +If is is needed to implement a semaphore-like function, the mutex ([`_thread.allocate_lock`](https://developer.quectel.com/doc/quecpython/API_reference/en/stdlib/_thread.html#Mutex) method) or message queue ([`queue.Queue`](https://developer.quectel.com/doc/quecpython/API_reference/en/syslib/Queue.html) method) can be applied. If the maximum value of the semaphore is only 1, the mutex or message queue can be applied to implement the semaphore function; if the value of the semaphore is greater than 1, the message queue will be valid to implement the semaphore function. diff --git a/docs/FAQ/zh/hardware/bsp.md b/docs/FAQ/zh/hardware/bsp.md index c7b47d485fa43627725f86ce573a5a329a91ea59..fe66282c602194492b2907b4d0197455eb1d1f41 100644 --- a/docs/FAQ/zh/hardware/bsp.md +++ b/docs/FAQ/zh/hardware/bsp.md @@ -15,13 +15,13 @@ GPIO输出电流能力：4mA 具体哪些引脚可以用作GPIO，需要参考wiki上面machine.Pin这一节。 -> 具体详情链接：[GPIO引脚说明]([class Pin - 控制I/O引脚 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html)) +> 具体详情链接：[GPIO引脚说明]([class Pin - 控制I/O引脚 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html)) ### 哪些引脚可以用作外部中断 有多少个GPIO引脚就能用作多少个外部中断，具体可以参考GPIO引脚wiki上面machine.Pin和machine.Extlnt。 -> 具体详情链接：[GPIO引脚说明]([class Pin - 控制I/O引脚 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.Pin.html))；[Extlnt外部中断说明]([class ExtInt - 外部中断 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/peripherals/machine.ExtInt.html)) +> 具体详情链接：[GPIO引脚说明]([class Pin - 控制I/O引脚 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.Pin.html))；[Extlnt外部中断说明]([class ExtInt - 外部中断 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/peripherals/machine.ExtInt.html)) ### 哪些引脚可以用作唤醒中断 diff --git a/docs/FAQ/zh/hardware/cellLocator.md b/docs/FAQ/zh/hardware/cellLocator.md index 601c99c82645c7a94c6be6d026e4663050011584..287188375b33b5154d81fe7b2a1cdfeb48920925 100644 --- a/docs/FAQ/zh/hardware/cellLocator.md +++ b/docs/FAQ/zh/hardware/cellLocator.md @@ -2,7 +2,7 @@ ### **如何使用基站定位** -需要申请Token，[基站定位Token申请指南](https://mp.weixin.qq.com/s/JZF3vURe61_kZDZGKBzxXw ),然后调用[cellLocation](https://python.quectel.com/doc/API_reference/zh/gnsslib/cellLocator.html)实现基站定位。 +需要申请Token，[基站定位Token申请指南](https://mp.weixin.qq.com/s/JZF3vURe61_kZDZGKBzxXw ),然后调用[cellLocation](https://developer.quectel.com/doc/quecpython/API_reference/zh/gnsslib/cellLocator.html)实现基站定位。 ### **基站定位原理** diff --git a/docs/FAQ/zh/hardware/gnss.md b/docs/FAQ/zh/hardware/gnss.md index f1723720527d5490a21ac36b7ed6988b08b4b50d..144b1fedad86ea36596ad6540f2db62b4827dc8c 100644 --- a/docs/FAQ/zh/hardware/gnss.md +++ b/docs/FAQ/zh/hardware/gnss.md @@ -36,7 +36,7 @@ ### **模块如何输出原始NMEA数据** -内置GNSS调用quecgnss.read(size)，QPYcom交互界面输出的日志为原始NMEA数据，详情见[quecgnss](https://python.quectel.com/doc/API_reference/zh/gnsslib/quecgnss.html)。 +内置GNSS调用quecgnss.read(size)，QPYcom交互界面输出的日志为原始NMEA数据，详情见[quecgnss](https://developer.quectel.com/doc/quecpython/API_reference/zh/gnsslib/quecgnss.html)。 ### **如何解读NMEA报文每个字段的含义** diff --git a/docs/FAQ/zh/network/cloud-platforms.md b/docs/FAQ/zh/network/cloud-platforms.md index 459d6f108ba1dd9cf6999fe550ed3d0e078c824e..a9c3a9963721636910266a972e31811dbe70f4d7 100644 --- a/docs/FAQ/zh/network/cloud-platforms.md +++ b/docs/FAQ/zh/network/cloud-platforms.md @@ -14,7 +14,7 @@ umqtt模块提供创建MQTT客户端的基础连接与发布订阅功能，并 ### **如何使用MQTT协议连接阿里 IoT 平台、腾讯 IoT 平台等？** -使用MQTT协议连接阿里 IoT 平台、腾讯 IoT 平台的步骤可以详细参见官网上的[wiki社区](https://python.quectel.com/doc/API_reference/zh/index.html)的QuecPython IoT 平台。 +使用MQTT协议连接阿里 IoT 平台、腾讯 IoT 平台的步骤可以详细参见官网上的[wiki社区](https://developer.quectel.com/doc/quecpython/API_reference/zh/index.html)的QuecPython IoT 平台。 ### **IoT 平台运行demo出现未订阅等信息** diff --git a/docs/FAQ/zh/network/fota.md b/docs/FAQ/zh/network/fota.md index 6c991e5012e89b267ce4efde9d74fed700711b72..d7db4f655223e3caaa95b7b29382b19269fbdc3e 100644 --- a/docs/FAQ/zh/network/fota.md +++ b/docs/FAQ/zh/network/fota.md @@ -14,7 +14,7 @@ 4. 升级包校验后需要重启模块，系统在设备重启之后自动进行OTA升级。 5. 升级完成后，可通过modem.getDevFwVersion()查看固件版本。 -> 更多详情请参考链接：[fota]([fota - 固件升级相关功能 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/syslib/fota.html)) +> 更多详情请参考链接：[fota]([fota - 固件升级相关功能 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/fota.html)) > ### 如何进行业务升级 @@ -25,7 +25,7 @@ 4. 重启模块，重启后即可启动升级工作，同时清除升级标志。 5. 升级完成后，可在文件系统分区查看升级后的目标文件。 -> 更多详情请参考链接：[app_fota]([app_fota - 用户文件升级相关功能 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/syslib/app_fota.html)) +> 更多详情请参考链接：[app_fota]([app_fota - 用户文件升级相关功能 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/app_fota.html)) ### fota升级的机制是怎样的，能否保证升级失败后不会变砖，能否断电再上电后继续升级 diff --git a/docs/FAQ/zh/network/net.md b/docs/FAQ/zh/network/net.md index 8eda028d779486212c7cbdac05b13c614d2ca536..42b78096b26ce5ef1d2ee26b258534335f24b1a1 100644 --- a/docs/FAQ/zh/network/net.md +++ b/docs/FAQ/zh/network/net.md @@ -60,7 +60,7 @@ ### **无法注册网络、注册网络慢、无法附着网络、附着网络慢的原因排查** -- 调用[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法检查SIM卡是否识别。 +- 调用[`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法检查SIM卡是否识别。 - 检查下sim卡是否欠费，流量是否用完【4G模块有一种欠费表现：无法注册4G网络，可以注册2G网络】。【其他情况可以咨询卡商】 diff --git a/docs/FAQ/zh/network/signal.md b/docs/FAQ/zh/network/signal.md index 57d8e41ed4b6d67551085208dc3e3be3ba562907..cc2ccebafea4b67df5a424c1376bd7bb35c487a1 100644 --- a/docs/FAQ/zh/network/signal.md +++ b/docs/FAQ/zh/network/signal.md @@ -7,7 +7,7 @@ - CSQ信号强度：net.csqQueryPoll() - RSRP信号强度：net.getSignal() -> 具体详情链接： [CSQ](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html?highlight=信号强度#获取CSQ信号强度);[RSRP]([net - 网络相关功能 - QuecPython (quectel.com)](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html?highlight=信号强度#获取详细信号强度)) +> 具体详情链接： [CSQ](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html?highlight=信号强度#获取CSQ信号强度);[RSRP]([net - 网络相关功能 - QuecPython (quectel.com)](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html?highlight=信号强度#获取详细信号强度)) ### 信号强度与网络数据业务的稳定性的关系 diff --git a/docs/FAQ/zh/network/sim.md b/docs/FAQ/zh/network/sim.md index 86caa44af1c4cedb4324ee417be911bf5f2fb15a..3da0cc35bbae39fad55c32fb08fd82bf4d2be239 100644 --- a/docs/FAQ/zh/network/sim.md +++ b/docs/FAQ/zh/network/sim.md @@ -24,7 +24,7 @@ ### **找不到SIM卡如何排查和解决** -- 用API检测SIM卡状态，sim.getStatus()，返回1正常，返回其他详情见[sim](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%E6%9F%A5%E8%AF%A2SIM%E5%8D%A1%E7%8A%B6%E6%80%81)这一章节说明 +- 用API检测SIM卡状态，sim.getStatus()，返回1正常，返回其他详情见[sim](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%E6%9F%A5%E8%AF%A2SIM%E5%8D%A1%E7%8A%B6%E6%80%81)这一章节说明 - 检查SIM卡是否插反、是否有损坏、是否接触不良 - 去掉SIM卡电路的电容和ESD器件，防止焊接电容容值不对或者ESD器件焊接错误导致模组SIM卡不识别 - 用万用表二极管挡位测试引脚阻抗，红表笔接地，黑表笔接引脚 diff --git a/docs/FAQ/zh/software/fs.md b/docs/FAQ/zh/software/fs.md index b2c6a69cc601a779038aeff68ae77c2a9d03ba7a..12f19665c3e2eeeed85acc4acc968300d63163e3 100644 --- a/docs/FAQ/zh/software/fs.md +++ b/docs/FAQ/zh/software/fs.md @@ -2,21 +2,21 @@ ### **ql_fs模块的作用是什么** -- 提供[`path_exists`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_exists%3C/code%3E)方法，判断文件是否存在。 +- 提供[`path_exists`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_exists%3C/code%3E)方法，判断文件是否存在。 -- 提供[`file_copy`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.file_copy%3C/code%3E)方法，快速拷贝文件。 +- 提供[`file_copy`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.file_copy%3C/code%3E)方法，快速拷贝文件。 -- 提供[`path_dirname`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_dirname%3C/code%3E)方法，获取最后一级路径的前缀路径名。 +- 提供[`path_dirname`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_dirname%3C/code%3E)方法，获取最后一级路径的前缀路径名。 -- 提供[`path_getsize`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_getsize%3C/code%3E)方法，获取文件大小。 +- 提供[`path_getsize`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.path_getsize%3C/code%3E)方法，获取文件大小。 -- 提供[`mkdirs`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.mkdirs%3C/code%3E)方法，创建嵌套文件夹。 +- 提供[`mkdirs`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.mkdirs%3C/code%3E)方法，创建嵌套文件夹。 -- 提供[`rmdirs`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.rmdirs%3C/code%3E)方法，删除嵌套文件夹。 +- 提供[`rmdirs`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.rmdirs%3C/code%3E)方法，删除嵌套文件夹。 -- 提供[`touch`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.touch%3C/code%3E)方法，快速创建文件。 +- 提供[`touch`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html#%3Ccode%3Eql_fs.touch%3C/code%3E)方法，快速创建文件。 -- 提供`write_json`和[`read_json`](https://python.quectel.com/doc/API_reference/zh/syslib/ql_fs.html?highlight=read_json#%3Ccode%3Eql_fs.read_json%3C/code%3E)方法，快速读写json文件。 +- 提供`write_json`和[`read_json`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/ql_fs.html?highlight=read_json#%3Ccode%3Eql_fs.read_json%3C/code%3E)方法，快速读写json文件。 ### **为什么用uos.remove()删除不了文件？** diff --git a/docs/FAQ/zh/software/threads.md b/docs/FAQ/zh/software/threads.md index a06d8293b8475a0567be0d3fcb3e1c83909be0f4..e717eceac644a35f6424ef5b12c5e868a2c3e4c4 100644 --- a/docs/FAQ/zh/software/threads.md +++ b/docs/FAQ/zh/software/threads.md @@ -16,7 +16,7 @@ QuecPython 的多线程模块的实现继承于标准 Python 的_thread，没有提供信号量相关接口。 -如果想实现类似信号量的功能，可使用 互斥锁（[`_thread.allocate_lock`](https://python.quectel.com/doc/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.allocate_lock%3C/code%3E)方法）或消息队列（[`queue.Queue`](https://python.quectel.com/doc/API_reference/zh/syslib/Queue.html#%3Ccode%3Equeue.Queue%3C/code%3E)方法）。 +如果想实现类似信号量的功能，可使用 互斥锁（[`_thread.allocate_lock`](https://developer.quectel.com/doc/quecpython/API_reference/zh/stdlib/_thread.html#%3Ccode%3E_thread.allocate_lock%3C/code%3E)方法）或消息队列（[`queue.Queue`](https://developer.quectel.com/doc/quecpython/API_reference/zh/syslib/Queue.html#%3Ccode%3Equeue.Queue%3C/code%3E)方法）。 如果信号量的最大值只有1，可使用互斥锁或消息队列实现信号量的功能；如果信号量的值大于1，可使用消息队列实现信号量的功能。 diff --git a/docs/Getting_started/en/4G/network-dev.md b/docs/Getting_started/en/4G/network-dev.md index 8ca590dd84ed46b2e1eae821a2e3b47882792c4d..148d35da72d8b9a264243af7fbd48de8e8993d39 100644 --- a/docs/Getting_started/en/4G/network-dev.md +++ b/docs/Getting_started/en/4G/network-dev.md @@ -67,7 +67,7 @@ Users can investigate the above situations in sequence to confirm the problem. If the return value is 1, it means that the SIM card has been detected and the network registration status needs to be checked -Reference for SIM card abnormalities in other states [SIM card abnormality handling](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#SIM-Card-Exception) +Reference for SIM card abnormalities in other states [SIM card abnormality handling](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#SIM-Card-Exception) ### **Get device network registration status** @@ -82,7 +82,7 @@ The API return value is `([voice_state, voice_lac, voice_cid, voice_rat, voice_reject_cause, voice_psc], [data_state, data_lac, data_cid, data_rat, data_reject_cause, data_psc])` -Among them, data_state represents the network registration status, which can have various situations. When the return value is 1 or 5, it can be considered as a successful network registration. For specific return values, please refer to [Get Network Registration Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Registration-Information), When the network registration status is not 1 or 5, it can be considered as a network abnormality. There may be multiple reasons for network abnormalities, such as SIM card arrears, SIM card only supporting specific network standards or frequency bands, poor RF performance, and no APN configuration. For detailed handling steps of the above abnormal situations, please refer to [Module Network Registration Failure](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) +Among them, data_state represents the network registration status, which can have various situations. When the return value is 1 or 5, it can be considered as a successful network registration. For specific return values, please refer to [Get Network Registration Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Registration-Information), When the network registration status is not 1 or 5, it can be considered as a network abnormality. There may be multiple reasons for network abnormalities, such as SIM card arrears, SIM card only supporting specific network standards or frequency bands, poor RF performance, and no APN configuration. For detailed handling steps of the above abnormal situations, please refer to [Module Network Registration Failure](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) Under normal circumstances, as long as the module network card can be successfully activated, users do not need to check the network registration status. The main scenarios that require querying the device's network registration status are as follows: @@ -109,7 +109,7 @@ Return a tuple in the following format:`(stage, state)` | parameter | type | meaning | | ----- | ---- | ------------------------------------------------------------ | | stage | integer | Indicate what state is currently being detected: 1 - Detecting SIM card status; 2 - Detecting network registration status; 3 - Detecting PDP Context activation status. | -| state | integer | According to the stage value, different states are represented as follows: When stage=1, state represents the status of the SIM card, range 0-21, detailed description of each state value, please refer to[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)the return value description of the method; When stage = 2, state indicate network registration status, range 0-11, detailed description of each state value, please refer to[`net.getState()`](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)the return value description of the method; When stage = 3, state represents the PDP Context activation status, 0 indicates no successful activation, 1 indicates successful activation. | +| state | integer | According to the stage value, different states are represented as follows: When stage=1, state represents the status of the SIM card, range 0-21, detailed description of each state value, please refer to[`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)the return value description of the method; When stage = 2, state indicate network registration status, range 0-11, detailed description of each state value, please refer to[`net.getState()`](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)the return value description of the method; When stage = 3, state represents the PDP Context activation status, 0 indicates no successful activation, 1 indicates successful activation. | diff --git a/docs/Getting_started/en/Wi-Fi/network-dev.md b/docs/Getting_started/en/Wi-Fi/network-dev.md index 8ca590dd84ed46b2e1eae821a2e3b47882792c4d..148d35da72d8b9a264243af7fbd48de8e8993d39 100644 --- a/docs/Getting_started/en/Wi-Fi/network-dev.md +++ b/docs/Getting_started/en/Wi-Fi/network-dev.md @@ -67,7 +67,7 @@ Users can investigate the above situations in sequence to confirm the problem. If the return value is 1, it means that the SIM card has been detected and the network registration status needs to be checked -Reference for SIM card abnormalities in other states [SIM card abnormality handling](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#SIM-Card-Exception) +Reference for SIM card abnormalities in other states [SIM card abnormality handling](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#SIM-Card-Exception) ### **Get device network registration status** @@ -82,7 +82,7 @@ The API return value is `([voice_state, voice_lac, voice_cid, voice_rat, voice_reject_cause, voice_psc], [data_state, data_lac, data_cid, data_rat, data_reject_cause, data_psc])` -Among them, data_state represents the network registration status, which can have various situations. When the return value is 1 or 5, it can be considered as a successful network registration. For specific return values, please refer to [Get Network Registration Information](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#Get-Network-Registration-Information), When the network registration status is not 1 or 5, it can be considered as a network abnormality. There may be multiple reasons for network abnormalities, such as SIM card arrears, SIM card only supporting specific network standards or frequency bands, poor RF performance, and no APN configuration. For detailed handling steps of the above abnormal situations, please refer to [Module Network Registration Failure](https://python.quectel.com/doc/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) +Among them, data_state represents the network registration status, which can have various situations. When the return value is 1 or 5, it can be considered as a successful network registration. For specific return values, please refer to [Get Network Registration Information](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#Get-Network-Registration-Information), When the network registration status is not 1 or 5, it can be considered as a network abnormality. There may be multiple reasons for network abnormalities, such as SIM card arrears, SIM card only supporting specific network standards or frequency bands, poor RF performance, and no APN configuration. For detailed handling steps of the above abnormal situations, please refer to [Module Network Registration Failure](https://developer.quectel.com/doc/quecpython/Application_guide/en/network-comm/nic/cellular/exception-handling.html#Module-Network-Registration-Failure) Under normal circumstances, as long as the module network card can be successfully activated, users do not need to check the network registration status. The main scenarios that require querying the device's network registration status are as follows: @@ -109,7 +109,7 @@ Return a tuple in the following format:`(stage, state)` | parameter | type | meaning | | ----- | ---- | ------------------------------------------------------------ | | stage | integer | Indicate what state is currently being detected: 1 - Detecting SIM card status; 2 - Detecting network registration status; 3 - Detecting PDP Context activation status. | -| state | integer | According to the stage value, different states are represented as follows: When stage=1, state represents the status of the SIM card, range 0-21, detailed description of each state value, please refer to[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)the return value description of the method; When stage = 2, state indicate network registration status, range 0-11, detailed description of each state value, please refer to[`net.getState()`](https://python.quectel.com/doc/API_reference/en/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)the return value description of the method; When stage = 3, state represents the PDP Context activation status, 0 indicates no successful activation, 1 indicates successful activation. | +| state | integer | According to the stage value, different states are represented as follows: When stage=1, state represents the status of the SIM card, range 0-21, detailed description of each state value, please refer to[`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)the return value description of the method; When stage = 2, state indicate network registration status, range 0-11, detailed description of each state value, please refer to[`net.getState()`](https://developer.quectel.com/doc/quecpython/API_reference/en/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)the return value description of the method; When stage = 3, state represents the PDP Context activation status, 0 indicates no successful activation, 1 indicates successful activation. | diff --git a/docs/Getting_started/en/Wi-Fi/wifi-dev.md b/docs/Getting_started/en/Wi-Fi/wifi-dev.md index 95ade6c80799f5257ceaa91f77c19ecc5bf648cd..c6c957b82f14c6b06714dc19c0ed182746092580 100644 --- a/docs/Getting_started/en/Wi-Fi/wifi-dev.md +++ b/docs/Getting_started/en/Wi-Fi/wifi-dev.md @@ -35,7 +35,7 @@ The necessary list of components includes: Connect the FCM360W development board to the computer using the USB Type-C data cable, and the development board will automatically power on and start running. -[Click here](https://python.quectel.com/doc/Getting_started/en/evb/fcm360w-evb.html) to view the resources and usage documentation for the FCM360W development board. +[Click here](https://developer.quectel.com/doc/quecpython/Getting_started/en/evb/fcm360w-evb.html) to view the resources and usage documentation for the FCM360W development board. ### Setting Up the Software Environment @@ -74,7 +74,7 @@ Visit the [download page](https://python.quectel.com/en/resource-download?cid=26 ![QPYcom_download.png](media/wifi-dev/QPYcom_download.png) -[Click here](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/index.html) to view the tutorial on how to use the QPYcom tool, with a focus on the [Download Function](https://python.quectel.com/doc/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html). +[Click here](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/index.html) to view the tutorial on how to use the QPYcom tool, with a focus on the [Download Function](https://developer.quectel.com/doc/quecpython/Application_guide/en/dev-tools/QPYcom/qpycom-dw.html). #### Download FCM360W Firmware @@ -104,16 +104,16 @@ The following table provides an overview of network connection APIs and their bl | Function Description | Method (Click for Details) | Blocking | |----------------------|----------------------------|----------| -| Create WLAN Interface | [class network.WLAN(mode)](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3Enetwork.WLAN%3C/code%3E) | - | -| Mode Switching and Query | [WLAN.mode([mode])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.mode%3C/code%3E) | - | -| Parameter Configuration and Query | [WLAN.config('param' \| param=value)](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.config%3C/code%3E) | - | -| Activate and Query Interface | [WLAN.active([enable])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.active%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | -| Network Connection | [WLAN.connect([ssid, password, bssid, timeout=15])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.connect%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | -| Disconnect Network Connection | [WLAN.disconnect([interface, mac, ip])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.disconnect%3C/code%3E) | - | -| WLAN Status Query | [WLAN.status('param')](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.status%3C/code%3E) | - | -| Hotspot Scanning | [WLAN.scan([ssid, bssid, channel, passive, max_item, scan_time])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.scan%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | -| Network Address Configuration and Query | [WLAN.ifconfig([interface, config])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.ifconfig%3C/code%3E) | - | -| Network Configuration | [WLAN.netcfg([enable=True, type=nic.NETCFG_SMARTCONFIG, timeout=120])](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.netcfg%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | +| Create WLAN Interface | [class network.WLAN(mode)](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3Enetwork.WLAN%3C/code%3E) | - | +| Mode Switching and Query | [WLAN.mode([mode])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.mode%3C/code%3E) | - | +| Parameter Configuration and Query | [WLAN.config('param' \| param=value)](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.config%3C/code%3E) | - | +| Activate and Query Interface | [WLAN.active([enable])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.active%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | +| Network Connection | [WLAN.connect([ssid, password, bssid, timeout=15])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.connect%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | +| Disconnect Network Connection | [WLAN.disconnect([interface, mac, ip])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.disconnect%3C/code%3E) | - | +| WLAN Status Query | [WLAN.status('param')](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.status%3C/code%3E) | - | +| Hotspot Scanning | [WLAN.scan([ssid, bssid, channel, passive, max_item, scan_time])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.scan%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | +| Network Address Configuration and Query | [WLAN.ifconfig([interface, config])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.ifconfig%3C/code%3E) | - | +| Network Configuration | [WLAN.netcfg([enable=True, type=nic.NETCFG_SMARTCONFIG, timeout=120])](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#%3Ccode%3EWLAN.netcfg%3C/code%3E) | Default blocking mode, can be configured to non-blocking mode through the `WLAN.config` interface | > In the above methods' parameters: > - `[]` indicates optional parameters, as in `WLAN.mode([mode])`. @@ -127,9 +127,9 @@ Regardless of whether it operates in blocking mode or not, all Wi-Fi-related eve ### Error Codes, Event Codes, and Status Codes During Wi-Fi Connection -- Error Codes: Refer to [WLAN - Wireless Local Area Network - Error Codes](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#Error-Codes)。 -- Event Codes: Refer to [WLAN - Wireless Local Area Network - Event Codes](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#Event-Codes)。 -- Status Codes: Refer to [WLAN - Wireless Local Area Network - Status Codes](https://python.quectel.com/doc/API_reference/en/wifilib/WLAN.html#Status-Codes)。 +- Error Codes: Refer to [WLAN - Wireless Local Area Network - Error Codes](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#Error-Codes)。 +- Event Codes: Refer to [WLAN - Wireless Local Area Network - Event Codes](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#Event-Codes)。 +- Status Codes: Refer to [WLAN - Wireless Local Area Network - Status Codes](https://developer.quectel.com/doc/quecpython/API_reference/en/wifilib/WLAN.html#Status-Codes)。 ## Basic Flow of Network Connection diff --git a/docs/Getting_started/zh/4G/driver_prepare.md b/docs/Getting_started/zh/4G/driver_prepare.md index 647a41130093b87cb70aa0d9a4b607a4f78ba682..baa170b0304da57ca98be825d4762a6972ee2d3b 100644 --- a/docs/Getting_started/zh/4G/driver_prepare.md +++ b/docs/Getting_started/zh/4G/driver_prepare.md @@ -33,6 +33,6 @@ **安装驱动后:** -驱动安装常见问题参考: [开发环境与工具相关问题](https://python.quectel.com/doc/FAQ/zh/tools/index.html) +驱动安装常见问题参考: [开发环境与工具相关问题](https://developer.quectel.com/doc/quecpython/FAQ/zh/tools/index.html) diff --git a/docs/Getting_started/zh/4G/network-dev.md b/docs/Getting_started/zh/4G/network-dev.md index eadb9474e58946ce9c8d64b14f64cdbbde8ef548..45a7fb42aa1d52db717df20e9543bfcd54cac170 100644 --- a/docs/Getting_started/zh/4G/network-dev.md +++ b/docs/Getting_started/zh/4G/network-dev.md @@ -67,7 +67,7 @@ sim.getStatus() 如果返回值为1，说明已经检测到SIM卡，则需要检测注网状态 -其他状态的SIM卡异常参考[SIM卡异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#SIM%E5%8D%A1%E5%BC%82%E5%B8%B8) +其他状态的SIM卡异常参考[SIM卡异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#SIM%E5%8D%A1%E5%BC%82%E5%B8%B8) ### **获取设备网络注册状态** @@ -82,7 +82,7 @@ API返回值为 `([voice_state, voice_lac, voice_cid, voice_rat, voice_reject_cause, voice_psc], [data_state, data_lac, data_cid, data_rat, data_reject_cause, data_psc])` -其中data_state为网络注册状态，网络注册状态有多种情况，当返回值为1或者5时可视为网络注册成功，具体返回值参考[获取网络注册信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)，当网络注册状态不为1或5的情况，可视为网络异常，导致网络异常的原因可能有多种，比方说SIM卡欠费、SIM卡只支持特定网络制式或者特定频段等、射频性能不好、没有配置APN等，以上异常的情况的详细处理步骤参考[模块网络注册失败](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) +其中data_state为网络注册状态，网络注册状态有多种情况，当返回值为1或者5时可视为网络注册成功，具体返回值参考[获取网络注册信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)，当网络注册状态不为1或5的情况，可视为网络异常，导致网络异常的原因可能有多种，比方说SIM卡欠费、SIM卡只支持特定网络制式或者特定频段等、射频性能不好、没有配置APN等，以上异常的情况的详细处理步骤参考[模块网络注册失败](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) 正常情况下，只要模组网卡能激活成功，用户是不需要查询注网状态的。需要查询设备注网状态的场景主要如下： @@ -109,7 +109,7 @@ checkNet.waitNetworkReady(timeout) | 参数 | 类型 | 含义 | | ----- | ---- | ------------------------------------------------------------ | | stage | 整型 | 表示当前正在检测什么状态： 1 - 正在检测SIM卡状态； 2 - 正在检测网络注册状态； 3 - 正在检测PDP Context激活状态。 | -| state | 整型 | 根据stage值，来表示不同的状态，具体如下： stage = 1时，state表示 SIM卡的状态，范围0-21，每个状态值的详细说明，请参考[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法的返回值说明； stage = 2时，state表示网络注册状态，范围0-11，每个状态值的详细说明，请参考[`net.getState()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)方法的返回值说明； stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | +| state | 整型 | 根据stage值，来表示不同的状态，具体如下： stage = 1时，state表示 SIM卡的状态，范围0-21，每个状态值的详细说明，请参考[`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法的返回值说明； stage = 2时，state表示网络注册状态，范围0-11，每个状态值的详细说明，请参考[`net.getState()`](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)方法的返回值说明； stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | diff --git a/docs/Getting_started/zh/Wi-Fi/driver_prepare.md b/docs/Getting_started/zh/Wi-Fi/driver_prepare.md index 60cf656ddeb9094dadb091e3acf038ec80b0b857..66db64b7eeb966be1b8ba3b175fe4387c3e2e29d 100644 --- a/docs/Getting_started/zh/Wi-Fi/driver_prepare.md +++ b/docs/Getting_started/zh/Wi-Fi/driver_prepare.md @@ -28,6 +28,6 @@ **安装驱动后:** -驱动安装常见问题参考: [开发环境与工具相关问题](https://python.quectel.com/doc/FAQ/zh/tools/index.html) +驱动安装常见问题参考: [开发环境与工具相关问题](https://developer.quectel.com/doc/quecpython/FAQ/zh/tools/index.html) diff --git a/docs/Getting_started/zh/Wi-Fi/network-dev.md b/docs/Getting_started/zh/Wi-Fi/network-dev.md index eadb9474e58946ce9c8d64b14f64cdbbde8ef548..45a7fb42aa1d52db717df20e9543bfcd54cac170 100644 --- a/docs/Getting_started/zh/Wi-Fi/network-dev.md +++ b/docs/Getting_started/zh/Wi-Fi/network-dev.md @@ -67,7 +67,7 @@ sim.getStatus() 如果返回值为1，说明已经检测到SIM卡，则需要检测注网状态 -其他状态的SIM卡异常参考[SIM卡异常处理](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#SIM%E5%8D%A1%E5%BC%82%E5%B8%B8) +其他状态的SIM卡异常参考[SIM卡异常处理](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#SIM%E5%8D%A1%E5%BC%82%E5%B8%B8) ### **获取设备网络注册状态** @@ -82,7 +82,7 @@ API返回值为 `([voice_state, voice_lac, voice_cid, voice_rat, voice_reject_cause, voice_psc], [data_state, data_lac, data_cid, data_rat, data_reject_cause, data_psc])` -其中data_state为网络注册状态，网络注册状态有多种情况，当返回值为1或者5时可视为网络注册成功，具体返回值参考[获取网络注册信息](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)，当网络注册状态不为1或5的情况，可视为网络异常，导致网络异常的原因可能有多种，比方说SIM卡欠费、SIM卡只支持特定网络制式或者特定频段等、射频性能不好、没有配置APN等，以上异常的情况的详细处理步骤参考[模块网络注册失败](https://python.quectel.com/doc/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) +其中data_state为网络注册状态，网络注册状态有多种情况，当返回值为1或者5时可视为网络注册成功，具体返回值参考[获取网络注册信息](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%E8%8E%B7%E5%8F%96%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E4%BF%A1%E6%81%AF)，当网络注册状态不为1或5的情况，可视为网络异常，导致网络异常的原因可能有多种，比方说SIM卡欠费、SIM卡只支持特定网络制式或者特定频段等、射频性能不好、没有配置APN等，以上异常的情况的详细处理步骤参考[模块网络注册失败](https://developer.quectel.com/doc/quecpython/Application_guide/zh/network-comm/nic/cellular/exception-handling.html#%E6%A8%A1%E7%BB%84%E7%BD%91%E7%BB%9C%E6%B3%A8%E5%86%8C%E5%A4%B1%E8%B4%A5) 正常情况下，只要模组网卡能激活成功，用户是不需要查询注网状态的。需要查询设备注网状态的场景主要如下： @@ -109,7 +109,7 @@ checkNet.waitNetworkReady(timeout) | 参数 | 类型 | 含义 | | ----- | ---- | ------------------------------------------------------------ | | stage | 整型 | 表示当前正在检测什么状态： 1 - 正在检测SIM卡状态； 2 - 正在检测网络注册状态； 3 - 正在检测PDP Context激活状态。 | -| state | 整型 | 根据stage值，来表示不同的状态，具体如下： stage = 1时，state表示 SIM卡的状态，范围0-21，每个状态值的详细说明，请参考[`sim.getStatus()`](https://python.quectel.com/doc/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法的返回值说明； stage = 2时，state表示网络注册状态，范围0-11，每个状态值的详细说明，请参考[`net.getState()`](https://python.quectel.com/doc/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)方法的返回值说明； stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | +| state | 整型 | 根据stage值，来表示不同的状态，具体如下： stage = 1时，state表示 SIM卡的状态，范围0-21，每个状态值的详细说明，请参考[`sim.getStatus()`](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/sim.html#%3Ccode%3Esim.getStatus%3C/code%3E)方法的返回值说明； stage = 2时，state表示网络注册状态，范围0-11，每个状态值的详细说明，请参考[`net.getState()`](https://developer.quectel.com/doc/quecpython/API_reference/zh/iotlib/net.html#%3Ccode%3Enet.getState%3C/code%3E)方法的返回值说明； stage = 3时，state表示PDP Context激活状态，0表示没有激活成功，1表示激活成功。 | diff --git a/docs/Getting_started/zh/Wi-Fi/wifi-dev.md b/docs/Getting_started/zh/Wi-Fi/wifi-dev.md index 078713a7a7145a0f7d6d55692b0fadb2d713b44a..dc24204bdb3dfcf00261c4916fdf84b5f53d9250 100644 --- a/docs/Getting_started/zh/Wi-Fi/wifi-dev.md +++ b/docs/Getting_started/zh/Wi-Fi/wifi-dev.md @@ -35,7 +35,7 @@ FCM360W 模块的特性如下： 使用 USB Type-C 数据线连接 FCM360W 开发板和电脑，开发板上电后即可自动开机运行。 -> [点此查看](https://python.quectel.com/doc/Getting_started/zh/evb/fcm360w-evb.html) FCM360W 开发板资源和使用说明文档。 +> [点此查看](https://developer.quectel.com/doc/quecpython/Getting_started/zh/evb/fcm360w-evb.html) FCM360W 开发板资源和使用说明文档。 ### 搭建软件环境 @@ -74,7 +74,7 @@ QPYcom 是专为 QuecPython 打造的集成开发环境，包含 Python 命令 ![QPYcom_download.png](media/wifi-dev/QPYcom_download.png) -[点此查看](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/index.html) QPYcom 工具的使用教程，重点查阅[固件与脚本的下载](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)部分。 +[点此查看](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/index.html) QPYcom 工具的使用教程，重点查阅[固件与脚本的下载](https://developer.quectel.com/doc/quecpython/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html)部分。 #### 下载 FCM360W 固件 @@ -104,16 +104,16 @@ QPYcom 是专为 QuecPython 打造的集成开发环境，包含 Python 命令 | 功能描述 | 方法（点击查看详情） | 阻塞特性 | |------------------|---|---| -| 创建网卡 | [class network.WLAN(mode)](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3Enetwork.WLAN%3C/code%3E) | - | -| 模式切换与查询 | [WLAN.mode([mode])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.mode%3C/code%3E) | - | -| 参数配置与查询 | [WLAN.config('param' \| param=value)](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.config%3C/code%3E) | - | -| 网卡激活与查询 | [WLAN.active([enable])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.active%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | -| 网络连接 | [WLAN.connect([ssid, password, bssid, timeout=15])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.connect%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | -| 断开网络连接 | [WLAN.disconnect([interface, mac, ip])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.disconnect%3C/code%3E) | - | -| 网卡状态查询 | [WLAN.status('param')](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.status%3C/code%3E) | - | -| 热点扫描 | [WLAN.scan([ssid, bssid, channel, passive, max_item, scan_time])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.scan%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | -| 网络地址配置与查询 | [WLAN.ifconfig([interface, config])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.ifconfig%3C/code%3E) | - | -| 网络配置 | [WLAN.netcfg([enable=True, type=nic.NETCFG_SMARTCONFIG, timeout=120])](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.netcfg%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | +| 创建网卡 | [class network.WLAN(mode)](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3Enetwork.WLAN%3C/code%3E) | - | +| 模式切换与查询 | [WLAN.mode([mode])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.mode%3C/code%3E) | - | +| 参数配置与查询 | [WLAN.config('param' \| param=value)](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.config%3C/code%3E) | - | +| 网卡激活与查询 | [WLAN.active([enable])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.active%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | +| 网络连接 | [WLAN.connect([ssid, password, bssid, timeout=15])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.connect%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | +| 断开网络连接 | [WLAN.disconnect([interface, mac, ip])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.disconnect%3C/code%3E) | - | +| 网卡状态查询 | [WLAN.status('param')](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.status%3C/code%3E) | - | +| 热点扫描 | [WLAN.scan([ssid, bssid, channel, passive, max_item, scan_time])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.scan%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | +| 网络地址配置与查询 | [WLAN.ifconfig([interface, config])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.ifconfig%3C/code%3E) | - | +| 网络配置 | [WLAN.netcfg([enable=True, type=nic.NETCFG_SMARTCONFIG, timeout=120])](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#%3Ccode%3EWLAN.netcfg%3C/code%3E) | 默认阻塞模式，可通过 `WLAN.config` 接口配置为非阻塞模式 | > 上述方法的参数中： > - `[]` 表示参数可选，如 `WLAN.mode([mode])`。 @@ -127,9 +127,9 @@ QPYcom 是专为 QuecPython 打造的集成开发环境，包含 Python 命令 ### Wi-Fi 连接过程中错误码、事件码、状态码 -- 错误码：参考 [WLAN - 无线网络控制 - 错误码](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#错误码)。 -- 事件码：参考 [WLAN - 无线网络控制 - 事件码](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#事件码)。 -- 状态码：参考 [WLAN - 无线网络控制 - 状态码](https://python.quectel.com/doc/API_reference/zh/wifilib/WLAN.html#状态码)。 +- 错误码：参考 [WLAN - 无线网络控制 - 错误码](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#错误码)。 +- 事件码：参考 [WLAN - 无线网络控制 - 事件码](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#事件码)。 +- 状态码：参考 [WLAN - 无线网络控制 - 状态码](https://developer.quectel.com/doc/quecpython/API_reference/zh/wifilib/WLAN.html#状态码)。 ## 网络连接的基础流程 diff --git a/publish.py b/publish.py index 6c7ef1e51791475a23877a238546497cbd421136..ce262d35f0d0e5c79b6a1f7312fb448b5cf9fe47 100644 Binary files a/publish.py and b/publish.py differ diff --git a/smtp_quectel.py b/smtp_quectel.py index b56b45f666ffd8913710052cb431ac8f7b73c90a..9dd8cada93aa34858647e51ddb41c9481519cc32 100644 Binary files a/smtp_quectel.py and b/smtp_quectel.py differ