TiLDA MK4/tilda-tools: Difference between revisions

From EMF Badge
Jump to navigation Jump to search
(Remove python3.7 note.)
(Correct tilda-tools to tilda_tools.)
Line 1: Line 1:
''tilda-tools'' is a toolchain for working with the micropython environment on the badge.
''tilda_tools'' is a toolchain for working with the micropython environment on the badge.


== Dependencies ==
== Dependencies ==
Line 10: Line 10:
* Clone the Mk4-Apps repo from https://github.com/emfcamp/Mk4-Apps/ (see [https://help.github.com/articles/cloning-a-repository/ Cloning a repository] for help). Alternatively you can download a ZIP file from the repository page.  
* Clone the Mk4-Apps repo from https://github.com/emfcamp/Mk4-Apps/ (see [https://help.github.com/articles/cloning-a-repository/ 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.
* Open a terminal in the Mk4-Apps/ directory. ''tilda_tools'' is in the root of this directory.


== tilda-tools ==
== tilda-tools ==


<pre>tilda-tools <options></pre>
<pre>tilda_tools <options></pre>


<pre>
<pre>

Revision as of 17:12, 30 August 2018

tilda_tools is a toolchain for working with the micropython environment on the badge.

Dependencies

  • Python 3
  • pyserial

Installation

  • Open a terminal in the Mk4-Apps/ directory. tilda_tools is in the root of this directory.

tilda-tools

tilda_tools <options>
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