Skip to content
This repository has been archived by the owner on Nov 25, 2023. It is now read-only.

Latest commit

 

History

History
184 lines (132 loc) · 7.4 KB

README.md

File metadata and controls

184 lines (132 loc) · 7.4 KB
Raw

Ecowitt Sensors Homebridge Plugin

NOTE: This is a fork of christocomm/homebridge-ecowitt that adds the following functionality:

  • Added option for even less update logging

A Homebridge plugin providing support for a wide range of Ecowitt sensors.

The plugin operates as a service that listens for data reports from an Ecowitt WiFi Gateway or Weather Display Console.

Features include -

  • Support for a wide range of sensor types
  • Operates locally without the need for any cloud services
  • Sensors can be hidden via the plugin settings
  • Configurable display units

Release Notes

  • 1.3.0

    • Cloned from christocomm/homebridge-ecowitt v1.2.1 (2023-10-23)
    • Added option for even less update logging

  • 1.2.0

    • Added support for WH90

  • 1.1.7

    • Added support for WH32
    • Added support for all types of GW1100 (A, B, C, etc.)

  • 1.1.5

    • Cloned from @conquistadore/homebridge-ecowitt v1.1.4 (2023-03-19)
    • Changed the temperature sensors to optionally show up as Thermostat tiles in Homekit
    • Added the option to unregister existing accessories trhough the config
    • Fixed an issue with how the exisiting accessories were initialized

  • 1.1.0

    • Added rain detection thresholds
    • Added lux conversion factor setting
    • Round inches to mm conversion to 1 decimal place

  • 1.0.0

    • Initial release

Note: This plugin is still in development. Please consider this when installing it on your system. Feedback is welcome.

Requirements

  • GW1000/GW1100A Gateway or HP2551 Weather Display Console

Installation

Option 1: Install via Homebridge Config UI X:

Search for "Ecowitt" in homebridge-config-ui-x and install homebridge-ecowitt.

Option 2: Manually Install:

sudo npm install -g @kshakir/homebridge-ecowitt

Configuration

It is recommended to configure the plugin via the Settings UI.

The plugin's Base Station settings must be configured before configuring the Ecowitt gateway or display console.

MAC Address

This can be found int he About screen on the Weather Display Console or via the WS View app.

The MAC address is used validate that the data report received is coming from the correct gateway or display console.

Data Report Service

The Port and Path settings configure on which port and path the data report service will listen for data reports coming from the gateway or display console.

Typical settings for the are 8080 for the port and /data/report for the path. Other values may be used as desired. Depending on your system or network configuration ensure the Port number being used is not blocked.

Geteway / Display Console

After configuring the Base Station settings, restart Homebridge and confirm via the status log that there are no errors and that the data report service has been started and is listening.

The gateway or display console can be configured using the Ecowitt WS View app. The display console can also be configured directly via its UI.

Before updating the gateway or display console to report its data to the plugin, ensure all the available sensors have been configured and are correctly reporting their data.

The plugin requires the custom weather service to be configured to report data with Path and Port parameters that match the same in the Base Station settings.

The service Protocol Type must be configured as Ecowitt. The Upload Interval can be configured as desired. 20 seconds is recommended as the data report messages are relatively small and do not put much load on the network or Homebridge host.

It is also recommended to configure the Homebridge host system with a static IP address to avoid issues with address changes after system reboots.

After the gateway or display console has been configuration has been updated, sensor data reports will appear in the Homebridge status log. The plugin will automatically configure the accessories based on the first data report received.

Tested Devices

  • GW1000 - WiFi Weather Station Gateway with Indoor Temperature, Humidity and Barometric Sensor
  • GW1100A - WiFi Weather Station Gateway with Indoor Temperature, Humidity and Barometric Sensor
  • HP2551 - Weather Station Display Console
  • WH24 - Solar Powered 7-in-1 Outdoor Sensor
  • WH31 - Multi-Channel Temperature and humidity Sensor
  • WH32 - Outdoor Temperature and Humidity Sensor
  • WH41 - PM2.5 Air Quality Sensor Monitor Outdoor
  • WH51 - Wireless Soil Moisture Sensor
  • WH55 - Wireless Water Leak Detection Sensor with Loud Audio Alarm
  • WH57 - Wireless Lightning Detection Sensor
  • WH65 - Solar Powered 7-in-1 Outdoor Sensor

Sensor Notes

Outdoor Weather Sensors

Wind

  • Sensors (Can be indvidually hidden via the plugin settings)
    • Direction
    • Speed
    • Gust
    • Maximum Daily Gust
  • Presented as Motion Sensors
    • Motion Detected status is triggered based on thresholds configured in the plugin settings
  • Thresholds are configured using the Beaufort Scale
  • Wind speed display units can be configured in the plugin setting.

Rain

  • Sensors (Can be individually hidden via the plugin settings)
    • Rate
    • Event
    • Hourly
    • Daily
    • Weekly
    • Monthly
    • Yearly
  • Presented as Leak Sensors
    • For the Rate sensor, the Leak Detected status is based on the threshold configured in the plugin settings.
    • For all other sensors the Leak Detected status is triggered if the sensor's value is non-zero
  • Rain display units and detection thresholds are configured the plugin settings

UV Index

  • Can be hidden via plugin settings
  • Presented as an Occupancy Sensor
    • Occupancy Detected status is based on the threshold configured in the plugin settings

Solar Radiation

  • Can be hidden via plugin settings
  • Presented as a Light Sensor
  • Display units and conversion factor to lux are configured in plugin settings

Indoor Thermometer/Hygrometer/Barometer Sensor

  • Can be hidden via plugin settings

Multi-Channel Thermometer/Hygrometer Sensors

  • Can be hidden via plugin settings
  • Up to 8 sensors supported
  • Sensors can be individually named via the plugin settings

Outdoor Thermometer/Hygrometer/Barometer Sensor

  • Can be hidden via plugin settings

Lightning Detection Sensor

  • Can be hidden via plugin settings
  • Number of lighing events is presented as a Contact Sensor
    • Open state when number of events is > 0
    • Closed state when number of events is 0
  • Distance and time presented as an Occupancy Sensor
    • Occupancy Detected status is set when number of events is > 0
  • Distance units configured via plugin settings

Soil Moisture Sensors

  • Can be hidden via plugin settings
  • Up to 8 sensors supported
  • Sensors can be individually named via the plugin settings
  • Presented as Humidity Sensors

Leak Detection Sensors

  • Can be hidden via plugin settings
  • Up to 4 sensors supported
  • Sensors can be individually named via the plugin settings

PM2.5 Air Quality Sensors

  • Can be hidden via plugin settings
  • Up to 4 sensors supported
  • Sensors can be individually named via the plugin settings
  • Current and 24H Average presented as separate sensors