homebridge-ewelink

Fixed

• Fixed an issue where an irrigation valve simulation would not turn off after the set time

Changed

• configureAccessory function simplified to reduce chance of accessory cache retrieval failing
• Bump axios to v0.21.4
• Bump ws to v8.2.2

Changed

• Recommended node version bumped to v14.17.6
• Bump axios to v0.21.3
• Bump ws to v8.2.1

Added

• Support for KingArt KING-Q1 garage door device
• Expose KingArt KING-Q4 device as a Window or Door HomeKit accessory type
• Custom Eve characteristic to invert status of inched switch without sending a command to device

Changed

• 'Status By Inching' switches will no longer revert to 'off' when Homebridge is restarted

Changed

• Bump ws to v8.2.0

Fixed

• An issue preventing DUALR3 from initialising
• Fix for uiid 112

Added

• Support for UIIDs 138 139 140 141

Added

• inchChannels option for multi-channel switches and outlets (where the plugin will set on/off status based on inching)
• language option to have the plugin log in French, thanks to @jp-lno

Changed

• Platform Versions
  • Recommended node version bumped to v14.17.5

Changed

• Improved battery calculations for DW2 sensors

Important Note

• Your Accessory Simulations will stop working with this update if you have not re-set them up in the appropriate device configuration sections.
• There is no longer a separate Accessory Simulations section
• It is recommended to re-setup your simulations before updating to this version

Added

• Single Channel Devices
  • Option to configure a single channel device to set its status based on device inching
• DUALR3 Motor Mode
  • Expose a DUALR3 in motor mode as a GarageDoorOpener accessory type
• Temperature/Humidity Sensor Devices
  • Option to offset recorded temperature or humidity by a scale factor
• Configuration
  • disableNoResponse setting to disable marking cloud-offline devices as 'No Response' in HomeKit
  • Plugin will now check for duplicate device ID entries in the config and ignore them

Changed

• ⚠️ Platform Versions
  • Recommended node version bumped to v14.17.4
  • Recommended homebridge version bumped to v1.3.4
• ⚠️ Accessories
  • Plugin will now mark cloud-offline devices with 'No Response' by default
  • Plugin will now use HomeKit Battery service type instead of BatteryService
• Backend
  • Plugin will now reattempt initial HTTP connection on ECONNABORTED error

Fixed

• Plugin will correctly update StatusLowBattery characteristic with INT instead of type BOOL

Removed

• ⚠️ offlineAsNoResponse configuration setting - is now default - can be disabled with new disableNoResponse setting
• ⚠️ ignoredDevices configuration setting - now use the ignoreDevice option in the device type sections
• ⚠️ groups configuration setting - now use the showAs option in the device type sections

Added

• New Devices
  • Support for Zigbee multi-channel devices

Changed

• Homebridge UI
  • label field now appears first in the device configuration sections
  • A device can now be ignored/removed from Homebridge by the ignoreDevice setting in the device configuration sections
• Bump ws dependency to v7.5.3

Changes

• Revert node version bump to v14.17.3 (back to v14.17.2)

Changes

• Device model in configuration will be validated

Fixed

• An issue preventing garage doors and locks with a defined sensor from initialising

Important Notes

• This release includes breaking changes (denoted below with a ⚠️), so take note especially if:
  • You use the plugin in LAN-only mode,
  • You have Sonoff devices exposed as Outlet accessories, or
  • You use Accessory Simulations

Added

• LAN Mode (without eWeLink credentials)
  • The plugin now supports removing eWeLink credentials from the config when in LAN mode. It is important to read about this feature before enabling it - read more
• Homebridge UI
  • Device-specific settings will show and hide depending on the new 'Device Model' (deviceModel) option
  • This showing/hiding of options will hopefully be available in the HOOBS UI soon
• Accessory Logging
  • overrideLogging setting per device type (to replace the removed overrideDisabledLogging), which can be set to (and will override the global device logging and debug logging settings):
    • "default" to follow the global device update and debug logging setting for this accessory (default if setting not set)
    • "standard" to enable device update logging but disable debug logging for this accessory
    • "debug" to enable device update and debug logging for this accessory
    • "disable" to disable device update and debug logging for this accessory
• Startup Logging
  • An accessory warning if a manually configured IP is different from the discovered IP
  • An accessory warning if a shared device is used over the cloud
  • An accessory warning if a cloud-device is reported offline
• No Response Status
  • Added a global setting offlineAsNoResponse to mark cloud-offline accessories as 'No Response' in HomeKit
• Power Readings
  • Power readings (via Eve app) now visible for accessories when exposed as Switch
• DUALR3 Devices
  • Support for LAN mode control for DUALR3 in motor mode
  • Power readings (via Eve app) available when in motor mode
  • Option to expose as a WindowCovering, Window or Door accessory type when in motor mode
• iFan Devices
  • Support for LAN mode and ability to specify a manual IP
• TH10/16 Devices
  • Support for LAN mode for all Accessory Simulations and ability to specify a manual IP
• RF Bridge Devices
  • Ability to change sensor type and other configurable options without the need to re-add the accessory
  • Configuration option resetOnStartup to reset the subdevices, useful when adding/removing subdevices to the bridge
  • Added option to specify a manual IP for an RF Bridge
  • Added option to expose an RF sensor device as a Doorbell accessory type
  • Added option to expose an RF sensor device as a StatelessProgrammableSwitch accessory type
• Light Devices
  • Remove Adaptive Lighting feature from a device by setting the adaptiveLightingShift to -1
• Zigbee Button Devices
  • Comparison of trigger time against notification time to reduce duplicate accessory updates
  • Will no longer request current state when coming back online to reduce duplicate accessory updates
• Zigbee Switch Devices
  • Option to expose as an Outlet
• Humidity Sensor Devices
  • Config option to offset the recorded humidity (%RH) for devices that report this
• Accessory Simulations
  • Expose a generic single/multi-channel device as a Doorbell accessory
  • Expose a generic single/multi-channel device as a StatelessProgrammableSwitch accessory
  • Added the option of using a DW2 or Zigbee contact sensor to determine Locked and Unlocked state for lock simulation
  • Power readings (via Eve app) visible for simulations when using a DUALR3 device
• New Devices
  • Support for Zigbee leak sensors
  • Support for device with eWeLink UIID 67 RollingDoor

Changed

• LAN Mode
  • ⚠️ If you have the plugin in lan-only mode then the plugin will remove any accessories that do not support LAN mode
• Configuration
  • ⚠️ The 'Outlet Devices' (outletDevices[]) section has been removed from the configuration - you will need to reconfigured these devices within the 'Single Devices' (singleDevices[]) section
• Accessory Simulations
  • ⚠️ The 'Accessory Simulations' (groups[]) section will be removed in a future plugin version - you should now setup your simulations from within the appropriate device type section using the 'Show As' setting
    • Simulations for TH10/16, DW2 and doorbell, p_button & sensor will need to be recreated immediately
    • Garage door, window blind, door, window, valve, tap, lock and switch-valve simulations will continue to work for now but will need to be recreated at some point in the future
  • ⚠️ Eachen GD-DC5 devices no longer need to be setup as a simulation if this deviceModel is chosen in the configuration
• Outlet Devices
  • ⚠️ Will now be exposed by default as Switch, use the 'Show As' setting to change back to Outlet if needed
• Homebridge UI
  • More interactive - device configuration will expand once device ID and model entered
  • Device configuration options will now hide/show based on the deviceModel field
• Startup Logging
  • Accessory configuration options will be logged regardless of logging level
• iFan Devices
  • Previous fan speed will be used again after turning off and on
• Polling
  • Polling for power/temperature/humidity readings increased to two minutes
  • Polling for power/temperature/humidity readings will be skipped if device is marked as offline
• Configuration
  • sensorTimeDifference minimum reduced to 5 seconds and default reduced to 60 seconds
• Dependencies
  • Recommended node version bump to v14.17.3
  • Bump ws dependency to v7.5.2

Fixed

• An issue preventing controlling a garage door simulation when using a sensor
• An issue with the DUALR3 in motor mode hanging on 'Closing...' or 'Opening...'
• Fixed the multiple notifications when closing an Eachen device garage door
• A RangeError error which caused HOOBS bridge to restart

Removed

• overrideDisabledLogging setting for each accessory type
• outletDevices[] configuration section
• switchDevices[].showAsOutlet removed - use switchDevices[].showAs instead
• ContactSensorState and other unneeded characteristics from garage (simulation) services

Added

• Accessory Simulations
  • Expose a single/multi channel device as any type of sensor
  • Expose a single/multi channel device an Air Purifier
  • Expose a TH10/16 device as a Cooler
  • Expose a TH10/16 device as a Humidifier
  • Expose a TH10/16 device as a Dehumidfier
• LAN Mode
  • Enabled for TH10/16 (requires firmware 3.5.0, not available when using an accessory simulation)
• Plugin UI
  • Show MAC address of accessory in plugin-ui

Changes

• TH10/16 simulation accessory type change from Thermostat to Heater
• Remove setup config option for simulations as device type is now automatically determined
• Fix a logging issue for the zigbee contact sensor

Changes

• Fixes an issue with sensors with a garage simulation
• Fixes an issue with TH10/16 devices with web socket timeouts

Added

• Hide a contact sensor from HomeKit when used with a garage door simulation
• Support devices with eWeLink UIID 112, 113, 114

Changes

• Avoid repeated battery logging for the Sonoff DW2
• iFan logging modifications
• Fix internal API auth issue when using a base64 encoded password
• Throw an error when controlling a device when the web socket is closed (avoid queuing updates)
• Recommended node version bump to v14.17.0
• Bump ws dependency to v7.4.6
• Use standard-prettier code formatting

Added

• Log internal API requests when in debug mode
• Support querying temperature and humidity values via the internal API

Changes

• Removed encodedPassword and language config options
  • The plugin will now initially try the supplied password and if incorrect will attempt another login with a base64 decoded version
  • Language option unnecessary until if and when other languages are available
• Display temperature and humidity units for the zigbee temperature/humidity sensor in the logs
• Fixes an issue where the web socket would not close on plugin shutdown
• Reduce the 'No Response' timeout to 2 seconds
• Update the correct corresponding characteristic after the 'No Response' timeout
• Ensure user is using at least Homebridge v1.3.0
• Update homebridge-ui wiki links to match github readme file

Changes

• Fixes an initialisation issue with the 'garage' and 'obstruction detection' switch simulations
• Amendments to internal API endpoints
• Device IP changes will now reflect correctly

Added

• Internal HTTP API to query/control the state of certain homebridge-ewelink accessories
  • Options for new configuration setting apiPort are:
    • 0 to disable the API (default setting)
    • 1 to enable the API with a random available port (port will be shown in the log)
    • Any higher integer to enable the API on this fixed port
  • Documentation for the API can be seen at the base url (Homebridge IP + API port)