https://github.com/elboletaire/ha-weatherxm
🌤 A WeatherXM Home Assistant integration
https://github.com/elboletaire/ha-weatherxm
hacs hacs-integration home-assistant
Last synced: 4 months ago
JSON representation
🌤 A WeatherXM Home Assistant integration
- Host: GitHub
- URL: https://github.com/elboletaire/ha-weatherxm
- Owner: elboletaire
- License: mit
- Created: 2024-06-06T17:45:08.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-02T10:12:50.000Z (4 months ago)
- Last Synced: 2025-01-02T10:45:10.457Z (4 months ago)
- Topics: hacs, hacs-integration, home-assistant
- Language: Python
- Homepage:
- Size: 59.6 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WeatherXM Home Assistant Integration
WeatherXM Home Assistant integration connects WeatherXM weather stations with Home Assistant, providing real-time weather data from around the world to your home automation system.
> Note: A WeatherXM account is required, but owning a device is not necessary; you can get data of any followed device.
## Installation
### HACS Installation
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=elboletaire&repository=ha-weatherxm&category=integration)
1. **Add Custom Repository:**
- Go to HACS in Home Assistant.
- Click on `Integrations` > `top three dot menu` > `Custom repositories`.
- Add `https://github.com/elboletaire/ha-weatherxm` as Repository and select `Integration` as the Category.
2. **Install the Integration:**
- Search for "WeatherXM" in HACS and install.
### Manual Installation
1. **Clone the Repository:**
~~~bash
git clone https://github.com/elboletaire/ha-weatherxm.git
~~~
2. **Copy to Home Assistant:** Copy the `custom_components/weatherxm` directory to your Home Assistant `custom_components` directory.
3. **Restart Home Assistant:** Restart Home Assistant to load the new integration.
## Configuration
1. Go to the Home Assistant web interface.
2. Navigate to `Configuration` > `Integrations`.
3. Click on `Add Integration` and search for "WeatherXM".
4. Follow the on-screen instructions to configure the integration.
> **Note:** A WeatherXM account is required, but owning a device is not necessary; you can follow any WeatherXM device and they will be populating your sensors.
## Usage
Once configured, you can access WeatherXM data in your Home Assistant dashboard and use it in your automations.
### Entities
The integration creates the following sensors:
- `weather.`, with all the weather and forecast information.
- `sensor._battery`, with the battery level of the device.
- `sensor._firmware`, with the firmware version of the device.
- `sensor._rewards`, with the rewards of the device (also has total_rewards as additional attribute).
- `sensor._total_rewards`, with the total rewards generated to date from that device.
`` is the alias of the device defined via the WeatherXM app. If you have not defined an alias, the device ID will be used instead.
## License
This project is licensed under the MIT License. See the [LICENSE] file for more details.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any changes or improvements.
## Support
For support or feature requests, please open an issue on the [GitHub repository](https://github.com/elboletaire/ha-weatherxm/issues).
[LICENSE]: ./LICENSE