bwp91/ewelink_v4v5Update.md

## ewelink_v4v5Update.md

      
    Raw
  

              ewelink_v4v5Update.md
            
          
    eWeLink Version 5 Config Changes


With the plugin becoming more and more configurable to adapt to users' needs, the list of options has been growing to a point where I felt a different approach is needed.


The new configuration is based on defining each setting per device, whereas before it was based on defining each device per setting.


This new method of configuration allows easier implementation of new options in the future

For Homebridge UI users, the plugin settings screen offers a simple way to set up the new configuration
For HOOBS UI users, the new way may seem a little complex but examples are available at the end of this file
For CLI users, I assume with pre-existing knowledge the JSON configuration will be straightforward


Update First

I would recommend updating the plugin first, and then saving your new configuration.

New Configuration Format
Device settings are now divided into nine 'base' configuration arrays:

singleDevices

for single-switch devices and zigbee switches


multiDevices

for multi-switch devices


outletDevices

for outlet devices


lightDevices

for dimmer, bulb and LED strip devices


thDevices

for thermostats and TH10/16 devices


fanDevices

for iFan devices


sensorDevices

for DW2 and zigbee sensors


bridgeSensors

for sensors via RF bridges (this setting has not changed from v4)


groups

for Accessory Simulations (this setting has not changed from v4)


Usage
For each of the items above you can add an entry inside the array for an individual device using deviceId. For example:
"singleDevices": [
  {
    "deviceId": "1000abcde",
    "showAsOutlet": true
  }
]
A full list of options per device type can be see in the updated configuration page in the wiki - here.
Removed Options
The following options have been replaced and will no longer have any effect:

hideChanFromHB

now available in multiDevices[].hideChannels


switchAsOutlet

now available in singleDevices[].showAsOutlet


outletAsSwitch

now available in outletDevices[].showAsSwitch


inUsePowerThreshold

now available in outletDevices[].inUsePowerThreshold


hideLightFromFan

now available in fanDevices[].hideLight


hideSwitchFromTH

now available in thDevices[].hideSwitch


thAsThermostat

now available as an Accessory Simulation


resetRFBridge

now available using ignoredDevices


lowBattThreshold

now available in sensorDevices[].lowBattThreshold


sensorTimeDifference

now available in sensorDevices[].sensorTimeDifference


bulbB02BA60

now available in lightDevices[].model


bulbB02FST64

now available in lightDevices[].model


thTempOffset

now available in thDevices[].offset


hideZBLDPress

now available in sensorDevices[].hideLongDouble


ZBDWBatt

now available in sensorDevices[].scaleBattery


ipOverride

now available in singleDevices[].ipAddress, multiDevices[].ipAddress, outletDevices[].ipAddress and groups[].ipAddress


Common Examples


Hide channels 2 and 3 of a multi-channel device:


HOOBS users, copy and paste this code block into the 'Multi Devices' config box


If editing the config JSON directly, don't forget the "multiDevices": before the first [
[
   {
      "deviceId": "1000ab23cd",
      "label": "Front Lights",
      "hideChannels": "2,3"
   }
]


Hiding channels of multiple devices:
[
   {
      "deviceId": "1000ab23cd",
      "label": "Front Lights",
      "hideChannels": "2,3"
   },
   {
      "deviceId": "1000ab23cf",
      "label": "Bed Lights",
      "hideChannels": "2,3"
   }
]


Assign a single-channel device an IP address


HOOBS users, copy and paste this code block into the 'Single Devices' config box


If editing the config JSON directly, don't forget the "singleDevices": before the first [
[
   {
      "deviceId": "1000ab23cd",
      "label": "Hall Light",
      "ipAddress": "192.168.4.78"
   }
]


Hide the light from an iFan device


HOOBS users, copy and paste this code block into the 'Fan Devices' config box


If editing the config JSON directly, don't forget the "fanDevices": before the first [
[
   {
      "deviceId": "1000ab23cd",
      "label": "Master Fan",
      "hideLight": true
   }
]


Hide the switch from a TH10/16


HOOBS users, copy and paste this code block into the 'TH Devices' config box


If editing the config JSON directly, don't forget the "thDevices": before the first [
[
   {
      "deviceId": "1000ab23cd",
      "label": "Thermometer",
      "hideSwitch": true
   }
]


Support

If you need any help with this, or need a hand with updating your current config, please reach out on my Discord Server or by creating an issue on the plugin Github Repo.