Documentation cleanup and reorganization

Author: Riksu9000

README.md

@@ -1,73 +1,18 @@
-# InfiniTime
+# [InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime)
 
 [![Build PineTime Firmware](https://github.com/InfiniTimeOrg/InfiniTime/workflows/Build%20PineTime%20Firmware/badge.svg?branch=master)](https://github.com/InfiniTimeOrg/InfiniTime/actions)
 
-![InfiniTime logo](images/infinitime-logo.jpg "InfiniTime Logo")
+![InfiniTime logo](images/infinitime-logo-small.jpg "InfiniTime Logo")
 
-The goal of this project is to design an open-source firmware for the [Pinetime smartwatch](https://www.pine64.org/pinetime/) :
-
- - Code written in **modern C++**;
- - Build system based on **CMake**;
- - Based on **[FreeRTOS 10.0.0](https://freertos.org)** real-time OS.
- - Using **[LittleVGL/LVGL 7](https://lvgl.io/)** as UI library...
- - ... and **[NimBLE 1.3.0](https://github.com/apache/mynewt-nimble)** as BLE stack.
+InfiniTime is an open-source firmware for the [Pinetime smartwatch](https://www.pine64.org/pinetime/)
 
 ## New to InfiniTime?
 
- - [Getting started with InfiniTime 1.0 (quick user guide, update bootloader and InfiniTime,...)](doc/gettingStarted/gettingStarted-1.0.md)
- - [Flash, upgrade (OTA), time synchronization,...](doc/gettingStarted/ota-gadgetbridge-nrfconnect.md)
-
-## Overview
-
-![Pinetime screens](images/1.0.0/collage.png "PinetimeScreens")
-
-As of now, here is the list of achievements of this project:
-
- - Fast and optimized LCD driver
- - BLE communication
- - Rich user interface via display, touchscreen and pushbutton
- - Time synchronization via BLE
- - Notification via BLE
- - Heart rate measurements
- - Step counting
- - Wake-up on wrist rotation
- - Quick actions
-    * Disable vibration on notification
-    * Brightness settings
-    * Flashlight
-    * Settings
- - 3 watch faces:
-    * Digital
-    * Analog
-    * [PineTimeStyle](https://wiki.pine64.org/wiki/PineTimeStyle)
- - Multiple 'apps' :
-    * Music (control the playback of music on your phone)
-    * Heart rate (measure your heart rate)
-    * Navigation (displays navigation instructions coming from the companion app)
-    * Notification (displays the last notification received)
-    * Paddle (single player pong-like game)
-    * Twos (2048 clone game)
-    * Stopwatch
-    * Steps (displays the number of steps taken)
-    * Timer (set a countdown timer that will notify you when it expires)
-    * Metronome (vibrates to a given bpm with a customizable beats per bar)
- - User settings:
-    * Display timeout
-    * Wake-up condition
-    * Time format (12/24h)
-    * Default watch face
-    * Daily step goal
-    * Battery status
-    * Firmware validation
-    * System information
- - Supported by 3 companion apps (development is in progress):
-    * [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/) (on Android via F-Droid)
-    * [Amazfish](https://openrepos.net/content/piggz/amazfish) (on SailfishOS and Linux)
-    * [Siglo](https://github.com/alexr4535/siglo) (on Linux)
-    * **[Experimental]** [WebBLEWatch](https://hubmartin.github.io/WebBLEWatch/) Synchronize time directly from your web browser. [video](https://youtu.be/IakiuhVDdrY)
-    * **[Experimental]** [InfiniLink](https://github.com/xan-m/InfiniLink) (on iOS)
- - OTA (Over-the-air) update via BLE
- - [Bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader) based on [MCUBoot](https://www.mcuboot.com)
+ - [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md)
+ - [About the software and updating](doc/gettingStarted/updating-software.md)
+ - Companion apps:
+   - [Gadgetbridge](doc/companionapps/Gadgetbridge.md)
+   - [AmazFish](doc/companionapps/Amazfish.md)
 
 ## Documentation
 
@@ -84,16 +29,11 @@ As of now, here is the list of achievements of this project:
  - [Files included in the release notes](doc/filesInReleaseNotes.md)
  - [Build the project](doc/buildAndProgram.md)
  - [Flash the firmware using OpenOCD and STLinkV2](doc/openOCD.md)
+ - [Flash the firmware using SWD interface](doc/SWD.md)
  - [Build the project with Docker](doc/buildWithDocker.md)
  - [Build the project with VSCode](doc/buildWithVScode.md)
  - [Bootloader, OTA and DFU](./bootloader/README.md)
  - [Stub using NRF52-DK](./doc/PinetimeStubWithNrf52DK.md)
- - Logging with JLink RTT.
- - Using files from the releases
-
-### Contribute
-
- - [How to contribute ?](doc/contribute.md)
 
 ### API
 
@@ -103,29 +43,13 @@ As of now, here is the list of achievements of this project:
 
  - [Memory analysis](./doc/MemoryAnalysis.md)
 
-### Using the firmware
-
- - [Integration with Gadgetbridge](doc/companionapps/Gadgetbridge.md)
- - [Integration with AmazFish](doc/companionapps/Amazfish.md)
- - [Firmware update, OTA](doc/companionapps/NrfconnectOTA.md)
-
-## TODO - contribute
+## Contributing
 
 This project is far from being finished, and there are still a lot of things to do for this project to become a firmware usable by the general public.
 
-Here a quick list out of my head of things to do for this project:
-
- - Improve BLE communication stability and reliability
- - Improve OTA and MCUBoot bootloader
- - Add more functionalities : Alarm, chronometer, configuration, activities, heart rate logging, games,...
- - Add more BLE functionalities : call notifications, agenda, configuration, data logging,...
- - Measure power consumption and improve battery life
- - Improve documentation, take better pictures and video than mine
- - Improve the UI
- - Create companion app for multiple OSes (Linux, Android, iOS) and platforms (desktop, ARM, mobile). Do not forget the other devices from Pine64 like [the Pinephone](https://www.pine64.org/pinephone/) and the [Pinebook Pro](https://www.pine64.org/pinebook-pro/).
- - Design a simple CI (preferably self-hosted and easy to reproduce).
+Do not hesitate to fork the code, hack it and create pull-requests!
 
-Do not hesitate to clone/fork the code, hack it and create pull-requests. I'll do my best to review and merge them :)
+Read this page for more information on how you can help: [How to contribute?](doc/contribute.md)
 
 ## Licenses
 

doc/SWD.md

@@ -0,0 +1,14 @@
+# How to flash InfiniTime using the SWD interface
+Download the files **bootloader.bin**, **image-x.y.z.bin** and **pinetime-graphics-x.y.z.bin** from the release page:
+
+![Image file](imageFile.png)
+
+The bootloader reads a boot logo from the external SPI flash memory. The first step consists of flashing a tool in the MCU that will flash the boot logo into this SPI flash memory. This first step is optional but recommended (the bootloader will display garbage on screen for a few second if you don't do it).
+Using your SWD tool, flash **pinetime-graphics-x.y.z.bin** at offset **0x0000**. Reset the MCU and wait for a few second, until the logo is completely drawn on the display.
+
+Then, using your SWD tool, flash those file at specific offset:
+
+ - bootloader.bin : **0x0000**
+ - image-x.y.z.bin : **0x8000**
+
+Reset and voilà, you're running InfiniTime on your PineTime!

doc/companionapps/Gadgetbridge.md

@@ -1,13 +1,7 @@
 # Integration with Gadgetbridge
 [Gadgetbridge](https://gadgetbridge.org/) is an Android application that supports many smartwatches and fitness trackers.
 
-The integration of InfiniTime (previously Pinetime-JF) is now merged into the master branch (https://codeberg.org/Freeyourgadget/Gadgetbridge/) and initial support is available [starting with version 0.47](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/branch/master/CHANGELOG.md). Note that the official version is only available on F-Droid (as of May 2021), and the unofficial fork available on the Play Store is outdated and does not support Infinitime.
+Gadgetbridge supports InfiniTime [starting with version 0.47](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/branch/master/CHANGELOG.md). Note that the official version is only available on F-Droid (as of May 2021), and the unofficial fork available on the Play Store is outdated and does not support InfiniTime.
 
-## Features
-The following features are implemented:
- - Scanning & detection of Pinetime-JF / InfiniTime
- - Connection / disconnection
- - Notifications
- 
 ## Demo
-[This video](https://seafile.codingfield.com/f/0a2920b9d765462385e4/) shows how to scan, connect, send notification (using the debug screen) and disconnect from the Pinetime.
+[This video](https://seafile.codingfield.com/f/0a2920b9d765462385e4/) shows how to scan, connect, send notification (using the debug screen) and disconnect from the PineTime.

doc/companionapps/NrfconnectOTA.md

@@ -1,91 +1,23 @@
-# Getting started with InfiniTime 1.0
+# Getting started with InfiniTime 1.0.0
 
-On April 22 2021, InfiniTime and Pine64 [announced the release of InfiniTime 1.0](https://www.pine64.org/2021/04/22/its-time-infinitime-1-0/) and the availability of PineTime smartwatches as *enthusiast grade end-user product*. This page aims to guide you with your first step with your new PineTime.
+On April 22 2021, InfiniTime and Pine64 [announced the release of InfiniTime 1.0.0](https://www.pine64.org/2021/04/22/its-time-infinitime-1-0/) and the availability of PineTime smartwatches as *enthusiast grade end-user product*. This page aims to guide you with your first step with your new PineTime.
 
-## Firmware, InfiniTime, Bootloader, Recovery firmware, OTA, DFU... What is it?
+It is highly recommended to update the firmware to the latest version when you receive your watch and when a new InfiniTime version is released. More information on updating the firmware [here](/doc/gettingStarted/updating-software.md).
 
-You might have already seen these words by reading the announcement, release notes, or [the wiki guide](https://wiki.pine64.org/wiki/Upgrade_PineTime_to_InfiniTime_1.0.0) and, you may find them misleading if you're not familiar with the project.
+## InfiniTime 1.0.0 quick user guide
 
-Basically, a **firmware** is just a software running on the embedded hardware of a device, the PineTime in this case.
-**InfiniTime** is based on 3 distinct **firmwares**:
- - **[InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime)** itself, this is the *application firmware* running on the PineTime. This is the main firmware which provides most of the functionalities you'll use on a daily basis : bluetooth low-energy (BLE) connectivity, applications, watchfaces,...
- - **[The bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader)** is responsible for safely applying **updates** of the *application firmware*, reverting them in case of issues and load the recovery firmware when requested.
- - **The recovery firmware** is a specific *application firmware* than can be loaded by the bootloader on user request. This firmware can be useful in case of serious issue, when the main application firmware cannot perform an OTA update correctly. Currently, this  recovery firmware is based on [InfiniTime 0.14.1](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/0.14.1).
-
-**OTA** and **DFU** refer to the update of the firmware over BLE (**B**luetooth **L**ow **E**nergy). **OTA** means **O**ver **T**he **A**ir, this is a functionality that allows the user to update the firmware how their device using a wireless communication like BLE. When we talk about **DFU** (**D**evice **F**irmware **U**pdate), we refer to the file format and protocol used to send the update of the firmware to the watch over-the-air. InfiniTime implement the (legacy) DFU protocol from Nordic Semiconductor (NRF).
-
-## How to check the version of InfiniTime and the bootloader?
-
-Since September 2020, all PineTimes (devkits or sealed) are flashed using the **[first iteration of the bootloader](https://github.com/lupyuen/pinetime-rust-mynewt/releases/tag/v4.1.7)** and **[InfiniTime 0.7.1](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/0.7.1)**. There was no recovery firmware at that time.
-
-The bootloader only runs when the watch starts (from an empty battery, for example) or after a reset (after a successful OTA or a manual reset - long push on the button).
-
-You can recognize this first iteration of the bootloader with it greenish **PINETIME** logo.
-
-![Old bootloader logo](oldbootloaderlogo.jpg)
-
-You can check the version of InfiniTime by opening the app *SystemInfo*. For version < 1.0:
-
-![InfiniTime 0.7.1 Application menu](appmenu-071.jpg)
-![InfiniTime 0.7.1 version](version-071.jpg)
-
-And for version >= 1.0 :
-
-![InfiniTime 1.0 version](version-1.0.jpg)
-
-PineTime shipped from June 2021 (to be confirmed) will be flashed with the [new version of the bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader/releases/tag/1.0.0), the [recovery firmware](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/0.14.1) and [InfiniTime 1.0](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/1.0.0).
-
-The bootloader is easily recognizable with it white pine cone that is progressively drawn in green. It also displays its own version on the bottom (1.0.0 as of now).
-
-![Bootloader 1.0](bootloader-1.0.jpg)
-
-## How to update your PineTime?
-
-To update your PineTime, you can use one of the compatible companion applications. Here are the main ones:
-
- - **[Amazfish](https://github.com/piggz/harbour-amazfish)** (Desktop Linux, mobile Linux, SailfishOS, runs on the PinebookPro and the Pinephone)
- - **[Gadgetbridge](https://www.gadgetbridge.org/)** (Android)
- - **[Siglo](https://github.com/alexr4535/siglo)** (Linux, GTK based)
- - **NRFConnect** (closed source, Android & iOS).
-
-See [this page](ota-gadgetbridge-nrfconnect.md) for more info about the OTA procedure using Gadgetbridge and NRFConnect.
-
-### From InfiniTime 0.7.1 / old bootloader
-
-If your PineTime is currently running InfiniTime 0.7.1 and the old bootloader, we strongly recommend you update them to more recent version (Bootloader 1.0.0 and InfiniTime 1.0.0 as of now). We also recommend you install the recovery firmware once the bootloader is up-do-date.
-
-Using the companion app of your choice, you'll need to apply the OTA procedure for these 3 firmwares in this sequence (failing to follow this specific order might temporarily or permanently brick your device):
-
- 1. Flash the latest version of InfiniTime. The file to upload is named **pinetime-mcuboot-app-dfu-x.y.z.zip**. Here is the link to [InfiniTime 1.0](https://github.com/InfiniTimeOrg/InfiniTime/releases/download/1.0.0/pinetime-mcuboot-app-dfu-1.0.0.zip).
- 2. Update the bootloader by applying the OTA procedure with the file named [**reloader-mcuboot.zip** from the repo of the bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader/releases/download/1.0.0/reloader-mcuboot.zip).
- 3. Install the recovery firmware by applying the OTA procedure with the file named [**pinetime-mcuboot-recovery-loader-dfu-0.14.1.zip** from the version 0.14.1 of InfiniTime](https://github.com/InfiniTimeOrg/InfiniTime/releases/download/0.14.1/pinetime-mcuboot-recovery-loader-dfu-0.14.1.zip).
-
-You'll find more info about this process in [this wiki page](https://wiki.pine64.org/wiki/Upgrade_PineTime_to_InfiniTime_1.0.0). You can also see the procedure in video [here](https://video.codingfield.com/videos/watch/831077c5-16f3-47b4-9b2b-c4bbfecc6529) and [here (from Amazfish)](https://video.codingfield.com/videos/watch/f7bffb3d-a6a1-43c4-8f01-f4aeff4adf9e)
-
-### From version > 1.0
-
-If you are already running the new "1.0.0" bootloader, all you have to do is update your version of InfiniTime when it'll be available. We'll write specific instructions when (if) we release a new version of the bootloader.
-
-### Firmware validation
-
-The bootloader requires a (manual) validation of the firmware. If the watch reset with an updated firmware that was not validated, the bootloader will consider it as non-functioning and will revert to the previous version of the firmware. This is a safety feature to prevent bricking your device with a faulty firmware.
-
-You can validate your updated firmware on InfiniTime >= 1.0 by following this simple procedure:
-
- - From the watchface, swipe **right** to display the *Quick Actions menu*
- - Open the **Settings** app by tapping the *gear* icon on the bottom right
- - Swipe down and tap on the entry named **Firmware**
- - This app shows the version that is currently running. If it's not validated yet, it displays 2 buttons:
-    - **Validate** to validate your firmware
-    - **Reset** to reset the watch and revert to the previously running version of the firmware
+### Setting the time
 
-## InfiniTime 1.0 quick user guide
+By default, InfiniTime starts on the digital watchface. It'll probably display the epoch time (1 Jan 1970, 00:00).
 
-### Setting the time
+You can sync the time using companion apps.
 
-By default, InfiniTime starts on the digital watchface. It'll probably display the epoch time (1 Jan 1970, 00:00). The time will be automatically synchronized once you connect on of the companion app to your PineTime using BLE connectivity. InfiniTime does not provide any way to manually set the time for now.
+ - Gadgetbridge automatically synchronizes the time when you connect it to your watch. More information on Gadgetbridge [here](/doc/gettingStarted/ota-gadgetbridge.md)
+ - You can use NRFConnect to [sync the time](/doc/gettingStarted/time-nrfconnect.md)
+ - Sync the time with your browser https://hubmartin.github.io/WebBLEWatch/
+ - Since InfiniTime 1.7.0, you can set the time in the settings without needing to use a companion app
 
-### Navigation in the menu
+## Navigation in the menu
 
 ![Quick actions](quickactions.jpg)
 ![Settings](settings.jpg)
@@ -98,14 +30,7 @@ By default, InfiniTime starts on the digital watchface. It'll probably display t
     - Start the **flashlight** app
     - Enable/disable vibrations on notifications (Do Not Disturb mode)
     - Enter the **settings** menu
- - Settings
-    - Display timeout
-    - Wake up event (Tap, wrist rotation)
-    - Time format (12/24H)
-    - Default watchface (digital / analog)
-    - Battery info
-    - Firmware validation
-    - About (system info, firmware version,...)
+       - Swipe up and down to see all options
 
 ### Bootloader