Files
Home-Assistant-Addons/oru/README.md
T
2020-09-11 19:50:34 -04:00

74 lines
2.2 KiB
Markdown
Executable File

# Orange and Rockland Utility to MQTT Bridge hass.io addon
Add-on for retrieving the last meter read from [Orange and Rockland Utility](oru.com) or [ConEdison](coned.com) and publish the data via MQTT
## Configuration
Add-on configuration example:
```yaml
email: example@email.com
password: '!secret oru_password'
mfa_type: TOTP
mfa_secret: '!secret oru_mfa_secret'
account_uuid: ef788d65-5380-11e8-8211-2655115779ac
meter_number: 706438804
site: oru
mqtt_host: hassio.local
mqtt_user: mqtt
mqtt_password: '!secret mqtt_password'
```
### Option: `email`
The email address for the oru.com / coned.com account
### Option: `password`
The password for the oru.com / coned.com account
### Option: `mfa_type`
The MFA type for the oru.com / coned.com account. Can be either `SECURITY_QUESTION` or `TOTP` (e.g. Google Authenticator).
### Option: `mfa_secret`
The MFA secret for the oru.com / coned.com account. For MFA type Security Question, to set up your MFA secret (answer), log into oru.com / coned.com, go to your profile and reset your 2FA method. When setting up 2FA again, there will be option to say you do not have texting on your phone. Select this and you should be able to use a security question instead.
For MFA type TOTP, choose Google Authenticator, choose a device type and when presented with the QR code, click on "Can't scan?". It should provide you with the MFA secret.
### Option: `account_uuid`
The Orange and Rockland Utility account uuid. To find it log into oru.com / coned.com then use the browser developer tools to search for `uuid` in the network tab.
### Option: `meter_number`
The Orange and Rockland Utility meter number. You can find it on a utility bill.
### Option: `site`
Either `oru` for Orange and Rockland Utility or `coned` for ConEdison
### Option: `mqtt_host`
Defines the hostname or ip of the MQTT server
### Option: `mqtt_user`
Defines the username for the MQTT server
### Option: `mqtt_password`
Defines the password for the MQTT server
## MQTT Data
The addon will publish the latest meter read value and unit of measure to the following topics:
`electric_meter/startTime`
`electric_meter/endTime`
`electric_meter/value`
`electric_meter/uom`