mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 20:49:49 +04:00
Code Issues Activity

Update Get started with the Dev Board.md

Browse Source 
Signed-off-by: DerSkythe <31771569+derskythe@users.noreply.github.com>
This commit is contained in:
DerSkythe
2024-07-24 18:47:36 +04:00
committed by GitHub
parent 4ed19b518b
commit 4b4e9cab8b
1 changed files with 16 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
documentation/devboard/Get started with the Dev Board.md
View File

@@ -2,7 +2,8 @@
The Wi-Fi Developer Board serves as a tool to debug the Flipper Zero firmware. To debug the firmware, the initial step involves compiling the firmware from its source code. This process enables the debugging functionality within the firmware and generates all the necessary files required for debugging purposes.
> [!IMPORTANT]
> [!IMPORTANT]
>
> Building and debugging the Flipper Zero firmware is fully supported on MacOS and Linux.
> Support for Windows is in beta test.
@@ -55,7 +56,8 @@ Then, run the **Flipper Build Tool** (FBT) to build the firmware:
The Developer Board can work in the **Wired** mode and two **Wireless** modes: **Wi-Fi access point (AP)** mode and **Wi-Fi client (STA)** mode. The Wired mode is the simplest to set up, but requires a USB Type-C cable. The Wireless modes are more complex to set up, but they allow you to debug your Flipper Zero wirelessly.
> [!TIP]
> [!TIP]
>
> Use the following credentials when connecting to the Developer Board in **Wi-Fi access point** mode:
> Name: **blackmagic**
> Password: **iamwitcher**
@@ -88,12 +90,15 @@ To connect the Developer Board in **Wired** mode, do the following:
4. Rerun the command. Two new devices have to appear: this is the Developer Board.
> [!NOTE]
> [!NOTE]
>
> If the Developer Board doesn't appear in the list of devices, try using a different cable, USB port, or computer.
<br />
> [!IMPORTANT] Flipper Zero logs can only be viewed when the Developer Board is connected via USB.
> [!IMPORTANT]
>
> Flipper Zero logs can only be viewed when the Developer Board is connected via USB.
> The option to view logs over Wi-Fi will be added in future updates.
> For more information, visit [Reading logs via the Dev Board](https://docs.flipperzero.one/development/hardware/wifi-debugger-module/reading-logs).
@@ -110,14 +115,10 @@ Out of the box, the Developer Board is configured to work as a **Wi-Fi access po
To connect the Developer Board in **Wi-Fi access point** mode, do the following:
1. Cold-plug the Developer Board by turning off your Flipper Zero and connecting the Developer Board, and then turning it back on.
2. Open Wi-Fi settings on your client device (phone, laptop, or other).
3. Connect to the network:
* Name: `blackmagic`
* Password: `iamwitcher`
4. To configure the Developer Board, open a browser and go to `http://192.168.4.1`.
### Wi-Fi client (STA) mode
@@ -127,13 +128,9 @@ To connect the Developer Board in **Wi-Fi access point** mode, do the following:
To connect the Developer Board in **Wi-Fi client** mode, you need to configure it to connect to your Wi-Fi network by doing the following:
1. Cold-plug the Developer Board by turning off your Flipper Zero and connecting the Developer Board, and then turning it back on.
2. Connect to the Developer Board in **Wi-Fi access point** mode.
3. In a browser, go to the configuration page on `http://192.168.4.1`.
4. Select the **STA** mode and enter your network's **SSID** (name) and **password**. For convenience, you can click the **+** button to see the list of nearby networks.
5. Save the configuration and reboot the Developer Board.
![In the Wi-Fi tab, you can set the Developer Board mode](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/klbLVj8lz2bEvm7j4wRaj_monosnap-miro-2023-06-23-13-06-32.jpg)
@@ -144,8 +141,6 @@ After connecting to your debugger via [http://blackmagic.local](http://blackmagi
![In the SYS tab, you can view the IP address of your Developer Board](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/5XbUptlfqzlV0p6hRUqiG_monosnap-miro-2023-06-22-18-11-30.jpg)
***
## Debugging the firmware
Open the **Terminal** in the `flipperzero-firmware` directory that you cloned earlier and run the following command:
@@ -159,16 +154,16 @@ This will upload the firmware you've just built to your Flipper Zero via the Dev
To debug in **VSCode**, do the following:
1. In VSCode, open the `flipperzero-firmware` directory.
2. You should see a notification about recommended extensions. Install them.
> [!TIP] If there were no notifications, open the `Extensions` tab, enter `@recommended` in the search bar, and install the workspace recommendations.
> [!TIP]
>
> If there were no notifications, open the `Extensions` tab,
> enter `@recommended` in the search bar,
> and install the workspace recommendations.
>
3. In the **Terminal**, run the `./fbt vscode_dist` command. This will generate the VSCode configuration files needed for debugging.
4. In VSCode, open the **Run and Debug** tab and select **Attach FW (blackmagic)** from the dropdown menu.
5. If needed, flash your Flipper Zero with the `./fbt flash` command, then click the **Play** button in the debug sidebar to start the debugging session.
6. Note that starting a debug session halts the execution of the firmware, so you'll need to click the **Continue** button on the toolbar at the top of your VSCode window to continue execution.
![Click Continue in the toolbar to continue execution of the firmware](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/lp8ygGaZ3DvWD3OSI9yGO_monosnap-miro-2023-06-23-17-58-09.jpg)
@@ -176,5 +171,4 @@ To debug in **VSCode**, do the following:
To learn about debugging, visit the following pages:
* [Debugging with GDB](https://sourceware.org/gdb/current/onlinedocs/gdb.pdf)
* [Debugging in VS Code](https://code.visualstudio.com/docs/editor/debugging)
* [Debugging in VSCode](https://code.visualstudio.com/docs/editor/debugging)