Added support for Duke Energy smart meters by w1ll1am23 · Pull Request #15165 · home-assistant/core

w1ll1am23 · 2018-06-26T23:05:56Z

Description:

This adds support for reading previous days smart meter readings, both gas and electric. Each meter will be represented as a sensor sensor.duke_energy_123456 where 123456 is the meter ID.

Each meter will also include attributes for total usage for last bill, average usage for last bill, and total number of days billed.

This will only work for users who have a smart meter installed and actively reporting data here https://www.duke-energy.com/my-account/usage-analysis

The only issue I have seen while testing this (only happened once) is that the API took really long to respond but didn't timeout or get any errors. The entity never showed up in HA. It showed up after doing another reboot. Is there something that is needed to let HA know setup can take a long time?

Couple of notes:

This isn't an official API
beautiful soup is used to parse the site to obtain the meter ID which is need to call the API for usage
Previous days usage isn't available exactly at 00:00:01 and in my experience it isn't available prior to 00:07:30 I assume this time is different for everyone/every day. The update is only pulled from the API approximately every 2 hours.
The previous days usage is reported as 0 until Duke updates the information.
The service doesn't return any useful information if the username/password are bad so a generic error will occur.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5644

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: duke_energy
    username: !secret duke_username
    password: !secret duke_password

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

houndci-bot · 2018-06-26T23:06:00Z

+    def update(self):
+        """Update meter."""
+        self.duke_meter.update()
+


blank line at end of file

houndci-bot · 2018-06-26T23:06:00Z

+
+    try:
+        duke = DukeEnergy(config.get(CONF_USERNAME),
+            config.get(CONF_PASSWORD),


continuation line under-indented for visual indent

houndci-bot · 2018-06-26T23:06:00Z

+from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
+from homeassistant.helpers.entity import Entity
+import homeassistant.helpers.config_validation as cv
+import homeassistant.util as util


'homeassistant.util' imported but unused

frenck · 2018-06-27T10:42:46Z

Note: The docs seem to be missing. Added label.

w1ll1am23 · 2018-06-27T10:45:25Z

@frenck correct, I haven't created the .io PR yet. I'll try to do that later today.

blinkwise · 2018-06-27T11:54:01Z

Have been using this for almost a month now with great success. Thank you w1ll1iam23 for the hard work and effort.

dgomes

Looking good

dgomes · 2018-06-27T23:33:02Z

+    @property
+    def name(self):
+        """Return the name."""
+        return "duke_energy_" + self.duke_meter.id


I'm betting the meter id to be unique.

Why not implement unique_id ?

It has been awhile since I added a new platform forgot that was even a thing. I'll add it.

Use new style string formatting instead of string concatenation. That's what @pvizeli meant. But unique id is the way to go.

dgomes · 2018-06-27T23:34:30Z

+    def device_state_attributes(self):
+        """Return the state attributes."""
+        attributes = {
+            "lastBillsUsage": self.duke_meter.get_total(),


its common to move any string from the body of the class to the beginning of the file and use a constant, eg.

ATTR_LAST_BILLS_USAGE = 'lastBillsUsage'

dgomes · 2018-06-27T23:36:07Z

+    meters = duke.get_meters()
+    sensors = []
+    for meter in meters:
+        sensors.append(DukeEnergyMeter(meter))


add_devices([DukeEnergyMeter(meter) for meter in duke.get_meters()])

dgomes · 2018-06-27T23:37:19Z

+        sensors.append(DukeEnergyMeter(meter))
+    add_devices(sensors)
+
+    return True


don't need to return anything (no one is checking)

I thought you had to return False if setup failed? Is that not true anymore?

houndci-bot · 2018-06-28T00:43:15Z

+
+    @property
+    def unique_id(self):
+        """Return the unique ID."


SyntaxError: invalid syntax

houndci-bot · 2018-06-28T00:43:15Z

@@ -0,0 +1,84 @@
+"""


TokenError: EOF in multi-line string

pvizeli

Please use formated strings...

w1ll1am23 · 2018-06-29T22:46:34Z

@pvizeli not sure what you mean? I also just found a bug in the pydukeenergy library and I am testing the fix now. I am going to run with the new version for a day or two and then update the version. Moving this to a WIP.

MartinHjelmare · 2018-06-30T10:36:54Z

+Support for Duke Energy Gas and Electric meters.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/sensor/duke_energy/


Wrong url format.

MartinHjelmare · 2018-06-30T10:37:39Z

+    from pydukeenergy.api import DukeEnergy, DukeEnergyException
+
+    try:
+        duke = DukeEnergy(config.get(CONF_USERNAME),


Don't use dict.get for required keys.

MartinHjelmare · 2018-06-30T10:38:05Z

+                          update_interval=500)
+    except DukeEnergyException:
+        _LOGGER.error("Failed to setup Duke Energy")
+        return False


Just return.

MartinHjelmare · 2018-06-30T10:39:38Z

+    @property
+    def name(self):
+        """Return the name."""
+        return "duke_energy_" + self.duke_meter.id


Use new style string formatting instead of string concatenation. That's what @pvizeli meant. But unique id is the way to go.

MartinHjelmare · 2018-06-30T10:40:37Z

+    @property
+    def state(self):
+        """Return yesterdays usage."""
+        return self.duke_meter.get_usage()


Is this doing I/O? No I/O in properties is allowed.

No all of the values are stored in a dict in the library and are only updated when update is called.

MartinHjelmare · 2018-06-30T10:42:37Z

+    vol.Required(CONF_PASSWORD): cv.string,
+})
+
+LAST_BILL_USAGE = "lastBillsUsage"


Please use lowercase snakecase for state attribute strings.

* Added support for Duke Energy smart meters * Fixed hound * Added function docstring * Moved strings to constants, implemented unique_id, and cleaned up setup. * Added doc string. * Fixed review issues. * Updated pydukenergy to 0.0.6 and set update interval to 2 hours * Updated requirements_all

Added support for Duke Energy smart meters

25c3275

homeassistant added cla-signed new-platform platform: sensor.duke_energy labels Jun 26, 2018

ghost assigned w1ll1am23 Jun 26, 2018

ghost added the in progress label Jun 26, 2018

houndci-bot reviewed Jun 26, 2018

View reviewed changes

Fixed hound

e98c0a9

homeassistant added the cla-signed label Jun 26, 2018

Added function docstring

445ead8

frenck added the docs-missing label Jun 27, 2018

dgomes requested changes Jun 27, 2018

View reviewed changes

Moved strings to constants, implemented unique_id, and cleaned up setup.

c44fa30

homeassistant added the cla-signed label Jun 28, 2018

houndci-bot reviewed Jun 28, 2018

View reviewed changes

Added doc string.

b317b7b

w1ll1am23 force-pushed the duke_energy branch from 85b270a to b317b7b Compare June 28, 2018 00:45

homeassistant added the cla-signed label Jun 28, 2018

pvizeli reviewed Jun 29, 2018

View reviewed changes

w1ll1am23 changed the title ~~Added support for Duke Energy smart meters~~ [WIP] Added support for Duke Energy smart meters Jun 29, 2018

MartinHjelmare reviewed Jun 30, 2018

View reviewed changes

Fixed review issues.

4222321

homeassistant added the cla-signed label Jun 30, 2018

dgomes approved these changes Jun 30, 2018

View reviewed changes

w1ll1am23 added 2 commits July 1, 2018 09:34

Updated pydukenergy to 0.0.6 and set update interval to 2 hours

c858cc5

Updated requirements_all

f2731bf

w1ll1am23 changed the title ~~[WIP] Added support for Duke Energy smart meters~~ Added support for Duke Energy smart meters Jul 1, 2018

w1ll1am23 mentioned this pull request Jul 1, 2018

Doc to Duke Energy sensor home-assistant/home-assistant.io#5644

Merged

1 task

w1ll1am23 removed the docs-missing label Jul 1, 2018

dgomes added the Ready for review label Jul 1, 2018

pvizeli approved these changes Jul 2, 2018

View reviewed changes

pvizeli merged commit 2145ac5 into home-assistant:dev Jul 2, 2018

ghost removed the in progress label Jul 2, 2018

balloob mentioned this pull request Jul 20, 2018

0.74 #15570

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost added integration: duke_energy and removed platform: sensor.duke_energy labels Mar 21, 2019

Uh oh!

Conversation

w1ll1am23 commented Jun 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Couple of notes:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frenck commented Jun 27, 2018

Uh oh!

w1ll1am23 commented Jun 27, 2018

Uh oh!

blinkwise commented Jun 27, 2018

Uh oh!

dgomes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgomes Jun 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pvizeli left a comment

Choose a reason for hiding this comment

Uh oh!

w1ll1am23 commented Jun 29, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

w1ll1am23 commented Jun 26, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

dgomes Jun 27, 2018 •

edited

Loading