search

maorcc / citymind_water_meter

Home Assistant Integration with cp.city-mind.com, an Israeli water meters reading service
Apache License 2.0
41 stars 2 forks source link

Refactor v2 api #29

Closed elad-bar closed 2 years ago

elad-bar commented 2 years ago

Breaking Changes inside!

Account

Entity Name Type Description Additional information
CityMind {Account ID} Account Store Debug Data Select Sets whether to store API latest data for debugging
CityMind {Account ID} Account Alert Exceeded threshold Select Allows to control which communication channel should receive an alert when daily consumption exceeded threshold Available options are: None, Email, SMS, All
CityMind {Account ID} Account Alert Leak Select Allows to control which communication channel should receive an alert when leak identified Available options are: None, Email, SMS, All
CityMind {Account ID} Account Alert Leak While Away Select Allows to control which communication channel should receive an alert when leak identified when vacation is defined Available options are: None, Email, SMS, All
CityMind {Account ID} Account Alerts Sensor Indicates number of alerts set in the portal Attributes holds the alerts list
CityMind {Account ID} Account Messages Sensor Indicates number of messages set in the portal Attributes holds the messages list
CityMind {Account ID} Account Vacations Sensor Indicates number of vacations set in the portal Attributes holds the vacations list

Per meter

Entity Name Type Description Additional information
CityMind {Meter Count} Meter Last Read Sensor Represents the last read in m³ Statistics: Total Increment
CityMind {Meter Count} Meter Daily Consumption Sensor Represents the daily consumption in m³ Statistics: Total, reset on daily basis
CityMind {Meter Count} Meter Monthly Consumption Sensor Represents the monthly consumption in m³ Statistics: Total, reset on monthly basis
CityMind {Meter Count} Meter Yesterday's Consumption Sensor Represents the yesterday's consumption in m³ Statistics: Total, reset on daily basis
CityMind {Meter Count} Meter Consumption Forcast Sensor Represents the monthly consumption forcast in m³ Statistics: Total, reset on monthly basis
elad-bar commented 2 years ago

@maorcc please review and let me know if we can merge to main

thanks