harperreed / hass-firststreet

FirstStreet Integration for Home Assistant
MIT License
0 stars 0 forks source link
climate-change fire flood hacs hacs-integration home-assistant insurance

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:

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 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:

These sensors will provide vital data to assess environmental risks related to your property.

Tech Info πŸ› οΈ

Repository Structure πŸ“

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. 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! 🏑✨