Update documentation (#467)
* Fix and update documentation * Add newlines
This commit is contained in:
Riku Isokoski
GitHub
parent
ec2469a6c1
commit
7a6ceadb24
24
README.md
24
README.md
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
# PineTime
|
||||
|
||||
[](https://github.com/JF002/InfiniTime/actions)
|
||||
|
|
@ -12,6 +11,7 @@
|
|||
The **Pinetime** smartwatch is built around the NRF52832 MCU (512KB Flash, 64KB RAM), a 240*240 LCD display driven by the ST7789 controller, an accelerometer, a heart rate sensor, and a vibration motor.
|
||||
|
||||
# InfiniTime
|
||||
|
||||
|
||||
|
||||
The goal of this project is to design an open-source firmware for the Pinetime smartwatch :
|
||||
|
|
@ -46,20 +46,22 @@ As of now, here is the list of achievements of this project:
|
|||
* Analog
|
||||
* [PineTimeStyle](https://wiki.pine64.org/wiki/PineTimeStyle)
|
||||
- Multiple 'apps' :
|
||||
* Music (control the playback of the music on your phone)
|
||||
* Heart rate (controls the heart rate sensor and display current heartbeat)
|
||||
* 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)
|
||||
* Two (2048 clone game)
|
||||
* Stopwatch (with all the necessary functions such as play, pause, lap, stop)
|
||||
* Motion sensor and step counter (displays the number of steps and the state of the motion sensor in real-time)
|
||||
* 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
|
||||
|
|
@ -74,14 +76,17 @@ As of now, here is the list of achievements of this project:
|
|||
## Documentation
|
||||
|
||||
### Getting started
|
||||
|
||||
- [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)
|
||||
|
||||
### Develop
|
||||
|
||||
- [Generate the fonts and symbols](src/displayapp/fonts/README.md)
|
||||
- [Creating a stopwatch in Pinetime(article)](https://pankajraghav.com/2021/04/03/PINETIME-STOPCLOCK.html)
|
||||
|
||||
### Build, flash and debug
|
||||
|
||||
- [Project branches](doc/branches.md)
|
||||
- [Versioning](doc/versioning.md)
|
||||
- [Files included in the release notes](doc/filesInReleaseNotes.md)
|
||||
|
|
@ -94,20 +99,23 @@ As of now, here is the list of achievements of this project:
|
|||
- Using files from the releases
|
||||
|
||||
### Contribute
|
||||
|
||||
- [How to contribute ?](doc/contribute.md)
|
||||
|
||||
### API
|
||||
|
||||
- [BLE implementation and API](./doc/ble.md)
|
||||
|
||||
### Architecture and technical topics
|
||||
|
||||
- [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
|
||||
|
||||
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.
|
||||
|
|
@ -127,6 +135,7 @@ Here a quick list out of my head of things to do for this project:
|
|||
Do not hesitate to clone/fork the code, hack it and create pull-requests. I'll do my best to review and merge them :)
|
||||
|
||||
## Licenses
|
||||
|
||||
This project is released under the GNU General Public License version 3 or, at your option, any later version.
|
||||
|
||||
It integrates the following projects:
|
||||
|
|
@ -136,6 +145,7 @@ It integrates the following projects:
|
|||
- Font : **[Jetbrains Mono](https://www.jetbrains.com/fr-fr/lp/mono/)** under the Apache 2.0 license
|
||||
|
||||
## Credits
|
||||
|
||||
I’m not working alone on this project. First, many people create PR for this projects. Then, there is the whole #pinetime community : a lot of people all around the world who are hacking, searching, experimenting and programming the Pinetime. We exchange our ideas, experiments and code in the chat rooms and forums.
|
||||
|
||||
Here are some people I would like to highlight:
|
||||
|
|
|
|||
|
|
@ -1,7 +1,9 @@
|
|||
# Getting started with InfiniTime 1.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.
|
||||
|
||||
## Firmware, InfiniTime, Bootloader, Recovery firmware, OTA, DFU... What is it?
|
||||
|
||||
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.
|
||||
|
||||
Basically, a **firmware** is just a software running on the embedded hardware of a device, the PineTime in this case.
|
||||
|
|
@ -13,9 +15,10 @@ Basically, a **firmware** is just a software running on the embedded hardware of
|
|||
**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**igital **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/JF002/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 succesful OTA or a manual reset - long push on the button).
|
||||
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.
|
||||
|
||||
|
|
@ -30,14 +33,14 @@ And for version >= 1.0 :
|
|||
|
||||
|
||||
|
||||
|
||||
PineTime shipped from June 2020 (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/JF002/InfiniTime/releases/tag/0.14.1) and [InfiniTime 1.0](https://github.com/JF002/InfiniTime/releases/tag/1.0.0).
|
||||
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/JF002/InfiniTime/releases/tag/0.14.1) and [InfiniTime 1.0](https://github.com/JF002/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).
|
||||
|
||||
|
||||
|
||||
## 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)
|
||||
|
|
@ -45,9 +48,10 @@ To update your PineTime, you can use one of the compatible companion application
|
|||
- **[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 Gadgetbrige and NRFCOnnect.
|
||||
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):
|
||||
|
|
@ -59,10 +63,12 @@ Using the companion app of your choice, you'll need to apply the OTA procedure f
|
|||
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-functionning and will revert to the previous version of the firmware. This is a safety feature to prevent bricking your device with a faulty firmware.
|
||||
|
||||
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:
|
||||
|
||||
|
|
@ -74,7 +80,9 @@ You can validate your updated firmware on InfiniTime >= 1.0 by following this si
|
|||
- **Reset** to reset the watch and revert to the previously running version of the firmware
|
||||
|
||||
## InfiniTime 1.0 quick user guide
|
||||
|
||||
### Setting the time
|
||||
|
||||
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.
|
||||
|
||||
### Navigation in the menu
|
||||
|
|
@ -109,4 +117,3 @@ However, you can enable 2 functionalities using the push button:
|
|||
- Push the button until the pine cone is drawn in **red** to load the recovery firmware. This recovery firmware only provides BLE connectivity and OTA functionality.
|
||||
|
||||
More info about the bootloader in [its project page](https://github.com/JF002/pinetime-mcuboot-bootloader/blob/master/README.md).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue