Skip to content

Commit

Permalink
Updates to support v2.1.0-beta
Browse files Browse the repository at this point in the history
  • Loading branch information
rhockenbury committed Sep 10, 2024
1 parent 6da7113 commit e5648c7
Show file tree
Hide file tree
Showing 36 changed files with 373 additions and 98 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
### 2.1.0-beta

* Update device names to not include parentheses so default names can be saved in Homekit
* Update log messages around adding and removing accessories to include accessory UUID
* Correct migration guide link embedded in log messages
* Add links to collecting/submitting the Ecowitt data report for Github issues
* Implement removeStaleDevices setting to auto-remove devices that do not appear in data report
* Adjusted temperature and humidity service names to mirror Homekit formatting
* Implement rudimentary data report simulator to support manual plugin testing
* Fix issue with timestamp validation and timezone offset
* Add warning if data report interval is set to lower than 10 seconds

### 2.0.0-beta

* New plugin UI for plugin configuration with expanded capabilities
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,18 +169,21 @@ It's recommended to configure the plugin through the Plugin Config UI on the Hom
| additional.luxFactor | `126.7` | Factor to multiple the Solar Radiation data (in W/m<sup>2</sup>) to convert to Lux. |
| additional.acceptAnyPath | `false` | Process data reports that are submitted to the plugin on paths other than the path specified in `baseStation.path`. |
| additional.validateTimestamp | `true` | Check the recency of the data report with the `dateutc` weather data property, and do not process the data report if its determined to be old. |
| additional.removeStaleDevices | `true` | Remove the accessory from Homebridge if it does not appear in the current data report during device discovery. |

## Frequently Asked Questions

### How do I migrate to this plugin from other Homebridge Ecowitt plugins?

> This plugin includes most prior version of Homebridge Ecowitt plugin forks including v1.0 and v1.1 from [spatialdude](https://github.com/spatialdude), v1.2 and v1.3 from [ochong](https://github.com/ochong) and v1.4 from [pavelserbajlo](https://github.com/pavelserbajlo). If you are currently using any of these mentioned versions, you can switch to the equivalent version of this plugin and get the exact same functionality.
> This plugin includes most prior version of Homebridge Ecowitt plugin forks including v1.0 and v1.1 from [spatialdude](https://github.com/spatialdude), v1.2 and v1.3 from [ochong](https://github.com/ochong) and v1.4 from [pavelserbajlo](https://github.com/pavelserbajlo). If you are currently using any of these mentioned versions, you can switch to the same version of <em>this</em> plugin and get the same functionality.
> I would also recommend updating to the latest version of this plugin to take advantage of the new features. To migrate from any v1.x version to v2.x version (or higher), you should clear the Homebridge accessory cache for all Ecowitt accessories, install the latest plugin version, and then restart Homebridge. You may also want to check out the [v2 migration guide](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/wiki/V2-Migration-Guide).
> I would also recommend updating to the latest version of this plugin to take advantage of the new features. Check out the [v2 migration guide](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/wiki/V2-Migration-Guide) for more info on updating.
### Does this plugin support devices produced by other manufacturers?

> There are a number of weather station distributors that re-package and re-brand the hardware sensors from [Fine Offset](https://www.foshk.com/Wifi_Weather_Station/). Along with Ecowitt, other notable distributors include Aercus, Ambient Weather, and Frogger. These brands typically also use similar firmware / software within their ecosystem, and many provide the ability to publish weather data reports to a custom endpoint. If the weather station brand you are using relies on [Fine Offset](https://www.foshk.com/Wifi_Weather_Station/) hardware, and can publish custom/local weather reports, please [file a feature request](https://github.com/rhockenbury/homebridge-ecowitt/issues/new?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=) to let me know what devices you need support for.
> There are a number of weather station distributors that re-package and re-brand the hardware sensors from [Fine Offset](https://www.foshk.com/Wifi_Weather_Station/). Along with Ecowitt, other notable distributors include Aercus, Ambient Weather, and Frogger. These brands typically also use similar firmware / software within their ecosystem, and many provide the ability to publish weather data reports to a custom endpoint.
> If the weather station equipment you are using supports a custom weather service endpoint, please [file a feature request](https://github.com/rhockenbury/homebridge-ecowitt/issues/new?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=) to let me know what devices you would like support for. Please make sure to [include the data report](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/wiki/Submitting-Data-Report) in the feature request.
### I use an Ecowitt sensor that's not currently supported. What can I do to get it supported?

Expand Down
12 changes: 11 additions & 1 deletion config.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@
"description": "Verify the timestamp in each received <br> data report",
"enum": [true, false],
"enumNames": ["Enabled", "Disabled"]
},
"removeStaleDevices": {
"title": "Stale Device Removal",
"type": "string",
"required": true,
"default": true,
"description": "Remove an accessory if it is no longer <br> discovered from a data report",
"enum": [true, false],
"enumNames": ["Enabled", "Disabled"]
}
}
},
Expand Down Expand Up @@ -869,7 +878,8 @@
"type": "flex",
"items": [
"additional.luxFactor",
"additional.acceptAnyPath"
"additional.acceptAnyPath",
"additional.removeStaleDevices"
]
}
]
Expand Down
Binary file added docs/assets/homebridge-data-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/homebridge-debug-mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/v2-migrate-video-1.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/v2-migrate-video-2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e5648c7

Please sign in to comment.