Skip to content

Commit

Permalink
Housekeeping.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjdhjd committed May 21, 2024
1 parent 16a1b4a commit d3fc14b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ To get started with `homebridge-hunter-hydrawise`:
## Plugin Development Dashboard
This is mostly of interest to the true developer nerds amongst us.

[![License](https://img.shields.io/npm/l/homebridge-hunter-hydrawise?color=%23000000&logo=open%20source%20initiative&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/blob/main/LICENSE.md)
[![Build Status](https://img.shields.io/github/actions/workflow/status/hjdhjd/homebridge-hunter-hydrawise/ci.yml?branch=main&color=%23000000&logo=github-actions&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/actions?query=workflow%3A%22Continuous+Integration%22)
[![Dependencies](https://img.shields.io/librariesio/release/npm/homebridge-hunter-hydrawise?color=%23000000&logo=dependabot&style=for-the-badge)](https://libraries.io/npm/homebridge-hunter-hydrawise)
[![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/hjdhjd/homebridge-hunter-hydrawise/latest?color=%23000000&logo=github&sort=semver&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/commits/main)

[![License](https://img.shields.io/npm/l/homebridge-hunter-hydrawise?color=%230A6E93&logo=open%20source%20initiative&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/blob/main/LICENSE.md)
[![Build Status](https://img.shields.io/github/actions/workflow/status/hjdhjd/homebridge-hunter-hydrawise/ci.yml?branch=main&color=%230A6E93&logo=github-actions&logoColor=%23FFFFFF&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/actions?query=workflow%3A%22Continuous+Integration%22)
[![Dependencies](https://img.shields.io/librariesio/release/npm/homebridge-hunter-hydrawise?color=%230A6E93&logo=dependabot&style=for-the-badge)](https://libraries.io/npm/homebridge-hunter-hydrawise)
[![GitHub commits since latest release (by SemVer)](https://img.shields.io/github/commits-since/hjdhjd/homebridge-hunter-hydrawise/latest?color=%230A6E93&logo=github&sort=semver&style=for-the-badge)](https://github.com/hjdhjd/homebridge-hunter-hydrawise/commits/main)
6 changes: 3 additions & 3 deletions docs/MQTT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
### MQTT Support
[MQTT](https://mqtt.org) is a popular Internet of Things (IoT) messaging protocol that can be used to weave together different smart devices and orchestrate or instrument them in an infinite number of ways. In short - it lets things that might not normally be able to talk to each other communicate across ecosystems, provided they can support MQTT.

`homebridge-hunter-hydrawise` will publish MQTT events if you've configured a broker in the plugin settings. The plugin supports a rich set of capabilities over MQTT. This includes:
`homebridge-hunter-hydrawise` will publish MQTT events if you've configured a broker in the plugin settings. Supported MQTT capabilities include:

* Irrigation controller events.

### How to configure and use this feature
### Configuration

This documentation assumes you know what MQTT is, what an MQTT broker does, and how to configure it. Setting up an MQTT broker will not be covered here. There are plenty of guides available on how to do so just a search away.

Expand Down Expand Up @@ -60,7 +60,7 @@ The topics that `homebridge-hunter-hydrawise` subscribes to are:
| Topic | Message Expected
|-------------------------|----------------------------------
| `controller/get` | `true` will trigger a publish event of the current status of the irrigation controller and all the zones associated with it.
| `controller/set` | A message in the form of `<start|stop> <zone> [<duration>]` where you can choose to start a zone with a given duration, or stop a zone. If no duration is specified, the zone will start using the next scheduled duration for that zone.
| `controller/set` | A message in the form of <code><start|stop> <zone> [<duration>]</code> where you can choose to start a zone with a given duration, or stop a zone. If no duration is specified, the zone will start using the next scheduled duration for that zone.

> [!NOTE]
> * MQTT support is disabled by default. It's enabled when an MQTT broker is specified in the configuration.
Expand Down

0 comments on commit d3fc14b

Please sign in to comment.