Here is the latest, up to date drivers list. This file was autogenerated by running 'node scripts/getcommands.js' in the repository. All descriptions were taken from code. Remember that some drivers might not be yet enabled on certain platforms, but we can enable them for you per request. Some drivers might also be WIP. Do not add anything here, as it will overwritten with next rebuild.
| Driver | Description |
|---|---|
| TuyaMCU | TuyaMCU is a protocol used for communication between WiFI module and external MCU. This protocol is using usually RX1/TX1 port of BK chips. See TuyaMCU dimmer example, see TH06 LCD humidity/temperature sensor example, see fan controller example, see simple switch example. See also TuyaMCU on forum. |
| tmSensor | The tmSensor must be used only when TuyaMCU is already started. tmSensor is a TuyaMcu Sensor, it's used for Low Power TuyaMCU communication on devices like TuyaMCU door sensor, or TuyaMCU humidity sensor. After device reboots, tmSensor uses TuyaMCU to request data update from the sensor and reports it on MQTT. Then MCU turns off WiFi module again and goes back to sleep. See an example door sensor here. See also tmSensor on forum. |
| FREEZE | Freeze is a test driver for watchdog. Enabling this will freeze device main loop. See also FREEZE on forum. |
| PixelAnim | PixelAnim provides a simple set of WS2812B animations. See also PixelAnim on forum. |
| Drawers | WS2812B driver wrapper with REST API for smart drawers project. See also Drawers on forum. |
| NTP | NTP driver is required to get current time and date from web. Without it, there is no correct datetime. Put 'startDriver NTP' in short startup line or autoexec.bat to run it on start. See also NTP on forum. |
| HTTPButtons | This driver allows you to create custom, scriptable buttons on main WWW page. You can create those buttons in autoexec.bat and assign commands to them. See also HTTPButtons on forum. |
| TESTPOWER | This is a fake POWER measuring socket driver, only for testing. See also TESTPOWER on forum. |
| TESTLED | This is a fake I2C LED driver, only for testing. See also TESTLED on forum. |
| I2C | Generic I2C, not used for LED drivers, but may be useful for displays or port expanders. Supports both hardware and software I2C. See also I2C on forum. |
| RN8209 | Bqqqqqqqqqq . See also RN8209 on forum. |
| BL0942 | BL0942 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK. You need to calibrate power metering once, just like in Tasmota. See LSPA9 teardown example. By default, it uses 4800 baud, but you can also enable it with baud 9600 by using 'startDriver BL0942 9600', see related topic. See also BL0942 on forum. |
| PWMG | . See also PWMG on forum. |
| BL0942SPI | BL0942 driver version for SPI protocol. It's usually connected to SPI1 port of BK. You need to calibrate power metering once, just like in Tasmota. See PZIOT-E01 teardown example. . See also BL0942SPI on forum. |
| ChargingLimit | Mechanism to perform an action based on a max. delta value and max time. Used to control Electric Vehicle chargers. See discussion. See also ChargingLimit on forum. |
| BL0937 | BL0937 is a power-metering chip which uses custom protocol to report data. It requires setting 3 pins in pin config: CF, CF1 and SEL. See also BL0937 on forum. |
| CSE7766 | CSE7766 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK. See also CSE7766 on forum. |
| MAX6675 | Thermocouple driver for measuring high temperatures, see presentation. See also MAX6675 on forum. |
| PT6523 | Car radio LCD driver, see teardown and presentation. See also PT6523 on forum. |
| TextScroller | BQQQK. See also TextScroller on forum. |
| SM16703P | SM16703P is an individually addressable LEDs controller like WS2812B. Currently SM16703P LEDs are supported through hardware SPI, LEDs data should be connected to P16 (MOSI), here you can read how to break it out on CB2S. See also SM16703P on forum. |
| SM15155E | SM15155E is a WS2812B-like single wire LED controller. It's also always using P16 (SPI out) on Beken. See reverse-engineering topic. See also SM15155E on forum. |
| IR | IRLibrary wrapper, so you can receive remote signals and send them. See forum discussion here, also see LED strip and IR YT video. See also IR on forum. |
| DDP | DDP is a LED control protocol that is using UDP. You can use xLights or any other app to control OBK LEDs that way. See DDP topic. See also DDP on forum. |
| SSDP | SSDP is a discovery protocol, so BK devices can show up in, for example, Windows network section. See also SSDP on forum. |
| DGR | Tasmota Device groups driver. See forum example and video tutorial. See also DGR on forum. |
| Wemo | Wemo emulation for Alexa. You must also start SSDP so it can run, because it depends on SSDP discovery. See also Wemo on forum. |
| Hue | Hue emulation for Alexa. You must also start SSDP so it can run, because it depends on SSDP discovery. See also Hue on forum. |
| PWMToggler | PWMToggler is a custom abstraction layer that can run on top of raw PWM channels. It provides ability to turn off/on the PWM while keeping it's value, which is not possible by direct channel operations. It can be used for some custom devices with extra lights/lasers. See example here. See also PWMToggler on forum. |
| DoorSensor | DoorSensor is using deep sleep to preserve battery. This is used for devices without TuyaMCU, where BK deep sleep and wakeup on GPIO is used. This drives requires you to set a DoorSensor pin. Change on door sensor pin wakes up the device. If there are no changes for some time, device goes to sleep. See example here. If your door sensor does not wake up in certain pos, please use DSEdge command (try all 3 options, default is 2). . See also DoorSensor on forum. |
| ADCButton | This allows you to connect multiple buttons on single ADC pin. Each button must have a different resistor value, this works by probing the voltage on ADC from a resistor divider. You need to select AB_Map first. See forum post for details. See also ADCButton on forum. |
| MAX72XX_Clock | Simple hardcoded driver for MAX72XX clock. Requires manual start of MAX72XX driver with MAX72XX setup and NTP start. See also MAX72XX_Clock on forum. |
| SM2135 | SM2135 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2135 pin roles. This may need you to remap the RGBCW indexes with SM2135_Map command. See also SM2135 on forum. |
| BP5758D | BP5758D custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP5758D pin roles. This may need you to remap the RGBCW indexes with BP5758D_Map command. This driver is used in some of BL602/Sonoff bulbs, see video flashing tutorial here. See also BP5758D on forum. |
| BP1658CJ | BP1658CJ custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP1658CJ pin roles. This may need you to remap the RGBCW indexes with BP1658CJ_Map command. See also BP1658CJ on forum. |
| SM2235 | SM2335 andd SM2235 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2235 pin roles. This may need you to remap the RGBCW indexes with SM2235_Map command. This driver also works for SM2185N. See also SM2235 on forum. |
| BMP280 | BMP280 is a Temperature and Pressure sensor with I2C interface. See also BMP280 on forum. |
| MAX72XX | MAX72XX LED matrix display driver with font and simple script interface. See protocol explanation. See also MAX72XX on forum. |
| BMPI2C | Driver for BMP085, BMP180, BMP280, BME280, BME68X sensors with I2C interface. See also BMPI2C on forum. |
| CHT8305 | CHT8305 is a Temperature and Humidity sensor with I2C interface. See also CHT8305 on forum. |
| MCP9808 | MCP9808 is a Temperature sensor with I2C interface and an external wakeup pin, see docs. See also MCP9808 on forum. |
| KP18058 | KP18058 I2C LED driver. Supports also KP18068. Working, see reverse-engineering topic. See also KP18058 on forum. |
| ADCSmoother | Qq. See also ADCSmoother on forum. |
| SHT3X | Humidity/temperature sensor. See SHT Sensor tutorial topic here, also see this sensor teardown. See also SHT3X on forum. |
| SGP | SGP Air Quality sensor with I2C interface. See this DIY sensor for setup information. See also SGP on forum. |
| ShiftRegister | Simple Shift Register driver that allows you to map channels to shift register output. See related topic. See also ShiftRegister on forum. |
| AHT2X | AHT Humidity/temperature sensor. Supported sensors are: AHT10, AHT2X, AHT30. See presentation guide. See also AHT2X on forum. |
| HT16K33 | Driver for 16-segment LED display with I2C. See protocol explanation. See also HT16K33 on forum. |
| TM1637 | Driver for 7-segment LED display with DIO/CLK interface. See TM1637 information. See also TM1637 on forum. |
| GN6932 | Driver for 7-segment LED display with DIO/CLK/STB interface. See this topic for details. See also GN6932 on forum. |
| TM1638 | Driver for 7-segment LED display with DIO/CLK/STB interface. TM1638 is very similiar to GN6932 and TM1637. See this topic for details. See also TM1638 on forum. |
| HD2015 | Driver for 7-segment LED display with I2C-like interface. Seems to be compatible with TM1650. HD2015 is very similiar to GN6932 and TM1637. See this topic for details. See also HD2015 on forum. |
| Battery | Custom mechanism to measure battery level with ADC and an optional relay. See example here. See also Battery on forum. |
| Bridge | A bridge relay driver, added for TONGOU TO-Q-SY1-JWT Din Rail Switch. See linked topic for info. See also Bridge on forum. |