Skip to content

Doc improvements #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
josancamon19 merged 2 commits into from
May 17, 2024
+2 −2
Merged

Doc improvements #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
334a8bc
Clarification on where to find pre-built firmware
ebariaux May 17, 2024
6f951c6
Clarification on notifications for battery level
ebariaux May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_assembly/Install_firmware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you purchased an unassembled Friend device or built it yourself using our har
Important: If you purchased an assembled device please skip this step


SKIP and INSTALL PRE-BUILT FIRMWARE: We have uploaded a [build of the firmware](https://github.com/BasedHardware/Friend/tree/main/firmware/firmware_v1.5/Release) that will always contain the most up to date build of the firmware. Currently, we use .pcm (so choose that) but the goal is to implement opus firmware (please help if you can). To use this firmware, simply download it and skip to step 6. If you would like to build the firmware yourself please follow all the steps below.
SKIP and INSTALL PRE-BUILT FIRMWARE: Looking into the git repository, in the [firmware](https://github.com/BasedHardware/Friend/tree/main/firmware) folder, under the desired version, you'll find pre-built firmwares in the Release folder. For now, the safe bet is to use the pcm firmware, but the goal is to implement opus firmware (please help if you can). To use this firmware, simply download it and skip to step 6. If you would like to build the firmware yourself please follow all the steps below.

1. Set up nRF Connect by following the tutorial in this video: [https://youtu.be/EAJdOqsL9m8](https://youtu.be/EAJdOqsL9m8)

Expand Down
2 changes: 1 addition & 1 deletion docs/_developer/Protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Friend wearable device implements 2 services:
### the standard BLE [Battery Service](https://www.bluetooth.com/specifications/specs/battery-service)

The service uses the official UUID of 0x180F and exposes the standard Battery Level characteristic with UUID 0x2A19.
The characteristic supports notification but it seems the current firmware does not update the battery level after initial device start.
The characteristic supports notification to provide regulat updates of the level (this does not work with firmware 1.0 and requires at least v1.5).

### one BLE service to stream the audio data to the app

Expand Down