Skip to content

README.md

Latest commit

 

History

History
72 lines (55 loc) · 4.03 KB

README.md

File metadata and controls

72 lines (55 loc) · 4.03 KB
Raw

OpenShock Espressif Firmware

Documentation GitHub license GitHub Releases GitHub Downloads GitHub Sponsors Discord

master Build Status CodeQL Status Coverage Status
beta Build Status CodeQL Status Coverage Status
develop Build Status CodeQL Status Coverage Status

Espressif Firmware for OpenShock.

Controlling shockers via Reverse engineered proprietary Sub-1 GHz Protocols.

Compatible Hardware

You will need a ESP-32 and a 433 MHz antenna attached to it.

For more info about buying such hardware see here OpenShock Wiki - Vendors: Hardware.

Guide for assembly can be found here OpenShock Wiki - DIY: Assembling

Confirmed working boards:

  • PiShock
    • 2021 Q3
    • 2023
  • Seeed
    • Xiao ESP32S3
  • Wemos
    • D1 Mini
    • Lolin S2 Mini
    • Lolin S3
  • OpenShock (Legacy)
    • Core V1
  • DFRobot Firebeetle 2 ESP32-E

Flashing

Refer to OpenShock Wiki - Guides: First time setup on how to set up your microcontroller.

To flash a build of your own, see docs/DEVELOPING.md: python scripts/build.py <board> flash, or the "Firmware: flash" task in VS Code.

Contribute

Building, flashing, testing and updating dependencies are covered in docs/DEVELOPING.md. You will need ESP-IDF v6.1, Python, Node with pnpm, and a compatible ESP32 board with a 433 MHz transmitter.

Support

You can support the openshock dev team here: Sponsor OpenShock