1
0
Fork 0
No description
Find a file
2020-05-17 09:45:16 +01:00
bootloader@d8d7d76b17 Add PNVRAM support to avoid forgetting the time during a reboot. 2020-05-09 14:19:10 +01:00
docs README/TODO: Switch to restructured text 2020-05-15 19:55:18 +01:00
micropython@8ea3211068 Add PNVRAM support to avoid forgetting the time during a reboot. 2020-05-09 14:19:10 +01:00
reloader@6c403fb0bb reloader: Integrate into the main build system 2020-05-09 14:09:28 +01:00
res wasp: apps: Conway's Game of Life 2020-04-18 11:54:03 +01:00
tools pynus: Switch to the wasp-os version 2020-05-15 20:12:54 +01:00
wasp apps: demo: Move the demo code into a fully fledged application 2020-05-17 09:45:16 +01:00
.gitignore wasp: Automatically generate watch.py for PineTime 2020-04-11 21:12:18 +01:00
.gitmodules pynus: Switch to the wasp-os version 2020-05-15 20:12:54 +01:00
COPYING Add licensing information for all wasp-os files. 2020-03-22 15:40:18 +00:00
COPYING.LGPL Add licensing information for all wasp-os files. 2020-03-22 15:40:18 +00:00
hello.py docs: Introduce the Application Writer's Guide. 2020-05-11 21:44:30 +01:00
Makefile docs: Introduce the Application Writer's Guide. 2020-05-11 21:44:30 +01:00
README.rst apps: demo: Move the demo code into a fully fledged application 2020-05-17 09:45:16 +01:00
TODO.rst README/TODO: Switch to restructured text 2020-05-15 19:55:18 +01:00

Watch Application System in Python
==================================

Introduction
------------

Currently in its infancy wasp-os provides only a little more than a simple
digital clock application for `PineTime <https://www.pine64.org/pinetime/>`_
together with access to the MicroPython REPL for interactive testing and
tweaking. However it keeps time well and has enough power saving
functions implemented that it can survive for well over 72 hours between
charges so even at this early stage it is functional as a wearable
timepiece.

Wasp-os includes a robust bootloader based on the Adafruit NRF52
Bootloader. It has been extended to make it robust for development on
form-factor devices without a reset button, power switch, SWD debugger
or UART. This allows us to confidently develop on sealed devices relying
only on BLE for updates.

Videos
------

.. image:: https://img.youtube.com/vi/YktiGUSRJB4/0.jpg
   :target: https://www.youtube.com/watch?v=YktiGUSRJB4
   :alt: An M2 pre-release running on Pine64 PineTime

`An M2 pre-release running on Pine64 PineTime <https://www.youtube.com/watch?v=YktiGUSRJB4>`_

.. image:: https://img.youtube.com/vi/tuk9Nmr3Jo8/0.jpg
   :target: https://www.youtube.com/watch?v=tuk9Nmr3Jo8
   :alt: How to develop wasp-os python applications on a Pine64 PineTime

`How to develop wasp-os python applications on a Pine64 PineTime <https://www.youtube.com/watch?v=tuk9Nmr3Jo8>`_

.. image:: https://img.youtube.com/vi/kf1VHj587Mc/0.jpg
   :target: https://www.youtube.com/watch?v=kf1VHj587Mc
   :alt: Developing for Pine64 PineTime using wasp-os and MicroPython

`Developing for Pine64 PineTime using wasp-os and MicroPython <https://www.youtube.com/watch?v=kf1VHj587Mc>`_

Documentation
-------------

Wasp-os is has `extensive documentation <https://wasp-os.readthedocs.io>`_
which includes a detailed `Applicaiton Writer's Guide
<https://daniel-thompson.github.io/wasp-os/appguide.html>`_ to help you
get started coding for wasp-os as quickly as possible.

Building from a git clone
-------------------------

Get the code from
`https://github.com/daniel-thompson/wasp-os <https://github.com/daniel-thompson/wasp-os>`_ .

.. code-block:: sh

   pip3 install --user click serial pyserial
   make submodules
   make softdevice
   make -j `nproc` BOARD=pinetime all

.. note::

    You will need a toolchain for the Arm Cortex-M4. wasp-os is developed and
    tested using the `GNU-RM toolchain
    <https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm>`_
    (9-2019-q4) from Arm.

    There are known problems with toolchains older than gcc-7.3 due to problems
    with link-time-optimization (which is enabled by default).

Installing
----------

Use an SWD programmer to install ``bootloader.hex`` to the PineTime.  This
file is an Intel HEX file containing both the bootloader and the Nordic
SoftDevice. Be careful to disconnect cleanly from the debug software
since just pulling out the SWD cable will mean the nRF52 will still
believe it is being debugged (and won't properly enter deep sleep
modes).

.. note::

    If you have a new PineTime then it will have been delivered with flash
    protection enabled. You must disable the flash protection before trying to
    program it.

To install using Android device:

* Copy ``micropython.zip`` to your Android device and download nRF Connect
  for Android if you do not already have it.
* In nRF Connect, choose settings and reduce the DFU packet count from
  10 to 4.
* Connect to PineDFU using nRFConnect, click the DFU button and send
  ``micropython.zip`` to the device.

To install using Linux and ota-dfu:

* Look up the MAC address for your watch (try: ``sudo hcitool lescan``\ ).
* Use ota-dfu to upload ``micropython.zip`` to the device. For example:
  ``tools/ota-dfu/dfu.py -z micropython.zip -a A0:B1:C2:D3:E3:F5 --legacy``

At the end of this process your watch will show the time (03:00) together
with a date and battery meter. When the watch goes into power saving mode
you can use the side button to wake it again.

At this point you will also be able to use the Nordic UART Service to
access the MicroPython REPL, although currently you must send ^C to
interrupt the program that updates the watch display.

To set the time and restart the main application:

.. code-block:: python

   ^C
   watch.rtc.set_localtime((yyyy, mm, dd, HH, MM, SS))
   wasp.system.run()

Or just use:

.. code-block:: sh

   ./tools/wasptool --rtc

which can run these commands automatically.

As mentioned above there are many drivers and features still to be
developed, see the `TODO list <TODO.md>`_ for current status.

Screenshots
-----------

.. image:: res/clock_app.jpg
   :alt: wasp-os digital clock app running on PineTime