Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix monitored_conditions bug #32666

Closed
wants to merge 2 commits into from
Closed

Fix monitored_conditions bug #32666

wants to merge 2 commits into from

Conversation

gtdiehl
Copy link
Contributor

@gtdiehl gtdiehl commented Mar 11, 2020

Proposed change

The sensor code did not let the user pick which conditions that were to be monitored. By default all conditions were monitored.

This change correctly implements the monitored_conditions so they user can optionally pick and choose what they want to monitor.

Bumping API version to resolve Unknown value for monitored conditions, if device does not collect the data.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml
  - platform: rainforest_eagle
    ip_address: 10.0.0.2
    cloud_id: 123456
    install_code: 5432543653456
    monitored_conditions:
      - instantanous_demand
      - summation_total

Additional information

  • This PR fixes or closes issue: fixes # N/A
  • This PR is related to issue: N/A
  • Link to documentation pull request:

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:

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

@project-bot project-bot bot added this to Needs review in Dev Mar 11, 2020
@probot-home-assistant
Copy link

Hey there @jcalbert, mind taking a look at this pull request as its been labeled with a integration (rainforest_eagle) you are listed as a codeowner for? Thanks!

@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Mar 11, 2020
@@ -46,6 +47,9 @@
vol.Required(CONF_IP_ADDRESS): cv.string,
vol.Required(CONF_CLOUD_ID): cv.string,
vol.Required(CONF_INSTALL_CODE): cv.string,
vol.Optional(CONF_MONITORED_CONDITIONS, default=list(SENSORS)): vol.All(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please create a constant for list(SENSORS) named DEFAULT_MONITORED_CONDITIONS

@@ -46,6 +47,9 @@
vol.Required(CONF_IP_ADDRESS): cv.string,
vol.Required(CONF_CLOUD_ID): cv.string,
vol.Required(CONF_INSTALL_CODE): cv.string,
vol.Optional(CONF_MONITORED_CONDITIONS, default=list(SENSORS)): vol.All(
cv.ensure_list, [vol.In(list(SENSORS))]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You do not need the list() here

Suggested change
cv.ensure_list, [vol.In(list(SENSORS))]
cv.ensure_list, [vol.In(SENSORS)]

@@ -83,7 +87,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):

eagle_data = EagleData(eagle_reader)
eagle_data.update()
monitored_conditions = list(SENSORS)
monitored_conditions = config[CONF_MONITORED_CONDITIONS]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this up to the other local variables that store config values e.g. line 81.

@balloob
Copy link
Member

balloob commented Mar 11, 2020

Monitored conditions is being phased out. See ADR-003

@balloob balloob closed this Mar 11, 2020
Dev automation moved this from By Code Owner to Cancelled Mar 11, 2020
@lock lock bot locked and limited conversation to collaborators Mar 17, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Cancelled
Development

Successfully merging this pull request may close these issues.

None yet

4 participants