During the beta version, the options are unstable, may get changed during updates.
The main function of deviceOverrides is to convert "non-standard schema" to "standard schema", making the device compatible with this plugin.
Before configuring, you may need to:
- Have basic programming skills in JavaScript (Only used in
onGet/onSethandlers). - Understand the concept of device schema (also known as Data Type): Tuya IoT Development Platform > Cloud Development > Standard Instruction Set > Data Type
- Read the documentation of your device product in SUPPORTED_DEVICES.md.
- Obtain device info json from
/path/to/persist/TuyaDeviceList.xxx.json(the full path can be found from logs). - Locate any "incorrect schema" in your device info json, and convert it to the "correct schema".
options.deviceOverrides is an optional array of device overriding config objects, which is used for converting "non-standard schema" to "standard schema", making the device compatible with this plugin. The structure of each element in the array is described as follows:
id- required: Device ID, Product ID, Scene ID, orglobal.category- optional: Device category code. See SUPPORTED_DEVICES.md. Also you can usehiddento hide the device, product, or scene.⚠️ Overriding this property may lead to unexpected behaviors and exceptions, so please remove the accessory cache after making changes.unbridged- optional: Unbridge accessories. Defaults tofalse.adaptiveLighting- optional: Adaptive Lighting. Defaults tofalse. Not all light device support this feature, please use it on demand.schema- optional: An array of schema overriding config objects, used for describing datapoint (DP). When your device has non-standard DP, you need to transform them manually with configuration. Each element in the schema array is described as follows:code- required: DP code.newCode- optional: New DP code.type- optional: New DP type. One ofBoolean,Integer,Enum,String,Json, orRaw.property- optional: New DP property object. ForIntegertype, the object should containmin,max,scale, andstep. ForEnumtype, the object should containrange. For more information, seeTuyaDeviceSchemaPropertyin TuyaDevice.ts.onGet- optional: A one-line JavaScript code to convert the old value to the new value. The function is called with two arguments:deviceandvalue.onSet- optional: A one-line JavaScript code to convert the new value to the old value. The function is called with two arguments:deviceandvalue. Returningundefinedmeans to skip sending the command.hidden- optional: Hide the schema. Defaults tofalse.
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"category": "xxx"
}]
}
}Just the same way as changing category code.
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id_or_scene_id}",
"category": "hidden"
}]
}
}An example of hide camera's floodlight (floodlight_switch):
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "floodlight_switch",
"hidden": true
}]
}]
}
}{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"adaptiveLighting": true
}]
}
}If you want to display off status when device is offline:
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "{dp_code}",
"onGet": "(device.online && value)"
}]
}]
}
}{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "{old_dp_code}",
"newCode": "{new_dp_code}"
}]
}]
}
}An example of convert open/close into true/false:
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "{dp_code}",
"type": "Boolean",
"onGet": "(value === 'open') ? true : false;",
"onSet": "(value === true) ? 'open' : 'close';"
}]
}]
}
}Some odd thermostat stores double of the real value to keep the decimal part (0.5°C).
We need override both range and value in order to make it working. (Only override value is not enough, range is required too.)
Here's an example of the invalid schema:
{
code: 'temp_set',
mode: 'rw',
type: 'Integer',
property: { unit: '℃', min: 10, max: 70, scale: 1, step: 5 }
}The value 41 actually represents for 20.5°C, the range 10~70 actually represents for 5.0°C~35.0°C.
To fix this, first we need set scale to 1, and convert 41 to 205 when getting, convert 205 to 41 when getting, which means value x 5 when getting, and value / 5 when setting.
Here's the example config:
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "temp_set",
"onGet": "(value * 5);",
"onSet": "(value / 5);",
"property": {
"min": 50,
"max": 350,
"scale": 1,
"step": 5
}
}]
}]
}
}After transform value using onGet and onSet, and new range in property, it should be working now.
Most curtain motor have "reverse mode" setting in the Tuya App, if you don't have this, you can reverse percent_control/position and percent_state in the plugin config:
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "percent_control",
"onGet": "(100 - value)",
"onSet": "(100 - value)"
}, {
"code": "percent_state",
"onGet": "(100 - value)",
"onSet": "(100 - value)"
}]
}]
}
}Some products (dimmer, fan) having issue when sending brightness/speed command with on/off command together. Here's an example of skip on/off command.
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "switch_led",
"onSet": "(value === device.status.find(status => status.code === 'switch_led').value) ? undefined : value"
}]
}]
}
}F = 1.8 * C + 32
C = (F - 32) / 1.8
{
"options": {
// ...
"deviceOverrides": [{
"id": "{device_id}",
"schema": [{
"code": "temp_current",
"onGet": "Math.round((value - 32) / 1.8);",
"onSet": "Math.round(1.8 * value + 32);"
}]
}]
}
}