-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
90 additions
and
110 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Do-It-Yourself | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters