Add additional sensors to RainMachine #80914

shbatm · 2022-10-24T21:44:04Z

Proposed change

Expose additional sensors from the RainMachine controller:

Flow Sensor Leak Clicks & Volume: the reported number of clicks and calculated volume of a leak (flow meter activity when sprinklers are not running)
Last Leak Time: the last reported leak time (as timestamp)
Rain Sensor Rain Start: the last reported rain detection start time (as timestamp)

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #n/a
This PR is related to issue: n/a
Link to documentation pull request: n/a

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2022-10-24T21:44:10Z

Hey there @bachya, mind taking a look at this pull request as it has been labeled with an integration (rainmachine) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of rainmachine can trigger bot actions by commenting:

@home-assistant close Closes the issue.
@home-assistant rename Awesome new title Change the title of the issue.
@home-assistant unassign rainmachine Removes the current integration label and assignees on the issue, add the integration domain after the command.

shbatm · 2022-10-24T21:50:44Z

@bachya All information is already returned every minute from the /provision endpoint, so I don't need to use the /watering/flowmeter endpoint. In case you ever need to in the future, I noticed that the /provision endpoint uses flowSensor but the other uses flowMeter, both report the same values. Just FYI.

bachya · 2022-10-24T21:52:39Z

In case you ever need to in the future, I noticed that the /provision endpoint uses flowSensor but the other uses flowMeter, both report the same values. Just FYI.

More fun with the RainMachine API. 😂

shbatm · 2022-10-24T21:58:03Z

More fun with the RainMachine API.

As a side note: my unit was severely borked a while back and I had to get creative in some ssh repairs--long story short, I have some de-compiled python source code for the main controller if you ever need it for reference.

bachya · 2022-10-24T22:26:32Z

homeassistant/components/rainmachine/sensor.py

@@ -317,6 +377,14 @@ def update_from_latest_data(self) -> None:
            self._attr_native_value = self.coordinator.data.get("system", {}).get(
                "flowSensorWateringClicks"
            )
+        elif self.entity_description.key == TYPE_LAST_LEAK_DETECTED:
+            self._attr_native_value = utc_from_timestamp(
+                self.coordinator.data.get("system", {}).get("lastLeakDetected")


Won't utc_from_timestamp blow up if this ends up being None?

Yep. Resolved in the restuctured method. See comment below.

homeassistant/components/rainmachine/sensor.py

bachya · 2022-10-24T22:28:01Z

homeassistant/components/rainmachine/sensor.py

+            )
+
+            if clicks and clicks_per_m3:
+                self._attr_native_value = round((clicks * 1000) / clicks_per_m3, 1)


Feels like we have a bunch of replicated logic throughout here – what would you think about some easy helper methods (attached to this class) that centralize it?

I would look at anything you're replicating between sensor types (e.g., the round((clicks * 1000) / clicks_per_m3, 1) calculation [and the data points fed into it]).

Restructured the method to be less redundant. Take a look.

Looks reasonable to me!

homeassistant/components/rainmachine/sensor.py

bachya · 2022-10-25T01:51:26Z

You've confirmed this functionally works?

shbatm · 2022-10-25T10:15:03Z

Confirmed working:

config_entry-rainmachine-044f461135ae717322ae9b933b75b1a4.json.txt

Side note: any objections to using the zoneDuration info from the controller to set the default zone run times?

shbatm · 2022-10-25T10:35:38Z

Caught an error when I reset the last leak event in the controller. API says it uses null for no last event, but actually returns 0 which angers the timestamp-type sensor. Updated with fix.

bachya · 2022-10-25T14:06:53Z

Side note: any objections to using the zoneDuration info from the controller to set the default zone run times?

That would be useful! I'd make that a config entry option so users can decide if they want that or a manually set duration (would avoid a breaking change, too).

bachya

Looks great!

shbatm · 2022-10-25T15:49:55Z

That would be useful! I'd make that a config entry option so users can decide if they want that or a manually set duration (would avoid a breaking change, too).

Only problem is I have NO IDEA where those durations are being set. They don't match the last manual runs or the suggested program values. I'll do a PR in the future if I figure out how to set/store them, but for now, I'll leave it alone.

shbatm · 2022-10-25T17:40:04Z

Ahh.. found it. It's the last manual time you used in the RainMachine App.

Add additional sensors to RainMachine

e5f0b3e

home-assistant bot added cla-signed Hacktoberfest integration: rainmachine labels Oct 24, 2022

home-assistant bot assigned bachya Oct 24, 2022

home-assistant bot added the Quality Scale: No score label Oct 24, 2022

Merge branch 'dev' into rainmachine_add_sensors

97a4a06

shbatm marked this pull request as ready for review October 24, 2022 21:49

shbatm requested a review from bachya as a code owner October 24, 2022 21:49

bachya reviewed Oct 24, 2022

View reviewed changes

shbatm added 2 commits October 24, 2022 23:14

Restructure sensor data parsing

2af73dc

Fix logic fall through for unknown value

03c3658

Guard against 0 for timestamp

92d821a

Merge branch 'dev' into rainmachine_add_sensors

2c5702d

bachya approved these changes Oct 25, 2022

View reviewed changes

bachya merged commit e9a3982 into home-assistant:dev Oct 25, 2022

shbatm deleted the rainmachine_add_sensors branch October 25, 2022 15:20

shbatm mentioned this pull request Oct 26, 2022

Add RainMachine config option to use default run times from app #80984

Merged

19 tasks

github-actions bot locked and limited conversation to collaborators Oct 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add additional sensors to RainMachine #80914

Add additional sensors to RainMachine #80914

shbatm commented Oct 24, 2022 •

edited

Loading

home-assistant bot commented Oct 24, 2022

shbatm commented Oct 24, 2022

bachya commented Oct 24, 2022

shbatm commented Oct 24, 2022

bachya Oct 24, 2022

shbatm Oct 24, 2022

bachya Oct 24, 2022

shbatm Oct 24, 2022

bachya Oct 25, 2022

bachya commented Oct 25, 2022

shbatm commented Oct 25, 2022 •

edited

Loading

shbatm commented Oct 25, 2022

bachya commented Oct 25, 2022

bachya left a comment

shbatm commented Oct 25, 2022

shbatm commented Oct 25, 2022

Add additional sensors to RainMachine #80914

Add additional sensors to RainMachine #80914

Conversation

shbatm commented Oct 24, 2022 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Oct 24, 2022

shbatm commented Oct 24, 2022

bachya commented Oct 24, 2022

shbatm commented Oct 24, 2022

bachya Oct 24, 2022

Choose a reason for hiding this comment

shbatm Oct 24, 2022

Choose a reason for hiding this comment

bachya Oct 24, 2022

Choose a reason for hiding this comment

shbatm Oct 24, 2022

Choose a reason for hiding this comment

bachya Oct 25, 2022

Choose a reason for hiding this comment

bachya commented Oct 25, 2022

shbatm commented Oct 25, 2022 • edited Loading

shbatm commented Oct 25, 2022

bachya commented Oct 25, 2022

bachya left a comment

Choose a reason for hiding this comment

shbatm commented Oct 25, 2022

shbatm commented Oct 25, 2022

shbatm commented Oct 24, 2022 •

edited

Loading

shbatm commented Oct 25, 2022 •

edited

Loading