Library for NodeMCU ESP8266 in combination with Hassio Home Assistant ESPHome ITHO Eco Fan CC1101 Code is optimized for Itho CVE Eco-fan 2. For newer fans, please see the IthoCC1101.cpp file and search for "> 2011" and make the changes as described.
Trying to get ESPHome to mimic what is comprised in
- https://github.com/jodur/ESPEASY_Plugin_ITHO/blob/master/_P145_Itho.ino
- https://github.com/adri/IthoEcoFanRFT / https://github.com/supersjimmie/IthoEcoFanRFT
Connections between the CC1101 and the ESP8266 or Arduino:
CC11xx pins ESP pins Arduino pins Description
* 1 - VCC VCC VCC 3v3
* 2 - GND GND GND Ground
* 3 - MOSI 13=D7 Pin 11 Data input to CC11xx
* 4 - SCK 14=D5 Pin 13 Clock pin
* 5 - MISO/GDO1 12=D6 Pin 12 Data output from CC11xx / serial clock from CC11xx
* 6 - GDO2 04=D1 Pin 2 Programmable output
* 7 - GDO0 ? Pin ? Programmable output (NOT CONNECTED)
* 8 - CSN 15=D8 Pin 10 Chip select / (SPI_SS)
Install the ESPHome addon for Home Assistant. I like to use the program ESPHome flasher on my laptop for flashing the firmware on my NodeMCU.
Open your configuration.yaml file and insert the following lines of code: (I like to put this code into fans.yaml and insert fan: !include fans.yaml in my configuration.yaml file)
fan:
- platform: template
fans:
mechanical_ventilation:
friendly_name: "Mechanische afzuiging"
value_template: >
{{ "off" if states('sensor.fanspeed') == 'Standby' else "on" }}
percentage_template: >
{% set speedperc = {'Standby': 0, 'Low': 33, 'Medium': 66, 'High': 100} %}
{{speedperc [states('sensor.fanspeed')]}}
turn_on:
service: switch.turn_on
data:
entity_id: switch.fansendhigh
turn_off:
service: switch.turn_on
data:
entity_id: switch.fansendstandby
set_percentage:
service: switch.turn_on
data_template:
entity_id: >
{% set id_mapp = {0: 'switch.fansendstandby', 33:'switch.fansendlow', 66:'switch.fansendmedium', 100:'switch.fansendhigh'} %}
{{id_mapp[percentage]}}
speed_count: 2
I created a new device in Home Assistant ESPHome addon (named itho_eco_fan), and choose platform "ESP8266" and board "nodemcuv2". After that, I changed the YAML of that device to look like this:
DON'T COMPILE THE SOURCE YET! Just save the YAML config and continue!
esphome:
name: itho_eco_fan
platform: ESP8266
board: nodemcuv2
includes:
- itho_eco_fan/itho/cc1101.h
libraries:
- SPI
- Ticker
- https://github.com/Scriptman/ESPHome_ITHO_Eco_Fan_CC1101.git
#Set ID from remotes that are used, so you can identify the root of the last State change
on_boot:
then:
- lambda: |-
Idlist[0]={"e9:ee:93:f1:fd:e6:ee:b2","Badkamer"};
Idlist[1]={"65:6a:9a:69:a6:69:9a:56","Keuken"};
Idlist[2]={"ID3","ID3"};
Mydeviceid="HomeAssistant";
id(swfan_low).turn_on(); //This ensures fan is at low-speed at boot
wifi:
ssid: "WiFi SSID"
password: "wifi_password"
# Enable fallback hotspot (captive portal) in case wifi connection fails
ap:
ssid: "Itho Eco Fan Fallback Hotspot"
password: "IEdsgfeESFEzS"
captive_portal:
# Enable logging
logger:
level: verbose # Enable this line to find out the ID of your remote.
# Enable Home Assistant API
api:
password: "api_password"
ota:
password: "ota_password#"
switch:
- platform: custom
lambda: |-
auto fansendstandby = new FanSendStandby();
App.register_component(fansendstandby);
return {fansendstandby};
switches:
name: "FanSendStandby"
id: swfan_standby
icon: mdi:fan
- platform: custom
lambda: |-
auto fansendlow = new FanSendLow();
App.register_component(fansendlow);
return {fansendlow};
switches:
name: "FanSendLow"
id: swfan_low
icon: mdi:fan
- platform: custom
lambda: |-
auto fansendmedium = new FanSendMedium();
App.register_component(fansendmedium);
return {fansendmedium};
switches:
name: "FanSendMedium"
id: swfan_medium
icon: mdi:fan
- platform: custom
lambda: |-
auto fansendhigh = new FanSendHigh();
App.register_component(fansendhigh);
return {fansendhigh};
switches:
name: "FanSendHigh"
id: swfan_high
icon: mdi:fan
- platform: custom
lambda: |-
auto fansendt1 = new FanSendIthoTimer1();
App.register_component(fansendt1);
return {fansendt1};
switches:
name: "FanSendTimer1"
- platform: custom
lambda: |-
auto fansendt2 = new FanSendIthoTimer2();
App.register_component(fansendt2);
return {fansendt2};
switches:
name: "FanSendTimer2"
- platform: custom
lambda: |-
auto fansendt3 = new FanSendIthoTimer3();
App.register_component(fansendt3);
return {fansendt3};
switches:
name: "FanSendTimer3"
- platform: custom
lambda: |-
auto fansendjoin = new FanSendIthoJoin();
App.register_component(fansendjoin);
return {fansendjoin};
switches:
name: "FanSendJoin"
text_sensor:
- platform: custom
lambda: |-
auto fanrecv = new FanRecv();
App.register_component(fanrecv);
return {fanrecv->fanspeed,fanrecv->fantimer,fanrecv->Lastid};
text_sensors:
- name: "FanSpeed"
icon: "mdi:transfer"
- name: "FanTimer"
icon: "mdi:timer"
- name: "fanLastID"
icon: "mdi:id-card"
You're almost done! With the "Home Assistant Configurator" I navigate to the folder esphome/itho_eco_fan. Create the folder itho and go into the folder. Create the file cc1101.h and add the following contents to the file:
#include "esphome.h"
#include "IthoCC1101.h"
#include "Ticker.h"
// List of States:
// 0 - Itho ventilation unit to standby
// 1 - Itho ventilation unit to lowest speed
// 2 - Itho ventilation unit to medium speed
// 3 - Itho ventilation unit to high speed
// 4 - Itho ventilation unit to full speed
// 13 -Itho to high speed with hardware timer (10 min)
// 23 -Itho to high speed with hardware timer (20 min)
// 33 -Itho to high speed with hardware timer (30 min)
typedef struct { String Id; String Roomname; } IdDict;
// Global struct to store Names, should be changed in boot call,to set user specific
IdDict Idlist[] = { {"ID1", "Controller Room1"},
{"ID2", "Controller Room2"},
{"ID3", "Controller Room3"}
};
IthoCC1101 rf;
void ITHOinterrupt() ICACHE_RAM_ATTR;
void ITHOcheck();
// extra for interrupt handling
bool ITHOhasPacket = false;
Ticker ITHOticker;
int State=1; // after startup it is assumed that the fan is running low
int OldState=1;
int Timer=0;
String LastID;
String OldLastID;
String Mydeviceid = "ESPHOME"; // should be changed in boot call,to set user specific
long LastPublish=0;
bool InitRunned = false;
// Timer values for hardware timer in Fan
#define Time1 10*60
#define Time2 20*60
#define Time3 30*60
TextSensor *InsReffanspeed; // Used for referencing outside FanRecv Class
String TextSensorfromState(int currentState)
{
switch (currentState)
{
case 0:
return "Standby";
case 1:
return "Low";
break;
case 2:
return "Medium";
break;
case 3:
return "High";
break;
case 13: case 23: case 33:
return "High(T)";
case 4:
return "Full";
break;
default:
return "Unknown";
}
}
class FanRecv : public PollingComponent {
public:
// Publish 3 sensors
// The state of the fan, Timer value and Last controller that issued the current state
TextSensor *fanspeed = new TextSensor();
// Timer left (though this is indicative) when pressing the timer button once, twice or three times
TextSensor *fantimer = new TextSensor();
// Last id that has issued the current state
TextSensor *Lastid = new TextSensor();
// For now poll every 1 second (Update timer 1 second)
FanRecv() : PollingComponent(1000) { }
void setup() {
InsReffanspeed = this->fanspeed; // Make textsensor outside class available, so it can be used in Interrupt Service Routine
rf.init();
// Followin wiring schema, change PIN if you wire differently
pinMode(D1, INPUT);
attachInterrupt(D1, ITHOinterrupt, RISING);
//attachInterrupt(D1, ITHOcheck, RISING);
rf.initReceive();
InitRunned = true;
}
void update() override {
if (State >= 10)
{
Timer--;
}
if ((State >= 10) && (Timer <= 0))
{
State = 1;
Timer = 0;
fantimer->publish_state(String(Timer).c_str()); // this ensures that times value 0 is published when elapsed
}
//Publish new data when vars are changed or timer is running
if ((OldState != State) || (Timer > 0)|| InitRunned)
{
fanspeed->publish_state(TextSensorfromState(State).c_str());
fantimer->publish_state(String(Timer).c_str());
Lastid->publish_state(LastID.c_str());
OldState = State;
InitRunned = false;
}
}
};
// Figure out how to do multiple switches instead of duplicating them
// we need
// send: standby, low, medium, high, full
// timer 1 (10 minutes), 2 (20), 3 (30)
// To optimize testing, reset published state immediately so you can retrigger (i.e. momentarily button press)
class FanSendFull : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoFull);
State = 4;
Timer = 0;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendHigh : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoHigh);
State = 3;
Timer = 0;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendMedium : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoMedium);
State = 2;
Timer = 0;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendLow : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoLow);
State = 1;
Timer = 0;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendStandby : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoStandby);
State = 0;
Timer = 0;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendIthoTimer1 : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoTimer1);
State = 13;
Timer = Time1;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendIthoTimer2 : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoTimer2);
State = 23;
Timer = Time2;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendIthoTimer3 : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoTimer3);
State = 33;
Timer = Time3;
LastID = Mydeviceid;
publish_state(!state);
}
}
};
class FanSendIthoJoin : public Component, public Switch {
public:
void write_state(bool state) override {
if ( state ) {
rf.sendCommand(IthoJoin);
State = 1111;
Timer = 0;
publish_state(!state);
}
}
};
void ITHOinterrupt() {
ITHOticker.once_ms(10, ITHOcheck);
}
int RFRemoteIndex(String rfremoteid)
{
if (rfremoteid == Idlist[0].Id) return 0;
else if (rfremoteid == Idlist[1].Id) return 1;
else if (rfremoteid == Idlist[2].Id) return 2;
else return -1;
}
void ITHOcheck() {
noInterrupts();
if (rf.checkForNewPacket()) {
IthoCommand cmd = rf.getLastCommand();
String Id = rf.getLastIDstr();
int index = RFRemoteIndex(Id);
if ( index>=0) { // Only accept commands that are in the list
switch (cmd) {
case IthoUnknown:
ESP_LOGD("custom", "Unknown command");
break;
case IthoStandby:
case DucoStandby:
ESP_LOGD("custom", "IthoStandby");
State = 0;
Timer = 0;
LastID = Idlist[index].Roomname;
case IthoLow:
case DucoLow:
ESP_LOGD("custom", "IthoLow");
State = 1;
Timer = 0;
LastID = Idlist[index].Roomname;
break;
case IthoMedium:
case DucoMedium:
ESP_LOGD("custom", "Medium");
State = 2;
Timer = 0;
LastID = Idlist[index].Roomname;
break;
case IthoHigh:
case DucoHigh:
ESP_LOGD("custom", "High");
State = 3;
Timer = 0;
LastID = Idlist[index].Roomname;
break;
case IthoFull:
ESP_LOGD("custom", "Full");
State = 4;
Timer = 0;
LastID = Idlist[index].Roomname;
break;
case IthoTimer1:
ESP_LOGD("custom", "Timer1");
State = 13;
Timer = Time1;
LastID = Idlist[index].Roomname;
break;
case IthoTimer2:
ESP_LOGD("custom", "Timer2");
State = 23;
Timer = Time2;
LastID = Idlist[index].Roomname;
break;
case IthoTimer3:
ESP_LOGD("custom", "Timer3");
State = 33;
Timer = Time3;
LastID = Idlist[index].Roomname;
break;
case IthoJoin:
break;
case IthoLeave:
break;
}
}
else {
ESP_LOGV("custom","Ignored device-id: %s", Id.c_str());
}
}
interrupts();
}
Save the file and go back to your device in the Home Assistant ESPHome addon.
- "VALIDATE" the changes we made by clicking on the "VALIDATE" button/link. If everything is correct, Compile the code and download the BIN file.
- Restart Home Assistant to apply the configuration changes you made earlier.
- Attach the NodeMCU device with an USB cable to your laptop and start "ESPHome Flasher" with administrator privileges.
- Select the correct COM-port and select the BIN file you just created and downloaded.
- Flash the device.
- If you done everything right, your device should be up and running and connected to your WiFi network. In Home Assistant, navigate to "Settings > Integrations", your device should be found by Home Assistant. Click "Configure" and couple the device to Home Assistant (It will ask for the password you choose for the "API section" in the ESPHome device YAML).
Congrats! Your Itho Eco Fan Controller is connected to your Home Assistant, but we need to pair the device with your Itho Eco Fan.
- Disconnect the Itho Eco Fan from your power net and wait +/- 30 seconds (This is what I did).
- Meanwhile, navigate in Home Assistant to "Settings > Integrations > Itho_eco_fan", you will see a couple of switches. Don't click any yet.
- Connect the Itho Eco Fan to your power net.
- Within +/- 20 seconds (as soon as you can), click on the switch behind "FanSendJoin".
If everything went right, which never happens the first 30 times, then your device should be connected to your Itho Eco Fan. Sometimes the fan goes into mode "2/Medium" when pairing, to let you know the pairing process went right.