Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harperreed/hass-firststreet
FirstStreet Integration for Home Assistant
https://github.com/harperreed/hass-firststreet
climate-change fire flood hacs hacs-integration home-assistant insurance
Last synced: 16 days ago
JSON representation
FirstStreet Integration for Home Assistant
- Host: GitHub
- URL: https://github.com/harperreed/hass-firststreet
- Owner: harperreed
- License: mit
- Created: 2024-09-11T20:27:14.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-11T02:23:47.000Z (3 months ago)
- Last Synced: 2024-12-23T12:06:02.410Z (18 days ago)
- Topics: climate-change, fire, flood, hacs, hacs-integration, home-assistant, insurance
- Language: Python
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FirstStreet Integration for Home Assistant 🌍💧🔥
Welcome to the **FirstStreet Integration for Home Assistant**! This project enables users to monitor risk factors associated with environmental conditions such as flooding, fires, heatwaves, winds, and air quality, all based on property location. The data is sourced directly from the FirstStreet API.
## Summary of Project 📜
This integration connects Home Assistant with the FirstStreet API, providing five distinct sensors:
- **Flood** 🌊
- **Fire** 🔥
- **Heat** 🌞
- **Wind** 🍃
- **Air Quality** 🌫️
With these sensors, users gain real-time risk assessments for their properties, empowering better decision-making for asset protection and personal safety.
## How to Use ⚙️
### Installation Steps
1. **HACS (Highly Recommended):**
- Ensure you have [HACS](https://hacs.xyz) installed in your Home Assistant.
- Go to **HACS > Integrations > 3 dots > Custom repositories**.
- Add this repository URL: `https://github.com/harperreed/hass-firststreet` and select **Integration** for the category.
- Click **Install**.
- Restart Home Assistant for the changes to take effect.
2. **Manual Installation:**
- Download the `firststreet` folder from this repository.
- Place it in your `custom_components` directory in Home Assistant.
- Restart Home Assistant.
### Configuration Steps 🔧
1. In the Home Assistant user interface, navigate to **Configuration > Integrations**.
2. Click on the **+** button to add a new integration.
3. Search for **FirstStreet** and select it.
4. Follow the on-screen instructions to complete the setup.
### Usage 📊
Once successfully set up, the following sensors will be available on your Home Assistant dashboard:
- **FirstStreet Flood:** Displays flood risk factors.
- **FirstStreet Fire:** Displays fire risk factors.
- **FirstStreet Heat:** Displays heat-related risk factors.
- **FirstStreet Wind:** Displays wind risk factors.
- **FirstStreet Air:** Displays air quality risk factors.
These sensors will provide vital data to assess environmental risks related to your property.
## Tech Info 🛠️
- **Languages & Frameworks:**
- Python
- Home Assistant Framework
- **Key Dependencies:**
- `requests`
- **Core Functionality:**
- Integrates with the FirstStreet API to retrieve risk factor data.
- Utilizes Home Assistant’s custom component structure for smooth integration.
- Supports data retrieval and JSON parsing across various environmental risks.
### Repository Structure 📁
```plaintext
hass-firststreet/
├── LICENSE
├── README.md
├── custom_components
│ └── firststreet
│ ├── __init__.py
│ ├── config_flow.py
│ ├── const.py
│ ├── firststreet_api.py
│ ├── manifest.json
│ ├── property_queries.py
│ ├── sensor.py
│ └── test_firststreet_api.py
├── hacs.json
├── info.md
```
### Support & Contributions 🤝
For issues, suggestions, or feature requests, please use the [GitHub issue tracker](https://github.com/harperreed/hass-firststreet/issues). Your contributions are welcome! Feel free to open pull requests for enhancements or fixes.
Thank you for choosing the FirstStreet Integration! Together, we can make our homes safer, one sensor at a time! 🏡✨