Author: Derry Tutt <82726593+everypizza1@users.noreply.github.com>
Documentation improvements (#2091) Add documentation about watch faces and applications. Update getting started documentation. Co-authored-by: tituscmd <154823939+tituscmd@users.noreply.github.com>
README.md | 4 doc/gettingStarted/Applications.md | 99 ++++++++++++++++++++++++++ doc/gettingStarted/Watchfaces.md | 31 ++++++++ doc/gettingStarted/gettingStarted-1.0.md | 4 doc/gettingStarted/ota-gadgetbridge.md | 20 +++- doc/gettingStarted/updating-software.md | 4
diff --git a/README.md b/README.md index d3d1130f7ae0158ab31b435dbdb3108f07ca083d..765d5d4ba467d12d55175c5741212ac001395ff7 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ - [Getting started with InfiniTime](doc/gettingStarted/gettingStarted-1.0.md) - [Updating the software](doc/gettingStarted/updating-software.md) - [About the firmware and bootloader](doc/gettingStarted/about-software.md) +- [Available apps](doc/gettingStarted/Applications.md) +- [Available watch faces](/doc/gettingStarted/Watchfaces.md) - [PineTimeStyle Watch face](https://pine64.org/documentation/PineTime/Watchfaces/PineTimeStyle) - [Weather integration](https://pine64.org/documentation/PineTime/Software/InfiniTime_weather/) @@ -35,7 +37,7 @@ - [External resources](doc/ExternalResources.md) ### Contributing -- [How to contribute?](CONTRIBUTING.md) +- [How to contribute](CONTRIBUTING.md) - [Coding conventions](doc/coding-convention.md) ### Build, flash and debug diff --git a/doc/gettingStarted/Applications.md b/doc/gettingStarted/Applications.md new file mode 100644 index 0000000000000000000000000000000000000000..8ca2b25287a3643b1e90f17a8f8cb32ba3784510 --- /dev/null +++ b/doc/gettingStarted/Applications.md @@ -0,0 +1,99 @@ +# Applications + +InfiniTime has 13 apps on the `main` branch at the time of writing. + +## List of apps +- Stopwatch +- Alarm +- Timer +- Steps +- Heartrate +- Music +- InfiniPaint +- Paddle +- 2 +- InfiniDice +- Metronome +- Maps +- Weather + +### Stopwatch + +- Press the Start button (bottom right) to start or stop the timer. + - You can also press the side button while the timer is running to pause the timer. +- Press the Flag button (bottom left) to add a lap. +- The stopwatch will not yet continue counting time while the app is closed. + +### Alarm + +- Ajust the time with the time picker. +- Press the Info button in the top middle to see time remaning. +- Use the toggle in the bottom left to turn the alarm on/off. +- Use the button in the bottom right to change the alarm frequency. + - You can choose between once, daily, or Monday - Friday. + +### Timer + +- Ajust how long the timer should go for with the time picker. +- Press the Start button at the bottom to start/stop the timer. + +### Steps + +- The total count of steps for the current display will show in the middle of the screen. +- The Reset button in the bottom middle resets the Trip counter. (Total of all steps taken.) +- The progress circle shows the percentage of your daily goal completed. + +### Heartrate + +- Press Start to start measuring your heartrate. + - It may take a bit to get the first measurement. + +### Music + +- This app shows currently playing music. + - Please note that this app is not very useful without a device connected. +- Press the button in the center to play/pause, and the buttons on the left and right to go to the previous and next tracks, respectively. +- Swipe up to get to volume controls. + +### InfiniPaint + +- This app does not allow you to swipe from the top to exit, use the side button instead. +- Draw on the screen to add lines. +- Hold down in one spot to change paint colors. + +### Paddle + +- This app does not allow you to swipe from the top to exit, use the side button instead. +- Drag your finger to move the paddle. +- Goal: Don't let the ball go off the left side of the screen. + +### 2 + +- This app does not allow you to swipe from the top to exit, use the side button instead. +- Play a game of 2048. +- Swipe up, down, left, or right tomove the tiles. +- When two tiles with the same number run into each other, they will add together. +- Goal: Don't let the screen fill up with tiles, and get to the 2048 tile to win. + +### InfiniDice + +- Ajust the count to change the number of dice. +- Ajust the sides to change the number of sides. +- Press the button at the bottom to roll. +- The result will be on the right side of the screen. + +### Metronome + +- Ajust the BPM with the circular slider. + - A bug currently makes it always snap to 98 BPM. +- Use the button in the bottom left to start the metronome. + +### Maps + +- This app shows info from a navigation app. + - Please note that this app is not very useful without a device connected. + +### Weather + +- This app shows weather info. + - Please note that this app is not very useful without a device connected. diff --git a/doc/gettingStarted/AppsScreenshots/2048.png b/doc/gettingStarted/AppsScreenshots/2048.png new file mode 100644 index 0000000000000000000000000000000000000000..472e4fcecd8feb3ef024ab9dc65d4eea2a41a973 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/2048.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Dice.png b/doc/gettingStarted/AppsScreenshots/Dice.png new file mode 100644 index 0000000000000000000000000000000000000000..f5421c83f45cf6a60ae90d662d4a693d1098f320 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Dice.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Heartrate.png b/doc/gettingStarted/AppsScreenshots/Heartrate.png new file mode 100644 index 0000000000000000000000000000000000000000..ed0470dcb6209aba0d3fe2b42006ab432fe66237 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Heartrate.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Maps.png b/doc/gettingStarted/AppsScreenshots/Maps.png new file mode 100644 index 0000000000000000000000000000000000000000..84e3ebef55937890914ecc77e34209677f9f6153 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Maps.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Metronome.png b/doc/gettingStarted/AppsScreenshots/Metronome.png new file mode 100644 index 0000000000000000000000000000000000000000..989fbfda9cd76f40e58a7f4f14a31742b7ecb711 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Metronome.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Music.png b/doc/gettingStarted/AppsScreenshots/Music.png new file mode 100644 index 0000000000000000000000000000000000000000..063603e7a14d87c98c8f19ada0c801a2ad2d0bd6 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Music.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Paint.png b/doc/gettingStarted/AppsScreenshots/Paint.png new file mode 100644 index 0000000000000000000000000000000000000000..147487f9fdf4ccd1cdbcf5d89791c411291b0ee6 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Paint.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Pong.png b/doc/gettingStarted/AppsScreenshots/Pong.png new file mode 100644 index 0000000000000000000000000000000000000000..08f739ef1aa1e649f0aa060126cf8e1b04c387fb Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Pong.png differ diff --git a/doc/gettingStarted/AppsScreenshots/Weather.png b/doc/gettingStarted/AppsScreenshots/Weather.png new file mode 100644 index 0000000000000000000000000000000000000000..89714aa46760ff10682d943630c074cbfc25247f Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/Weather.png differ diff --git a/doc/gettingStarted/AppsScreenshots/alarm.png b/doc/gettingStarted/AppsScreenshots/alarm.png new file mode 100644 index 0000000000000000000000000000000000000000..5d840e80c6b9d060f135baa19660902d48f53d06 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/alarm.png differ diff --git a/doc/gettingStarted/AppsScreenshots/steps.png b/doc/gettingStarted/AppsScreenshots/steps.png new file mode 100644 index 0000000000000000000000000000000000000000..1d7f5608f3fcb7c167b4323543177197895e3c4c Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/steps.png differ diff --git a/doc/gettingStarted/AppsScreenshots/stopwatch.png b/doc/gettingStarted/AppsScreenshots/stopwatch.png new file mode 100644 index 0000000000000000000000000000000000000000..19b34a5ac30e81ff09dc0eb33eec597d9f42a564 Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/stopwatch.png differ diff --git a/doc/gettingStarted/AppsScreenshots/timer.png b/doc/gettingStarted/AppsScreenshots/timer.png new file mode 100644 index 0000000000000000000000000000000000000000..a0d3babfda37fe6f2d5a22e462b5ed90230d44ff Binary files /dev/null and b/doc/gettingStarted/AppsScreenshots/timer.png differ diff --git a/doc/gettingStarted/Watchfaces/Analog.png b/doc/gettingStarted/Watchfaces/Analog.png new file mode 100644 index 0000000000000000000000000000000000000000..9e64e5aabbb1319e62dacd440f41327ca8602602 Binary files /dev/null and b/doc/gettingStarted/Watchfaces/Analog.png differ diff --git a/doc/gettingStarted/Watchfaces/CasioG7710.png b/doc/gettingStarted/Watchfaces/CasioG7710.png new file mode 100644 index 0000000000000000000000000000000000000000..b8a55cd5ecfef4c5e5a210ea40fbca7ea64a4578 Binary files /dev/null and b/doc/gettingStarted/Watchfaces/CasioG7710.png differ diff --git a/doc/gettingStarted/Watchfaces/Digital.png b/doc/gettingStarted/Watchfaces/Digital.png new file mode 100644 index 0000000000000000000000000000000000000000..242c9d5b0f6b82f2de22edff409997753e940bf5 Binary files /dev/null and b/doc/gettingStarted/Watchfaces/Digital.png differ diff --git a/doc/gettingStarted/Watchfaces/Infinineat.png b/doc/gettingStarted/Watchfaces/Infinineat.png new file mode 100644 index 0000000000000000000000000000000000000000..6b8cd614d5ef16e95cc946a44b92aa8eb574a794 Binary files /dev/null and b/doc/gettingStarted/Watchfaces/Infinineat.png differ diff --git a/doc/gettingStarted/Watchfaces/PineTimeStyle.png b/doc/gettingStarted/Watchfaces/PineTimeStyle.png new file mode 100644 index 0000000000000000000000000000000000000000..46f0b42b2d7b8bc1350d5b5b3c304eecb69234ae Binary files /dev/null and b/doc/gettingStarted/Watchfaces/PineTimeStyle.png differ diff --git a/doc/gettingStarted/Watchfaces/Terminal.png b/doc/gettingStarted/Watchfaces/Terminal.png new file mode 100644 index 0000000000000000000000000000000000000000..3f148c5fffdd91f3d024d35053bf1b12affceb82 Binary files /dev/null and b/doc/gettingStarted/Watchfaces/Terminal.png differ diff --git a/doc/gettingStarted/Watchfaces.md b/doc/gettingStarted/Watchfaces.md new file mode 100644 index 0000000000000000000000000000000000000000..9edff0bb51e0b069c27a1b3be430f47316ba67ee --- /dev/null +++ b/doc/gettingStarted/Watchfaces.md @@ -0,0 +1,31 @@ +# Watchfaces + +InfiniTime has 6 apps on the `main` branch at the time of writing. + +## List of apps +- Digital +- Analog +- PineTimeStyle +- Terminal +- Infinineat +- Casio G7710 + +### Digital + + +### Analog + + +### PineTimeStyle + + - You can long-press on the display to change colors, step style, and weather. + +### Terminal + + +### Infinineat + + - You can long-press on the display to change colors. + +### Casio G7710 + diff --git a/doc/gettingStarted/gadgetbridge0.jpg b/doc/gettingStarted/gadgetbridge0.jpg index 7ea2e3cd13c4d5d12fe99926bfa92a88b19803cc..2a0a295eadd5862736e35122969b983954788b53 100644 Binary files a/doc/gettingStarted/gadgetbridge0.jpg and b/doc/gettingStarted/gadgetbridge0.jpg differ diff --git a/doc/gettingStarted/gadgetbridge1.jpg b/doc/gettingStarted/gadgetbridge1.jpg index 470b0b3c1449520a946f30e8d28cf405a6eac402..20fa7d5a66bdfdf5d2dbc31e9af1cc54dc85e3da 100644 Binary files a/doc/gettingStarted/gadgetbridge1.jpg and b/doc/gettingStarted/gadgetbridge1.jpg differ diff --git a/doc/gettingStarted/gadgetbridge2.jpg b/doc/gettingStarted/gadgetbridge2.jpg index 8f75b232139698cfe1e93c2081c93ac161e4a60f..a03b071a82225c343602cb00590abcfdb80b5d82 100644 Binary files a/doc/gettingStarted/gadgetbridge2.jpg and b/doc/gettingStarted/gadgetbridge2.jpg differ diff --git a/doc/gettingStarted/gadgetbridge3.jpg b/doc/gettingStarted/gadgetbridge3.jpg index cfb83f521332c3a27dfd27c0c55c9e8bfeac659a..2e9bea34443b322a45047a7d47713522cb0510b7 100644 Binary files a/doc/gettingStarted/gadgetbridge3.jpg and b/doc/gettingStarted/gadgetbridge3.jpg differ diff --git a/doc/gettingStarted/gadgetbridge4.jpg b/doc/gettingStarted/gadgetbridge4.jpg index e41aff041fc4949f1fc194ec0f1c32a01732ef60..1b4210ca39b56ce35b0ae28eaf5c94885a5d1377 100644 Binary files a/doc/gettingStarted/gadgetbridge4.jpg and b/doc/gettingStarted/gadgetbridge4.jpg differ diff --git a/doc/gettingStarted/gadgetbridge5.jpg b/doc/gettingStarted/gadgetbridge5.jpg index 1ef9f779d6560f23426bca83a62ff0e01a926fee..15efb4d4ba88c01d0eb224dd430226eea4a1f369 100644 Binary files a/doc/gettingStarted/gadgetbridge5.jpg and b/doc/gettingStarted/gadgetbridge5.jpg differ diff --git a/doc/gettingStarted/gettingStarted-1.0.md b/doc/gettingStarted/gettingStarted-1.0.md index 5c607444f6f019f0b813a838d5e2df2247adbcf9..2c35f1c133f03c06f85a31bfd39ac0076ed05cdb 100644 --- a/doc/gettingStarted/gettingStarted-1.0.md +++ b/doc/gettingStarted/gettingStarted-1.0.md @@ -14,7 +14,7 @@ You can sync the time using companion apps. - Gadgetbridge automatically synchronizes the time when you connect it to your watch. More information on Gadgetbridge [here](/doc/gettingStarted/ota-gadgetbridge.md) - [Sync the time with NRFConnect](/doc/gettingStarted/time-nrfconnect.md) -- Sync the time with your browser https://hubmartin.github.io/WebBLEWatch/ +- [Sync the time with your browser](https://hubmartin.github.io/WebBLEWatch/) You can also set the time in the settings without a companion app. (version >1.7.0) @@ -46,7 +46,7 @@   - Swipe **up** to display the application menus. Apps (stopwatch, music, step, games,...) can be started from this menu. -- Swipe **down** to display the notification panel. Notification sent by your companion app will be displayed here. +- Swipe **down** to display the notification panel. Notifications sent by your companion app will be displayed here. - Swipe **right** to display the Quick Actions menu. This menu allows you to - Set the brightness of the display - Start the **flashlight** app diff --git a/doc/gettingStarted/ota-gadgetbridge.md b/doc/gettingStarted/ota-gadgetbridge.md index fe26c03b6e4273606deb523fdfb9fa174aed6fbd..76f9914598ee144675036e45f2e6daadb168014e 100644 --- a/doc/gettingStarted/ota-gadgetbridge.md +++ b/doc/gettingStarted/ota-gadgetbridge.md @@ -1,29 +1,35 @@ # Connecting to Gadgetbridge -Launch Gadgetbridge and tap on the **"+"** button on the bottom right to add a new device: +Launch Gadgetbridge and tap on the menu button in the top left:  -Wait for the scan to complete, your PineTime should be detected: +Press the "Connect new device" button:  +Your PineTime should appear on the list. Tap on it. + Tap on it. Gadgdetbridge will pair and connect to your device:  # Updating with Gadgetbridge -Now that Gadgetbridge is connected to your PineTime, use a file browser application and find the DFU file (`pinetime-mcuboot-app-dfu-x.x.x.zip`) you downloaded previously. Tap on it and open it using the Gadgetbridge application/firmware installer: +Now that Gadgetbridge is connected to your PineTime, press the three dots on the device card:  -Read the warning carefully and tap **Install**: +Now press the "File Installer" button:  -Wait for the transfer to finish. Your PineTime should reset and reboot with the new version of InfiniTime! +Select the firmware you downloaded (`pinetime-mcuboot-app-dfu-x.x.x.zip`) from the [Releases tab](https://github.com/InfiniTimeOrg/InfiniTime/releases/latest): -Don't forget to **validate** your firmware. In the InfiniTime go to the settings (swipe right, select gear icon) and Firmware option and click **validate**. Otherwise after reboot the previous firmware will be used. + - +Wait for the transfer to finish. There will be a progress bar on both the watch and the phone. Your PineTime should reboot with the new version of InfiniTime! + +Don't forget to **validate** your firmware. In the InfiniTime go to the settings (swipe right, select gear icon) and scroll to the Firmware option and click **validate**. Otherwise, after reboot the previous firmware will be used. + + diff --git a/doc/gettingStarted/updating-software.md b/doc/gettingStarted/updating-software.md index 2b5d5d9231050c75a4851d47deb12475fec089cc..951499758ea0d840ec175cdf99add0393bc21868 100644 --- a/doc/gettingStarted/updating-software.md +++ b/doc/gettingStarted/updating-software.md @@ -6,7 +6,7 @@ ## Checking the version of InfiniTime You can check the InfiniTime version by first swiping right on the watch face to open quick settings, tapping the cogwheel to open settings, swipe up until you find an entry named "About" and tap on it. - + PineTimes shipped after June 2021 will ship with the latest version of [the bootloader](https://github.com/JF002/pinetime-mcuboot-bootloader/releases/tag/1.0.0) and [recovery firmware](https://github.com/InfiniTimeOrg/InfiniTime/releases/tag/0.14.1) @@ -49,7 +49,7 @@ Resources are packaged into a single .zip file named `infinitime-resources-x.y.z.zip` (where `x`, `y` and `z` are the version numbers of InfiniTime). You can use the companion app of your choice to flash the resources. -**Note : at the time of writing this page, [Amazfish](https://github.com/piggz/harbour-amazfish) and [ITD](https://gitea.arsenm.dev/Arsen6331/itd) have already integrated this functionality. Other companion apps will hopefully implement it soon!* +**Note: at the time of writing this page, [Amazfish](https://github.com/piggz/harbour-amazfish) and [ITD](https://gitea.arsenm.dev/Arsen6331/itd) have already integrated this functionality. Other companion apps will hopefully implement it soon!* ## Amazfish Use the `Download file` functionality of Amazfish. diff --git a/doc/gettingStarted/validate.png b/doc/gettingStarted/validate.png new file mode 100644 index 0000000000000000000000000000000000000000..a6f3286b63325d1855945aa864dd20b83a950aff Binary files /dev/null and b/doc/gettingStarted/validate.png differ diff --git a/doc/gettingStarted/version.png b/doc/gettingStarted/version.png new file mode 100644 index 0000000000000000000000000000000000000000..89f505a32566e174840f54fa9d1375e4ae1f5bfd Binary files /dev/null and b/doc/gettingStarted/version.png differ