diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 26 insertions, 9 deletions
@@ -1,3 +1,4 @@ + # PineTime  @@ -10,6 +11,9 @@ 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 : - Code written in **modern C++**; @@ -26,34 +30,39 @@ As of now, here is the list of achievements of this project: - Fast and optimized LCD driver - BLE communication - - Rich user interface via display, touch panel and push button + - Rich user interface via display, touchscreen and pushbutton - Time synchronization via BLE - Notification via BLE - Multiple 'apps' : * Clock (displays the date, time, battery level, BLE connection status, heart rate and step count) * Heart rate * Motion - * System info (displays various info : BLE MAC adress, build date/time, uptime, version, ...) + * System info (displays various info : BLE MAC, build date/time, uptime, version, ...) * Brightness (allows the user to configure the brightness of the display) - - Supported by 2 companion apps (development is ongoing): - * [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/branch/pinetime-jf) (on Android) + - Supported by 2 companion apps (development is in progress): + * [Gadgetbridge](https://codeberg.org/Freeyourgadget/Gadgetbridge/) (on Android) * [Amazfish](https://openrepos.net/content/piggz/amazfish) (on SailfishOS) - **[Experimental]** OTA (Over-the-air) update via BLE - **[Experimental]** Bootloader based on [MCUBoot](https://juullabs-oss.github.io/mcuboot/) ## Documentation +### Develop + - [Generate the fonts and symbols](src/displayapp/fonts/Readme.md) + ### Build, flash and debug - [Project branches](doc/branches.md) - [Versioning](doc/versioning.md) - [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) + - [Build the project with Docker](doc/buildWithDocker.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 +### Contribute - [How to contribute ?](doc/contribute.md) ### API @@ -63,10 +72,9 @@ As of now, here is the list of achievements of this project: - [Memory analysis](./doc/MemoryAnalysis.md) ### Using the firmware - - Integration with Gadgetbridge - - Integration with AmazFish - - Integration with NRFConnect - - Firmware update, OTA + - [Integration with Gadgetbridge](doc/companionapps/Gadgetbridge.md) + - [Integration with AmazFish](doc/companionapps/Amazfish.md) + - [Firmware update, OTA](doc/companionapps/NrfconnectOTA.md) ## TODO - contribute @@ -87,6 +95,15 @@ 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: + - RTOS : **[FreeRTOS](https://freertos.org)** under the MIT license + - UI : **[LittleVGL/LVGL](https://lvgl.io/)** under the MIT license + - BLE stack : **[NimBLE](https://github.com/apache/mynewt-nimble)** under the Apache 2.0 license + - 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. |