|
2 | 2 |
|
3 | 3 | [OpenEarable](openearable.com) is the world's first fully open-source AI platform for ear-based sensing applications with true wireless audio. Packed with an unprecedented array of high-precision sensors, OpenEarable redefines what's possible in wearable tech. Designed for both development and research applications, OpenEarable is modular, reconfigurable, and built for the future. |
4 | 4 | <br/><br/><br/> |
5 | | - |
| 5 | +<img width="1323" height="568" alt="image" src="https://github.com/user-attachments/assets/ab4e2b0e-9645-4428-975f-466c7ef2f13b" /> |
| 6 | + |
6 | 7 |
|
7 | 8 | ## Table of Contents |
8 | 9 |
|
|
63 | 64 | - Do not set any of the FOTA flags described above. |
64 | 65 |
|
65 | 66 | 9. **J-Link Setup** |
66 | | - - Wire your J-Link to the debugging breakout PCB as shown below. |
67 | | -  |
68 | | - - If you do not own a J-Link yet, here are a few options (do **NOT** use J-Link clones, they will not work and are illegal!): |
69 | | - - [J-Link EDU Mini](https://mou.sr/3LrwiVe) (available to educational institutions, private persons, and students) with [JTAG adapter](https://www.adafruit.com/product/2094) and [cable](https://www.adafruit.com/product/1675). |
70 | | - - Full-scale J-Link for commercial use (e.g., [J-Link BASE Compact](https://mou.sr/4oQkAls)). |
71 | | - - ⚠️ The wiring show in the figure above is for the full-scale J-Link pinout. If you use the [JTAG adapter](https://www.adafruit.com/product/2094) the wiring may be different so make sure it is correct in your case! _(to be confirmed, picture coming soon)_. |
72 | | - |
73 | | - |
74 | | -10. **Build and Flash** |
| 67 | + - Wire your J-Link to the debugging breakout PCB as shown below. |
| 68 | +  |
| 69 | + - If you do not own a J-Link yet, here are a few options (do **NOT** use J-Link clones, they will not work and are illegal!): |
| 70 | + - [J-Link EDU Mini](https://mou.sr/3LrwiVe) (available to educational institutions, private persons, and students) with [JTAG adapter](https://www.adafruit.com/product/2094) and [cable](https://www.adafruit.com/product/1675). |
| 71 | + - Full-scale J-Link for commercial use (e.g., [J-Link BASE Compact](https://mou.sr/4oQkAls)). |
| 72 | + - ⚠️ The wiring show in the figure above is for the full-scale J-Link pinout. If you use the [JTAG adapter](https://www.adafruit.com/product/2094) the wiring may be different so make sure it is correct in your case!. |
| 73 | + |
| 74 | +11. **Build and Flash** |
75 | 75 | - Click on `Generate and Build` and wait for the application to build (this will take some time) |
76 | 76 | - Make sure your device is charged or powered via USB. If the battery is fully discharged, the charging management IC will no longer supply power to the MCU from the battery, so you won’t be able to flash the MCU unless the battery is charged or the device is directly powered via USB. |
77 | 77 | - Open a new terminal in VS Code and run the following command from the root of the `open-earable-v2` directory to flash the FOTA build. Make sure to set the serial number of your J-Link (right click your J-Link in the `CONNECTED DEVICES` tab of the nRF connect extension and copy the serial number). |
78 | | - ```bash |
79 | | - # --right for the right ear device, or no flag to retain left/right bonding |
80 | | - # --hw version is optional and can only be used with --left or --right |
81 | | - ./tools/flash/flash_fota.sh --snr 123456789 --left --hw 2.0.1 |
82 | | - |
83 | | - ``` |
| 78 | + ```bash |
| 79 | + # --right for the right ear device, or no flag to retain left/right bonding, --standalone for no pair |
| 80 | + # --hw version is optional and can only be used with --left or --right |
| 81 | + ./tools/flash/flash_fota.sh --snr 123456789 --left --hw 2.0.1 |
| 82 | + ``` |
| 83 | + |
84 | 84 | - or without FOTA |
85 | | - ```bash |
86 | | - # --right for the right ear device, or no flag to retain left/right bonding |
87 | | - # --hw version is optional and can only be used with --left or --right |
88 | | - ./tools/flash/flash.sh --snr 123456789 --left --hw 2.0.1 |
89 | | - ``` |
| 85 | + ```bash |
| 86 | + # --right for the right ear device, or no flag to retain left/right bonding, --standalone for no pair |
| 87 | + # --hw version is optional and can only be used with --left or --right |
| 88 | + |
| 89 | + ./tools/flash/flash.sh --snr 123456789 --left |
| 90 | + ``` |
| 91 | + |
90 | 92 | - The FOTA update script is also available for Windows as `./tools/flash/flash_fota.ps1`. To execute it, open PowerShell with administrative privileges. |
91 | 93 |
|
92 | 94 | 11. **Recover Board** |
93 | | -- If the application or network core becomes unresponsive, or you encounter flashing issues, you can recover the board using the recovery script. The `--snr` parameter specifies the serial number of your J-Link debugger. |
94 | | -- Ensure the device is powered via USB or that the battery is sufficiently charged before running the recovery process. Otherwise, the MCU may not power up correctly and the recovery will fail. |
95 | | - ```bash |
96 | | - ./tools/flash/recover.sh --snr 123456789 |
97 | | - ``` |
98 | | -- After successful recovery, you can attempt to flash the firmware again (you will have to restore left/right bonding and hardware version). |
| 95 | + - If the application or network core becomes unresponsive, or you encounter flashing issues, you can recover the board using the recovery script. The `--snr` parameter specifies the serial number of your J-Link debugger. |
| 96 | + - Ensure the device is powered via USB or that the battery is sufficiently charged before running the recovery process. Otherwise, the MCU may not power up correctly and the recovery will fail. |
| 97 | + ```bash |
| 98 | + ./tools/flash/recover.sh --snr 123456789 |
| 99 | + ``` |
| 100 | + - After successful recovery, you can attempt to flash the firmware again. |
99 | 101 |
|
100 | 102 | 12. **Enable Debug Output** |
101 | | -- Open the **J-Link Configuration** program on your computer. |
102 | | - - On macOS: Press `CMD` + `Space` and search for `J-Link Config`. |
103 | | - - On Windows: Search for the program from the taskbar. |
104 | | -- Ensure your J-Link is connected to your computer. |
105 | | -- In the **Connected via USB** table, locate your J-Link device. Double-click it or right-click and select **Configure**. |
106 | | -- Find the **Virtual COM-Port** option and select **Enable**. Click **OK** to apply the setting. |
107 | | -- Open **Visual Studio Code**. |
108 | | -- In the left sidebar, open the **Extensions** menu. |
109 | | -- Search for and install the [**Serial Monitor**](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor) extension. |
110 | | -- In the top menu bar, click **Terminal → New Terminal**. |
111 | | -- A terminal window will appear at the bottom of VS Code. Open the **Serial Monitor** tab. |
112 | | -- In the **Port** dropdown menu, select your J-Link’s COM port. |
113 | | -- Set the **Baud rate** to **115200**. |
114 | | -- Click **Start Monitoring**. |
115 | | -- Ensure your earable is connected to the debugger probe. You should now see debug output appearing when you interact with the device (e.g., press button). |
| 103 | + - Open the **J-Link Configuration** program on your computer. |
| 104 | + - On macOS: Press `CMD` + `Space` and search for `J-Link Config`. |
| 105 | + - On Windows: Search for the program from the taskbar. |
| 106 | + - Ensure your J-Link is connected to your computer. |
| 107 | + - In the **Connected via USB** table, locate your J-Link device. Double-click it or right-click and select **Configure**. |
| 108 | + - Find the **Virtual COM-Port** option and select **Enable**. Click **OK** to apply the setting. |
| 109 | + - Open **Visual Studio Code**. |
| 110 | + - In the left sidebar, open the **Extensions** menu. |
| 111 | + - Search for and install the [**Serial Monitor**](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor) extension. |
| 112 | + - In the top menu bar, click **Terminal → New Terminal**. |
| 113 | + - A terminal window will appear at the bottom of VS Code. Open the **Serial Monitor** tab. |
| 114 | + - In the **Port** dropdown menu, select your J-Link’s COM port. |
| 115 | + - Set the **Baud rate** to **115200**. |
| 116 | + - Click **Start Monitoring**. |
| 117 | + - Ensure your earable is connected to the debugger probe. You should now see debug output appearing when you interact with the device (e.g., press button). |
| 118 | + |
| 119 | +13. **Recover Board** |
| 120 | + - If the application or network core becomes unresponsive, or you encounter flashing issues, you can recover the board using the recovery script. The `--snr` parameter specifies the serial number of your J-Link debugger. |
| 121 | + - Ensure the device is powered via USB or that the battery is sufficiently charged before running the recovery process. Otherwise, the MCU may not power up correctly and the recovery will fail. |
| 122 | + ```bash |
| 123 | + ./tools/flash/recover.sh --snr 123456789 |
| 124 | + ``` |
| 125 | + - After successful recovery, you can attempt to flash the firmware again (you will have to restore left/right bonding and hardware version). |
116 | 126 |
|
117 | 127 |
|
118 | 128 |
|
|
0 commit comments