rei-forks/InfiniTime
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Revised documentation

Browse Source
This commit is contained in:
Eli Weiss 2021-12-05 14:04:35 -06:00 committed by JF
parent 97668c775b
commit ab059b9004
4 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/NavigationService.md
View File

@ -1,6 +1,6 @@
# Navigation Service # Navigation Service
## Introduction ## Introduction
The navigation ble service provides 4 characteristics to allow the the watch to display navigation instructions from a companion application. This service is intended to be used when performing some outdoor activities, for example running or cycling. The navigation ble service provides 4 characteristics to allow the watch to display navigation instructions from a companion application. This service is intended to be used when performing some outdoor activities, for example running or cycling.
The 4 characteristics are: The 4 characteristics are:
flag (string) - Upcoming icon name flag (string) - Upcoming icon name

2
doc/PinetimeStubWithNrf52DK.md
View File

@ -5,7 +5,7 @@ This development kit can be very useful for PineTime development:
* You can use its embedded JLink SWD programmer/debugger to program and debug your code on the PineTime * You can use its embedded JLink SWD programmer/debugger to program and debug your code on the PineTime
* As it's based on the same SoC than the PineTime, you can program it to actually run the same code as the PineTime. * As it's based on the same SoC than the PineTime, you can program it to actually run the same code as the PineTime.
This page is about the 2nd point : we will build a stub that will allow us to run the same code you can run on the PineTime. This will allow you to work more easily if you don't have a PineTime dev kit around, if you don't want to modify your dev kit for SWD programming, or if you want to use some feature from the NRF52-DK (like power measurement). This page is about the 2nd point. We will build a stub that will allow us to run the same code you can run on the PineTime. This will allow you to work more easily if you don't have a PineTime dev kit around, if you don't want to modify your dev kit for SWD programming, or if you want to use some feature from the NRF52-DK (like power measurement).
This stub only implements the display, the button and the BLE radio. The other features from the pintime are missing: This stub only implements the display, the button and the BLE radio. The other features from the pintime are missing:
* heart rate sensor * heart rate sensor

2
doc/SWD.md
View File

@ -6,7 +6,7 @@ Download the files **bootloader.bin**, **image-x.y.z.bin** and **pinetime-graphi
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). 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 seconds until the logo is completely drawn on the display. Using your SWD tool, flash **pinetime-graphics-x.y.z.bin** at offset **0x0000**. Reset the MCU and wait for a few seconds until the logo is completely drawn on the display.
Then, using your SWD tool. Flash those file at specific offset: Then, using your SWD tool, flash these file at the following offsets:
- bootloader.bin : **0x0000** - bootloader.bin : **0x0000**
- image-x.y.z.bin : **0x8000** - image-x.y.z.bin : **0x8000**

2
doc/code/Apps.md
View File

@ -21,7 +21,7 @@ A destructor is needed to clean up LVGL and restore any changes (for example re-
App classes can override `bool OnButtonPushed()`, `bool OnTouchEvent(TouchEvents event)` and `bool OnTouchEvent(uint16_t x, uint16_t y)` to implement their own functionality for those events. App classes can override `bool OnButtonPushed()`, `bool OnTouchEvent(TouchEvents event)` and `bool OnTouchEvent(uint16_t x, uint16_t y)` to implement their own functionality for those events.
If an app only needs to display some text and do something upon a touch screen button press, If an app only needs to display some text and do something upon a touch screen button press,
it does not need to override any of these functions, as LVGL can also handle touch events for you. it does not need to override any of these functions, as LVGL can also handle touch events for you.
If you have any doubts, you can always look at how the other apps function for examples. If you have any doubts, you can always look at how the other apps function for reference.
### Continuous updating ### Continuous updating
If your app needs to be updated continuously, you can do so by overriding the `Refresh()` function in your class If your app needs to be updated continuously, you can do so by overriding the `Refresh()` function in your class