New Provider: SMUD #70

BrianHenryIE · 2024-02-24T17:55:54Z

It works, and is unit tested.

Reviewed at andylittle#1 by @kitchung, @Swanky-Bubbles, @nebhead, @v-yarotsky, @Borillion.

DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Fetching SMUD login page: https://myaccount.smud.org/
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Set new cookies: `NSC_wt_abc_nzbddpvou-abcd-psh-tx`, `ABCDM_BTa`, `language`, `ASP.NET_SessionId`, `__RequestVerificationToken`
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:SMUD self verify token: oS1wABCd1EzD8FJbpJ1osABCJF9PPn0iqwYvLtjXY6KI1RSktMeL4s7aPKaovSo1ykOorXrfOc8Yd_4RbaHpEdTGPhGaaeN_RmduIo4dWhs1
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Performing SMUD login to: https://myaccount.smud.org/
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Performed 1 redirects
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:-> https://myaccount.smud.org/manage/residential
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Set new cookies: `.ASPXAUTH`, `ADRUM_BT1`
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Opening SMUD energy usage page: https://myaccount.smud.org/manage/opowerresidential/energyusage
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Performed 1 redirects
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:-> https://smud.okta.com/login/sessionCookieRedirect?token=20111owABCDEv7eqyW5BtpokhEzocxMjinJNTsABCjXk6lTuSlZ6UdT&redirectUrl=https://smud.okta.com/app/sacramentomunicipalutilitydistrict_opower_1/exk2iie3ABCDEicF0x7/sso/saml?RelayState=https://smud.opower.com/ei/app/myEnergyUse
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Set new cookies: `sid`, `proximity_b5b7cabc8e6dafc3300abcd63b415d49`, `JSESSIONID`, `DT`, `t`
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Fetching second OKTA login page: https://smud.okta.com/app/sacramentomunicipalutilitydistrict_opower_1/exk2iie3ABCDlW7iAF0x7/sso/saml?RelayState=https://smud.opower.com/ei/app/myEnergyUse
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Parsed SAMLResponse: PD94b...lPg== (9932 characters)
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:POSTing opower sso page with SAMLResponse: https://sso.opower.com/sp/ACS.saml2
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Performed 2 redirects
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:-> https://smud.opower.com/ei/app/myEnergyUse?opentoken=TABCAQIg-PcKvJVUcABCDkwdOKPaQGzOBD-4eV1ZScEXKa2ycEBstXRAADA20wMXZVZ3AT-Wjs4MENa67iu2hb7ZbxMCVEqgZ12Djs7bJ0UBWEu0L4ExYkRV2FaFmKGHy0c0yABCi9TAEP_r7UnsVrIOXqPgcH6B01PBAzLwYQEHTl8nueVRcPKawyV_hny0VIMWiKWLoJ20T-miJaijdewLh7Url05WpECp7ABC1tdQF7J44wbL-5f_gn7tINUhM_G937Rf6ydkiXPyfXs9bVLf8Q2cJDK66VLy3oEK_8UlkY3ypp7LSG7mWg
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:-> https://smud.opower.com/ei/app/myEnergyUse
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/utilities/smud.py:Set new cookies: `JSESSIONID-samesite`, `JSESSIONID`
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/opower.py:Fetching: https://smud.opower.com/ei/edge/apis/multi-account-v1/cws/smud/customers?offset=0&batchSize=100&addressFilter=
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/opower.py:Fetching: https://smud.opower.com/ei/edge/apis/bill-forecast-cws-v1/cws/smud/customers/123123d1-76c1-11ed-a3ac-01231708442c/combined-forecast

Current bill forecast: Forecast(account=Account(customer=Customer(uuid='123123d1-76c1-11ed-a3ac-02001708442c'), uuid='12346e54-76c1-11ed-a3ac-02001708442c', utility_account_id='1233317578', meter_type=<MeterType.ELEC: 'ELEC'>, read_resolution=None), start_date=datetime.date(2024, 2, 6), end_date=datetime.date(2024, 3, 7), current_date=datetime.date(2024, 2, 24), unit_of_measure=<UnitOfMeasure.KWH: 'KWH'>, usage_to_date=179.0, cost_to_date=22.0, forecasted_usage=348.0, forecasted_cost=43.0, typical_usage=294.0, typical_cost=34.0)

Getting historical data: account= Account(customer=Customer(uuid='123123d1-76c1-11ed-a3ac-02001708442c'), uuid='12346e54-76c1-11ed-a3ac-02001708442c', utility_account_id='1233317578', meter_type=<MeterType.ELEC: 'ELEC'>, read_resolution=<ReadResolution.HOUR: 'HOUR'>) aggregate_type= day start_date= 2024-02-17 09:25:35.556275 end_date= 2024-02-24 09:25:35.556293
DEBUG:/Users/brianhenry/Sites/opower-smud/src/opower/opower.py:Fetching: https://smud.opower.com/ei/edge/apis/DataBrowser-v1/cws/cost/utilityAccount/12346e54-76c1-11ed-a3ac-02001708442c?aggregateType=day&startDate=2024-02-17T00%3A00%3A00-08%3A00&endDate=2024-02-25T00%3A00%3A00-08%3A00
start_time	end_time	consumption	provided_cost	start_minus_prev_end	end_minus_prev_end
2024-02-17 00:00:00-08:00	2024-02-18 00:00:00-08:00	10.6296	1.22346696	None	None
2024-02-18 00:00:00-08:00	2024-02-19 00:00:00-08:00	7.4316	0.85537716	0:00:00	1 day, 0:00:00
2024-02-19 00:00:00-08:00	2024-02-20 00:00:00-08:00	8.0004	0.92084604	0:00:00	1 day, 0:00:00
2024-02-20 00:00:00-08:00	2024-02-21 00:00:00-08:00	11.1372	1.33741644	0:00:00	1 day, 0:00:00
2024-02-21 00:00:00-08:00	2024-02-22 00:00:00-08:00	8.0208	0.95938524	0:00:00	1 day, 0:00:00
2024-02-22 00:00:00-08:00	2024-02-23 00:00:00-08:00	7.7832	0.96522588	0:00:00	1 day, 0:00:00

There is an error during linting:

$ mypy --install-types .

src/opower/utilities/smud.py: error: Source file found twice under different module names: "opower.utilities.smud" and "src.opower.utilities.smud"
Found 1 error in 1 file (errors prevented further checking)

And you mentioned async_auth_saml() – I tried it briefly and didn't get it to work. The reason I hadn't used it earlier was that I had forked a fork which was out of date so hadn't seen it.

I added a check to confirm any existing cookie is valid as discussed in #66.

Closes #54

this works as far as getting the token

Was previously showing the requested URL and the redirect and stating there were two redirects (where there was two requests)

src/opower/__init__.py:5:5: F401 [*] `.opower.DEBUG_LOG_RESPONSE` imported but unused

tronikos · 2024-02-26T23:29:05Z

Can you fix the mypy warnings?

BrianHenryIE · 2024-02-28T06:03:07Z

I fixed them all except:

 error: X | Y syntax for unions requires Python 3.10

AIUI, Home Assistant doesn't support < 3.11, so maybe it would be easier to just increase the version used by this library? LMK.

tronikos · 2024-02-28T12:18:34Z

I released v0.4.0. Please bump the version on the home assistant side, update documentation to mention support for this utility and add a virtual integration with icon.

fgonza2 · 2024-03-06T18:54:27Z

will this be on home assistant 2024.3 ?

tronikos · 2024-03-06T19:54:20Z

No. According to https://github.com/home-assistant/core/blob/dev/homeassistant/components/opower/manifest.json the version isn't bumped yet. Someone needs to do it and, in a separate PR, create a virtual integration.

teliseo · 2024-03-29T20:06:25Z

This integration was working for a while for me, and then stopped working around a week ago. I tried deleting and re-adding the entry, but now it fails to add. Nothing has changed with my SMUD account, and I can log in normally using a browser.

2024-03-28 14:44:39.555 ERROR (MainThread) [homeassistant.components.opower.coordinator] Unexpected error fetching Opower data: 500, message='Internal Server Error', url=URL('https://myaccount.smud.org/')
Traceback (most recent call last):
  File "/opt/hass/lib64/python3.12/site-packages/opower/opower.py", line 194, in async_login
    self.access_token = await self.utility.async_login(
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hass/lib64/python3.12/site-packages/opower/utilities/smud.py", line 130, in async_login
    login_response = await session.post(
                     ^^^^^^^^^^^^^^^^^^^
  File "/opt/hass/lib64/python3.12/site-packages/aiohttp/client.py", line 693, in _request
    resp.raise_for_status()
  File "/opt/hass/lib64/python3.12/site-packages/aiohttp/client_reqrep.py", line 1060, in raise_for_status
    raise ClientResponseError(
aiohttp.client_exceptions.ClientResponseError: 500, message='Internal Server Error', url=URL('https://myaccount.smud.org/')

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/hass/lib64/python3.12/site-packages/homeassistant/helpers/update_coordinator.py", line 318, in _async_refresh
    self.data = await self._async_update_data()
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hass/lib64/python3.12/site-packages/homeassistant/components/opower/coordinator.py", line 80, in _async_update_data
    await self.api.async_login()
  File "/opt/hass/lib64/python3.12/site-packages/opower/opower.py", line 202, in async_login
    raise CannotConnect(err)
opower.exceptions.CannotConnect: 500, message='Internal Server Error', url=URL('https://myaccount.smud.org/')

andylittle and others added 11 commits February 24, 2024 09:03

first try at adding smud

e0b27f1

login sucessful unable to parse opower token

2c26758

not yet working, token is in history

5c3e86d

proof of concept getsokta token

45435dd

this works as far as getting the token

SMUD, tested.

c64e640

@v-yarotsky code review changes

83345e2

Fix redirects logging

e74d418

Was previously showing the requested URL and the redirect and stating there were two redirects (where there was two requests)

Ignore .env.secret

045fbd3

Add pytest to optional dependencies

8b66e89

use len()

16330f6

If we already have a cookie, return early if it is valid.

ea82a74

BrianHenryIE mentioned this pull request Feb 24, 2024

Added tests for smud.py – working andylittle/opower-smud#1

Closed

0.4.0

1c8a2ea

tronikos approved these changes Feb 26, 2024

View reviewed changes

tronikos added 2 commits February 26, 2024 14:19

Update __init__.py

60b0fc4

src/opower/__init__.py:5:5: F401 [*] `.opower.DEBUG_LOG_RESPONSE` imported but unused

Update test_smud.py

f7f03ed

tronikos mentioned this pull request Feb 27, 2024

Add SMUD as a provider home-assistant/home-assistant.io#31640

Closed

Set types for mypy

bc4e86f

tronikos added 2 commits February 28, 2024 04:02

Use Optional[str]

80ef923

Update README.md

2b77450

tronikos merged commit 562b936 into tronikos:main Feb 28, 2024
4 checks passed

BrianHenryIE mentioned this pull request Apr 3, 2024

Updated SMUD login #77

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Provider: SMUD #70

New Provider: SMUD #70

BrianHenryIE commented Feb 24, 2024 •

edited

Loading

tronikos commented Feb 26, 2024

BrianHenryIE commented Feb 28, 2024

tronikos commented Feb 28, 2024

fgonza2 commented Mar 6, 2024

tronikos commented Mar 6, 2024

teliseo commented Mar 29, 2024

New Provider: SMUD #70

New Provider: SMUD #70

Conversation

BrianHenryIE commented Feb 24, 2024 • edited Loading

tronikos commented Feb 26, 2024

BrianHenryIE commented Feb 28, 2024

tronikos commented Feb 28, 2024

fgonza2 commented Mar 6, 2024

tronikos commented Mar 6, 2024

teliseo commented Mar 29, 2024

BrianHenryIE commented Feb 24, 2024 •

edited

Loading