Files
OpenBK7231T_App/docs/json/drivers.json
openshwprojects d4aaa8dfcd docs
2023-03-06 12:23:08 +01:00

170 lines
7.0 KiB
JSON

[
{
"name": "TuyaMCU",
"title": "TODO",
"descr": "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](https://www.elektroda.com/rtvforum/topic3929151.html), see [TH06 LCD humidity/temperature sensor example](https://www.elektroda.com/rtvforum/topic3942730.html), see [fan controller example](https://www.elektroda.com/rtvforum/topic3908093.html), see [simple switch example](https://www.elektroda.com/rtvforum/topic3906443.html)",
"requires": ""
},
{
"name": "tmSensor",
"title": "TODO",
"descr": "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](https://www.elektroda.com/rtvforum/topic3914412.html).",
"requires": ""
},
{
"name": "NTP",
"title": "TODO",
"descr": "NTP driver is required to get current time and date from web. Without it, there is no correct datetime.",
"requires": ""
},
{
"name": "TESTPOWER",
"title": "TODO",
"descr": "This is a fake POWER measuring socket driver, only for testing",
"requires": ""
},
{
"name": "TESTLED",
"title": "TODO",
"descr": "This is a fake I2C LED driver, only for testing",
"requires": ""
},
{
"name": "HTTPButtons",
"title": "TODO",
"descr": "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",
"requires": ""
},
{
"name": "I2C",
"title": "TODO",
"descr": "Generic I2C, not used for LED drivers, but may be useful for displays or port expanders. Supports both hardware and software I2C.",
"requires": ""
},
{
"name": "BL0942",
"title": "TODO",
"descr": "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](https://www.elektroda.com/rtvforum/topic3887748.html). ",
"requires": ""
},
{
"name": "BL0937",
"title": "TODO",
"descr": "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",
"requires": ""
},
{
"name": "CSE7766",
"title": "TODO",
"descr": "BL0942 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK",
"requires": ""
},
{
"name": "SM16703P",
"title": "TODO",
"descr": "WIP driver",
"requires": ""
},
{
"name": "IR",
"title": "TODO",
"descr": "IRLibrary wrapper, so you can receive remote signals and send them. See [forum discussion here](https://www.elektroda.com/rtvforum/topic3920360.html), also see [LED strip and IR YT video](https://www.youtube.com/watch?v=KU0tDwtjfjw)",
"requires": ""
},
{
"name": "DDP",
"title": "TODO",
"descr": "DDP is a LED control protocol that is using UDP. You can use xLights or any other app to control OBK LEDs that way.",
"requires": ""
},
{
"name": "SSDP",
"title": "TODO",
"descr": "SSDP is a discovery protocol, so BK devices can show up in, for example, Windows network section",
"requires": ""
},
{
"name": "Wemo",
"title": "TODO",
"descr": "Wemo emulation for Alexa. You must also start SSDP so it can run, because it depends on SSDP discovery.",
"requires": ""
},
{
"name": "DGR",
"title": "TODO",
"descr": "Tasmota Device groups driver. See [forum example](https://www.elektroda.com/rtvforum/topic3925472.html) and TODO-video tutorial (will post on YT soon)",
"requires": ""
},
{
"name": "PWMToggler",
"title": "TODO",
"descr": "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](https://www.elektroda.com/rtvforum/topic3939064.html).",
"requires": ""
},
{
"name": "DoorSensor",
"title": "TODO",
"descr": "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](https://www.elektroda.com/rtvforum/topic3960149.html).",
"requires": ""
},
{
"name": "SM2135",
"title": "TODO",
"descr": "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",
"requires": ""
},
{
"name": "BP5758D",
"title": "TODO",
"descr": "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](https://www.youtube.com/watch?v=L6d42IMGhHw)",
"requires": ""
},
{
"name": "BP1658CJ",
"title": "TODO",
"descr": "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",
"requires": ""
},
{
"name": "SM2235",
"title": "TODO",
"descr": "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",
"requires": ""
},
{
"name": "CHT8305",
"title": "TODO",
"descr": "TODO",
"requires": ""
},
{
"name": "MAX72XX",
"title": "TODO",
"descr": "WIP driver",
"requires": ""
},
{
"name": "TM1637",
"title": "TODO",
"descr": "Driver for 7-segment LED display with DIO/CLK interface",
"requires": ""
},
{
"name": "SHT3X",
"title": "TODO",
"descr": "Humidity/temperature sensor. See [SHT Sensor tutorial topic here](https://www.elektroda.com/rtvforum/topic3958369.html), also see [this sensor teardown](https://www.elektroda.com/rtvforum/topic3945688.html)",
"requires": ""
},
{
"name": "Battery",
"title": "TODO",
"descr": "Custom mechanism to measure battery level with ADC and an optional relay. See [example here](https://www.elektroda.com/rtvforum/topic3959103.html).",
"requires": ""
},
{
"name": "Bridge",
"title": "TODO",
"descr": "TODO",
"requires": ""
}
]