You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+18-8
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ This plugin operates as a service that listens for data reports from an Ecowitt
20
20
21
21
For bugs, feature requests, and questions - [please file a new issue](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/issues/new/choose).
22
22
23
-
> :arrow\_up: :arrow\_up: :arrow\_up: **v2 beta is now available! These docs are for v2, and v1 docs can be found [here](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/tree/v1-release). The [v2 config migration guide](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/wiki/V2-Migration-Guide)is also available. Note that the initial v2 beta has temporarily removed support for WH65 which will be added back shortly in an upcoming release. Please [report any issues](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/issues/new/choose).**
23
+
> :arrow\_up: :arrow\_up: :arrow\_up: **v2 is now available! These docs are for v2, and v1 docs can be found [here](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/tree/v1-release). See the [v2 config migration guide](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/wiki/V2-Migration-Guide)to get started with the migration. Please [report any issues](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/issues/new/choose).**
24
24
25
25
## Features
26
26
@@ -112,7 +112,7 @@ The full list of all [Ecowitt sensors](https://shop.ecowitt.com/collections/wifi
112
112
113
113
This plugin currently supports the Ecowitt devices shown in the table below. If your Ecowitt device is currently not supported, [please open a feature request](https://github.com/rhockenbury/homebridge-ecowitt/issues/new?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=).
114
114
115
-
| Device | Description | Service Types| Product Image |
115
+
| Device | Description | Service | Product Image |
| WN31 / WH31 (and EP variants) | Multi-Channel Temperature and Humidity Sensor | <ul><li>Temperature</li><li>Humdity</li></ul> | <imgsrc="./docs/assets/WN31.jpeg"alt="WN31"width="200"/> |
126
+
| WN31 / WH31 (including S and EP variants) | Multi-Channel Temperature and Humidity Sensor | <ul><li>Temperature</li><li>Humdity</li></ul> | <imgsrc="./docs/assets/WN31.jpeg"alt="WN31"width="200"/> |
127
127
| WN34 (S, D, and L variants) | Multi-Channel Temperature Sensor | <ul><li>Temperature</li></ul> | <imgsrc="./docs/assets/WN34.jpeg"alt="WN34"width="200"/> |
| WN36 | Floating Pool Thermometer <br> *Note this will register as a WN30*| <ul><li>Temperature</li></ul> | <imgsrc="./docs/assets/WN36.jpeg"alt="WN36"width="200"/> |
| WH41 / WH43 | PM2.5 Air Quality Sensor Monitor Outdoor | <ul><li>PM2.5 Air Quality</li><li>PM2.5 Air Quality (24hrs)</li></ul> | <imgsrc="./docs/assets/WH41.jpeg"alt="WH41"width="200"/> |
131
+
| WH41 | PM2.5 Air Quality Sensor with Solar Panel | <ul><li>PM2.5 Air Quality</li><li>PM2.5 Air Quality (24hrs)</li></ul> | <imgsrc="./docs/assets/WH41.jpeg"alt="WH41"width="200"/> |
132
+
| WH43 | PM2.5 Air Quality Sensor <br> *Note this will register as a WH41*| <ul><li>PM2.5 Air Quality</li><li>PM2.5 Air Quality (24hrs)</li></ul> | <imgsrc="./docs/assets/WH43.jpeg"alt="WH43"width="200"/> |
130
133
| WH45 | 5-in-1 PM2.5 / PM10 / CO₂ Air Quality Sensor | <ul><li>Temperature</li><li>Humidity</li><li>PM2.5 Air Quality</li><li>PM2.5 Air Quality (24hrs)</li><li>PM10 Air Quality</li><li>PM10 Air Quality (24hrs)</li><li>CO₂ Level</li><li>CO₂ Level (24 hrs)</li></ul> | <imgsrc="./docs/assets/WH45.jpeg"alt="WH45"width="200"/> |
131
134
| WH46 | 7-in-1 PM1.0 / PM2.5 / PM4.0 / PM10 / CO₂ Air Quality Sensor | <ul><li>Temperature</li><li>Humidity</li><li>PM2.5 Air Quality</li><li>PM2.5 Air Quality (24hrs)</li><li>PM10 Air Quality</li><li>PM10 Air Quality (24hrs)</li><li>CO₂ Level</li><li>CO₂ Level (24 hrs)</li></ul> | <imgsrc="./docs/assets/WH46.jpeg"alt="WH46"width="200"/> |
> :warning:**This plugin does not currently implement barometric (pressure) services and PM1.0/PM4.0 air quality services. While these are not supported natively by HomeKit as this time, they are planned to be implemented with custom characteristics, see [this issue](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/issues/5).**
139
145
@@ -168,7 +174,7 @@ It's recommended to configure the plugin through the Plugin Config UI on the Hom
168
174
| units.distance |`mi`| The units to display distance such as lightning strike distance. Possible values are: <br/><br/>`mi`: Miles<br/>`km`: Kilometers |
169
175
| units.temperature |`fh`| The units to display temperature. Possible values are: <br/><br/>`fh`: Fahrenheit<br/>`ce`: Celcius |
170
176
| thresholds |`{}`| A mapping of a weather data property to the trigger threshold for that property. By default no thresholds are set. Trigger thresholds should be specified in the units selected under the `units` configuration block. Possible keys are: <br/><br/>`windSpeed`<br/>`windGustSpeed`<br/>`windMaxDailySpeed`<br/>`rainRate`<br/>`rainEventTotal`<br/>`rainHourlyTotal`<br/>`rainDailyTotal`<br/>`rainWeeklyTotal`<br/>`rainMonthlyTotal`<br/>`rainYearlyTotal`<br/>`uvIndex`<br/>`lightningEvents`<br/>`lightningDistance *`<br/>`lightningTime *` <br/><br/> \*The value of the weather data property must be <strong>greater than</strong> the threshold to trigger the accessory (motion detected), except for `lightningDistance` and `lightningTime` which are triggered when the weather data property is <strong>less than</strong> the threshold. |
171
-
| hidden |`{}`| A mapping of a weather data property or device to whether it should be displayed. By default no weather data or devices are hidden. Possible keys to hide weather data are: <br/><br/>`windDirection`<br>`windSpeed`<br/>`windGustSpeed`<br/>`windMaxDailySpeed`<br/>`rainRate`<br/>`rainEventTotal`<br/>`rainHourlyTotal`<br/>`rainDailyTotal`<br/>`rainWeeklyTotal`<br/>`rainMonthlyTotal`<br/>`rainYearlyTotal`<br/>`solarRadiation`<br/>`uvIndex`<br/>`temperature`<br/>`humdity`<br/>`indoorTemperature`<br/>`indoorHumdity`<br/>`soilMoisture`<br/>`dewPoint`<br/>`waterLeak`<br/>`airQualityPM25`<br/>`airQualityPM25Avg`<br/>`airQualityPM10`<br/>`airQualityPM10Avg`<br/>`carbonDioxide`<br/>`carbonDioxideAvg`<br/>`lightningEvents`<br/>`lightningDistance`<br/>`lightningTime` <br/><br/> Possible keys to hide devices are: <br/><br>`GW1000`<br>`GW2000`<br>`HP2560`<br>`WH25`<br>`WH26`<br>`WN30`<br>`WN31`<br>`WN34`<br>`WH40`<br>`WH41`<br>`WH45`<br>`WH46`<br>`WH51`<br>`WH55`<br>`WH57`<br>`WS85`<br/> |
177
+
| hidden | `{}` | A mapping of a weather data property or device to whether it should be displayed. By default no weather data or devices are hidden. Possible keys to hide weather data are: <br/><br/>`windDirection`<br>`windSpeed`<br/>`windGustSpeed`<br/>`windMaxDailySpeed`<br/>`rainRate`<br/>`rainEventTotal`<br/>`rainHourlyTotal`<br/>`rainDailyTotal`<br/>`rainWeeklyTotal`<br/>`rainMonthlyTotal`<br/>`rainYearlyTotal`<br/>`solarRadiation`<br/>`uvIndex`<br/>`temperature`<br/>`humdity`<br/>`indoorTemperature`<br/>`indoorHumdity`<br/>`soilMoisture`<br/>`leafWetness`<br/>`waterLeak`<br/>`airQualityPM25`<br/>`airQualityPM25Avg`<br/>`airQualityPM10`<br/>`airQualityPM10Avg`<br/>`carbonDioxide`<br/>`carbonDioxideAvg`<br/>`lightningEvents`<br/>`lightningDistance`<br/>`lightningTime` <br/><br/> Possible keys to hide devices are: <br/><br>`GW1000`<br>`GW2000`<br>`HP2560`<br>`WH25`<br>`WH26`<br>`WN30` (Also use for `WN36`)<br>`WN31`<br>`WN34`<br>`WN35`<br>`WH40`<br>`WH41` (Also use for `WH43`)<br>`WH45`<br>`WH46`<br>`WH51`<br>`WH55`<br>`WH57`<br>`WH65`<br>`WS68`<br>`WS80`<br>`WS85`<br/>`WS90`<br> |
172
178
| nameOverrides |`[]`| A list of key value pairs that specifies the override name for an accessory service. Each override takes on the form: <br><br> `{"key": "<the-service-identifier>", "value", "<the-override-name"}` <br><br> The service identifier is specified in the form `YYYY(CHZ)` or if an accessory has multiple services the weather data property should be included in the identifier `YYYY(CHZ):<weather-data-property>`. <br><br>`YYYY` is the device id (e.g. WH41) <br> `(CHZ)` is the optional channel id if the device uses a channel. <br><br> The weather data property can be set to any of the weather data keys indicated in `hidden`|
173
179
| additional.staticNames |`false`| Set to `true` to not show the weather metric value in the service names of the accessory so that the service names do not change. |
174
180
| additional.validateMac |`true`| Check that the MAC address in each data report matches the MAC address specified for the plugin, and do not process the data report if it does not match. |
@@ -199,6 +205,10 @@ It's recommended to configure the plugin through the Plugin Config UI on the Hom
199
205
200
206
Contributions are welcomed! Please report bugs, suggest improvements, and open pull requests. For major pull requests, please open an issue first to discuss what you would like to change. See the [Contributing Guide](./docs/CONTRIBUTING.md) for more info.
201
207
208
+
## Supporting
209
+
210
+
This plugin requires my time and energy to develop and maintain, as well as the occasional Ecowitt device purchase. If you feel you have gotten value from this plugin, please consider [making a donation](https://www.paypal.com/donate/?business=4G6G3V4CYG2CY).
0 commit comments