m5-docs

MPY Official

Machine ESP32

MPY Docs

UIFlow 1.0 API

Display

M5Stack LVGL

Hardwares

Here's the entire content translated into English:

M5Slider

Create slider

from m5stack_ui import *

screen = M5Screen()

# M5Slider(x=0, y=0, w=None, h=None, min=None, max=None, bg_c=None, color=None, parent=None)

## M5Slider

<img src="https://static-cdn.m5stack.com/resource/docs/static/image/m5stack_lvgl/M5Slider.webp" width="100%">

> Create a slider

```python

from m5stack_ui import *

screen = M5Screen()

# M5Slider(x=0, y=0, w=None, h=None, min=None, max=None, bg_c=None, color=None, parent=None):
Slider = M5Slider(50, 50, 100, 30, 0, 100, 0x888888, 0x000fff)

Slider.set_bg_color(0x888888)

Slider.set_color(0x000fff)

Slider.set_range(0, 100)

Slider.set_value(10)

Slider.get_value()

def onChange(value):
    print(value)

# Register slider change callback function
Slider.changed(onChange)

M5List

Create a list


from m5stack_ui import *

screen = M5Screen()

# M5List(x=0, y=0)
List = M5List(50, 50)

List.add_label("Hello")

List.add_label("M5Stack")

handle = List.add_label("Hi")

List.get_sel_label_index()

List.get_sel_label_text()

List.get_label_index(handle)

List.get_label_text(handle)

M5Line

Draw a line


from m5stack_ui import *

screen = M5Screen()

# M5Line(x1=0, y1=0, x2=0, y2=0, color=None, width=None)
Line = M5Line(20, 50, 140, 50, 0xfff, 10)

Line.set_points(x1, y1, x2, y2)

Line.set_line_width(width)

Line.set_line_rounded(state)

Line.set_color(color)

# opa 0-100
Line.set_opacity(100)

M5Label

Draw a text label


from m5stack_ui import *

screen = M5Screen()

/* M5Label(text, x=0, y=0, color=None, font=None) */
| ---------------------------------------------------------------------
| font:
| FONT_MONT_12/14/16/18/20/22/24/26/28/30/32/34/36/38/40/42/44/46/48
| FONT_UNICODE_24 = lv.font_PHT_unicode_24
/*---------------------------------------------------------------------*/

Label = M5Label("Hello!", 20, 50, 0xff, FONT_MONT_48)

Label.set_text(text)

Label.set_text_color(color)

Label.set_text_font(font)

Label.get_width()

M5Img

Insert an image (supports png only).


from m5stack_ui import *

screen = M5Screen()

# M5Img(filename, x=0, y=0, w=None, h=None)
Img = M5Img("res/default.png", x=0, y=0, parent=None)

Img.set_img_src(filename)

M5Dropdown

Create a dropdown menu


from m5stack_ui import *

screen = M5Screen()

# M5Dropdown(x=0, y=0, w=None, h=None)
Dropdown = M5Dropdown(30, 30, 240, 40)

Dropdown.set_options(['option0', 'option1'])

Dropdown.add_option('option2', 2)
Dropdown.add_option('option3', 3)
Dropdown.add_option('option4', 4)

Dropdown.set_sel_index(1)

Dropdown.get

_sel_index()

M5Cpicker

Create a color picker


coming soon...

M5Checkbox

Create a checkbox


from m5stack_ui import *

screen = M5Screen()

# M5Checkbox(text, x=0, y=0, w=None, h=None, text_c=None, check_c=None, font=None):
Checkbox = M5Checkbox("check", 50, 50, 50, 50, 0xff, 0xff, FONT_MONT_12)
Checkbox.set_text(text)

# state: True | False
Checkbox.set_checked(state)

Checkbox.set_text_color(color)

Checkbox.set_checked_color(color)
Checkbox.set_text_font(font)
Checkbox.get_width()

def Checkbox_checked():
  pass

def Checkbox_unchecked():
  pass

Checkbox.checked(Checkbox_checked)

Checkbox.unchecked(Checkbox_unchecked)

M5Btn

Create a button


from m5stack_ui import *

screen = M5Screen()

# M5Btn(text='', x=0, y=0, w=70, h=30, bg_c=None, text_c=None, font=None)
Btn = M5Btn("button", 50, 50, 80, 50, 0xff, 0xffffff, FONT_MONT_12)

Btn.set_bg_color(color)

Btn.set_btn_text(text)

Btn.set_btn_text_color(color)

Btn.set_btn_text_font(font)

def pressed_cb():
    pass

def released_cb():
    pass

Btn.pressed(pressed_cb)

Btn.released(released_cb)

M5Arc

Create an arc (parameters: start, end are clockwise angles).


from m5stack_ui import *

screen = M5Screen()

# M5Arc(x=0, y=0, w=None, h=None)
Arc = M5Arc(0, 0, 150, 150)

Arc.set_angles(0, 90)

M5Bar

Create a progress bar.


from m5stack_ui import *

screen = M5Screen()

# M5Bar(x=0, y=0, w=None, h=None, min=None, max=None, bg_c=None, color=None)
Bar = M5Bar(50, 50, 150, 30, 0, 100, 0xdddddd, 0xff)

# Set progress bar value
Bar.set_value(50)

Bar.set_bg_color(color)

Bar.set_color(color)

Bar.set_range(min, max)

Bar.get_value()

M5Imgbtn

Create an image button.

from m5stack_ui import *

screen = M5Screen()

# M5Imgbtn(filename, x=0, y=0, w=None, h=None)
Imgbtn = M5Imgbtn("res/default.png", 0, 0, 50, 50)

Imgbtn.set_pressed_img(filename, w, h)

Imgbtn.set_released_img(filename, w, h)