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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nac climatisation device type #517

Merged
merged 4 commits into from
Feb 18, 2025

Conversation

pectum83
Copy link
Contributor

@pectum83 pectum83 commented Feb 16, 2025

Add NAC device type (netatmo climatisation).
It has been tested on my local home assistant dev instance.

Summary by Sourcery

New Features:

  • Add support for Netatmo NAC (Smart AC Control) devices, enabling users to control their Netatmo AC units through the API and Home Assistant integration.

Copy link

sourcery-ai bot commented Feb 16, 2025

Reviewer's Guide by Sourcery

This pull request introduces support for the Netatmo Smart AC Control (NAC) device type within the pyatmo library. It includes defining a new class for the NAC, adding it to the device type enumeration, mapping it to the climate device category, and updating the room evaluation logic to recognize NAC devices.

ER diagram for DeviceType and DeviceCategory

erDiagram
    DeviceType { 
        DeviceType type PK
        string name
    }
    DeviceCategory {
        DeviceCategory category PK
        string description
    }
    DeviceType ||--o{ DeviceCategory : belongs_to
Loading

Class diagram for NAC device type

classDiagram
    class NAC {
        <<Module>>
    }
    NAC --|> FirmwareMixin
    NAC --|> RfMixin
    NAC --|> BatteryMixin
    class FirmwareMixin {
    }
    class RfMixin {
    }
    class BatteryMixin {
    }
    class Module {
    }
Loading

File-Level Changes

Change Details Files
Introduce a new class NAC to represent the Netatmo Smart AC Control device.
  • Created a NAC class inheriting from FirmwareMixin, RfMixin, BatteryMixin, and Module.
  • Added a docstring to the NAC class.
src/pyatmo/modules/netatmo.py
Add NAC to the DeviceType enumeration.
  • Added NAC to the DeviceType enum with the value "NAC".
  • Mapped DeviceType.NAC to DeviceCategory.climate in DEVICE_CATEGORY_MAP.
  • Added DeviceType.NAC to DEVICE_DESCRIPTION_MAP with the description "Netatmo, Smart AC Control".
src/pyatmo/modules/device_types.py
Update room evaluation logic to recognize NAC devices.
  • Added a condition to check for "NAC" in self.device_types and set self.climate_type to DeviceType.NAC if found.
src/pyatmo/room.py
Expose the new NAC class in the pyatmo.modules namespace.
  • Added NAC to the list of exported classes in src/pyatmo/modules/__init__.py.
src/pyatmo/modules/__init__.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @pectum83 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a more descriptive class name for NAC that reflects its specific functionality.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@pectum83
Copy link
Contributor Author

pectum83 commented Feb 16, 2025

Waiting the commit to be integrated in a new version of home assistant Netatmo integration, I have installed my patch in my green box. It has required the two new commits (python required version increase and add 'auto' to schedule type)

@jabesq jabesq merged commit 0eeb6e8 into jabesq-org:development Feb 18, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants