Skip to content

Support v2 of API - Read Your Meter Pro
Compare
Choose a tag to compare
@elad-bar elad-bar released this 15 Oct 16:25
· 75 commits to master since this release
v2.0.0
1688c66
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Breaking Changes inside!

  • Switched to new API of City Mind
  • Add ability to change media for each alert
  • Add switch to store debug data from API
  • Visit URL redirects to the new portal
  • During weekend the component will sample the API every 3 hours as opposed to default time when it updates data every 10 minutes
  • All consumption sensors (including last read) support long-term statistics as total, reset date is according to the sensor
  • Multi-meter is now supported

Entities

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
Assets 2
Loading