HomeAssistant - Sensus Analytics Integration

A custom Home Assistant integration to monitor your water usage from Sensus Analytics.

Features

• Daily Usage: Monitors daily water usage.
• Usage Unit: Displays the unit of measurement for water usage.
• Meter Address: Shows the address of the water meter.
• Last Read: Timestamp of the last meter reading.
• Meter Longitude: Longitude coordinate of the meter's location.
• Meter ID: Unique identifier for the water meter.
• Meter Latitude: Latitude coordinate of the meter's location.
• Meter Odometer: The total cumulative usage recorded by the meter.
• Billing Usage: Total usage amount that has been billed.
• Billing Cost: Total cost of the billed usage.
• Daily Fee: Daily fee based on usage.
• Last Hour Usage: Water usage for the last hour from the previous day.
• Last Hour Rainfall: Rainfall data (in inches) for the last hour from the previous day.
• Last Hour Temperature: Temperature data (in °F) for the last hour from the previous day.
• Last Hour Timestamp: Timestamp of the last hour's data from the previous day.

Installation via HACS

Prerequisites

• HACS (Home Assistant Community Store): Make sure HACS is installed in your Home Assistant instance. If not, follow the HACS Installation Guide.

Steps to Install

1. Open Home Assistant UI

   Navigate to your Home Assistant instance in your web browser.

2. Access HACS

   • Click on "HACS" in the sidebar.

3. Add Custom Repository

   • In HACS, go to the "Integrations" tab.
   • Click on the "⋮" (three dots) menu in the top right corner and select "Custom repositories".

4. Add the Sensus Analytics Repository

   • Repository URL: https://github.com/zestysoft/sensus_analytics_integration
   • Category: Select "Integration" from the dropdown menu.
   • Click "Add".

5. Install the Integration

   • After adding the repository, return to the "Integrations" tab in HACS.
   • Search for "Sensus Analytics Integration".
   • Click on the integration and then click "Install".
   • Wait for HACS to download and install the integration. You should see a confirmation message once it's complete.

6. Restart Home Assistant

   • After installation, it's essential to restart Home Assistant to load the new integration.
   • Go to "Configuration" > "Settings" > "System" > "Restart".
   • Confirm the restart.

7. Configure the Integration via Home Assistant UI

   • Once Home Assistant has restarted, navigate to "Configuration" > "Integrations".
   • Click the "+ Add Integration" button in the bottom right corner.
   • Search for "Sensus Analytics" and select "Sensus Analytics Integration".
   • Follow the prompts to enter your credentials and settings:
     • Base URL: Enter the base URL for your Sensus Analytics API (e.g., https://<your_city>.sensus-analytics.com/).
     • Username: Your Sensus Analytics account username.
     • Password: Your Sensus Analytics account password.
     • Account Number: Your Sensus Analytics account number.
     • Meter Number: Your water meter number.
     • Unit Type: Choose which unit type you want the data to be used by Home Assistant.
     • Tier 1 Gallons Cutoff: Number of gallons before transitioning to tier 2 pricing.
     • Tier 1 Per Gallon Price: Price per gallon (not unit or CF) at tier 1 level.
     • Tier 2 Gallons Cutoff: Number of gallons before transitioning to tier 3 pricing.
     • Tier 2 Per Gallon Price: Price per gallon (not unit or CF) at tier 2 level.
     • Tier 3 Per Gallon Price: Price per gallon (not unit or CF) at tier 3 level.
     • Service Fee: Price the water company charges just to have service.
   • Click "Submit" to finalize the configuration.

Sensor Entities

Below are the sensor entities created by this integration:

• sensor.sensus_analytics_daily_usage: Daily water usage.
• sensor.sensus_analytics_usage_unit: Native unit of measurement chosen by Sensus Analytics.
• sensor.sensus_analytics_meter_address: Street address of the water meter.
• sensor.sensus_analytics_last_read: Timestamp of the last meter reading.
• sensor.sensus_analytics_meter_longitude: Longitude coordinate of the meter's location.
• sensor.sensus_analytics_meter_id: Unique identifier for the water meter.
• sensor.sensus_analytics_meter_latitude: Latitude coordinate of the meter's location.
• sensor.sensus_analytics_meter_odometer: Total cumulative usage recorded by the meter.
• sensor.sensus_analytics_billing_usage: Total usage amount that has been billed.
• sensor.sensus_analytics_billing_cost: Total cost of the billed usage.
• sensor.sensus_analytics_daily_fee: Daily fee based on usage.
• sensor.sensus_analytics_last_hour_usage: Water usage for the last hour from the previous day.
• sensor.sensus_analytics_last_hour_rainfall: Rainfall for the last hour from the previous day.
• sensor.sensus_analytics_last_hour_temperature: Temperature for the last hour from the previous day.
• sensor.sensus_analytics_last_hour_timestamp: Timestamp of the last hour's data from the previous day.

Be kind

If you like the integration, how about buying me a coffee? :)

License

Apache 2.0