ESP32 MPY-Jama

🔅 What's new in version 1.2

:small_orange_diamond: Welcome to ESP32 MPY-Jama, a powerful and versatile cross-platform tool, designed to simplify your development with Espressif's ESP32 microcontrollers and MicroPython.

:small_orange_diamond: The lightweight IDE, file manager, terminal, and real-time dashboards provide all the essential features you need to develop your IoT projects quickly and efficiently on MacOS, Windows, and Linux.

:small_orange_diamond: With startup settings and customizable features, this tool can adapt to your workflow and preferences, making your coding experience seamless and enjoyable.

MacOS on arm64   ▪️   MacOS on Intel x86/64   ▪️   Windows 64-bits

To make it work under Linux :penguin: click here!

:bookmark_tabs:  Table of contents

• Features
• Real-time system dashboard
• Real-time networks dashboard
• Wi-Fi in 2 clicks
• Lightweight integrated IDE
• Embedded Jama Funcs
  • Already included
• SD card support
• Firmware upgrade
• Build & Run
• Linux version instructions
• Author
• Special thanks to
• License

:rocket:  Features

• User-friendly graphical interface for easy use
• Connect to multiple ESP32 board types
• Lightweight IDE for easy programming
• Terminal access for streamlined command execution
• Pinout diagrams for popular board types
• Easy installation of in-line modules with PyPI or MIP
• Flash file system browser for easy file access
• Native file tranfers and management
• Real-time visualization of GPIO states
• Access to important system information
• Configuration of Wi-Fi and Ethernet network interfaces
• SD card support for external storage
• Simplified flash firmware updates
• Advanced external component testing features
• Control and manipulate peripherals such as LEDs strips, MP3 players, etc
• Quick testing of IOs in digital or analog mode
• Customizable features for an extensible development
• Persistent configurations on boards if required
• Real-time memory and temperature monitoring

:gear:  Real-time system dashboard

Access all important system information, adjust the MCU frequency, monitor the current status of the set GPIOs, check startup configuration options and display the various partitions of the flash memory.
The startup options allow you to save your configurations on the board, so that you can always maintain them after each reboot.

:globe_with_meridians:  Real-time networks dashboard

Configure and display information about Wi-Fi connection and access point interfaces, set up a board with an integrated Ethernet PHY interface and verify that the Internet connection is available.
It is also possible to act on the state of the network interfaces, including the one for BLE.

:satellite:  Wi-Fi in 2 clicks

Quickly connect your device to available Wi-Fi networks and set up an access point with ease.
The authentication options and the maximum number of clients are adjustable.

:desktop_computer:  Lightweight integrated IDE

Develop your MicroPython programs and libraries and test them directly using the lightweight IDE.
Also, a terminal is usable in the same window with the management of the history of your commands like a shell.
Manage and transfer content from the device's flash memory or SD card.

In the code editor, common keyboard shortcuts such as save, undo, search or move line blocks are available.
Tips: leave the mouse on a file to display its full name and size, or double-click on the tab bar to create one more quickly.

Use Espressif's pinout diagrams for the GPIOs, which are available on most boards:

:control_knobs:  Embedded Jama Funcs

Jama Funcs are small dedicated functions that run on your device to perform a specific task.
They can be used to quickly test the functionality of the ESP32 or external modules and are designed to be easily configured.

Choose a Jama Func from those proposed, then configure its parameters directly in the graphical interface before executing it on your device:

When executing a Jama Func, a window with a terminal opens up, allowing you to view its output:

It is of course possible to develop your own Jama Funcs in order to import them into the interface and thus facilitate their use by implementing integrated parameters.
You can find a full template in MicroPython directly in the software or by clicking on this link.

The following table lists all the Jama Funcs already included in ESP32 MPY-Jama:

You are welcome to share your own Jama Funcs! 😉

:file_folder:  SD card support

If an SD card is available on the board, activate it and mount the corresponding file system.
A reformatting of all content is also possible.

:zap:  Firmware upgrade

Take advantage of the Espressif esptool to connect the device in bootloader mode and easily load new binary images.
Additionally, the tool allows you to completely erase the device for a full reset.

:hammer_and_wrench:  Build & Run

• Required dependencies

  pyWebView (Check out on GitHub):

  python -m pip install pywebview

  pySerial (Check out on GitHub):

  python -m pip install pyserial

• Run application

  Just use python:

  python src/app.py

:penguin:  Linux version instructions

This describes how to clone the repository and how to run from source. In the third step you will find instructions how to create a binary from source. All st eps have been tested on Ubuntu 22.04, but should work with little changes on similar distributions as well.

• Installation

  First, First, make sure you have all the required files:

  # clone the repository:
  git clone https://github.com/jczic/ESP32-MPY-Jama
  
  # install python modules requirements:
  sudo apt install libcairo2-dev libgirepository1.0-dev python3-pyqt5 python3-pyqt5.qtwebengine python3-pyqt5.qtwebchannel libqt5webkit5-dev gir1.2-webkit2-4.0
  
  # initialize python venv:
  cd ESP32-MPY-Jama
  python3 -m venv venv
  
  . venv/bin/activate
  
  pip3 install wheel setuptools
  pip3 install pyserial pywebview[qt] pycairo PyGObject pyinstaller

• Running from source

  When you executed all steps listed under "Installation" you may run directly from sources by executing these steps:

  cd ESP32-MPY-Jama
  . venv/bin/activate
  python3 src/app.py

  In case of an issue with the initialization of the graphical user interface, it is possible to force the desired interface by using the argument --gui (or -g) followed by qt or gtk.

  # example:
  python3 src/app.py -g gtk

• Building executable

  Execute the steps listed under "Installation" and then continue like this:

  cd ESP32-MPY-Jama
  ./create_binary.sh

  When the script finishes you should end up with a "esp32-mpy-jama" executable in the "dist" subfolder.

:wink:  Author

Jean-Christophe Bos (:fr:)

• GitHub: @jczic
• Email: jczic.bos@gmail.com
• Profil: LinkedIn
• Music: SoundCloud Spotify YouTube

:+1:  Special thanks to

• rdagger > www.rototron.info
• happenpappen > www.stop.pe

:eight_pointed_black_star:  License

• Copyright :copyright: 2023 Jean-Christophe Bos.
• This project is MIT licensed.