Tasmota/README.md

9.0 KiB

Sonoff-Tasmota (KNX_MOD)

This is a MOD for Sonoff-Tasmota to integrate KNX Protocol to its features.

This MOD requires the KNX Library ascillato/ESP-KNX-IP_Lite

Basic Functionality is Available. Work in progress.


Road Map

For Sonoff-Tasmota_KNX:

  • Add Web Menu (uses the one provided by the library)
  • Add Feature to Receive telegrams and modify Relay Status
  • Add Feature to Receive telegrams from multiple Group Addresses to modify just one relay status (useful for scenes)
  • Add Feature to Send telegrams of relay status change
  • Add Feature to Send telegrams of one relay status to multiple Group Addresses (useful for scenes)
  • Add Feature to Send telegrams of button pressed
  • Add Feature to receive telegrams to toggle relay status
  • Add Feature to read Temperature from Tasmota
  • Add Feature to send Temperature by a set interval (tasmota teleperiod)
  • Add Feature to receive command to read temperature
  • Add Feature to recognize Tasmota config to show the same amount of relays, buttons, etc
  • Add Feature to Save Config
  • Add Feature to Load Config
  • Change Web Menu to a Tasmota one to save FLASH and RAM
  • Complete all the language files with keys
  • Optimize code to reduce Flash and RAM

For ESP_KNX_IP_LITE:

  • Add Functions to control library from code and not only by Web Menu
  • Complete needed functions for Tasmota
  • Add WebUI Functions
  • Change all *_id_t to config_id_t so as to have control over webpage order
  • Mod GA_Register function to be similar to CB_Register (needed for Send telegrams of one relay status to multiple Group Addresses)
  • Optimize code to reduce Flash and RAM

Modifications to Original Tasmota

  • Adding the file /sonoff/xdrv_10_KNX.ino
  • Add the entry #define USE_KNX on /sonoff/user_config.h
  • Add entries to the file /sonoff/webserver.ino
  • Add entries to the file /sonoff/sonoff.ino
  • Add entries to language files

Up to now, enabling KNX uses +14.7k of code

There is NO CONFLICT with MQTT, Home Assistant, Web, etc. Tests show fast response of all features running at same time.

This version is kept in sync with the Original Sonoff-Tasmota


Contributors to this Project

  • Adrian Scillato ascillato
  • Sisamiwe sisamiwe - Thanks for the guide on using KNX.
  • Nico Weichbrodt envy - Thanks for the patience and help with the modifications to ESP_KNX_IP.

Sonoff-Tasmota

Alternative Firmware for 'ESP8266 based Devices' like Sonoff by iTead Studio, with control under Serial, Web, KNX and MQTT, and allowing 'Over the Air' (OTA) firmware updates. Written using Arduino IDE and PlatformIO.

GitHub version GitHub download License

If you like Sonoff Tasmota, give it a star, or fork it and contribute! GitHub stars GitHub forks

Development:

Build Status

Current version is 5.12.0i - See sonoff/_releasenotes.ino for change information.

Quick install

Download one of the released binaries from https://github.com/arendst/Sonoff-Tasmota/releases and flash it to your hardware as documented in the wiki.

Important User Compilation Information

If you want to compile Sonoff-Tasmota yourself keep in mind the following:

  • Only Flash Mode DOUT is supported. Do not use Flash Mode DIO / QIO / QOUT as it might seem to brick your device. See Wiki for background information.
  • Sonoff-Tasmota uses a 1M linker script WITHOUT spiffs for optimal code space. If you compile using ESP/Arduino library 2.3.0 then download the provided new linker script to your Arduino IDE or Platformio base folder. Later version of ESP/Arduino library already contain the correct linker script. See Wiki > Prerequisite.
  • To make compile time changes to Sonoff-Tasmota it can use the user_config_override.h file. It assures keeping your settings when you download and compile a new version. To use user_config.override.h you will have to make a copy of the provided user_config.override_sample.h file and add your setting overrides. To enable the override file you will need to use a compile define as documented in the user_config_override_sample.h file.

Version Information

  • Sonoff-Tasmota provides all (Sonoff) modules in one file and starts with module Sonoff Basic.
  • Once uploaded select module using the configuration webpage or the commands Modules and Module.
  • After reboot select config menu again or use commands GPIOs and GPIO to change GPIO with desired sensor.

See Wiki for more information.
See Community for forum and more user experience.

The following devices are supported:

License

This program is licensed under GPL-3.0