Home-Assistant City-Mind Water Meter (Israel only)

This is a Home Assistant integration for the Israeli cp.city-mind.com online water meters service that serves many water services.

Please ⭐️ this repo if you find it useful

This integration provides Home Assistant with five sensors for water consumption in a minimum resolution of 100 liters:

• Last Reading (Current meter reading in a resolution of 100 liters)
• Today's Consumption
• Yesterday's Consumption
• Monthly Consumption
• Consumption Predication

This project is not associated in any way with Arad Group or any of its companies that own and operate the City Mind water services.

Requirements

You need to sign-up for the service at https://cp.city-mind.com. If your registration was successful, then you can use this integration.

Registration may not succeed for one of the following reasons:

• Your home water meters is not made by the brand "ARAD", as shown in the image above.
• Your water utility company does not allow residents access to the "Read Your Meter" service (website cp.city-mind.com) that is offered by Arad Technologies.

Here is an outdated map showing water utilities companies in Israel that use Arad's water meters:

Here is a partial list (may also be outdated) of supported water utilities and cities:

אפשרי רק ללקוח של אחדמתאגידי המים שמקבלים שרותי קריאת מונים אונליין מארד טכנולוגיות, לדוגמא:

• מיתב: פתח תקווה, אלעד
• מי-נעם: נצרת עילית, עפולה, מגדל העמק
• פלג הגליל: צפת ועוד
• מעיינות הדרום: דימונה, ערד, ירוחם, ומצפה רמון
• מי-מודיעין
• מי ציונה: נס ציונה, מזכרת בתיה, קריית עקרון
• מי התנור: קריית שמונה, מטולה, קצרין
• מי רקת טבריה
• מי עכו
• מעיינות זיו: מעלות
• מעיינות העמקים: יוקנעם, זכרון יעקב
• מניב ראשון: ראשון לציון
• יובלים בשומרון

Installation

Make sure you have signed up at https://cp.city-mind.com as mentioned above, and have a working username/password. The username is usually your email address.

It is recommended to install using HACS, but it is also easy to install manually

Install using HACS (Recommended)

Add this repository to HACS as a custom repository. After few seconds (be patient), the option to install this integration will show up. Just add it.

After adding with HACS go to Integrations UI (under Configuration page) and add the "Citymind-water-meter" integration.

Install Manually

Copy the /custom_components/citymind_water_meter folder from this repository to your <config_dir>/custom_components/ folder. Restart Home Assistant.

After adding the custom component go to Integrations UI (under Configuration page), click "+" and add the "Citymind-water-meter" integration.

Configuration

Configure using the "Integrations" UI. Just fill in your username/password as mentioned above.

Breaking Changes

When upgrading from v0.x.x to v1.0, please remove any use of "citymind_water_meter" platform from configuration.yaml. Configuration is now only available via the UI.

Example of a History Chart

Below is a history graph of a 24 hours meter readings.

Notice that the system only shows usage in "steps" of 100 liters. That's the provided resolution by City-Mind service:

Example of Lovelace Charts

For this example you would need to have the Lovelace Mini Graph Card installed. It is a highly recommended UI feature. Install it using HACS.

In the UI, add the following card to see a 24-hours, and a 7-days charts. Replace the XXXXXXXXX with the Meter ID (מספר מונה):

type: entities
title: Water Meter
entities:
  - type: 'custom:mini-graph-card'
    name: 24 Hours Water Meter
    entities:
      - entity: sensor.water_meter_XXXXXXXXX_last_reading
        name: Water Meter
    points_per_hour: 12
    smoothing: false
    show:
      labels: true
  - type: 'custom:mini-graph-card'
    name: 7 Days Water Consumption
    hours_to_show: 168
    group_by: date
    aggregate_func: delta
    entities:
      - sensor.water_meter_XXXXXXXXX_last_reading
    show:
      graph: bar
      state: false
  - type: weblink
    url: 'https://cp.city-mind.com/Default.aspx'

Why water meters in Israel have the 100-Liter tics? (Only in Israel)

Almost all water meters in Israel have the minimum resolution that is no less than 100 liters.

The reason for that is religious. It allows normal use of water during a Saturday to not always triggers an electric pulse. You can find all kosher water meters reasoning in this article.

Unfortunately, the 100 liter limitation in Israel reduces the water meter capabilities to identify water leaks.

Glatt Kosher water meters can support fine metering resolution because they have automatic timers that shut the meter down completely during Saturdays.

Credits

This project was inspired by the Read Your Meter project, made by my neighbor eyalcha.

I created this alternative project because I wanted it lighter, quicker, and easy to setup. Mostly, I wanted to avoid the manual installation of a Selenium docker on Hass.io.

Kudos to Elad Bar for his help, a wonderful code contribution, and refactoring.