Skip to content

Appdaemon app to read a Kingspan Sensit tank meter and write to Home Assistant via MQTT

License

Notifications You must be signed in to change notification settings

fboundy/ha_sensit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ha_sensit

Appdaemon app to read a Kingspan Sensit tank meter and write to Home Assistant via MQTT. For this to work you will have to have already set up the Watchman Sensit Hardware and App. This app uses code from Jon Connell's Kingspan Connect.

AppDaemon and MQTT Installation

Install AppDaemon
Install Mosquitto MQTT Broker
Configure AppDaemon's HASS and MQTT plugins: the appdaemon.yaml file in this repo should have most of the configuration required.

Install MQTT Explorer or equivalent somewhere on your network so you can check the MQTT broker is working correctly.

At this point you might want to write a simple AppDaemon app to check that it is working properly and that it can talk to your MQTT broker. There are some useful guides here and here

Add the Zeep Module to AppDaemon

You need the Zeep SOAP module installed to be able to communicate with the Sensit server.

Go to AppDaemon's Configuration Page. Click on the 3 dots and Edit in YAML:

init_commands: []
python_packages:
  - zeep
system_packages: []

Save and Restart AppDaemon

The Tank App

Copy _tanks.py_ from the _apps_ folder to _config/appdaemon/apps_
Merge the contents of _apps.yampl_ into the _apps.yaml_ file in _config/appdaemon/apps_
Add two secrets to your _config/secrets.yaml_ file:
sensit_user: email_address_from_sensit_app
sensit_pass: password_from_sensit_app

Open the AppDaemon Main Log. Your should see the following:
2022-11-07 17:37:25.127050 INFO AppDaemon: Initializing app tank using class Tank from module tank

Test Trigger the App with an Event

In a separate browser window go to [HA Developer Tools](http://homeassistant.local:8123/developer-tools/event):
Event Type*: READ_TANK

Click on: FIRE EVENT

Back in the Appdaemon Log window you should see something like:

2022-11-07 19:40:43.960708 INFO tank: Done!
2022-11-07 19:40:43.940654 INFO tank: homeassistant/sensor/tank_energy/config:{"name": "Tank Energy Used", "object_id": "tank_energy", "unit_of_measurement": "kWh", "value_template": "{{ value_json.energy}}", "state_topic": "homeassistant/sensor/tank/state", "state_class": "total_increasing", "device_class": "energy"}
2022-11-07 19:40:43.923549 INFO tank: homeassistant/sensor/tank_predicted_empty/config:{"name": "Tank Predicted Empty", "object_id": "tank_predicted_empty", "value_template": "{{ value_json.runoutdate}}", "state_class": "measurement", "state_topic": "homeassistant/sensor/tank/state"}
2022-11-07 19:40:43.896472 INFO tank: homeassistant/sensor/tank_last_read/config:{"name": "Tank Last Read", "object_id": "tank_last_read", "units": "", "value_template": "{{ value_json.readingdate}}", "state_class": "measurement", "state_topic": "homeassistant/sensor/tank/state"}
2022-11-07 19:40:43.876574 INFO tank: homeassistant/sensor/tank_rate/config:{"name": "Tank Consumption Rate", "object_id": "tank_rate", "units": "litres/day", "value_template": "{{ value_json.consumptionrate}}", "state_class": "measurement", "state_topic": "homeassistant/sensor/tank/state"}
2022-11-07 19:40:43.856673 INFO tank: homeassistant/sensor/tank_percent/config:{"name": "Tank Percentage", "object_id": "tank_percent", "units": "%", "value_template": "{{ value_json.levelpercent}}", "state_class": "measurement", "state_topic": "homeassistant/sensor/tank/state"}
2022-11-07 19:40:43.847321 INFO tank: homeassistant/sensor/tank_level/config:{"name": "Tank Level", "object_id": "tank_level", "device_class": "volume", "unit_of_measurement": "L", "value_template": "{{ value_json.levellitres}}", "state_topic": "homeassistant/sensor/tank/state", "state_class": "measurement"}
2022-11-07 19:40:43.845510 INFO tank: Energy Used = 7948.799999999999
2022-11-07 19:40:43.843775 INFO tank: Run Out = 02-Feb-2023
2022-11-07 19:40:43.842107 INFO tank: Last Read = 07-Nov-2022 00:55:16
2022-11-07 19:40:43.840396 INFO tank: Level = 45% (682 litres)
2022-11-07 19:40:43.838555 INFO tank: Model = Unknown
2022-11-07 19:40:43.836844 INFO tank: Serial Number = 2000xxxx
2022-11-07 19:40:43.835014 INFO tank: Capacity = 1450
2022-11-07 19:40:43.833025 INFO tank: Your Tank Name:
2022-11-07 19:40:42.748583 INFO tank: 0
2022-11-07 19:40:42.747518 INFO tank: User: [email protected]

This means that the app has successfully logged into Sensit and downloaded the tank data (bottom 10 lines) and then written the data to the MQTT broker (top 7 lines).

In MQTT Explorer connect to your HA MQTT Broker. You should see:

192.168.x.x
    homeassistant
        sensor
            tank(1 topic, 1 message)
            tank_level(1 topic, 1 message)
            tank_percent(1 topic, 1 message)
            tank_last_read(1 topic, 1 message)
            tank_rate(1 topic, 1 message)
            tank_predicted_empty(1 topic, 1 message)
            tank_energy(1 topic, 1 message)

Through MQTT Discovery you should also now have the equivalent sensor entities in Home Assistant

About

Appdaemon app to read a Kingspan Sensit tank meter and write to Home Assistant via MQTT

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages