Skip to content

Commit

Permalink
Merge pull request #33 from Kyobinoyo/kyo-guides
Browse files Browse the repository at this point in the history
Updated "How to flash the firmware" and "How to Update"
  • Loading branch information
Kyobinoyo committed Feb 2, 2024
2 parents 3be24cd + 4fad6eb commit 0bafc5d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
17 changes: 17 additions & 0 deletions docs/guides/openshock-how-to-flash-your-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@
- A Chromium based browser like Google Chrome for example. **Firefox will not work since it doesn't support Web Serial**
- A flash tool like [ESP Tool](https://espressif.github.io/esptool-js/)
- The newest [Openshock firmware](https://github.com/OpenShock/Firmware/releases), make sure you download the firmware that is made for your kind of board.
- (Optional) [CP210x Universal Windows Driver](https://download.openshock.org/drivers/CP210x_Universal_Windows_Driver.zip)

!!! warning "Important"
Make sure you have a cable that supports data transfer.
Make sure your cable is not damaged.
Make sure your USB port is not damaged.

## Connecting the Device to the PC
1. Connect your Device via USB cable to your PC, make sure you use a cable that allows data transfer.
2. Open the Device-Manager in windows and make sure it is connected and has a Driver installed.
3. If your Devices shows up with a yellow exclamation mark:
1. Download the [CP210x Universal Windows Driver](https://download.openshock.org/drivers/CP210x_Universal_Windows_Driver.zip) and unzip it.
2. In the Device-Manager, right click your Device and select "Update Driver".
3. Select "Browse my PC for Drivers"
4. Select the folder of the downloaded driver and proceed.
5. It should now work
4. If your Device shows up normally in the Device-Manager proceed with the next step.

## Flashing the firmware
1. Plug your Device into your PC using a USB cable.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/openshock-how-to-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [Shocklink account](https://shocklink.net/)
- **Firmware 1.1.0 or newer**

### Using Over the Air Update (Recommended)
## Over the Air Update (Recommended)
1. Login to the [website](https://shocklink.net/)
2. Connect your Device to a power source and make sure it appears as Online in the Device section.
3. Open the context menu of your Device.
Expand All @@ -23,7 +23,7 @@ After it's done it should restart your Device and everything should just work™
If the update is not successful the updater will not overwrite anything and your Device should just stay on the old version.
Ask on the [Discord](https://discord.gg/OpenShock) for help.

### Using a Flash tool
## Using a Flash tool
This basically means re-flashing your firmware with a newer version, like it is explained in the [How to flash the firmware](../guides/openshock-how-to-flash-your-board.md) guide.
**Doing it this way will also reset all your configuration.**
!!! failure "What if something fails?"
Expand Down

0 comments on commit 0bafc5d

Please sign in to comment.