/OS-Firmware

Espressif Firmware for OpenShock, Controlling shock collars via Reverse engineered proprietary Sub-1 GHz Protocols.

Primary LanguageC++GNU Affero General Public License v3.0AGPL-3.0

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.

Other than that, you can just flash via platform io in vscode. More in the contribute section.

Contribute

You will need:

  • VSCode
  • Knowledge about Arduino library and C++
  • Compatible ESP-32 board with 433 MHz antenna

Setting up

# Install dependencies
pip install -r requirements.txt

Support

You can support the openshock dev team here: Sponsor OpenShock