Fix typo in buildAndProgram.md.
Add documentation about companion apps + link to videos.
This commit is contained in:
		
							parent
							
								
									142f25f06f
								
							
						
					
					
						commit
						8254622af5
					
				
							
								
								
									
										10
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								README.md
									
									
									
									
									
								
							@ -44,6 +44,9 @@ As of now, here is the list of achievements of this project:
 | 
				
			|||||||
 
 | 
					 
 | 
				
			||||||
## Documentation
 | 
					## Documentation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Develop
 | 
				
			||||||
 | 
					 - [Generate the fonts and symbols](src/DisplayApp/Fonts/Readme.md)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Build, flash and debug
 | 
					### Build, flash and debug
 | 
				
			||||||
 - [Project branches](doc/branches.md)
 | 
					 - [Project branches](doc/branches.md)
 | 
				
			||||||
 - [Versioning](doc/versioning.md)
 | 
					 - [Versioning](doc/versioning.md)
 | 
				
			||||||
@ -64,10 +67,9 @@ As of now, here is the list of achievements of this project:
 | 
				
			|||||||
 - [Memory analysis](./doc/MemoryAnalysis.md)
 | 
					 - [Memory analysis](./doc/MemoryAnalysis.md)
 | 
				
			||||||
 
 | 
					 
 | 
				
			||||||
### Using the firmware
 | 
					### Using the firmware
 | 
				
			||||||
 - Integration with Gadgetbridge
 | 
					 - [Integration with Gadgetbridge](doc/CompanionApps/Gadgetbridge.md)
 | 
				
			||||||
 - Integration with AmazFish
 | 
					 - [Integration with AmazFish](doc/CompanionApps/Amazfish.md)
 | 
				
			||||||
 - Integration with NRFConnect
 | 
					 - [Firmware update, OTA](doc/CompanionApps/NrfconnectOTA.md)
 | 
				
			||||||
 - Firmware update, OTA
 | 
					 | 
				
			||||||
 
 | 
					 
 | 
				
			||||||
    
 | 
					    
 | 
				
			||||||
## TODO - contribute
 | 
					## TODO - contribute
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										15
									
								
								doc/CompanionApps/Amazfish.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										15
									
								
								doc/CompanionApps/Amazfish.md
									
									
									
									
									
										Normal file
									
								
							@ -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.
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
							
								
								
									
										13
									
								
								doc/CompanionApps/Gadgetbridge.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								doc/CompanionApps/Gadgetbridge.md
									
									
									
									
									
										Normal file
									
								
							@ -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 ongoing in a [feature branch](https://codeberg.org/Freeyourgadget/Gadgetbridge/src/branch/pinetime-jf).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 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.
 | 
				
			||||||
							
								
								
									
										12
									
								
								doc/CompanionApps/NrfconnectOTA.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								doc/CompanionApps/NrfconnectOTA.md
									
									
									
									
									
										Normal file
									
								
							@ -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.
 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user