microPy-IDE

STATUS: Beta release version 0.1.3 05/06/2022.

The microPy-IDE is a development environment for the microPython language which is a subset of Python 3 and is optimised to run on microcontrollers and in constrained environments.

Using the familiar Python programming language you can interact with development hardware and control it, much the same as controlling hardware with the Arduino IDE using C/C++. The Abbykus QDEV family of boards makes it easy to get started using MicroPython and thanks to recent contributions to MicroPython, you can turn any QDEV board into a MicroPython device.

The microPy-IDE runs on a host PC and connects to a target device (QDEV board) via a serial port (USB-serial) or over WiFi. The target device must be running the correct version of the microPython interpreter for the target's specific microcontroller. See microPython downloads.

The microPy-IDE allows the user to create, test, and deploy microPython scripts. microPy-IDE features include:

• Written in Python 3 using PYQT5 GUI library.
• Runs under Linux, MacOS, and Windows.
• Full featured tabbed text editor with microPython syntax highlighting and intuitive keyword look-ahead.
• Interactive shell to communicate with the Target REPL.
• File viewers for both current project and the file directory on the target.
• Python help using the open source Zeal offline developer reference tool.
• Find & replace, bookmarks, Auto-indent, comment/uncomment, etc.
• Templates add common code constructs (user can easily add/modify).
• microPython control:
  • Reset target.
  • Run a python script from host.
  • Stop a running script.
  • Download files to target file directory.
  • Upload files from target directory.
  • Remove files from target directory.
  • Create new directory on target.
  • Delete target directory.
• microPython deployment:
  • Erase and program the target devices flash memory with microPython firmware.

Install Dependencies

Python 3.x

As a prerequisite the host PC must have at least Python 3.6 and PIP3 installed. Your OS likely has Python 3.x installed. If not please google for installation on your OS. If the version of Python is lower than 3.6 please upgrade to the latest release.

Install PIP3

PIP3 is a package manager for Python applications. Use the following instrctuins if your system does not have PIP3 installed.

• Linux / MacOS

  • Launch a terminal (CTRL-ALT-T) and type sudo apt install python3-pip

• Windows

  • See here for details on Windows installation.

Install PYQT5 GUI Widgets Toolkit

Open a terminal and type pip install pyqt5 pyqt5-tools.

Install Espressif esptool (optional)

Install esptool to allow the IDE to erase and program ESP8266 or ESP32 target boards with microPython.

• Launch a terminal window and type pip install esptool.

Install Zeal Offline Language Reference (optional)

Zeal is an offline developer help system. This can be a very useful application for looking up Python / MicroPython language constructs.

• Linux / MacOS

  • Launch terminal window and type sudo apt-get install zeal.

• Windows

  • See here for Windows 10 installation directions.

After installing zeal, launch it and goto tools->docsets and add Python language support.

microPy-IDE Install & Run

Install microPy-IDE by cloning this project to your local machine. Click on the Code button and download the Zip file. Unpack the Zip file in a folder of your choice. Open a terminal and navigate to the microPy-IDE-master folder. Type python microPy.py.

MicroPython Firmware for ESP32 Boards

All versions of the Abbykus QDEV boards are capable of running the MicroPython language. Please see MicroPython-python for Microcontrollers for more information.

The microPython interpreter can be installed on the specific ESP32 MCU variant using the microPy-IDE software. The microPython folder contains stable releases for supported MCU's. See also MicroPython Downloads for the latest firmware releases.

Firmware installation instructions

Install Firmware from microPy-IDE

1. In the microPy-IDE Settings menu choose the supported MCU (ESP8266, etc.).
2. Click the Erase Target Memory button on the microPython toolbar on the bottom of the application. Wait for it to finish.
3. Click the Flash Target Firmware button and select the correct firmware .bin file for your MCU. Wait for it to finish.

Install Firmware Manually

To manually install MicroPython firmware on the QDEV board see Getting Started with the ESP8266 or Getting Started with the ESP32.

Once you have installed MicroPython on the QDEV board you can connect to the board with the microPy-IDE. First set the serial port name, on Linux typically /dev/ttyUSB0. Also set the baudrate to 115200. Reset the target board and you should expect to see a '>>>' prompt in the interactive shell terminal indicating the interactive mode. You can enter MicroPython commands or scripts manually.

TODO

• Add MacOS & Windows support (COM ports, etc.)
• Create microPython developer docset for Zeal.
• Add support for REPL over WiFi (WebREPL, Telnet, or other?).
• Create WiKi use instructions.