From 9c9a5085806643d9b41a535c4d7130da8c22c4dc Mon Sep 17 00:00:00 2001 From: Daniel Thompson Date: Thu, 30 Jul 2020 22:41:39 +0100 Subject: [PATCH] install: Improve formating, add links and other good stuff Signed-off-by: Daniel Thompson --- docs/install.rst | 112 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 78 insertions(+), 34 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 2caaccd..8c3ed32 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -27,14 +27,13 @@ operating systems. By selling a watch with the intention that it be hacked every which way from Sunday then we get a bigger stronger community focused on the PineTime. There is a strong support forum, multiple different OS developers (who share ideas and knowledge even if hacking on very different code bases) -combined with a reasonable set of hardware documentation. +combined with a `reasonable set of hardware documentation `_. There's definitely a lot of fun to be had buying something off-the-shelf and -hacking it to become something the manufacturer never intended. We know -this because we've done it! However the hackable devices are sold for -relatively short periods and may experience undocumented technical changes -between manufacturing runs. This makes it hard for a community to form -around any particular device. +hacking it to become something the manufacturer never intended. We know this +because we've done it! However hackable devices are often only sold for short +periods and may experience undocumented technical changes between manufacturing +runs. This makes it hard for a community to form around any particular device. Thus the second criteria it to think about your own needs and abilities. If you want to enjoy the social and community aspects of open source @@ -43,15 +42,15 @@ watch development then you should look very closely at the PineTime. Pine64 PineTime (developer edition) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pine64 PineTime is a square smart watch based on an nRF52832 SoC and -includes a 240x240 colour display with touch screen, a step counter and -a heart rate sensor. +`Pine64 PineTime `_ is a square smart watch +based on an nRF52832 SoC and includes a 240x240 colour display with touch +screen, a step counter and a heart rate sensor. -The developer edition comes pre-programmed with a test firmware that -is used as part of the factory testing. Both the wasp-bootloader and -the main OS image can be installed onto a developer edition PineTime -using DaFlasher for Android. No tools are required to install using -DaFlasher. +The `developer edition `_ +comes pre-programmed with a test firmware that is used as part of the factory +testing. Both the wasp-bootloader and the main OS image can be installed onto a +developer edition PineTime using DaFlasher for Android. No tools are required +to install using DaFlasher. Since the developer edition comes without the case glued shut it is also possible to install the wasp-bootloader using an SWD programmer. @@ -59,21 +58,50 @@ also possible to install the wasp-bootloader using an SWD programmer. Colmi P8 ~~~~~~~~ -The Colmi P8 is an almost square smart watch based on an nRF52832 SoC -and includes a 240x240 colour display with touch screen, a step counter -and a heart rate sensor. +The `Colmi P8 `_ is an almost +square smart watch based on an nRF52832 SoC and includes a 240x240 colour +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 P8 using DaFlasher for Android. No tools are required. -Installing wasp-bootloader using DaFlasher for Android ------------------------------------------------------- +Installing wasp-bootloader +-------------------------- -For all the DaFit family of smart watches (including the developer -edition of the Pine64 PineTime) the install instructions are the -same although it is important to ensure that both ``bootloader-daflasher.zip`` -and ``micropython.zip`` match the device you are installing on. There are -no runtime checks. +DaFlasher for Android +~~~~~~~~~~~~~~~~~~~~~ + +To install the bootloader using DaFlasher for Android: + +* Download and install + `DaFlasher `_ + and copy the DaFlasher bootloaders to your Android device. You will need + `DaFitBootloader23Hacked.bin `_ and + `FitBootloaderDFU2.0.1.zip `_. +* Copy ``bootloader-daflasher.zip`` to your Android device. +* Open the app and connect to the device (e.g. *Y7S* if you have a developer + edition PineTime). +* Read the disclaimer carefully, then click **Ok**. + PineTime). +* Click **Select file** and choose ``DaFitBootloader23Hacked.bin``, then wait + for the payload to be transferred and for the install process to complete + on the watch (leaving three coloured squares on the display). +* Press the Back button to return to the scanner and connect to the device. + The device name will have changed to *ATCdfu*. +* Click **Do DFU Update**. +* Click **Select DFU file** and select ``FitBootloaderDFU2.0.1.zip``, then wait + for the payload to transfer and the update to take place. The watch should + be showing a single red square which is captioned *ATCnetz.de*. +* Click **Select DFU file** again and select + ``bootloader-daflasher.zip``. Once the update is complete the watch will + show the wasp-os logo and some additional on-screen prompt. + +It is important to ensure that both ``bootloader-daflasher.zip`` +and ``micropython.zip`` match the device you are installing for. There are +no runtime compatibility checks. + +An end-to-end video of the above process (and the final install of wasp- +os) is also available: .. image:: https://img.youtube.com/vi/VJoDtMy-4pk/0.jpg :target: https://www.youtube.com/watch?v=VJoDtMy-4pk @@ -89,8 +117,19 @@ no runtime checks. has been installed the factory firmware will be permanently removed from the device. -Installing wasp-bootloader using an SWD programmer --------------------------------------------------- + Although it is not possible to restore the factory firmware it is + possible to switch back to Softdevice 5.0.1 and/or Softdevice 2.0.1 + on order to run alternative firmwares such as + `ATCwatch `_. The zip updates + in `DaFlasherFiles `_ cannot + be applied directly but we can return to the DaFlasher bootloaders + by installing + `DS-D6-adafruit-back-to-desay-sd132v201.zip `_ + followed by + `ATCdfuFromSD2toSD5.zip `_ + +Using an SWD programmer +~~~~~~~~~~~~~~~~~~~~~~~ There are many different SWD programmers that can be used to install wasp-bootloader. Use the @@ -113,12 +152,16 @@ logo and wait for a OTA update. debugged (which harms battery life because the device won't properly enter deep sleep states). -Installing wasp-os using DaFlasher for Android ----------------------------------------------- +Installing wasp-os +------------------ + +DaFlasher for Android +~~~~~~~~~~~~~~~~~~~~~ To install the main firmware using DaFlasher for Android: -* Copy ``micropython.zip`` to your Android device and download DaFlasher +* Copy ``micropython.zip`` to your Android device and download + `DaFlasher `_ if you do not already have it. * Open the app and connect to the device (e.g. *PineDFU* if you have a PineTime). @@ -127,20 +170,21 @@ To install the main firmware using DaFlasher for Android: * When the upload is complete the watch will reboot and launch the digital clock application. -Installing wasp-os using nRF Connect for Android ------------------------------------------------- +nRF Connect for Android +~~~~~~~~~~~~~~~~~~~~~~~ To install the main firmware using nRF Connect for Android: -* Copy ``micropython.zip`` to your Android device and download nRF Connect +* Copy ``micropython.zip`` to your Android device and download + `nRF Connect `_ for Android if you do not already have it. * Connect to the device (e.g. *PineDFU* if you have a PineTime) using nRFConnect, click the DFU button and send ``micropython.zip`` to the device. * When the upload is complete the watch will reboot and launch the digital clock application. -Installing wasp-os from a GNU/Linux workstation ------------------------------------------------ +wasptool for GNU/Linux +~~~~~~~~~~~~~~~~~~~~~~ To install the main firmware from a GNU/Linux workstation: