Introduction

OpenBK7231T/OpenBeken is a Tasmota/Esphome replacement for new Tuya modules featuring MQTT and Home Assistant compatibility. This repository is named "OpenBK7231T_App", but now it's a multiplatform app, supporting build for multiple separate chips:

BK7231T (WB3S, WB2S, WB2L, etc)
BK7231N (CB2S, CB2L, WB2L_M1, etc)
BK7231M, this is a non-Tuya version of BK7231N with 00000000 keys, also sometimes in BL2028 flavour
T34 (T34 is based on BK7231N), see flashing trick
BL2028N (BL2028N is a Belon version of BK7231N)
XR809 (XR3, etc)
BL602 (SM-028_V1.3 etc), see also BL602 flash OBK via OTA tutorial (Magic Home devices only)
LF686 (flash it as BL602)
W800 (W800-C400, WinnerMicro WiFi & Bluetooth), W801
W600 (WinnerMicro chip), W601 (WIS600, ESP-01W, TW-02, TW-03, etc)
LN882H by Lightning Semi - datasheet, see flashing how-to, see sample device teardown and flashing, see new flash tool, see dev board
Windows, via simulator
ESP32 (WIP)

Please use automatically compiled binaries from the Releases tab. To build yourself for a given platform, just checkout first our version of SDK and then checkout this app repository into it, details later.

See our guides in Russian: BK7231N/T34, and BL602 RGB, and Youtube guide for BK7231/T34

If you want to get some generic information about BK7231 modules, available datasheets, pinout, peripherals, consult our docs topic.

Supported Devices/Templates List Now with 600+ entries! (Get 🏆free SD Card🏆 for submitting new one!)

We have our own interactive devices database that is maintained by users. The database is also accessible from inside our firmware (but requires internet connection to fetch). Have a not listed device? HELP US, submit a teardown here and 🏆get free SD card and gadgets set🏆 ! Thanks to cooperation with Elektroda.com, if you submit a detailed teardown/article/review, we can send you this set of gadgets for free (🚚shipping with normal letter🚚). NOTE: Obviously almost any device with supported chip (BK7231, BL602, W600, etc is potentially supported and it's not possible to list all available devices in the market, so feel free to try even if your device is not listed - we are here to help and guide you step by step!)

Our Youtube Channel (See step by step guides for flashing and setup)

We have our own Youtube channel with OBK-related guides. Please see our playlists:

You can help us by giving like, a comment and subscribe!

Features

OpenBeken features:

Tasmota-like setup, configuration and experience on all supported platforms (supports common Tasmota JSON over http and MQTT, etc)
OTA firmware upgrade system (for BK, W*00, BL602, LN); to use OTA, drag and drop proper OTA file on OTA field on new Web App Javascript Console
Online builds for all platforms via Github, configurable per-user build system, also supports Docker builds
MQTT compatibility with Home Assistant (with both Yaml generator and HA Discovery)
Support for multiple relays, buttons, leds, inputs and PWMs, everything fully scriptable
Driver system for custom peripherals, including TuyaMCU (see Dimmer tutorial), I2C bus and BL0942, BL0937 power metering chips, Motor Driver Bridge.
Hardware and software I2C, supports multiple I2C devices, like TC74 temperature sensor, MCP23017 port expander, PCF8574T LCD 2x16 (or other?), etc
Hardware and software SPI, support for SPI BL0942, etc
NTP time from network (can be used with TH06 and other TuyaMCU devices), can run any script on selected weekday hour:minute:second
Dedicated TuyaMCU support with extra TuyaMCU analyzer tool for decoding new devices (tutorial here, code repository here)
support for TuyaMCU Battery Powered devices protocol (TuyaMCU enables WiFi module only to report the state, eg. for door sensors, water sensors)
RGBCW LED lighting control compatible with Home Assistant (including PWM LEDs, and SM2135, BP5758, SM15155 etc )
LittleFS integration for scripts and large files (you can write scripts there, you can host a page there with REST interface control of device)
Command line system for starting and configuring drivers, for controlling channels, etc
Short startup command (up to 512 characters) storage in flash config, so you can easily init your drivers (eg. BL0942) without LittleFS
Advanced scripting and events system (allows you to mirror Tasmota rules, for example catch button click, double click, hold)
Easily configurable via commands (see tutorial)
Thanks to keeping Tasmota standard, OBK has basic compatibility with ioBroker and similar systems through TELE/STAT/CMND MQTT packets, Tasmota Control app is also supported
DDP lighting protocol support ("startDriver DDP" in autoexec.bat/short startup command), works with xLights,
Can be scripted to even work with shutters, see also second shutters script
Password-protected Web security see tutorial
Advanced deep sleep with GPIO/timer wakeup and hybrid power save systems, fully scriptable, can be configured to last longer than Tuya
Supports automatic GPIO setup with Tuya GPIO extraction, cloudcutter templates, can also import/export OpenBeken templates, you can also use GPIODoctor to find out quickly GPIO roles
Advanced and custom drivers like synchronized PWM groups with configurable dead time
WS2812B support, see scripting tutorial
LFS and REST API allows you to create and host a custom HTML+CSS+JS page on device with a custom GUI/display of channels/TuyaMCU dpIDs, see tutorial and see sample page , and see final version of custom TOMPD-63-WIFI page
can control 'smart lab organiser drawers' with a custom Drawers driver, see full presentation
DHT11 (and family) sensors support, BMP280 support, initial DS18B20 support
Can draw customizable charts directly on device, see tutorial
Can run on Windows with device simulator/schematic drawer, see tutorial
and much more

There is also a bit more outdated WIKI

Building

OpenBeken supports online builds for all platforms (BK7231T, BK7231N, XR809, BL602, W800), but if you want to compile it yourself, see BUILDING.md

Developer guides

online builds system guide
how to create custom obk driver
how to analyze unknown protocol with Salae logic analyzer
obk simulator short presentation
how to make changes to SDK during (automated) build process

Flashing

See our GUI easy flash tool, also see FLASHING.md

Docs - MQTT topics, Console Commands, Flags, Constants, Pin Roles, Channel Types, FAQ, autoexec.bat examples

Support project

If you want to support project, please donate at: https://www.paypal.com/paypalme/openshwprojects

Special thanks for Tasmota/Esphome/etc contributors for making a great reference for implementing Tuya module drivers

openshwprojects / OpenBK7231T_App

readme