stmrocket / ha-smartmetertexas Goto Github PK

Access your current meter reading from the Smart Meter Texas API! The Node-Red flow requests a meter read every hour and reports the results over MQTT or to a Home Assistant entity. There is also a package for Home Assistant providing a number of useful sensors for use in your instance, if you wish not to use the native Energy Dashboard.

• An electric meter enrolled with Smart Meter Texas
• Your Smart Meter Texas Username, Password, ESIID, and Meter Number
• An MQTT Server (Optional if using integration below)
• Home Assistant Node-Red Companion Integration (Optional if using MQTT)
• Node-Red and the following additional nodes:
  • node-red-contrib-https
  • node-red-contrib-credentials
  • node-red-contrib-home-assistant-websocket (only needed for those who want direct home assistant integration rather than MQTT)

1. Make sure your system meets the above prerequisites.
2. Import the Smart Meter Texas **.json file into your Node-Red instance. You only need one or the other, not both.
3. If you are using MQTT and Home Assistant (not integration), place the smartmetertexas.yaml file in your config/packages directory, or copy the sensor configuration lines in the file to your main configuration file. More information of using packages can be found HERE.

5. Continue with configuration!

1. Open the imported Node-Red flow and open the Credentials node. You will need to fill in your Smart Meter Texas Username, Password, ESIID, and Meter Number. Optionally, you can change the minute when the meter will be polled every hour in the respective cron job nodes. It is advised to have the authentication cron run BEFORE the request read cron. Click Done when you are finished.
2. MQTT Users: Open the MQTT: Send Reading node and configure your MQTT server information.
3. Node-Red Companion Integ. Users: Open the SMT Current Reading node and set your home assistant instance.
4. When you are finished configuring the nodes, click the Deploy button to start the flow with your new configuration. 5.(Optional): If you are using the optional Home Assistant sensors package, and do not wish to use the native Energy Dashboard, set your electricity cost in the entity input_number.smt_energy_cost.

The Node-Red flow will request a meter read at 30 minute intervals since the last successful read. It will then request the results of the meter read every 30 seconds until they are available. The current meter reading is reported over MQTT with the topic smt/reading or to the configured Home Assistant entity.

Note that the API limits each ESIID to two reads per hour and 24 reads per day. The limit is based on the time when the reading is successfully retrieved from the meter. Increasing the frequency of reads will result in an error until the hour or day resets (depending on the error).

Thanks: This code would not be possible without the previous work by keatontaylor.

Disclaimer: This information is not provided by, nor endorsed by Smart Meter Texas. As this API is unpublished, it could break at any time.