Skip to content

Latest commit

 

History

History

Sonoff_TH

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
Sonoff.cpp
Sonoff.cpp
 
 
Sonoff.h
Sonoff.h
 
 
Sonoff_TH.ino
Sonoff_TH.ino
 
 
config.example.h
config.example.h
 
 
th.jpg
th.jpg
 
 

README.md

Alternative firmware for Itead Sonoff TH switches

This is an alternative firmware for Itead Sonoff TH switches, which uses MQTT instead of the eWeLink mobile application. The switch is a very affordable (7.50$) product available on itead.cc, which can be easily reprogrammed as it is based on the popular ESP8266 Wi-Fi chip.

TH

Features

  • Remote control over the MQTT protocol
  • TLS support (uncomment #define TLS in config.h and change the fingerprint if not using CloudMQTT)
  • Debug printing over Telnet or Serial (uncomment #define DEBUG_TELNET or #define DEBUG_SERIAL in config.h)
  • ArduinoOTA support for over-the-air firmware updates (enabled, #define OTA in config.h)
  • Native support for Home Assistant, including MQTT discovery (enabled, #define MQTT_HOME_ASSISTANT_SUPPORT in config.h)
  • Store the current state of the switch in memory to prevent from losing its state in case of power cut (enabled, #define SAVE_STATE in config.h)

Last Will and Testament

The firmware will publish a MQTT Last Will and Testament at <chipID>/rgbw/status. When the device successfully connects it will publish alive to that topic and when it disconnects, dead will automatically be published.

Discovery

This firmware supports Home Assistant's MQTT discovery functionality, added in 0.40. This allows for instant setup and use of your device without requiring any manual configuration in Home Assistant. To get this working, discovery: true must be defined in your mqtt configuration in Home Assistant

configuration.yaml

mqtt:
  broker: 'm21.cloudmqtt.com'
  username: '[REDACTED]'
  password: '[REDACTED]'
  port: '[REDACTED]'
  discovery: true

How to

  1. Install the Arduino IDE and the ESP8266 core for Arduino
  2. Rename config.example.hto config.h
  3. Define your WiFi SSID and password (#define WIFI_SSID "<SSID>"and #define WIFI_PASSWORD "<password>"in config.h)
  4. Define your MQTT settings (#define MQTT_USERNAME "<username>", #define MQTT_PASSWORD "<password>", #define MQTT_SERVER "<server>" and #define MQTT_SERVER_PORT <port>)
  5. Install the external libraries (PubSubClient and ArduinoJson)
  6. Define MQTT_MAX_PACKET_SIZE to 256instead of 128in Arduino/libraries/pubsubclient/src/PubSubClient.h
  7. Connect cables from (Sonoff TH) 3V3 to 3V3 (FTDI), GND to GND, RX to TX and TX to RX
  8. Press the button while connecting the FTDI to the computer
  9. Flash the firmware (board Generic ESP8266 module, Upload Speed 115200 and Flash Size 1M (64K SPIFFS))

FOR SECURITY REASONS, IT'S HIGHLY RECOMMENDED TO HAVE A STRONG WI-FI PASSWORD, TO ENABLE TLS, TO DEACTIVATE THE DEBUGGING OUTPUT AND TO SET A PASSWORD FOR OTA.

Licence

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you like the content of this repo, please add a star! Thank you!