UnitV Maixpy Quick Start
Driver Installation
Connect the device to the PC, open the device manager to install
FTDI driver
for the device. Take the win10 environment as an example, download the driver file that matches the operating system, unzip it, and install it through the device manager. (Note: In some system environments, the driver needs to be installed twice for the driver to take effect. The unrecognized device name is usually M5Stack or USB Serial. Windows recommends using the driver file to install directly in the device manager (custom Update), the executable file installation method may not work properly).
Click here to download FTDI driver
For MacOS users, please tick System Preferences -> Security and Privacy -> General -> Allow downloadable apps from the following locations -> App Store and Approved Developer Options .
EasyLoader
1.EasyLoader is a simple and fast program burner, and each product page has a product-related case program for EasyLoader.For users who don't need to customize the firmware or perform other operations, using EasyLoader to burn firmware for M5StickV is the simplest solution.(Currently EasyLoader is only available for Windows OS)
2.After downloading the software, double-click to run the application, connect the M5 device to the computer via the data cable, select the port parameters, and click "Burn" to start burning.
Firmware
Users who use an operating system other than Windows or who need to specify a burning file can use Kflash for firmware burning. Click the link below to download the firmware.
- Flash tool Kflash_GUI.
| Software | Link |
|---|---|
| Kflash_GUI_Windows | Download |
| Kflash_GUI_MacOS | Download |
| Kflash_GUI_Linux | Download |
- Connect the device to the computer through the Tpye-C data cable, double-click to open the burning toolKflash_GUI application, select the corresponding device port, development board type (M5StickV), firmware program, baud rate. Click to download , start burning.
Kflash
- For users who are used to command line operation, can also choose Kflash as the firmware burning tool.
Serial-Tool
- You will need a serial debugging tool for programming M5StickV, you can use Putty in here ,for download and information.
- Run Putty, connect M5StickV to your PC, in Putty, set com number, baudrate, click "open", by now the connect process should started.(you can check the com number in device manager on your PC)
When connected, it will automatically enter Maixpy UI. Now the device is runing the default code, you can terminate it by "Ctrl+C".
Edit and Run the Code
Editting
The language shell programm(REPL) is good for instant code validatation, it can be used at short code programming and validation. In real project where we will have massive amount of code, in that case we will need a Code Editor for better orgnization of the code files.
Inside MaixPy,integrates a open source Editor Micropython Editor(pye) ,which is convenient for us to manage the code.
function os.listdir() is for checking the files in current directory.
With function pye("hello.py"), you can create new files and enter editing mode(if file exist, only enter editting mode)
click for more
If editing finished, you can do Ctrl+S > Enter to save the script. Ctrl+Q to exit edit mode.
Notice: This editor have some requiremnt on the Serial tool, KEY BackSpace have to set as DEL function,or BackSpace will implement the same function as Ctrl+H(charater replacement)
File Execution
Function os.chdir() is used for switch current directory to a certain directory, for example os.chdir("/flash")
Solution 1: import
Run import hello
You can see the output: hello maixpy
In this way, it is simple and handy, but thers something worth your attention, import can only be utilized once, the second time import won't work. If you need to use import mutiple times, please refers to solution 2 below
Solution 2: exec()
Use exec() function:
with open("hello.py") as f:
exec(f.read())
AutoRun after Power On
System will create a boot.py file at directory /flash or /sd , it will run this script after power on, modify this file will realize the AutoRun.
MaixPy IDE
Download MaixPy IDE
MaixPy IDE can easily realize real-time editing, uploading, execution, and real-time monitoring of camera images, file transfer and other functions. Using MaixPy IDE, because data compression and transmission require a part of resources, performance will be reduced, but This is a great development tool for developers who are not demanding in performance or who are in the debugging phase.
Install MaixPy IDE
Windows platform can directly double-click the exe file to run the installer.
Linux command line to run permissions, then execute commands
chmod +x maixpy-ide-linux-x86_64-0.2.2.run
./maixpy-ide-linux-x86_64-0.2.2.run
Use MaixPy IDE
Run the MaixPy IDE, click on the toolbar, select the model of the development board. Tool-> Select Board-> M5StickV (Tools -> Select Development Board)
Click the Connect button in the lower left corner and select the correct connection port, click OK.
When the connection button changes from green to red, it has been connected successfully. You can edit the code in the edit box above. Click the Run button in the lower left corner to execute the code and verify it.
WS2812
The firmware has a built-in WS2812 RGB LED driver library. The following is a reference routine. Note: Since the expansion port of UnitV does not have a driving load function, this program is only suitable for driving the built-in RGB LED:
from modules import ws2812
from fpioa_manager import *
fm.register(8)
class_ws2812 = ws2812(8,100)
r=0
dir = True
while True:
if dir:
r += 5
else:
r -= 5
if r>=255:
r = 255
dir = False
elif r<0:
r = 0
dir = True
for i in range(100):
a = class_ws2812.set_led(i,(0,0,r))
a=class_ws2812.display()
Library
In the library documentation, you can find more APIs to help you build a variety of applications。