https://github.com/timothyf/dte-eb-connect
JavaScript utility that will connect to a DTE energy bridge and real-time read energy usage.
https://github.com/timothyf/dte-eb-connect
dte energy energybridge mqtt powerley
Last synced: 3 months ago
JSON representation
JavaScript utility that will connect to a DTE energy bridge and real-time read energy usage.
- Host: GitHub
- URL: https://github.com/timothyf/dte-eb-connect
- Owner: timothyf
- License: mit
- Created: 2019-05-22T19:37:47.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T20:34:51.000Z (over 3 years ago)
- Last Synced: 2024-01-28T16:09:26.351Z (over 2 years ago)
- Topics: dte, energy, energybridge, mqtt, powerley
- Language: JavaScript
- Homepage:
- Size: 734 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DTE Energy Bridge Connect
If you are a customer of DTE, or another energy company that uses the Powerley Energy Bridge product, this script will allow you to connect to the Energy Bridge over MQTT to read real-time energy usage data and log that data to the console from which this script is run. See Compatible Products section below for known products that use the Powerley Energy Bridge.
The Energy Bridge is provided by power utility companies under their brand names. For instance, AEP Energy Bridge or DTE Energy Bridge.
## Installing
First clone this repository onto your local machine.
```sh
git clone git@github.com:timothyf/dte-eb-connect.git
```
Rename `.env.sample` to `.env` and replace `EP_IP`, `EB_PASSWORD`, and `EB_CLIENT_ID`
```sh
npm install
```
## Usage
This following commands will attempt to connect to your Energy Bridge using MQTT. Be sure that you are running this while on the same local network that your Energy Bridge is running on.
#### Read instantanous energy usage
```sh
npm run start:instant
```
This will subscribe to instantanous energy readings and print to the console real-time energy usage approximately every 2-3 seconds.
-------------------------------------------------------
#### Read periodic energy usage
```sh
npm start
```
Or
```sh
npm run start:summation
```
This will subscribe to summation energy readings and print to the console real-time energy usage approximately every minute.
## Compatible Products
#### DTE Insight
If you are a DTE customer, the product that includes the Energy Bridge is called DTE Insight. You can download the Insight mobile app, and request the Energy Bridge here:
https://www.newlook.dteenergy.com/wps/wcm/connect/dte-web/insight/insight-app
-------------------------------------------------------
#### AEP Ohio
If you are an AEP Ohio customer, the product that includes the Energy Bridge is called It's Your Power. You can download the It's Your Power mobile app, and request the Energy Bridge here:
https://itsyourpowerohio.com/
## License
Copyright 2019 Timothy Fisher
`dte-eb-connect` is licensed under the MIT License.
See the LICENSE file for details.