docs: install: Move Building from source into the install guide
Direct links to the install guide mean some people are reading the docs but never see the main docs index and, as a result, don't find the instructions on how to build from source. Let's fix that! Fixes: #49 Signed-off-by: Daniel Thompson <daniel@redfelineninja.org.uk>
This commit is contained in:
parent
70c1fb25ca
commit
66e8d3e58a
3 changed files with 67 additions and 60 deletions
56
README.rst
56
README.rst
|
@ -61,60 +61,6 @@ which includes a detailed `Applicaiton Writer's Guide
|
||||||
<https://wasp-os.readthedocs.io/en/latest/appguide.html>`_ to help you
|
<https://wasp-os.readthedocs.io/en/latest/appguide.html>`_ to help you
|
||||||
get started coding for wasp-os as quickly as possible.
|
get started coding for wasp-os as quickly as possible.
|
||||||
|
|
||||||
Building from source
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
Building wasp-os and launching the wasp-os simulator requires Python 3.6
|
|
||||||
(or later) and the following python modules: click, numpy, pexpect, PIL
|
|
||||||
(or Pillow), pyserial, pysdl2.
|
|
||||||
|
|
||||||
On Debian Buster the required python modules can be obtained using the
|
|
||||||
following commands:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
sudo apt install \
|
|
||||||
git build-essential libsdl2-2.0.0 \
|
|
||||||
python3-click python3-numpy python3-pexpect \
|
|
||||||
python3-pil python3-pip python3-serial
|
|
||||||
pip3 install --user pysdl2
|
|
||||||
|
|
||||||
You will also 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.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
There are known problems with toolchains older than gcc-7.3 when
|
|
||||||
link time optimization is enabled during the MicroPython build
|
|
||||||
(and LTO is enabled by default).
|
|
||||||
|
|
||||||
Get the code from
|
|
||||||
`https://github.com/daniel-thompson/wasp-os <https://github.com/daniel-thompson/wasp-os>`_ :
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
git clone https://github.com/daniel-thompson/wasp-os
|
|
||||||
cd wasp-os
|
|
||||||
make submodules
|
|
||||||
make softdevice
|
|
||||||
|
|
||||||
Build the firmware:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
make -j `nproc` BOARD=pinetime all
|
|
||||||
|
|
||||||
Finally to test out ideas and concepts on the simulator try:
|
|
||||||
|
|
||||||
.. code-block:: sh
|
|
||||||
|
|
||||||
make sim
|
|
||||||
|
|
||||||
See :ref:`Testing on the simulator` for more details on how
|
|
||||||
to use the simulator.
|
|
||||||
|
|
||||||
Getting Started
|
Getting Started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
@ -126,7 +72,7 @@ devices:
|
||||||
|
|
||||||
The
|
The
|
||||||
`Installation Guide <https://wasp-os.readthedocs.io/en/latest/install.html>`_
|
`Installation Guide <https://wasp-os.readthedocs.io/en/latest/install.html>`_
|
||||||
contains detailed instructions on how to install wasp-os.
|
contains detailed instructions on how to build and install wasp-os.
|
||||||
|
|
||||||
At the end of the install process your watch will show the time (03:00)
|
At the end of the install process your watch will show the time (03:00)
|
||||||
together with a date and battery meter. When the watch goes into power
|
together with a date and battery meter. When the watch goes into power
|
||||||
|
|
2
TODO.rst
2
TODO.rst
|
@ -46,7 +46,7 @@ Wasp-os
|
||||||
* [X] Implement simple RTC for nrf52
|
* [X] Implement simple RTC for nrf52
|
||||||
|
|
||||||
0.2 (a.k.a. M2): Great developer experience
|
0.2 (a.k.a. M2): Great developer experience
|
||||||
------------------------------
|
-------------------------------------------
|
||||||
|
|
||||||
The focus for M2 is to make development faster and easier by providing
|
The focus for M2 is to make development faster and easier by providing
|
||||||
a file system and file transfer code. This allows much faster
|
a file system and file transfer code. This allows much faster
|
||||||
|
|
|
@ -65,6 +65,63 @@ display with touch screen, a step counter and a heart rate sensor.
|
||||||
Both the wasp-bootloader and the main OS image can be installed onto a
|
Both the wasp-bootloader and the main OS image can be installed onto a
|
||||||
P8 using DaFlasher for Android. No tools are required.
|
P8 using DaFlasher for Android. No tools are required.
|
||||||
|
|
||||||
|
.. _Building wasp-os from source:
|
||||||
|
|
||||||
|
Building wasp-os from source
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
|
||||||
|
Building wasp-os and launching the wasp-os simulator requires Python 3.6
|
||||||
|
(or later) and the following python modules: click, numpy, pexpect, PIL
|
||||||
|
(or Pillow), pyserial, pysdl2.
|
||||||
|
|
||||||
|
On Debian Buster the required python modules can be obtained using the
|
||||||
|
following commands:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
sudo apt install \
|
||||||
|
git build-essential libsdl2-2.0.0 \
|
||||||
|
python3-click python3-numpy python3-pexpect \
|
||||||
|
python3-pil python3-pip python3-serial
|
||||||
|
pip3 install --user pysdl2
|
||||||
|
|
||||||
|
You will also 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.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
There are known problems with toolchains older than gcc-7.3 when
|
||||||
|
link time optimization is enabled during the MicroPython build
|
||||||
|
(and LTO is enabled by default).
|
||||||
|
|
||||||
|
Get the code from
|
||||||
|
`https://github.com/daniel-thompson/wasp-os <https://github.com/daniel-thompson/wasp-os>`_ :
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
git clone https://github.com/daniel-thompson/wasp-os
|
||||||
|
cd wasp-os
|
||||||
|
make submodules
|
||||||
|
make softdevice
|
||||||
|
|
||||||
|
Build the firmware:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
make -j `nproc` BOARD=pinetime all
|
||||||
|
|
||||||
|
Finally to test out ideas and concepts on the simulator try:
|
||||||
|
|
||||||
|
.. code-block:: sh
|
||||||
|
|
||||||
|
make sim
|
||||||
|
|
||||||
|
See :ref:`Testing on the simulator` for more details on how
|
||||||
|
to use the simulator.
|
||||||
|
|
||||||
Installing wasp-bootloader
|
Installing wasp-bootloader
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
|
@ -78,7 +135,8 @@ To install the bootloader using DaFlasher for Android:
|
||||||
and copy the DaFlasher bootloaders to your Android device. You will need
|
and copy the DaFlasher bootloaders to your Android device. You will need
|
||||||
`DaFitBootloader23Hacked.bin <https://github.com/atc1441/DaFlasherFiles/blob/master/DaFitBootloader23Hacked.bin>`_ and
|
`DaFitBootloader23Hacked.bin <https://github.com/atc1441/DaFlasherFiles/blob/master/DaFitBootloader23Hacked.bin>`_ and
|
||||||
`FitBootloaderDFU2.0.1.zip <https://github.com/atc1441/DaFlasherFiles/blob/master/FitBootloaderDFU2.0.1.zip>`_.
|
`FitBootloaderDFU2.0.1.zip <https://github.com/atc1441/DaFlasherFiles/blob/master/FitBootloaderDFU2.0.1.zip>`_.
|
||||||
* Copy ``bootloader-daflasher.zip`` to your Android device.
|
* Copy ``bootloader-daflasher.zip`` (see :ref:`Building wasp-os from source`
|
||||||
|
above) to your Android device.
|
||||||
* Open the app and connect to the device (e.g. *Y7S* if you have a developer
|
* Open the app and connect to the device (e.g. *Y7S* if you have a developer
|
||||||
edition PineTime).
|
edition PineTime).
|
||||||
* Read the disclaimer carefully, then click **Ok**.
|
* Read the disclaimer carefully, then click **Ok**.
|
||||||
|
@ -160,7 +218,8 @@ DaFlasher for Android
|
||||||
|
|
||||||
To install the main firmware using DaFlasher for Android:
|
To install the main firmware using DaFlasher for Android:
|
||||||
|
|
||||||
* Copy ``micropython.zip`` to your Android device and download
|
* Copy ``micropython.zip`` (see :ref:`Building wasp-os from source`) to
|
||||||
|
your Android device and download
|
||||||
`DaFlasher <https://play.google.com/store/apps/details?id=com.atcnetz.paatc.patc>`_
|
`DaFlasher <https://play.google.com/store/apps/details?id=com.atcnetz.paatc.patc>`_
|
||||||
if you do not already have it.
|
if you do not already have it.
|
||||||
* Open the app and connect to the device (e.g. *PineDFU* if you have a
|
* Open the app and connect to the device (e.g. *PineDFU* if you have a
|
||||||
|
@ -175,7 +234,8 @@ nRF Connect for Android
|
||||||
|
|
||||||
To install the main firmware using nRF Connect for Android:
|
To install the main firmware using nRF Connect for Android:
|
||||||
|
|
||||||
* Copy ``micropython.zip`` to your Android device and download
|
* Copy ``micropython.zip`` (see :ref:`Building wasp-os from source`) to
|
||||||
|
your Android device and download
|
||||||
`nRF Connect <https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp>`_
|
`nRF Connect <https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp>`_
|
||||||
for Android if you do not already have it.
|
for Android if you do not already have it.
|
||||||
* Connect to the device (e.g. *PineDFU* if you have a PineTime) using
|
* Connect to the device (e.g. *PineDFU* if you have a PineTime) using
|
||||||
|
@ -189,5 +249,6 @@ wasptool for GNU/Linux
|
||||||
To install the main firmware from a GNU/Linux workstation:
|
To install the main firmware from a GNU/Linux workstation:
|
||||||
|
|
||||||
* Look up the MAC address for your watch (try: ``sudo hcitool lescan``\ ).
|
* Look up the MAC address for your watch (try: ``sudo hcitool lescan``\ ).
|
||||||
* Use ota-dfu to upload ``micropython.zip`` to the device. For example:
|
* Use ota-dfu to upload ``micropython.zip`` (see
|
||||||
|
:ref:`Building wasp-os from source`) to the device. For example:
|
||||||
``tools/ota-dfu/dfu.py -z micropython.zip -a A0:B1:C2:D3:E3:F5 --legacy``
|
``tools/ota-dfu/dfu.py -z micropython.zip -a A0:B1:C2:D3:E3:F5 --legacy``
|
||||||
|
|
Loading…
Reference in a new issue