https://github.com/themoosman/weewx-ambientweatherapi-json
An AmbientWeather API driver for the weewx weather software using JSON.
https://github.com/themoosman/weewx-ambientweatherapi-json
ambientweather ambientweather-api-driver driver external-sensors json python3 weewx
Last synced: 4 months ago
JSON representation
An AmbientWeather API driver for the weewx weather software using JSON.
- Host: GitHub
- URL: https://github.com/themoosman/weewx-ambientweatherapi-json
- Owner: themoosman
- Created: 2020-02-28T15:12:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-29T13:01:02.000Z (11 months ago)
- Last Synced: 2025-01-27T17:14:08.552Z (4 months ago)
- Topics: ambientweather, ambientweather-api-driver, driver, external-sensors, json, python3, weewx
- Language: Python
- Size: 46.9 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# weewx AmbientWeather API Driver
[](https://github.com/themoosman/weewx-ambientweatherapi-json/actions?query=workflow%3A%22Linux+CI%22)
This is an AmbientWeather API driver for weewx. This will work with any AmbientWeather stations that uploads data to ambientweather.net. I decided to go this route as the only way to get access to some infomration is via the Ambinent Weather API. Since I have a number of external temperature sensors I wrote this driver so I could pull that data into weewx.
This driver uses the [AmbientAPI](https://github.com/avryhof/ambient_api) Python3 package to make the API calls.
This driver only works with Weewx 4.0+ and Python3.
## Install
1) Install the necessary Python packages
````bash
sudo -H pip3 install -r requirements.txt
````
2) Install the extension
````bash
weectl extension install https://github.com/themoosman/weewx-ambientweatherapi-json/archive/master.zip --yes
````
3) Modify `weewx.conf` using the snippets in this repo's `weeex.conf`
4) Restart `weewx`
## weewx.conf Overview
The following table outlines the `weewx.conf` station variables.
| Variable | Description |
| --- | --- |
| loop_interval | How often the driver will make an API call. Becareful as Ambient Weather has [limits](https://ambientweather.docs.apiary.io/#) |
| api_url | Ambient Weather API endpoint. You probably don't need to change this. |
| api_app_key | API Application Key from your ambientweather.net [website](https://ambientweather.docs.apiary.io/#) |
| api_key | API Key from your ambientweather.net [website](https://ambientweather.docs.apiary.io/#) |
| hardware | String to identify the hardware used |
| driver | Don't change this value |
| aw_debug | Optional: Set to `1` to get verbose output from the Ambient API. The default value is `0` |
| use_meteobridge | Optional: Set to `True` if using Meteobridge, `False` is the default or leave commented out |
| station_mac | Optional: Specify a specific station MAC address to return data. If blank or unspecified, then the first station in the list is returned. |