1
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 20:49:49 +04:00

fix: remove not printable symbols and update FAQ and BadUSB documentation links for clarity

This commit improves the documentation by converting raw URLs into descriptive text links in the FAQ and BadUSB documentation. This enhances readability and navigation for users looking for specific information. Additionally, minor formatting adjustments were made for better consistency and clarity.
This commit is contained in:
DerSkythe
2024-07-24 18:39:47 +04:00
parent 72af00ecc1
commit 4ed19b518b
10 changed files with 464 additions and 434 deletions

View File

@@ -1,10 +1,13 @@
# Firmware update on Developer Board {#dev_board_fw_update}
It's important to regularly update your Developer Board to ensure that you have access to the latest features and bug fixes. This tutorial will guide you through the necessary steps to update the firmware of your Developer Board.
> [!IMPORTANT]
>
> It's important to regularly update your Developer Board to ensure that you have access to the latest features and bug fixes.
> This tutorial will guide you through the necessary steps to update the firmware of your Developer Board.
This tutorial assumes that you're familiar with the basics of the command line. If youre not, please refer to the [Windows](https://www.digitalcitizen.life/command-prompt-how-use-basic-commands/) or [MacOS/Linux](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) command line tutorials.
This tutorial assumes that you're familiar with the basics of the command line.
***
If youre not, please refer to the [Windows](https://www.digitalcitizen.life/command-prompt-how-use-basic-commands/) or [MacOS / Linux](https://ubuntu.com/tutorials/command-line-for-beginners#1-overview) command line tutorials.
## Installing the micro Flipper Build Tool
@@ -14,20 +17,18 @@ Install uFBT on your computer by running the following command in the Terminal:
**For Linux & macOS:**
```text
```bash
python3 -m pip install --upgrade ufbt
```
**For Windows:**
```text
py -m pip install --upgrade ufbt
```powershell
python -m pip install --upgrade ufbt
```
If you want to learn more about uFBT, visit [the project's page](https://pypi.org/project/ufbt/).
***
## Connecting the Developer Board to your computer
1. List all of the serial devices on your computer.
@@ -38,49 +39,38 @@ If you want to learn more about uFBT, visit [the project's page](https://pypi.or
**macOS**
On macOS, you can run the following command in the Terminal:
```text
On macOS, you can run the following command in the Terminal:
```bash
ls /dev/cu.*
```
**Linux**
On Linux, you can run the following command in the Terminal:
On Linux, you can run the following command in the Terminal:
```text
ls /dev/tty*
```
View the devices in the list.
2. Connect the Developer Board to your computer using a USB-C cable.
![The Developer Board in Wired mode](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/Aq7gfMI-m_5H6sGGjwb4I_monosnap-miro-2023-07-19-19-47-39.jpg)
3. Switch your Developer Board to Bootloader mode:
3.1. Press and hold the **BOOT** button.
3.2. Press the **RESET** button while holding the **BOOT** button.
3.3. Release the **BOOT** button.\
3.3. Release the **BOOT** button.
![You can easily switch the Dev Board to Bootloader mode](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/KynP9iT6sJ3mXLaLyI82__image.png)
4. Repeat Step 1 and view the name of your Developer Board that appeared in the list.
For example, on macOS:
```text
```shell
/dev/cu.usbmodem01
```
***
## Flashing the firmware
To flash the firmware onto your Developer Board, run the following command in the terminal:
```text
```shell
python3 -m ufbt devboard_flash
```
@@ -90,33 +80,26 @@ You should see the following message: `WiFi board flashed successfully`.
If you get an error message during the flashing process, such as this:
```text
```shell
A fatal error occurred: Serial data stream stopped: Possible serial noise or corruption.
```
Or this:
```text
```shell
FileNotFoundError: [Errno 2] No such file or directory: '/dev/cu.usbmodem01'
```
Try doing the following:
* Disconnect the Developer Board from your computer, then reconnect it.
* Use a different USB port on your computer.
* Use a different USB-C cable.
***
## Finishing the installation
After flashing the firmware:
1. Reboot the Developer Board by pressing the **RESET** button.
![Reset the Developer Board](https://archbee-image-uploads.s3.amazonaws.com/3StCFqarJkJQZV-7N79yY/rcQeKARgrVwa51tLoo-qY_monosnap-miro-2023-07-20-18-29-33.jpg)
2. Disconnect and reconnect the USB-C cable.
The Developer Board should appear as a serial device on your computer. Now, you can use it with the Black Magic Debug client of your choice.