TiLDA MK4/tilda-tools: Difference between revisions
Jump to navigation
Jump to search
m (→tilda-tools) |
m (→tilda-tools) |
||
| Line 22: | Line 22: | ||
NOTE: Alternatively, you can create a tilda_tools.bat windows batch file to do the same, containing the following: | NOTE: Alternatively, you can create a tilda_tools.bat windows batch file to do the same, containing the following: | ||
<pre> | <pre> | ||
@ | @echo off | ||
CD ./.development | CD ./.development | ||
IF %1.==. GOTO No1 | IF %1.==. GOTO No1 | ||
python tilda_tools.py %* | |||
GOTO End1 | |||
python tilda_tools.py % | |||
:No1 | :No1 | ||
python tilda_tools.py --help | python tilda_tools.py --help | ||
:End1 | :End1 | ||
CD .. | |||
</pre> | </pre> | ||
This batch file copes with | This batch file copes with not putting in a parameter by defaulting to --help if you don't put in an argument. Previously, not putting a parameter in would result in a python path error message | ||
<pre> | <pre> | ||
Parameters | Parameters | ||
Revision as of 15:03, 1 September 2018
tilda_tools is a toolchain for working with the micropython environment on the badge.
Dependencies
- Python 3
- pyserial
Installation
- Clone the Mk4-Apps repo from https://github.com/emfcamp/Mk4-Apps/ (see Cloning a repository for help). Alternatively you can download a ZIP file from the repository page.
- Open a terminal in the Mk4-Apps/ directory. tilda_tools is in the root of this directory.
- Windows Users - you will need to install Pyserial to get some commands working - Instructions here and download here
tilda-tools
tilda_tools <options>
Windows users, cd into the .development folder then run:
> python tilda_tools.py <options>
NOTE: Alternatively, you can create a tilda_tools.bat windows batch file to do the same, containing the following:
@echo off CD ./.development IF %1.==. GOTO No1 python tilda_tools.py %* GOTO End1 :No1 python tilda_tools.py --help :End1 CD ..
This batch file copes with not putting in a parameter by defaulting to --help if you don't put in an argument. Previously, not putting a parameter in would result in a python path error message
Parameters ----------------- -d --device : serial interface (default: auto) -s --storage : path to flash storage Usage ------------------------------------ Reboot badge $ tilda_tools reset Soft reboot badge and start specific app $ tilda_tools reset --boot my_app Update files on the badge to match the current local version, restarts afterwards $ tilda_tools sync Update files in folder(s) to match current local version $ tilda_tools sync my_game shared $ tilda_tools sync <pattern1> <pattern2> ... Sync (as above), but execute my_app after reboot $ tilda_tools sync --boot my_app [<other sync parameter>] Sync (as above), but execute a single file afterwards without copying it to the badge $ tilda_tools sync --run some_other_file.py Sync a given app and execute it $ tilda_tools app home_default Executes a single file on the badge without copying anything (Using pyboard.py) $ tilda_tools run my_app/main.py Runs local validation (doesn't require a badge, but doesn't run unit tests) $ tilda_tools validate Runs local validation and badge-side tests $ tilda_tools test Update firmware on badge (warning, this will delete all settings etc. stored on the badge!) $ tilda_tools firmware-update Setup wifi.json to be copied to the badge on every sync $ tilda_tools wifi