Skip to content

Repository files navigation

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. Search for "Atomberg" in the search bar.
  4. You should see the Atomberg integration listed.
  5. 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 initialization (cloud control mode).
  • 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.

Control Methods

This integration supports two control methods. You choose which one to use during setup.

Cloud API Control

Uses the Atomberg cloud APIs for fan control. Requires an api_key and refresh_token from the Atomberg Developer Portal. Provides full two-way state feedback (speed, power, light, etc.).

Infrared (IR) Control

Uses an infrared transmitter to send NEC protocol commands directly to your Atomberg fan. No cloud credentials needed. Requires Home Assistant 2026.4.0 or later.

Prerequisites

  1. Home Assistant 2026.4.0+ — The integration depends on HA's built-in infrared entity platform.
  2. An IR emitter device — Any device that exposes an infrared transmitter entity to Home Assistant. Common options:
    • ESPHome IR proxy — ESP32/ESP8266 with an IR LED, using the ir_rf_proxy component.
    • Seeed XIAO IR Mate — Dedicated IR blaster device.
    • Broadlink RM devices — Via the Broadlink integration's infrared transmitter entities.

Setup

  1. Ensure your IR emitter device is already set up in Home Assistant and appears as an infrared transmitter entity.
  2. Add the Atomberg integration and select "Infrared (IR)" as the control method.
  3. Select your fan model from the dropdown.
  4. Select the infrared transmitter entity to use.
  5. Position the IR emitter so it has line-of-sight to your Atomberg fan's IR receiver.

Entities

The IR setup creates the following entities:

Entity Type Description
Fan fan On/off and speed control (6 speeds including boost)
Boost button Activate boost mode (speed 6)
LED button Toggle the fan's LED indicator
Sleep Mode button Toggle sleep mode
Timer button Toggle timer
Timer 1 Hour button Set timer to 1 hour
Timer 2 Hours button Set timer to 2 hours
Timer 3 Hours button Set timer to 3 hours
Timer 6 Hours button Set timer to 6 hours

Important Limitations

  • One-way communication — IR is transmit-only. The integration tracks assumed state internally but cannot detect if the fan is controlled by the physical remote. If you use the physical remote, resync the entity in Home Assistant by toggling it.
  • Line of sight required — The IR emitter must be able to "see" the fan's IR receiver. Obstructions will prevent commands from being received.
  • NEC protocol — Atomberg fans use NEC protocol with address 0xF300. The IR codes are based on community-decoded values and are compatible with Gorilla Efficio, Renesa, Aris, Erica, and other Atomberg models.

Contributions are welcome!

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

Credits

About

Home Assistant integration for Atomberg Fans.

Topics

Resources

Contributing

Stars

78 stars

Watchers

6 watching

Forks

Releases

Used by

Contributors

Languages