PeterCxy/wasp-os
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: appguide: Document how to upload pre-compiled files

Browse source 
Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
This commit is contained in:
Daniel Thompson 2021-01-17 14:55:57 +00:00
parent 2805c1f84e
commit 5170b97491
2 changed files with 38 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
TODO.rst
View file

@ -29,6 +29,8 @@ Micropython
* [ ] Use SoftDevice sleep logic * [ ] Use SoftDevice sleep logic
* [ ] Fix BLE hangs * [ ] Fix BLE hangs
* [ ] Allow asynchronous control of the SPI chip select signals (this will
allow for double buffered graphics updates)
Wasp-os Wasp-os
~~~~~~~ ~~~~~~~
@ -76,9 +78,9 @@ Wasp-os
* [X] Introduce an analog watch face * [X] Introduce an analog watch face
* [X] Add a configuration tool to enable disable applications * [X] Add a configuration tool to enable disable applications
* [ ] Documentation * [X] Documentation
* [ ] Describe how to upload pre-compiled modules * [X] Describe how to upload pre-compiled modules
0.3 (a.k.a. M3): Smartwatch 0.3 (a.k.a. M3): Smartwatch
--------------------------- ---------------------------

36
docs/appguide.rst
View file

@ -298,8 +298,10 @@ takes around five seconds). Once the watch is in OTA mode then
press the phyiscal button again to return to normal mode with the press the phyiscal button again to return to normal mode with the
application cleared out. application cleared out.
Making it permanent .. _Uploading in source code form:
~~~~~~~~~~~~~~~~~~~
Uploading in source code form
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To ensure you application survives a reboot then we must copy it to the To ensure you application survives a reboot then we must copy it to the
device and ensure it gets launched during system startup. device and ensure it gets launched during system startup.
@ -351,6 +353,36 @@ to the watch:
startup. If that happens, and you don't know how to debug the problem, then startup. If that happens, and you don't know how to debug the problem, then
you can use wasptool to restore the original version of main.py . you can use wasptool to restore the original version of main.py .
Uploading in binary form
~~~~~~~~~~~~~~~~~~~~~~~~
Some applications are too large to be compiled on the target. These applications
need to be pre-compiled and can then either be uploaded in binary form to the
wasp-os filesystem or
:ref:`included in the firmware image<Freezing your application into the wasp-os binary>`
to further reduce the RAM overhead.
To pre-compile your application:
.. code-block:: sh
sh$ ./micropython/mpy-cross/mpy-cross -mno-unicode -march=armv7m myapp.py
To copy the binary to the wasp-os filesystem try:
.. code-block:: sh
sh$ ./tools/wasptool --binary --upload myapp.mpy
Uploading myapp.mpy:
[##################################################] 100%
At this point your application is stored on the external FLASH but it will
not automatically be loaded but it can be imported using ``import myapp``.
The application can be registered from ``main.py`` using exactly the same
technique as :ref:`uploads in source code<Uploading in source code form>`.
.. _Freezing your application into the wasp-os binary:
Freezing your application into the wasp-os binary Freezing your application into the wasp-os binary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~