OpenBekenCostcoFan

KO | EN

gitlite — search

#list #containers #go #open-source #macos #csharp #kubernetes #agent #shell #video

OpenBekenCostcoFan

(★ 9)

Costco OmniBreeze Tower Fan -Home Assistant Integration via MQTT & OpenBeken- Flashing original Wifi Module

File Explorer

ZIP Download

LICENSE
pinout.png
README.md
wifimodule.png

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**Inspiration:** This project was inspired by [phdindota/Omnibreeze-esphome](https://github.com/phdindota/Omnibreeze-esphome), where the original Wi-Fi module was replaced with an ESP32. Based on a community comment, I decided to achieve the same result using the original hardware via the [OpenBeken project](https://github.com/openshwprojects/OpenBK7231T_App).

**Requirement:** This only works if your OmniBreeze fan contains a removable **UAM086 Wi-Fi module** and natively uses the uHome+ app. Mine purchased from  Costco Canada in 2026 did. Once the fan is opened (you need to remove all screws), the module can be easily disconnected from the JST connector and taken out for flashing. This project does involve soldering.

## Features
* ☁️ **Cloud-Free:** 100% local control via MQTT and Home Assistant.
* ⚡ **Full Feature Mapping:** Control Power, 5-Speed settings, Oscillation, and Modes.
* 🤫 **Hidden Features Unlocked:** Toggle the hardware beep and the LED display.
* 🌡️ **Live Telemetry:** Real-time room temperature sensor readout.

---

## 1. Hardware Flashing (Original BK7238)

I preferred to keep the original hardware, so I flashed OpenBeken (the Tasmota/ESPHome equivalent for Beken chips) directly onto the factory chip. Once flashed, the module goes back in fan and works without any additional power supply.

### Remove the Module
Unplug the JST connector and physically remove the UAM086 board from the fan chassis.

### Identify the Pads
You will need to find the `TX1`, `RX1`, `CEN` (Reset), and `GND` pads on the BK7238 module. After cross-referencing the FCC data and internal board pictures, the pinout is as follows:

* **Pad 15 (RXD1):** RX1 (UART1_RX)
* **Pad 16 (TXD1):** TX1 (UART1_TX)
* **Pad 3 (CEN):** Reset Pin
* **Pad 8 (3V3):** 3.3V Power
* **Pad 9 (GND):** Ground

### Connection
Connect your USB-to-TTL adapter (ensure it is set to **3.3V**):
* **Adapter TX** ➔ **Module RX1**
* **Adapter RX** ➔ **Module TX1**
* **Adapter GND** ➔ **Module GND**
* **Adapter 3.3V** ➔ **Module VCC (3V3)**
(Also keep an extra wire connected to GND to short CEN pin later)

> **⚠️ Power Note:** Most standard USB-TTL adapters provide very low current on their 3.3V rail. You may need to use an external 3.3V power supply (like a buck converter, bench supply, or an Arduino development board) to ensure the chip has enough power to boot properly during flashing.

### The Flashing Procedure
1. Plug the USB-TTL adapter into your PC.
2. Open the [BK7231GUIFlashTool](https://github.com/openshwprojects/BK7231GUIFlashTool).
3. Select your COM port and select the chip type: **BK7238**.
4. Click **Backup & Flash New**.
5. **The "Beken Trick":** The software will start searching for the chip. Take the additional GND wire, quickly tap it against the **CEN pad**, and release it. This momentarily reboots the chip, allowing the flasher to catch it!
6. Wait for the flasher to successfully back up the original firmware and write OpenBeken.

---

## 2. Initial Configuration (Bench Testing)

> **⚠️ IMPORTANT:** Do not re-install the module into the fan chassis just yet! Keep it connected to your USB-TTL adapter (for 3.3V power) on your desk so you can easily reset it if you make a Wi-Fi typo.

### Connect to Wi-Fi
1. With the module still powered by your TTL adapter, use your phone or PC to scan for available Wi-Fi networks. Look for a new, open access point starting with **`OpenBeken...`** and connect to it.
2. A captive portal should automatically open. If it doesn't, open a web browser and go to **`192.168.4.1`**.
3. Go to **Config** ➔ **Configure WiFi**.
4. Enter your home network's SSID and Password, then click **Submit**.
5. The device will reboot and join your home network. Check your router (or use a network scanner) to find the fan's new IP address.
6. Open a browser and navigate to that new IP address.

**Once you successfully see the OpenBeken web interface on your local LAN, it is safe to disconnect the module from the TTL adapter, plug it back into the fan's JST connector, and fully reassemble the tower.**

### Configure MQTT
1. Once the fan is reassembled and plugged into the wall, navigate back to the fan's IP address on your network.
2. Go to **Config** ➔ **Configure MQTT**.
3. Enter your Home Assistant MQTT details:
   * **Host:** Your MQTT Broker IP address.
   * **Port:** `1883`
   * **Client Topic:** `omnibreezefan` (or whatever you prefer)
   * **User / Password:** Your MQTT credentials.
4. Click **Submit** and let the device reboot.

---

## 3. Tuya DPID Mapping (The Rosetta Stone)

Using information from the original ESPHome project and serial logs, the following Data Point IDs (DPIDs) were decoded for this fan:

---

## 4. OpenBeken Configuration (autoexec.bat)

To map the Tuya serial data to OpenBeken's internal channels, we use a startup script. Instead of using the short command line box, we will save this permanently to the device's filesystem.

1. From the main OpenBeken UI, click on the **Web App** menu on the left side of your screen.
2. Click on **Filesystem**.
3. Look for a button that says **Create File** (if you already see a file named `autoexec.bat` in the list, click on it to edit it).
4. Name the new file exactly: **`autoexec.bat`**
5. Paste the following Master Script directly into the text editor:

```text
startDriver TuyaMCU
setPinRole 15 TuyaRX
setPinRole 17 TuyaTX
baudRate 9600

// DPID 1: Power (On/Off)
setChannelLabel 1 "Power" 1
setChannelType 1 toggle
linkTuyaMCUOutputToChannel 1 1 1

// DPID 2: Mode (0=Normal, 1=Natural, 2=Sleep, 3=Auto)
setChannelLabel 2 "Mode"
setChannelType 2 TextField
linkTuyaMCUOutputToChannel 2 4 2

// DPID 3: Fan Speed (1 to 5)
setChannelLabel 3 "Fan Speed"
setChannelType 3 TextField
linkTuyaMCUOutputToChannel 3 2 3

// DPID 5: Oscillation (On/Off)
setChannelLabel 5 "Oscillation" 1
setChannelType 5 toggle
linkTuyaMCUOutputToChannel 5 1 5

// DPID 13: Beep (On/Off)
setChannelLabel 13 "Beep" 1
setChannelType 13 toggle
linkTuyaMCUOutputToChannel 13 1 13

// DPID 15: Display LEDs (On/Off)
setChannelLabel 15 "Display LEDs" 1
setChannelType 15 toggle
linkTuyaMCUOutputToChannel 15 1 15

// DPID 21: Temperature (Read Only)
setChannelLabel 21 "Temperature"
setChannelType 21 temperature
linkTuyaMCUOutputToChannel 21 2 21

// DPID 22: Timer (0 to 12 Hours)
setChannelLabel 22 "Timer"
setChannelType 22 TextField
linkTuyaMCUOutputToChannel 22 4 22
```
6. Click **Save** and restart the device. Your fan will now display proper controls and labels on the main web UI.

---

## 5. Home Assistant Integration (YAML)

Add the following to your `configuration.yaml` (or your dedicated MQTT YAML file) to generate native Fan and Sensor entities. 
I have only used few controls, you can add all of them if needed. Also the Temperature sensor was off by few degrees, so I used an offset.

*Note: Replace `omnibreezefan` with your actual MQTT Client Topic if you changed it during the OpenBeken setup. An offset template has been added to the temperature sensor to correct for internal hardware heat.*

```yaml
mqtt:
  fan:
    - name: "OmniBreeze Fan"
      # Power Control
      state_topic: "omnibreezefan/1/get"
      command_topic: "omnibreezefan/1/set"
      payload_on: "1"
      payload_off: "0"
      
      # Speed Control (Speeds 1-5)
      percentage_state_topic: "omnibreezefan/3/get"
      percentage_command_topic: "omnibreezefan/3/set"
      speed_range_min: 1
      speed_range_max: 5
      
      # Oscillation Control
      oscillation_state_topic: "omnibreezefan/5/get"
      oscillation_command_topic: "omnibreezefan/5/set"
      payload_oscillation_on: "1"
      payload_oscillation_off: "0"

sensor:
    - name: "OmniBreeze Temperature"
      # Temperature Readout (With a -3 degree offset for internal heat)
      state_topic: "omnibreezefan/21/get"
      value_template: "{{ (value | float - 3) | round(1) }}"
      unit_of_measurement: "°C"
      device_class: temperature
      state_class: measurement
```

---

## Credits & Acknowledgments
* **[phdindota/Omnibreeze-esphome](https://github.com/phdindota/Omnibreeze-esphome):** For the original hardware teardown, the ESPHome inspiration, and the initial Tuya DPID discovery.
* **[The OpenBeken Project](https://github.com/openshwprojects/OpenBK7231T_App):** For the incredible custom firmware and flashing tools that made keeping the stock hardware possible.
* **[Home Assistant](https://www.home-assistant.io/):** For the ultimate local smart home platform that perfectly handles the MQTT routing, UI dashboards, and automations. It has helped me in my home automation journey since 2017.

## License
This project is open-source and available under the [MIT License](LICENSE). 
Feel free to use, modify, and share this guide to help free more hardware from the cloud!

OpenBekenCostcoFan

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README