Author: Avamander <avamander@gmail.com>
Renamed documentation folder for consistency
| 0 | 0 | 0
diff --git a/doc/CompanionApps/Amazfish.md b/doc/CompanionApps/Amazfish.md deleted file mode 100644 index eb9daa044b3ea3e1d31b012f9573b61ba21490ca..0000000000000000000000000000000000000000 --- a/doc/CompanionApps/Amazfish.md +++ /dev/null @@ -1,15 +0,0 @@ -# Amazfish -[Amazfish](https://openrepos.net/content/piggz/amazfish) is a companion app that supports many smartwatches and activity trackers running on [SailfishOS](https://sailfishos.org/). - -## Features -The following features are implemented: - - Scanning & detection of Pinetime-JF / InfiniTime - - Connection / disconnection - - Time synchronization - - Notifications - - Music control - -## Demo -[This video](https://seafile.codingfield.com/f/21c5d023452740279e36/) shows how to connect to the Pinetime and control the playback of the music on the phone. -Amazfish and Sailfish OS are running on the [Pinephone](https://www.pine64.org/pinephone/), another awesome device from Pine64. - \ No newline at end of file diff --git a/doc/CompanionApps/Gadgetbridge.md b/doc/CompanionApps/Gadgetbridge.md deleted file mode 100644 index 1a25069c30bbc805e6c4ddd2f5f4580ec22371d2..0000000000000000000000000000000000000000 --- a/doc/CompanionApps/Gadgetbridge.md +++ /dev/null @@ -1,13 +0,0 @@ -# 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/). - -## 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. diff --git a/doc/CompanionApps/NrfconnectOTA.md b/doc/CompanionApps/NrfconnectOTA.md deleted file mode 100644 index 0fa3cd037c7c5468760142569c40269ee2c4e57b..0000000000000000000000000000000000000000 --- a/doc/CompanionApps/NrfconnectOTA.md +++ /dev/null @@ -1,12 +0,0 @@ -# OTA using NRFConnect -[NRFConnect](https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-Connect-for-mobile) is a powerful application (running on Android and iOS) which allows to scan and connect to BLE devices. - -## Features - - Scanning, connect, disconnect - - Time synchronization - - OTA - -InfiniTime implements the Nordic DFU protocol for the OTA functionality. NRFConnect also supports this protocol. - -# Demo -[This video](https://seafile.codingfield.com/f/a52b69683a05472a90c7/) shows how to use NRFConnect to update the firmware running on the Pinetime. \ No newline at end of file diff --git a/doc/CompanionApps/firmwareNoValidated.jpg b/doc/CompanionApps/firmwareNoValidated.jpg deleted file mode 100644 index 28df7eaa8497ef58ae4d057afbd2bdb27bcdb7cb..0000000000000000000000000000000000000000 Binary files a/doc/CompanionApps/firmwareNoValidated.jpg and /dev/null differ diff --git a/doc/CompanionApps/firmwareValidated.jpg b/doc/CompanionApps/firmwareValidated.jpg deleted file mode 100644 index 0d6f99b5b900879016f7e4940a3775ef12ee2e01..0000000000000000000000000000000000000000 Binary files a/doc/CompanionApps/firmwareValidated.jpg and /dev/null differ diff --git a/doc/CompanionApps/firmwareValidationApp.jpg b/doc/CompanionApps/firmwareValidationApp.jpg deleted file mode 100644 index d78ad0c1331ec039ca6a627dc15db615bac2da57..0000000000000000000000000000000000000000 Binary files a/doc/CompanionApps/firmwareValidationApp.jpg and /dev/null differ diff --git a/doc/companionapps/Amazfish.md b/doc/companionapps/Amazfish.md new file mode 100644 index 0000000000000000000000000000000000000000..eb9daa044b3ea3e1d31b012f9573b61ba21490ca --- /dev/null +++ b/doc/companionapps/Amazfish.md @@ -0,0 +1,15 @@ +# Amazfish +[Amazfish](https://openrepos.net/content/piggz/amazfish) is a companion app that supports many smartwatches and activity trackers running on [SailfishOS](https://sailfishos.org/). + +## Features +The following features are implemented: + - Scanning & detection of Pinetime-JF / InfiniTime + - Connection / disconnection + - Time synchronization + - Notifications + - Music control + +## Demo +[This video](https://seafile.codingfield.com/f/21c5d023452740279e36/) shows how to connect to the Pinetime and control the playback of the music on the phone. +Amazfish and Sailfish OS are running on the [Pinephone](https://www.pine64.org/pinephone/), another awesome device from Pine64. + \ No newline at end of file diff --git a/doc/companionapps/Gadgetbridge.md b/doc/companionapps/Gadgetbridge.md new file mode 100644 index 0000000000000000000000000000000000000000..1a25069c30bbc805e6c4ddd2f5f4580ec22371d2 --- /dev/null +++ b/doc/companionapps/Gadgetbridge.md @@ -0,0 +1,13 @@ +# 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/). + +## 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. diff --git a/doc/companionapps/NrfconnectOTA.md b/doc/companionapps/NrfconnectOTA.md new file mode 100644 index 0000000000000000000000000000000000000000..0fa3cd037c7c5468760142569c40269ee2c4e57b --- /dev/null +++ b/doc/companionapps/NrfconnectOTA.md @@ -0,0 +1,12 @@ +# OTA using NRFConnect +[NRFConnect](https://www.nordicsemi.com/Software-and-tools/Development-Tools/nRF-Connect-for-mobile) is a powerful application (running on Android and iOS) which allows to scan and connect to BLE devices. + +## Features + - Scanning, connect, disconnect + - Time synchronization + - OTA + +InfiniTime implements the Nordic DFU protocol for the OTA functionality. NRFConnect also supports this protocol. + +# Demo +[This video](https://seafile.codingfield.com/f/a52b69683a05472a90c7/) shows how to use NRFConnect to update the firmware running on the Pinetime. \ No newline at end of file diff --git a/doc/companionapps/firmwareNoValidated.jpg b/doc/companionapps/firmwareNoValidated.jpg new file mode 100644 index 0000000000000000000000000000000000000000..28df7eaa8497ef58ae4d057afbd2bdb27bcdb7cb Binary files /dev/null and b/doc/companionapps/firmwareNoValidated.jpg differ diff --git a/doc/companionapps/firmwareValidated.jpg b/doc/companionapps/firmwareValidated.jpg new file mode 100644 index 0000000000000000000000000000000000000000..0d6f99b5b900879016f7e4940a3775ef12ee2e01 Binary files /dev/null and b/doc/companionapps/firmwareValidated.jpg differ diff --git a/doc/companionapps/firmwareValidationApp.jpg b/doc/companionapps/firmwareValidationApp.jpg new file mode 100644 index 0000000000000000000000000000000000000000..d78ad0c1331ec039ca6a627dc15db615bac2da57 Binary files /dev/null and b/doc/companionapps/firmwareValidationApp.jpg differ