[DOCS] Overhaul new-user onboarding, home page, and upload flow (#2347)
Getting started: - New 15-minute Getting Started guide featuring the two most popular tracks (BLE on esp32dev-ble, RF on lilygo-rtl_433), with broker setup and a verification step - Sidebar restructured around the new-user journey; upload options numbered by ease; Gitpod upload method removed Home page: - VitePress hero with clear actions, larger hero image - How-it-works pipeline diagram shared as a component (responsive via container queries), use-case grid, bigger video tiles without the image lightbox, refreshed press coverage list, functions pills - Support section pointing to Theengs Bridge and github.com/sponsors/1technophile Upload flow: - Decision-oriented upload landing page (journey strip, method cards, comparison table) - Pre-flight checklist and driver troubleshooting on the web installer - Guided environment picker (bridge + hardware wizard) replacing the filter chips, with manifest-verified recommendations - Post-flash next-steps card linking to the portal and verification Board images: - custom_img key in environments.ini and board photos for all web-flashable environments (licenses recorded); private prod_env.ini environments excluded from boards-info.json Corrections: - RF frequency coverage stated as 433/315/868/915MHz - Removed references to the retired compatible.openmqttgateway.com site (BLE list is decoder.theengs.io), the discontinued Theengs Plug, and the private sponsor forum Claude-Session: https://claude.ai/code/session_01TYysQW8tpmt1dWWuzKhTLi Co-authored-by: Florian <1technophile@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
67 files changed
+1142
-412
No files matched your search
@@ -1,11 +1,11 @@
|
||||
# Actuators
|
||||
## Compatible parts
|
||||
|Module|Purpose|Where to Buy|
|
||||
|-|-|-|
|
||||
|LED|Basic led|-|
|
||||
|FASTLED|RGB Leds management|-|
|
||||
|BUZZER|-|-|
|
||||
|RELAY|Switch power circuit|-|
|
||||
|Module|Purpose|
|
||||
|-|-|
|
||||
|LED|Basic led|
|
||||
|FASTLED|RGB Leds management|
|
||||
|BUZZER|-|
|
||||
|RELAY|Switch power circuit|
|
||||
|
||||
## Pinout
|
||||
|Module| Boards|
|
||||
|
||||
+4
-4
@@ -1,10 +1,10 @@
|
||||
# GSM 2G gateway
|
||||
## Compatible parts
|
||||
|
||||
|Module|Purpose|Where to Buy|
|
||||
|-|-|-|
|
||||
|A6|GSM GPRS module|-|
|
||||
|A7|GSM GPRS module with GPS|-|
|
||||
|Module|Purpose|
|
||||
|-|-|
|
||||
|A6|GSM GPRS module|
|
||||
|A7|GSM GPRS module with GPS|
|
||||
|
||||
## Hardware setup
|
||||
|
||||
|
||||
+7
-7
@@ -1,12 +1,12 @@
|
||||
# IR gateway
|
||||
## Compatible parts
|
||||
|Module|Purpose|Where to Buy|
|
||||
|-|-|-|
|
||||
|IR diode|Emitting|-|
|
||||
|IR receiver|Receiving|-|
|
||||
|transistor 2N2222|Amplify uC signal for the IR diode|-|
|
||||
|330 ohms resistor|-|-|
|
||||
|220 ohms resistor|limit current to LED|-|
|
||||
|Module|Purpose|
|
||||
|-|-|
|
||||
|IR diode|Emitting|
|
||||
|IR receiver|Receiving|
|
||||
|transistor 2N2222|Amplify uC signal for the IR diode|
|
||||
|330 ohms resistor|-|
|
||||
|220 ohms resistor|limit current to LED|
|
||||
|
||||
The IR setup can work with bc547 and a 4x3 LED-Matrix.
|
||||
|
||||
|
||||
+10
-10
@@ -1,4 +1,4 @@
|
||||
# RF gateway (433mhz/315mhz)
|
||||
# RF gateway (433/315/868/915MHz)
|
||||
|
||||
## Protocols, modules and library
|
||||
|
||||
@@ -21,13 +21,13 @@ If you want to try the RTL_433 module with a combination or a board outside of t
|
||||
Heltec LORA V3 is not compatible with RTL_433 library as it is based on an SX1262 module.
|
||||
|
||||
## Assembly/soldering required parts
|
||||
|Module|Purpose|Compatible modules|Receiver Switching|Where to Buy|
|
||||
|-|-|-|-|-|
|
||||
|SRX882 or SRX882S (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
|
||||
|STX882 (recommended)|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
|
||||
|CC1101|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders), RF(RCSwitch), RF2(KaKu), Pilight|Supported|-|
|
||||
|SX1276/SX1278|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|-|
|
||||
|LilyGo/Heltec|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|-|
|
||||
|Module|Purpose|Compatible modules|Receiver Switching|
|
||||
|-|-|-|-|
|
||||
|SRX882 or SRX882S (recommended)|433Mhz Receiver|RF(RCSwitch), RF2(KaKu), Pilight|Supported|
|
||||
|STX882 (recommended)|433Mhz Transmitter|RF(RCSwitch), RF2(KaKu), Pilight|Supported|
|
||||
|CC1101|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders), RF(RCSwitch), RF2(KaKu), Pilight|Supported|
|
||||
|SX1276/SX1278|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|
|
||||
|LilyGo/Heltec|433Mhz Transceiver|[RTL_433](../use/rf#supported-decoders)|Not Supported|
|
||||
|
||||
### SRX STX Pinout
|
||||
|Board| Receiver Pin| Emitter Pin|
|
||||
@@ -72,9 +72,9 @@ When **all** these variables are defined, OpenMQTTGateway will use your custom p
|
||||

|
||||
|
||||
## ESP8266 Hardware setup
|
||||
The default receiver pin is D2 (gpio 4). Avoid D3 (gpio 0): it is a boot strapping pin, a receiver holding it low at reset forces the ESP8266 into flash mode and the board never starts.
|
||||
If the gateway works only when serial monitor is connected don't use D3 use D2 instead (gpio 4) and modify config_RF.h accordingly.
|
||||
|
||||
With SRX882 some users reported issues on D2, use D1 instead in this case and modify config_RF.h accordingly.
|
||||
With SRX882 some users reported that D3 is not working use D1 instead in this case and modify config_RF.h accordingly.
|
||||
|
||||

|
||||
|
||||
|
||||
+16
-16
@@ -1,21 +1,21 @@
|
||||
# Sensors
|
||||
## Compatible sensors
|
||||
|Module|Purpose|Where to Buy|
|
||||
|-|-|-|
|
||||
|DHT11|Temperature, Humidity|-|
|
||||
|DHT22|Temperature, Humidity|-|
|
||||
|HCSR501|PIR|-|
|
||||
|BH1750|Digital light|-|
|
||||
|BME280|Temperature, Humidity, Pressure|-|
|
||||
|BMP280|Temperature, Pressure|-|
|
||||
|C-37, YL-83, HM-RD|Leak, Water|-|
|
||||
|HTU21|Temperature, Humidity|-|
|
||||
|GPIO Input|Inputs|-|
|
||||
|GPIO KeyCode|Keycode|-|
|
||||
|INA226|Current, Voltage|-|
|
||||
|MQ2|Gas (flammable)|-|
|
||||
|TEMT6000|Luminosity|-|
|
||||
|TSL2561|Luminosity|-|
|
||||
|Module|Purpose|
|
||||
|-|-|
|
||||
|DHT11|Temperature, Humidity|
|
||||
|DHT22|Temperature, Humidity|
|
||||
|HCSR501|PIR|
|
||||
|BH1750|Digital light|
|
||||
|BME280|Temperature, Humidity, Pressure|
|
||||
|BMP280|Temperature, Pressure|
|
||||
|C-37, YL-83, HM-RD|Leak, Water|
|
||||
|HTU21|Temperature, Humidity|
|
||||
|GPIO Input|Inputs|
|
||||
|GPIO KeyCode|Keycode|
|
||||
|INA226|Current, Voltage|
|
||||
|MQ2|Gas (flammable)|
|
||||
|TEMT6000|Luminosity|
|
||||
|TSL2561|Luminosity|
|
||||
|
||||
## Pinout
|
||||
|Module|Arduino Pin| ESP8266 Pin|ESP32 Pin|
|
||||
|
||||
Reference in new issue
Block a user