scratch/libretiny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
6bf549b10474c47db00d71da90dca043e436328e
libretiny/docs/resources/tuya-pin-config.md
Piotr Szulc bb7fcd5c4d [docs] Add more UPK key descriptions (#219) 
* Added description of some UPK keys

* More keys described.

This time by experimenting on my PIR-enabled lamp.
Motion is reported correctly via GPIO defined as pirin_pin.
I am also trying to set the PIR sensitivity by applying PWM to the pirsense_pin, and I _think_ it works. More experiments are needed.

* Add UPK2ESPHome link, reformat table

* Add descriptions from BK7231N SDK

* Update docs/resources/tuya-pin-config.md

* Corrected description of cwmaxp

* Description of ambient light sensor values

---------

Co-authored-by: Kuba Szczodrzyński <kuba@szczodrzynski.pl>
2023-12-08 19:13:15 +01:00

241 lines
21 KiB
Markdown
Raw Blame History

# Tuya Pinout Config
Device configuration (`user_param_key`) can be extracted to JSON, using bk7231tools from a full firmware dump.
Also see:
- [UPK2ESPHome](https://upk.libretiny.eu/)
Sources:
- [`tuya_demo_light_pwm`](https://github.com/tuya/tuya-iotos-embeded-sdk-wifi-ble-bk7231n/blob/master/apps/tuya_demo_light_pwm/include/common/device_config_load.h) for *Lights/bulbs*
- Original post [by @blakadder](https://discord.com/channels/967863521511608370/983843871320580096/1059286760074530947) on Discord channel #resources
Key(s) | Meaning | Possible values
--------------------------------------------|---------------------------------------|---------------------------------------------------------------------------------------
`crc` | UPK data checksum |
`module` | Tuya module used | `CB3S` / `WB3S` / `CBU`, etc.
`category` | Device type as a number | 0502 - CW light<br>0505 - RGBCW light
`Jsonver`<br>`jv` | "JSON" version |
**Common** | |
`netled_pin`<br>`netled1_pin`<br>`wfst_pin` | Status LED for WiFi |
`netled_lv`<br>`netled1_lv`<br>`wfst_lv` | Status LED Active Level | 0 - Active low<br>1 - Active high
`netled_reuse` | |
`reset_pin` + `reset_lv` | Reset Button Pin + Active Level |
`reset_t` | Button press time to reset the device | 3/5/6/9/10 seconds
`iicscl` | I²C SCL Pin |
`iicsda` | I²C SDA Pin |
`net_trig` | |
`net_type` | |
`wfct` | |
**Lights/bulbs** | |
`cmod` | Color Mode | `rgbcw` / `rgb` / `cw` / `c` / `rgbc`
`dmod` | Light driver type | 0 - PWM<br>1 - SM16726B<br>2 - SM2135E<br>3 - SM2135EH<br>4 - SM2135EJ<br>5 - BP1658CJ<br>6 - BP5758D<br>7 - SM2235/2335
`cwtype` | Color temperature driver | 0 - cool and warm white (CW)<br>1 - correlated color temperature (CCT)
`onoffmode` | On/off gradient enabled | 0 / 1
`pmemory` | Power-off memory enabled | 0 / 1
`defcolor` | Default Color | `c` / `r`
`defbright` | Default Brightness | 0%-100%
`deftemp` | Default Color Temperature | 0-100 when defcolor is cool white
`cwmaxp` | Cold-Warm Max Power | 100-200 with a pitch of 10
`brightmin`, `brightmax` | Min/Max Brightness | 0%-100%
`colormin`, `colormax` | RGB Min/Max Brightness | 0%-100%
`cwmin`, `cwmax` | Cold-Warm Min/Max Brightness | 0%-100%
`colormaxp` | RGB Max Power | 0%-100%
`colorpfun` | Color mixing power limit enabled | 0 / 1
`brightstep`<br>`bristep` | Brightness Step |
`hsvstep` | |
`rgbt` | Used in prod.tests, not relevant |
`title20` | "title20/T20" supported | 0 / 1
**Gamma correction** | |
`gmr`, `gmg`, `gmb` | |
`gmkr`, `gmkg`, `gmkb` | |
`gmwr`, `gmwg`, `gmwb` | |
**PWM Lights** | |
`r_pin` + `r_lv` | Red Channel Pin + Active Level |
`g_pin` + `g_lv` | Green Channel Pin + Active Level |
`b_pin` + `b_lv` | Blue Channel Pin + Active Level |
`c_pin` + `c_lv` | Cool White Pin + Active Level |
`w_pin` + `w_lv` | Warm White Pin + Active Level |
`pwmhz` | PWM Operating Frequency (Hz) |
**I²C Lights** | |
`dccur`<br>`ehccur`<br>`cjccur` | Cold White Current |
`dwcur`<br>`ehwcur`<br>`cjwcur` | Warm White Current |
`drgbcur` | RGB Current |
`campere` | Max current of SM2135 colored output | 10-45 with a pitch of 5 and defaults to 20
`wampere` | Max current of SM2135 white output | 10-80 with a pitch of 5 and defaults to 30
`iicr` | Red Channel Number | 0-5
`iicg` | Green Channel Number | 0-5
`iicb` | Blue Channel Number | 0-5
`iicc` | Cold White Channel Number | 0-5
`iicw` | Warm White Channel Number | 0-5
`iicccur` | Cold White Current | 0
`iicwcur` | Warm White Current | 5
**Sockets/switches** | |
`btX_pin` + `btX_lv` | Button X Pin + Active Level |
`btX_type`<br>`bt_type` | Button X Trigger Type | 0 - level_trig<br>1 - edge_trig
`rlX_pin` + `rlX_lv` | Relay X Pin + Active Level |
`rlX_type`<br>`rl_type` | Relay X Type | 0 - Electric holding relay<br>1 - Magnetic holding relay
`rl_onX_pin` + `rl_onX_lv` | Relay ON Pin + Active Level |
`rl_offX_pin` + `rl_offX_lv` | Relay OFF Pin + Active Level |
`rl1_dr_type` | |
`rl_drvtime` | |
`total_bt_pin` + `total_bt_lv` | |
**Power monitoring** | |
`ele_fun_en` | Power Monitoring Enabled | 0 / 1
`chip_type` | Power Monitoring Chip Type | 0 - BL0937<br>1 - HLW8012<br>2 - HLW8032<br>4 - BL0942
`ele_pin` | CF Pin |
`vi_pin` | CF1 Pin |
`sel_pin_pin` + `sel_pin_lv` | SEL Pin + Active Level | Active level is usually 1
`lose_vol` | Under voltage threshold in V |
`over_cur` | Overcurrent threshold in mA |
`over_vol` | Overvoltage threshold in V |
`sample_resistor` | Current shunt resistor value | 1 - 1mΩ<br>2 - 2mΩ
`vol_def` | Socket operating voltage | 0 - 220V<br>1 - 110V
`work_voltage` | Socket operating voltage |
**Infrared** | |
`irfunc` | IR Function enabled | 0 / 1
`infre` | IR Transmitter Pin |
`infrr`<br>`ir` | IR Receiver Pin |
`irkXfun` + `irkXval` | IR Key X Function + Value | X in 1..30
`irnightt` | |
`irstep` | |
`wgmod`, `swgmod`, `scgmod` | |
**PIR** | |
`pirmod` | |
`pirfreq` | PWM Operating Frequency (Hz) for PIR | 1000
`pirlduty` | | 100
`pirmduty` | | 50
`pirhduty` | | 0
`pirin_pin` + `pirin_lv` | Motion reporting GPIO + Active Level |
`pirsense_pin` + `pirsense_lv` | PIR sensitivity (PWM) + Active Level |
`pirrange` | |
`pirwarn` | |
**Ambient light sensor** | |
`day` | Value to compare against ADC readout | ADC value range (0-3300)
`dusk` | Value to compare against ADC readout | ADC value range (0-3300)
`evenfall` | Value to compare against ADC readout | ADC value range (0-3300)
`evening` | Value to compare against ADC readout | ADC value range (0-3300)
`night` | Value to compare against ADC readout | ADC value range (0-3300)
**Key-controlled** | |
`key_pin` + `key_lv` | Key Pin + Active Level |
`kXpin_pin` + `kXpin_lv` | |
`kXdfunc`, `kXlfunc`, `kXsfunc` | |
`kXldir`, `kXsdir` | |
`keyccfg1`, `keyccfg2` | |
`keyfunc`, `keyglobefunc` | |
`keylt`, `keynumber` | |
**Pairing-related** | |
`wfcfg` | Wi-Fi pairing config | `spcl` / `spcl_auto` / `prod` / `old` / `low`
`remdmode` | "light reset pairing mode" | 0 / 1
`rstnum` | On/off cycles to reset |
`rstcor` | Light color while connecting | `c` / `r`
`rstbr` | Light brightness while connecting | 10-100
`rsttemp` | Light temperature while connecting | 0-100
`remdtime` | Pairing mode timeout | seconds
`wfptime` | Light pairing time | minutes
`cagt` | Used in prod.tests, not relevant | N/A
`prodagain` | Used in prod.tests, not relevant | 0 / 1
`rstmode` | Pairing related - not relevant |
`pairt` | Pairing related - not relevant | 6-600
`wt` | Used in prod.tests, not relevant | N/A
**Other** | |
`buzzer_pwm` | Buzzer working PWM frequency |
`ismusic` | | 0 / 1
`ledX_pin` + `ledX_lv` | LED X Pin + Active Level |
`led_pin` + `led_lv` | LED Pin + Active Level |
**Unknown** | |
`0err` | |
`1err` | |
`adclimit` | |
`aging` | |
`alarm1_time` | |
`alarm_t1` | |
`backlit_dp` | |
`backlit_select` | |
`bitseq` | |
`bleonoff` | |
`blindt` | |
`buzzer` | |
`cctseg` | |
`cd_flag2` | |
`cdsval` | |
`ch1_stat` | |
`ch_cddpidX` | | X in 1..4
`ch_dpidX` | | X in 1..4
`ch_flagX` | | X in 1..4
`ch_num` | |
`clean_t` | |
`cntdown1` | |
`ctrl_lv` | |
`ctrl_pin` | |
`customcode` | |
`cyc_dpid` | |
`dctrl_select` | |
`dimmod` | |
`dimt` | |
`dimval` | |
`door1_magt_lv` | |
`door1_magt_pin` | |
`door_alarm_st1` | |
`door_mag1` | |
`ffc_select` | |
`inch_dp` | |
`indep_cfgbt` | |
`init_conf` | |
`knum` | |
`ktime` | |
`leaderr` | |
`led_dp` | |
`lfunc` | |
`light_status_select` | |
`lock_dp` | |
`lockt` | |
`micpin` | |
`mixway` | |
`mutex` | |
`mxcl_led_m` | |
`netn_led` | |
`netnc` | |
`nety_led` | |
`netyc` | |
`nightbrig` | |
`nightcct` | |
`nightled` | |
`notdisturb` | Do not disturb (DND) mode enabled | 0 / 1
`on_off_cnt` | |
`onoff1` | |
`onoff_clear_t` | |
`onoff_n` | |
`onoff_rst_m` | |
`onoff_rst_type` | |
`onoff_type` | |
`onofftime` | |
`owm` | |
`preheatt` | |
`rand_dpid` | |
`remote_add_dp` | |
`remote_list_dp` | |
`remote_select` | |
`resistor` | |
`reuse_led_m` | |
`rsthold` | |
`scenespct` | |
`series_ctrl` | |
`sfunc` | |
`standtime` | |
`starterr` | |
`step_rate` | |
`switch1` | |
`tempmix` | |
`tempstep` | |
`total_stat` | |
`tracetime1` | |
`trigdelay` | |
`trigmod` | |
`trl1_time` | |
`voice_ctrl1` | |
`voice_ctrl_set1` | |
`whiteseg` | |
`zero_select` | |
Reference in New Issue View Git Blame Copy Permalink