Published June 29, 2019 © CC BY

Execute Logo on M5Stack ESP32 Basic with MicroPython

Use your M5Stack ESP32 Basic to receive little Logo programs via MQTT and show the results.

IntermediateFull instructions provided1 hour4,836

Things used in this project

Hardware components

M5Stack ESP32 Basic Core IoT Development Kit

Software apps and online services

MicroPython Firmware for ESP32 v1.19.1

Download esp32-20220618-v1.19.1.bin from the download page.

MQTT Client

Use the MQTT client to send messages to your device from a web browser.

Story

For Windows:

1. Install Python, Esptool and Ampy

If you have no Python 3 installation on your computer please download the installer from https://www.python.org/downloads/ and execute it. Then install Esptool and Ampy with

> pip3 install esptool

> pip3 install adafruit-ampy

on the command line.

2. Download and Install Firmware

Download https://micropython.org/resources/firmware/esp32-20220618-v1.19.1.bin. Connect your M5Stack ESP32 Basic to your computer via USB. Open the Windows Device Manager and look into "COM & LPT" to find the correct COM port, e.g. COM6. Then install the firmware with

> esptool.py --chip esp32 --port COM6 erase_flash

> esptool.py --chip esp32 --port COM6 --baud 460800 write_flash -z 0x1000 esp32-20220618-v1.19.1.bin

Reset your device after the installation is finished.

3. Download and Install Libraries

Create a folder named lib on your computer. Download the files cooperative_multitasking.mpy, graphic_terminal.mpy, ili9341.mpy, logo.mpy, mqtt.mpy, mqtt_client.mpy and turtle.mpy from https://bitbucket.org/amotzek/micro-python/downloads/ into that lib folder. In the command line navigate to the folder above lib and then execute

> ampy.exe --port COM6 --delay 3 put lib

to upload the folder to your device.

4. Edit and Upload main.py

From the Code section of this project copy the file main.py to your computer and fill in your WLAN credentials in line 68, a user name in line 66 and a MQTT topic name in line 69. Execute

> ampy.exe --port COM6 --delay 3 put main.py

to upload the file to your device.

5. Test

In your browser go to http://www.hivemq.com/demos/websocket-client/. Click the Connect button. Enter the topic name from line 69 into the Topic field. Enter

{ ":message": "Hello!" }

into the Message field. Click the Publish button. Your M5Stack ESP32 Basic should display Hello! now.

Enter

{ ":logo": "pendown; right 18; forward 50; repeat 5 [right 144; forward 50; left 72; forward 50]" }

into the Message field. Click the Publish button. Your M5Stack ESP32 Basic should display a star now.

Supported Logo Commands

The following arithmetic expressions are supported:

Integer numbers, e.g. 0, 23, -17
Parameters are names that start with a ":", e.g. :size, :length
Arithmetic expressions combined with the operators +, -, * or /, e.g. 2 + 3, :size - 1
Arithmetic expressions in round brackets, e.g. (2 + 3)

The Logo parser is simple and does not account for operator precedence. So please use round brackets where needed.

The following boolean expressions are supported:

arithmetic_expression < arithmetic_expression, also with <=, >, >=, = or !=
boolean_expression or boolean_expression

There is no support for and. If you need that, please use nested ifs.

These are the supported Logo commands:

penup
pendown
setpencolor arithmetic_expression arithmetic_expression arithmetic_expression
right arithmetic_expression
left arithmetic_expression
setheading arithmetic_expression
forward arithmetic_expression
back arithmetic_expression
setxy arithmetic_expression arithmetic_expression

You can define procedures with

to name :parameter [commands] where name is the name of the procedure followed by zero or more parameters followed by multiple commands in square brackets. The commands must be separated by semicolons.

You can call procedures the same way as you call the Logo commands.

There are three control structures implemented:

repeat arithmetic_expression [ commands ]
if boolean_expression [ commands ]
ifelse boolean_expression [ commands ] [ commands ]

Logo Examples

pendown; right 18; forward 50; repeat 5 [right 144; forward 50; left 72; forward 50]
to square :side repeat 4 [ forward :side; right 90] pendown; square 50
to cross :length :depth [ if :depth > 0 [ repeat 4 [ forward :length; right 90; cross (:length * 4) / 10 :depth - 1 ]]] pendown; cross 100 3

main.py

from cooperative_multitasking import Tasks
from network import WLAN, AP_IF
from machine import Pin, SPI
from ili9341 import ILI9341
from graphic_terminal import GraphicTerminal
from mqtt_client import MQTTClient

tasks = Tasks()
ap = WLAN(AP_IF)
ap.active(False)
ap = None
spi = SPI(sck = Pin(18), mosi = Pin(23), miso = Pin(19))
tft = ILI9341(spi)
tft.set_background(tft.to_color(0, 0, 0))
left_button = Pin(39, Pin.IN, Pin.PULL_UP)
terminal = GraphicTerminal(tasks, tft)
terminal.start()
visibility = 0

def is_hidden():
    return visibility == 0

def is_button_touched():
    return left_button.value() == 0

def is_button_released():
    return left_button.value() == 1

def on_button_touched():
    if is_hidden():
        show()
    tasks.when_for_then(is_button_released, 300, on_button_released)
    
def on_button_released():
    tasks.when_then(is_button_touched, on_button_touched)

def hide():
    global visibility
    visibility -= 1
    if visibility == 0:
        tft.off()
        
def show():
    global visibility
    visibility += 1
    if visibility == 1:
        tft.on()
    tasks.after(300000, hide)
    
def on_receive(topic_name, payload):
    try:
        terminal.print(payload[':message'])
        show()
        return
    except:
        pass
    try:
        terminal.execute_logo(payload[':logo'])
        show()
    except:
        pass

client = MQTTClient(tasks,
                    hostname = 'broker.mqttdashboard.com',
                    client_id = '',
                    user_name = 'my-username',
                    password = '') 
client.activate_wlan([('...', '...')])
client.subscribe('my-topic', on_receive)
client.start() 
terminal.execute_logo('pendown; repeat 4 [forward 8; right 90]')
on_button_touched()

while tasks.available():
    tasks.run()

Credits

Andreas Motzek

16 projects • 9 followers

I like algorithms, code, statistics and decisions based on them, solving difficult problems and, if possible, avoiding them elegantly.

Embed the widget on your own site

Execute Logo on M5Stack ESP32 Basic with MicroPython

Execute Logo on M5Stack ESP32 Basic with MicroPython

Things used in this project

Hardware components

Software apps and online services

Story

1. Install Python, Esptool and Ampy

2. Download and Install Firmware

3. Download and Install Libraries

4. Edit and Upload main.py

5. Test

Supported Logo Commands

Logo Examples

Code

main.py

Credits

Andreas Motzek

Comments

Related channels and tags