This addon is designed to subscribe to the AmbientWeather Realtime API and broadcast the messages out over MQTT topics using the nodejs code found here: https://github.com/billchurch/ambient-mqtt
This is currently based off of the splitJSON Branch
This pulls data directly from the Ambient Weather API vs going through a third-party such as WUnderground.
TODO
Even though this add-on is just a basic add-on, it does come with some configuration options to play around with.
Note: Remember to restart the add-on when the configuration is changed.
Ambient MQTT add-on configuration:
{
"api_key": "youapikey",
"app_key": "yourappkey",
"mqtt_user": "mqttuserid",
"mqtt_password": "mqttpassword",
"mqtt_broker_address": "core-mosquitto",
"mqtt_topic_json": "true"
}This is your Ambient Weather API key. A key can be created by creating an account at https://ambientweather.net/ and generating an API key
This is your Ambient Weather API key. A key can be created by creating an account at https://ambientweather.net/ and generating an API key
This is the user account for your MQTT broker
This is the user password for your MQTT broker
This is your MQTT broker IP address for example core-mosquitto if you're using the Core Mosquitto broker add-on. Port is optional and defaults to 1883. Example mybroker.com:1234
By default, the status will be updated to the topic aw/data and the payload will be JSON received from the Ambient Weather query. Setting this to false will split each property in the JSON payload to individual topics, one for property.
Example of default behavior (mqtt_topic_json=true or mqtt_topic_json=):
{"dateutc":1537282680000,"tempf":85.6,"humidity":92,"hourlyrainin":0,"dailyrainin":0,"weeklyrainin":0,"monthlyrainin":1.83,"yearlyrainin":37.23,"totalrainin":37.23,"tempinf":87.8,"humidityin":63,"baromrelin":31.02,"baromabsin":30.06,"dewPoint":83,"lastRain":"2018-09-14T14:56:00.000Z","deviceId":"5a41138884f9e0000d5a822d","date":"2018-09-18T14:58:00.000Z"}Example of (mqtt_topic_json=false), individual topics with the vaule as the payload:
aw/data/dateutc
1537282680000
aw/data/tempf
85.6
aw/data/humidity
92
This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.
Releases are based on Semantic Versioning, and use the format
of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:
MAJOR: Incompatible or major changes.MINOR: Backwards-compatible new features and enhancements.PATCH: Backwards-compatible bugfixes and package updates.
Got questions?
You have several options to get them answered:
- The Community Hass.io Add-ons Discord chat server for add-on support and feature requests.
- The Home Assistant Discord chat server for general Home Assistant discussions and questions.
- Join the Reddit subreddit in /r/homeassistant
You could also open an issue here GitHub.
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
We have set up a separate document containing our contribution guidelines.
Thank you for being involved! 😍
The original setup of this repository is by Bill Church with much assistance from Dale Higgs
The original ambient-mqtt app was developed by Jeremy Bunting
For a full list of all authors and contributors, check the contributor's page.
Want some more functionality to your Hass.io Home Assistant instance?
We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.
MIT License
Copyright (c) 2018 Bill Church
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.