tanishqmanuja / ha.integration.atomberg

Home Assistant integration for Atomberg Fans.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Atomberg

GitHub Release GitHub Activity License

Project Maintenance

Discord Community Forum

Integration for Atomberg smart fans

Tested on

Installation

Method 1: Using HACS

  1. Open your Home Assistant UI.
  2. Go to "HACS" (Home Assistant Community Store).
  3. Click on "Integrations" from the top menu.
  4. Click the three dots in the upper right corner and select "Custom Repositories".
  5. Under "Add custom repository", enter:
    • URL: https://github.com/dasshubham762/atomberg-integration
    • Category: Integration
  6. Click "Add".
  7. Go back to the "Integrations" tab in HACS.
  8. Search for "Atomberg" in the search bar.
  9. You should see the Atomberg integration listed.
  10. Click "Install" and follow any prompts to complete the installation.

Method 2: Manual Installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called atomberg.
  4. Download all the files from the custom_components/atomberg/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant.

Configuration

Step 1: Generate API Key and Refresh Token

  1. Go to Atomberg Developer Portal.
  2. Follow the instructions to generate your api_key and refresh_token.

Step 2: Add Atomberg Integration to Home Assistant

  1. Open your Home Assistant UI.
  2. Navigate to "Configuration" -> "Integrations".
  3. Click the "+" icon to add a new integration.
  4. Search for "Atomberg" in the integration search bar and select it.

Step 3: Enter API Key and Refresh Token

  1. Enter your api_key and refresh_token in the appropriate fields.
  2. Submit the form.

Compatibility and Requirements

  • Please note that this integration is designed for the latest series of Atomberg fans and may not work with older models.
  • The integration relies on cloud APIs for communication with your Atomberg fans.
  • This integration uses UDP port 5625 for updating the fan state locally, make sure that port is not in use by any other application and that it is not blocked by any firewall.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Credits

About

Home Assistant integration for Atomberg Fans.

License:MIT License


Languages

Language:Python 96.8%Language:Shell 3.2%