Skip to content

Commit

Permalink
Yes
Browse files Browse the repository at this point in the history
  • Loading branch information
LucHeart committed Oct 31, 2024
1 parent 81f159b commit 672131b
Show file tree
Hide file tree
Showing 22 changed files with 90 additions and 110 deletions.
50 changes: 0 additions & 50 deletions docs/account/reset-password.md

This file was deleted.

Binary file removed docs/account/reset-password/email-inbox.png
Binary file not shown.
Binary file removed docs/account/reset-password/email.png
Binary file not shown.
Binary file removed docs/account/reset-password/enter-email.png
Binary file not shown.
Binary file removed docs/account/reset-password/new-password.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/account/reset-password/reset-sent.png
Binary file not shown.
Binary file removed docs/account/reset-password/success.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/account/sign-up.md

This file was deleted.

Binary file removed docs/account/signup-page-successful-signup.png
Binary file not shown.
Binary file removed docs/account/signup-page.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/dev/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:

## Backend Architecture

![Backend Architecture Diagram](/static/developer/backend-architecture-overview.svg)
![Backend Architecture Diagram](../static/developer/backend-architecture-overview.svg)


## OpenAPI Documentation
Expand Down
15 changes: 9 additions & 6 deletions docs/diy/assembling.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@

This guide mainly focuses on the parts listed in the [Hardware Buy guide](../quickstart/buying-guide.md).
This guide mainly focuses on the parts listed in the [Hardware Buy guide](hardware-buying.md).

## Requirements
## Hardware Requirements

+ ESP-32
+ 433 MHz transmitter
+ Soldering station
+ Soldering station (optional)
+ Hookup wire (optional, depending on whether the pins line up)

## What/Where to buy?

See the [Hardware Buy guide here](../quickstart/buying-guide.md). For the board/ESP-32 assembly you need the ESP-32 and a 433 MHz transmitter.
See the [Hardware Buy guide here](hardware-buying.md). For the board/ESP-32 assembly you need the ESP-32 and a 433 MHz transmitter.

## Figuring out the PINs

Any digital output pin on your micro-controller should work for outputting the signal for the transmitter, however the default is often close to the positive and ground pins on the controller. See the [boards](../hardware/boards/index.md) section dedicated to the micro-controller you are using to decide which pin to use.

For example, if you bought a [Wemos Lolin S3](../hardware/boards/wemos/lolin-s3) and a [Open Smart Transmitter](../hardware/transmitter/china/open-smart.md), simply connect the 5V to the 5V pins (aka VCC), ground to ground, and any numbered pin to data, for example, the 12 pin.
For example, if you bought a [Wemos Lolin S3](../hardware/boards/wemos/lolin-s3.md) and a [Open Smart Transmitter](../hardware/transmitter/china/open-smart.md), simply connect the 5V to the 5V pins (aka VCC), ground to ground, and any numbered pin to data, for example, the 12 pin.

!!! warning "Pins" Your data pin should be detected automatically by the OpenShock firmware. If the pin is not automatically selected (ie. the transmitter doesn't send any signals, or you aren't getting any voltage output) you can reflash the board and input the correct pin in the web UI, or open a UART terminal and send the command `rftxpin #` where `#` is your pin number.
!!! warning "Pins"
You will need to set your RFTX pin during setup. If the pin is incorrect the transmitter wont be able to send any signals.
If you already went through the setup process, you can change the pin via a serial terminal with the command `rftxpin #` where `#` is your pin number.
Or you reenable the Captive Portal on the website and connect to it again with your phone.

![Example Pinout](../static/diy/pinout.png)
12 changes: 6 additions & 6 deletions docs/quickstart/buying-guide.md → docs/diy/hardware-buying.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@

# Buying guide

!!! example "Still brewing!"
Sorry, we haven't *quite* finished this article yet. **In the meantime, feel free to hit us up on [Discord](https://discord.gg/OpenShock) if you have any trouble.**
# DIY Hardware

!!! tip "pre-built options available"
Not interested in building your own OpenShock hub? Head over to the [Hardware vendors](../vendors/hardware/index.md).
Expand All @@ -18,7 +14,11 @@ These are the **recommendations** of the OpenShock maintainers. This list is **n

### ESP32-S3

We recommend the `ESP32-S3` chip, specifically the `N16R8` variant for its 16 MiB of flash. The [Wemos Lolin S3](../hardware/boards/wemos/lolin-s3.md) board satisfies all these criteria.
We recommend the `ESP32-S3` chip, specifically the `N16R8` variant for its 16 MiB of flash. The [Wemos Lolin S3](../hardware/boards/wemos/lolin-s3.md) board satisfies all these criteria.

Requirements for the ESP are:
- Needs to be a **ESP32** specifically. Not a 8266 or other!
- 4MB or more of flash

## 433 MHz Transmitter

Expand Down
2 changes: 2 additions & 0 deletions docs/diy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Do-It-Yourself

21 changes: 10 additions & 11 deletions docs/guides/openshock-first-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

!!! danger "Safety Warning"
**Don't wear the shocker somewhere near your neck or your heart.**
Check out [Safety](../safety/safety-rules.md) for more information.
Check out [Safety](../home/safety-rules.md) for more information.

!!! danger "Safety Warning"
**Do not touch the pins of the shocker with both hands at the same time.**
Expand Down Expand Up @@ -33,11 +33,15 @@
??? Info "Images (click to expand)"
![Image "image"](../static/guides/first-setup/ESPWebGUI.png)

3. Set the RF TX Pin if needed

!!! warning "RF TX Pin"
**DO NOT** change the RF TX Pin **UNLESS IT IS NOT AUTOMATICALLY DETECTED**.
This is an advanced feature. It should be set correctly by default after flashing the OpenShock firmware. If the pin is not automatically selected, you can open a UART terminal and send the command `rftxpin #` where `#` is your pin number. If you do not know how to do this, you can also reflash the board and configure the pin in the web interface. For more information see the page dedicated to your micro-controller under [boards](../hardware/boards/index.md).
**DO NOT** change the RF TX Pin **UNLESS IT IS NOT AUTOMATICALLY DETECTED** or you are using a DIY hub.
This is an advanced feature. It should be set correctly by default after flashing the OpenShock firmware.
If the pin is not automatically selected, you can open a Serial terminal and send the command `rftxpin #` where `#` is your pin number.
If you do not know how to do this, you can also re-enable the captive portal (hotspot of the Hub) to re-configure it. For more information see the page dedicated to your micro-controller under [boards](../hardware/boards/index.md).

3. Create a hub on the website:
1. Create a hub on the website:
1. **On your PC** open [openshock.app](https://openshock.app/).
2. Create an account. *(If you don't have one already)*
3. Go to **Devices** and click the **green plus icon** at the lower right corner to create a new hub.
Expand All @@ -50,23 +54,18 @@
![Image "image"](../static/guides/first-setup/findaddbutton3.png)
![Image "image"](../static/guides/first-setup/find_device_context_menu.png)
![Image "image"](../static/guides/first-setup/edit_device.png)
4. Pair the hub:
2. Pair the hub:
1. Open the context menu of your hub again.
2. Select **pair** and press **get pair code**, this will generate a new pair code.
3. On your phone type the code into the account Linking field of the hub's web-interface, then press **pair**.
- After you linked the hub to your account it should shut down it's own Wi-Fi network.
??? Info "Images (click to expand)"
![Image "image"](../static/guides/first-setup/findpaircode.png)
![Image "image"](../static/guides/first-setup/paircodeexample.png)
5. The hub is now connected!
3. The hub is now connected!
- If everything went well, it should show a **green icon** next to the device name on the website.
![Image "image"](../static/guides/first-setup/checkifonline.png)

!!! warning "RF TX Pin"
**DO NOT** change the RF TX Pin **UNLESS IT IS NOT AUTOMATICALLY DETECTED**.
This is an advanced feature. It should be set correctly by default after flashing the OpenShock firmware. If the pin is not automatically selected, you can open a UART terminal and send the command `rftxpin #` where `#` is your pin number. If you do not know how to do this, you can also reflash the board and configure the pin in the web interface. For more information see the page dedicated to your micro-controller under [boards](../hardware/boards/index.md).


## Pairing shockers

1. Ensure the shocker is sufficiently charged.
Expand Down
2 changes: 1 addition & 1 deletion docs/home/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ If you want to support us you can do so via [GitHub Sponsors](https://github.com

## How can I build/get my own?

You can either buy a pre-built Hub from on of our [Community Vendors](../vendors/) or build your own [(DIY)](../diy/).
You can either buy a pre-built Hub from on of our [Community Vendors](../vendors/hardware/index.md) or build your own [(DIY)](../diy/index.md).
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to OpenShock! We're proud to present our fully open-source software solu
Head over to the Guides to get started:

- [What you need](quickstart/what-you-need.md)
- [Buying guide](quickstart/buying-guide.md)
- [DIY](diy/hardware-buying.md)
- [How to Flash the Firmware](guides/openshock-how-to-flash-your-board.md)
- [Setup ESP and Shocker](guides/openshock-first-setup.md)

Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart/what-you-need.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Interested in hosting your own server? Check out the [Self-hosting](../guides/se
A hub connects OpenShock to the shock device via a micro-controller and a 433 MHz transmitter.

- For pre-built options, check out the [Hardware vendors](../vendors/hardware/index.md).
- For building your own, after reading the [Buying guide](../quickstart/buying-guide.md), head over to our do it yourself [Assembly guide](../diy/assembling.md).
- For building your own [DIY Buying guide](../diy/hardware-buying.md).

### 3. Shockers

This is the easy part! Head to the [Buying Guide](../quickstart/buying-guide.md) for all the information you'll need.
See the [Shockers](../hardware/shockers/index.md). We recommend the [CaiXianlin](../hardware/shockers/caixianlin.md) shockers.
35 changes: 35 additions & 0 deletions docs/troubleshooting/hub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Troubleshooting: Hub

## Shocker not pairing

This could be due to 3 main reasons:

- The Hub is offline
- The RFTX pin is not configured correctly
- The transmitter is not connected properly

### Hub is offline

Make sure the Hub is online on the Website, you can confirm this by checking if the dot next to the name of it is green.

### RFTX pin is not configured correctly

!!! warning
If you bought a pre built Hub this is unlikely, but might be the case, especially after a re-flash.

The RFTX pin is the GPIO pin on your ESP32 that controls the signal to the antenna.
Therefor you want to configure the pin number to be matching what is wired up to the signal of your transmitter.

Usually you set this pin during the first time setup of your hub. If you have already done this setup and your hub is online, there is two ways to change the pin after that.

1. Re-enable the Captive portal via the website. (`Hubs -> Three dots -> Remote Debug -> Captive Portal On`)
2. Connect a serial terminal to the esp (via usb UART) and use the `rftxpin` command followed by the number of your GPIO pin.

### Transmitter is not connected properly

Make sure your GND and VCC are properly connected. VCC is either 5V or 3.3V, depending on what antenna you use and how much you want your range to be.

Also make sure you signal is connected to a GPIO pin that is free to use. For example in the lolin s3 we can use pin 12, which conveniently also is GPIO 12.
Do note that the numbers on the PCB do not always match the actual GPIO pin number. Refer to the datasheet of your board for more information.

Also make sure you are using a Transmitter! Not the Receiver!
19 changes: 2 additions & 17 deletions docs/troubleshooting/shockosc.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,4 @@
---
title: Troubleshooting: ShockOsc
description:
published: true
date: 2023-08-20T02:54:44.408Z
tags:
editor: markdown
dateCreated: 2023-08-20T02:12:22.728Z
---

Troubleshooting: ShockOsc
Troubleshooting: ShockOSC

## OSC active?

Expand All @@ -21,9 +11,4 @@ Go ahead and click reset config in the VRChat action menu. This should reload yo
or

If it doesn't, navigate to `%userprofile%\appdata\locallow\VRChat\VRChat` and delete `OSC` folder.
Then reload your avatar again.

## Check config

Make sure you have the correct name for the shocker set. Also double check you have set the correct ID.
You can get the shocker ID from clicking edit on a shocker and copying the shown ID.
Then reload your avatar again.
31 changes: 21 additions & 10 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ nav:
- Guides:
- Quickstart:
- quickstart/what-you-need.md
- quickstart/buying-guide.md
- OpenShock:
- guides/openshock-how-to-flash-your-board.md
- guides/openshock-first-setup.md
Expand All @@ -28,20 +27,13 @@ nav:
- guides/selfhosting/index.md

- Do It Yourself:
- diy/index.md
- Hardware:
- diy/hardware-buying.md
- diy/assembling.md

- Developer: dev/index.md

- Vendors:
- Hardware:
- vendors/hardware/index.md
- Europe:
- vendors/hardware/luc.md
- vendors/hardware/bosjesman.md
- North America:
- vendors/hardware/nullstalgia.md

- Hardware:
- Shockers:
- hardware/shockers/index.md
Expand All @@ -66,14 +58,33 @@ nav:
- hardware/boards/wemos/d1-mini-esp32.md
- hardware/boards/wemos/lolin-s2-mini.md
- hardware/boards/wemos/lolin-s3.md
- DFRobot:
- hardware/boards/dfr-firebeetle/dfr-firebeetle.md
- ESP32-S3:
- hardware/boards/china/esp32s3-dorx.md
- Transmitter:
- hardware/transmitter/index.md
- hardware/transmitter/china/open-smart.md

- Vendors:
- Hardware:
- vendors/hardware/index.md
- Europe:
- vendors/hardware/luc.md
- vendors/hardware/bosjesman.md
- North America:
- vendors/hardware/nullstalgia.md
- vendors/hardware/sillypupkit.md

- Contributing:
- contributing/contributing.md
- Software:
- contributing/compile-firmware.md

- Troubleshooting:
- troubleshooting/hub.md
- troubleshooting/shockosc.md

- Legal and Privacy:
- legal/terms-and-conditions.md
- legal/code-of-conduct.md
Expand Down

0 comments on commit 672131b

Please sign in to comment.