QuecPython Vs Code Extension

Extension for handling interaction with QuecPython based modules. Communicate with Python based Quectel modules using the built-in REPL or AT CLI. Besides serial communication, extension provides out-of-the box module file system preview in a tree view. Users are free to opt using commands from the extension UI or execute raw commands via REPL.

Works with Windows only at the moment.

✨ Features

🎯 Connect to Quectel Modules: Connect and disconnect to different ports and modules
📁 Open REPL Port: Open 🔍 repl port and run different QuecPython commands
🔘 Flash Firmware: Select Firmware online from our stie and locally and flash it to your module
⌨️ Transfer Files: Transfer one more multiple files to your module
🌐 Quectel Package Manager: Import Quectel projects, add components to your project and view information about different solutions
💡 Add / Remove QuecPython Components: Open your QuecPython Project, and add or remove compoenents from you project
⚙️ Run Script: Run files and scripts directly from your module
📊 File Treeview: View list of files and directories on your module
✅ Auto Complete: Increase your productivity with our auto complete for QuecPython modules

How to use

📖 Using Package Manager with VS Code

Using Package manger with VS Code

From QuecPython menu -> Quick Access -> Quectel -> Projects + Components

List of Projects + Components will show in the panel

Main Panel

From the panel, you can view usig view button for a project of component, which will show readme + submodules for project or component.

View Info

Note: View button will always show the info of project, component or submodule.

From Main Panel, Import button will clone the project to your machine.

click import

choose where to save the project
please wait while the extension clone the project
when done, the extension will open the new project

Clone Done

From Main Panel, Add to project button will clone the submodule to your current open project.

Add to Project

Note 1: Add to project will work only when there's an open project already. If there's no project open, the button will be disabled.

Note 2: Add to project and these submodules can be used and cloned with any of client QuecPython projects or with our projects from our github.

Banner buttons, and search fields are give a better experience while using the extension

Show all / Hide All: Show or Hide all the items from projects + components list.
New Project: Create a new project.
Home: Redirect to main page (Not active when user is alraedy at main page).
Back: go back to previouse page (active only when previouse page is avilable).
Search Projects / Components: search the list of Projects or Components.
Show More:show the list of Projects or Components.

💡 Current Proejct Page

❗❗ Please Import + Open QuecPython proejct to use this tab.

From QuecPython menu -> Quick Access -> Quectel -> Current Project

Project Readme + list of submodules will show

currnt-project-main-panel

From the panel, you can view usig view button for a project of component, which will show readme + submodules for project or component.

Ciew Button

To add more components to your quecpython project, please open Components -> choose component you want -> click on add-to-project button.

Note: If the project is not quecpython, you'll have an error message.

Ciew Button

Extension Requirements

NodeJS installed on your system (12 or higher) - NodeJS

Supported Modules

Support all QuecPython modules.

Usage

Check User Guide on our site.

Open the serial connection by opening the commands palette the CTRL+SHIFT+P and running the command QuecPython: Connect to COM Port. or click statusbar button Connect.

Upon successful connection, the terminal will open with either REPL or AT CLI depending on the chosen port. The board can be disconnected from the VSC by killing the active serial connection terminal. When manually closing the terminal (x on the right top of the terminal) the connection stays active.

Extension Settings

This extension contributes the following settings for configuring it's usage:

QuecPython.defaultLineTerminator: Text added to end of all sent lines. Will be appended to sent data but will not be rendered in terminal. Allows escape characters (\r, \n etc.), hex representation (\x6F, \xF8 etc.) and unicode representation (\u006F, \u00F8 etc.)
QuecPython.translateHex: Set to true to translate incomming hex data. Set to false to output raw hex.

Commands list

openConnection - Opens a connection with a serial port of choice
closeConnection - Closes currently open connection
qpy-ide.clearTerminal - Clears active terminal

Flashing Firmware

It is possible to flash firmware using built-in activity bar QuecPython. Steps for flashing are:

Select firmware from the PC file system or select firmware from the online.
Click Flash button

Known Issues

There are cases when file system does not appear on boot-up, if that happens, please manually refresh the file system tree view.

Release Notes

Please Check CHANGELOG.md for release info