Introduction

OpenBK7231T/OpenBeken is a Tasmota/ESPHome alternative for modern Tuya-based modules, offering MQTT and Home Assistant compatibility. Although this repository is named OpenBK7231T_App, it has evolved into a multi-platform application, supporting builds for multiple chipsets from various vendors, including ESWIN, Transa Semi, Lightning Semi, Espressif, Beken, WinnerMicro, Xradiotech/Allwinner, Realtek, and Bouffalo Lab.

• BK7231T (eg WB3S, WB2S, WB2L)
• BK7231N (eg CB2S, CB2L, WB2L_M1)
• BK7231M, this is a non-Tuya version of BK7231N with 00000000 keys, sometimes labelled as Belon BL2028. example1 example2
• T34 (flash as if standard BK7231N), see flashing trick
• BL2028N (BL2028N is a Belon version of BK7231N)
• BK7238 (eg XH-CB3S) (see tutorial for 1$ board)
• BK7231S/BK7231U - BK7231S is the original non-Tuya version of BK7231T. BK7231U is a version intended for cameras/displays. Usually comes with 00000000 keys. If flashing via SPI, can be updated to use BK7231T firmware built with zero keys. (eg C-8133U LED driver boards, HLK-B30 Dev Board)
• XR809 (eg XR3) (Example)
• XR806 (eg T103C-HL, WXU, Allwinner Dev Board, see development thread)
• BL602 (eg SM-028_V1.3, BW2L), see also BL602 flash OBK via OTA tutorial (Magic Home devices only). For 2MB BL602 use latest toml in BLDevCube.
• LF686 (LeapFive BL602. Flash as if standard BL602). BL602 factory firmware backup/restore guide1 guide2. For 2MB BL602 use latest toml in BLDevCube.
• TG7100C (T-Mall BL602. Flash as if standard BL602). BL602 factory firmware backup/restore guide1 guide2 (eg TL7100C) (Example). For 2MB BL602 use latest toml in BLDevCube.
• W800 (W800-C400, WinnerMicro WiFi & Bluetooth), W801, W803
• W600 (WinnerMicro chip), W601 (WIS600, ESP-01W, TW-02, TW-03, etc)
• T6605 Flash as WinnerMicro W600
• 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 (original), ESP32-S2, ESP32-S3, ESP32-C2, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-C61 development topic)
• ESP8266/ESP8285 (1MB variant without OTA, 2MB or more with OTA)
• RTL8711AM (Ameba1 family, with SDRAM only. Can't be flashed via UART, only JTAG or SPI) (eg WRG1, see development thread)
• RTL8710B (AmebaZ family) (eg T102_V1.0, W302/T102_V1.0, T112_V1.1, WR2, WR3E, BW14)
• RTL8710C/RTL8720C (AmebaZ2 family) (eg BW15, W701, W701H, W701M, W701P, WBR2, WBR3, CR3L, CRG1) (see guide)
• RTL8720D (AmebaD family) (eg BW16, BW16E, W701D, W701DH, WBR3D, WBR3T)
• RTL872xCSM/RTL8720CS (AmebaCS family, firmware is compatible with RTL8720D) (eg WBRG1 (see Zigbee gateway guide), WBR3N, WBR3S)
• RTL87x1DA (AmebaDplus family, not compatible with AmebaD/RTL8720D) (eg BW20, WR11-U, WR11-2S)
• RTL87x0E (AmebaLite family) (eg PKM8710ECF)
• TR6260 (eg HLK-M20, XY-WE2S-A V1.1) (see guide)
• ECR6600 (eg AXYU, AXY2S, WG236, DSM-036, CDI-WX56600A-00, BL-M6600XT1, HF-LPT6200 (see guide)
• TXW81X (eg TXW817-810, see development thread)
• RDA5981 (eg RDA5981AM, RDA5981BM, WRD2L, TYWRD3S, HLK-M50, see development thread, see guide)
• LN8825B (eg SCW-T503)
• BL616/BL618 (eg Ai-M62-12F, Ai-M61-32S)
• GD32VW553 (eg GD32VW553-MINI, GD32VW553-UNIFI)

Please use automatically compiled binaries from the Releases tab. To build OpenBeken yourself for any supported platform, fork our version of the submodule SDK first, and then check out this app repository alongside it. Details further down. Alternatively consider using the easier override method.

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

For general information about the BK7231 family, available datasheets, pinout, peripherals, consult our docs topic.

TXW81X Camera Sensor Support

OpenTXW81x camera sensor support is defined at build time (see project_config.h).

Supported sensors (enabled in the current config):

• GalaxyCore: GC0308, GC0309, GC0311, GC0312, GC0328, GC0329
• OmniVision: OV2640, OV7660, OV7670, OV7725
• BYD: BF3A03, BF30A2, BF2013, BF3703, BF3720
• Hynix: HI704
• SuperPix: SP0A19, SP0828, SP0A20, SP0718
• Other: XC7011_GC1054, XC7011_H63, XC7016_H63, XCG532

In Progress

To varying degrees, support for the following is in development.

• XR872/XF16 (eg A9 camera)
• BK7252U (eg Tuya doorbell, eg A9 camera PCB)
• BK7252N (eg A9 camera)

Supported Devices/Templates List Now with 800+ 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 device not yet listed? 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:

• flashing guides playlist
• generic setup hints, tricks, tips

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 (except XR809); 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 support. For example AHT30, CHT8305, BME680, TC74 temperature and humidity sensors, MCP23017 port expander, PCF8574T LCD 2x16.
• Hardware and software SPI support. For example BL0942SPI.
• 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)
• 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 GPIO roles quickly
• 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
• Sensors: DHT11, DHT12, DHT21, DHT22, AHT10, AHT2X, AHT3X, SHT3X, CHT83XX, DS18B20, BMP280, BME280, BME680
• Can draw customizable charts directly on device, see tutorial
• Berry scripting option (not enabled by default)
• Can run on Windows with device simulator/schematic drawer, see tutorial
• Per-platform code build self-checks
• Full conversion for Tuya Matter devices example1, example2
• and much more

There is also a bit more outdated WIKI

Building

OpenBeken supports online builds for all platforms (BK7231T, BK7231N, BK7238, XR809, BL602, W600, W800, ESP32, RTL8710A, RTL8710B, RTL87X0C, RTL8720D/CS, TR6260, ECR6600, LN882H), 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 for BK7231N, BK7231T, BK7231M, BK7238, BK7252N, BK7252U, BL2028N, T34, BL602, ECR6600, LN882H, RDA5981, RTL8710B, RTL8710C, RTL8720D / RTL8720CS, W800, and W600 (write-only). Also see FLASHING.md

Repository of flash tools for all other supported platforms

TXW81X requires either CK-Link or STM32F103 (64kb flash or more). See flashing guide

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

Further Reading

For technical insights and generic SDK information related to Beken, WinnerMicro, Bouffalo Lab and Xradio modules, please refer to:

https://www.elektroda.com/rtvforum/topic3850712.html

https://www.elektroda.com/rtvforum/topic3866123.html

https://www.elektroda.com/rtvforum/topic3806769.html

Support Project

❤️ Love the project? Please consider supporting it with a donation: https://www.paypal.com/paypalme/openshwprojects ❤️

Special thanks to all open-source contributors whose work has served as a valuable reference and inspiration for the development of this project.