Skip to content

Commit

Permalink
Update FAQs and prep 2.5.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
rhockenbury committed Sep 22, 2024
1 parent 7c16463 commit 7453c59
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 93 deletions.
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* Implement support for WN32 and WN32P
* Add Homebridge verified badge


### 2.4.1

* Promote v2 to GA
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<!-- badges -->

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![NPM Version](https://img.shields.io/npm/v/homebridge-ecowitt-weather-sensors)](https://www.npmjs.com/package/homebridge-ecowitt-weather-sensors) [![NPM Downloads](https://img.shields.io/npm/d18m/homebridge-ecowitt-weather-sensors)](https://www.npmjs.com/package/homebridge-ecowitt-weather-sensors) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Test Status](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/actions/workflows/build-master.yml/badge.svg)](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/actions/workflows/build-master.yml)
[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![Test Status](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/actions/workflows/build-master.yml/badge.svg)](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/actions/workflows/build-master.yml) [![NPM Version](https://img.shields.io/npm/v/homebridge-ecowitt-weather-sensors)](https://www.npmjs.com/package/homebridge-ecowitt-weather-sensors) [![NPM Downloads](https://img.shields.io/npm/d18m/homebridge-ecowitt-weather-sensors)](https://www.npmjs.com/package/homebridge-ecowitt-weather-sensors) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

:fast\_forward: :fast\_forward: :fast\_forward: **[Getting Started](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/tree/master?tab=readme-ov-file#getting-started) | [Supported Devices](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/tree/master?tab=readme-ov-file#supported-devices) | [Configuration](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors?tab=readme-ov-file#configuration) | [FAQs](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors?tab=readme-ov-file#frequently-asked-questions) | [Contributing](https://github.com/rhockenbury/homebridge-ecowitt-weather-sensors/blob/master/docs/CONTRIBUTING.md)** :rewind: :rewind: :rewind:

Expand Down Expand Up @@ -199,13 +199,13 @@ It's recommended to configure the plugin through the Plugin Config UI on the Hom
> 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?
### I've added an Ecowitt device to my gateway or console, and can see it on the **WSView Plus** app , but the accessory is not showing up in Homebridge or Homekit?

> Please [open a feature request](https://github.com/rhockenbury/homebridge-ecowitt/issues/new?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=) on the Github project to let me know what devices you are interested in getting support for.
> The plugin only performs device discovery on the first data report after the plugin starts. If you add a device, please restart Homebridge to trigger the discovery and the plugin should pick up the new device, and create the accessory. In the Homebridge logs, you can look for logs that begin with `Adding new accessory` to confirm it was added.
### I've added an Ecowitt device to my gateway or console, and can see it on the WS View App, but the accessory is not showing up in Homebridge or Homekit?
### I use an Ecowitt sensor that's not currently supported. What can I do to get it supported?

> The plugin only does device discovery on the first data report after the plugin starts. If you add a device, please restart Homebridge to trigger the discovery and the plugin should pick up the new device. In the Homebridge logs, you can look for logs like `Adding new accessory` to confirm it was added.
> Please [open a feature request](https://github.com/rhockenbury/homebridge-ecowitt/issues/new?assignees=\&labels=enhancement\&projects=\&template=feature-request.md\&title=) on the Github project to let me know what devices you are interested in getting 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.
## Contributing

Expand Down
116 changes: 31 additions & 85 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"remark": "remark --frail --use remark-validate-links --use remark-lint-no-dead-urls . --quiet --frail --output",
"build": "rimraf ./dist && tsc && npm link",
"test": "NODE_OPTIONS=\"--import=tsx\" mocha \"tests/**/*.spec.ts\"",
"prepublishOnly": "npm run lint && npm run remark && npm run build && npm run test"
"all": "npm run lint && npm run remark && npm run build && npm run test",
"prepublishOnly": "npm run all"
},
"keywords": [
"homebridge-plugin",
Expand All @@ -41,7 +42,7 @@
"body-parser": "^1.20.2",
"date-fns": "^3.6.0",
"deepmerge": "^4.3.1",
"express": "^4.19.2"
"express": "^4.21.0"
},
"devDependencies": {
"@types/node": "^20.14.12",
Expand Down

0 comments on commit 7453c59

Please sign in to comment.