Compiling

Flash and memory space on an ESP82XX chip is limited and very valuable. Because of that our precompiled binaries include the most popular features of Tasmota but no build can include all of them.

To include a feature you need (or build completely customized Tasmota) you will have to configure and compile your own version.

First you will need Tasmota's source code (either development or master branch) and a compiling tool.

Compiling Tools~

If you want to modify the code or default settings you can use:

• PlatformIO - setup and configure PlatformIO for Tasmota compilation and upload
• PlatformIO CLI - how to flash Tasmota using the PlatformIO command line interface on Linux
• PlatformIO-Core - automate firmware builds using PlatformIO-Core and flash with esptool
• Visual Studio Code - setup and configure Visual Studio Code with PlatformIO for Tasmota
• Atom - beginner guide building Tasmota firmware using Atom with PlatformIO plugin
• Arduino IDE - setup and configure Arduino IDE for Tasmota compilation and upload
• Docker Tasmota - compile from a Docker container using PlatformIO

Online Compilers

Can only create a firmware binary. Use one of the tools to flash it to your device.

• Gitpod - compile your own binary in the cloud using Gitpod.
• TasmoCompiler - simple web GUI to compile Tasmota with your own settings

Simplest way to compile is with GitPod, requires only a web browser.

Once you have set up the development environment, unzip the source code into a folder.

Preparing compiler~

PlarformIO based~

Go to root directory of source code, rename "platformio_override_sample.ini" to "platformio_override.ini". By doing this you enable using user_config_override.h and will build the standard tasmota variant with your customized features.

Alternatively you can:

Open platformio.ini and uncomment line containing -DUSE_CONFIG_OVERRIDE by deleting ;

; *********************************************************************
; *** Uncomment, by deleting ";" in line below, to use custom settings from file user_config_override.h 
                            -DUSE_CONFIG_OVERRIDE

Arduino IDE~

Navigate to where you unpacked Tasmota and into /tasmota folder.

Open my_user_config.h and uncomment (remove //) line with #define USE_CONFIG_OVERRIDE. It should look like this:

#define USE_CONFIG_OVERRIDE                          // Uncomment to use user_config_override.h file. See README.md

Customize your build~

Create a new file in /tasmota folder called user_config_override.h.

Open the file in chosen development environment for editing.

Enter lines required to enable or disable desired feature. All features and their identifier can be found in my_user_config.h.

Best practice to enable a feature is to use

#ifndef %identifier%
#define %identifier%
#endif

Example: enable blinds and shutters support

#ifndef USE_SHUTTER
#define USE_SHUTTER             // Add Shutter support for up to 4 shutter with different motortypes (+6k code)
#endif

identifier = USE_SHUTTER

1. check whether USE_SHUTTER is already defined and proceed if it is not
2. this line copied from my_user_config.h then uncommented, tells the compiler to include (#define) shutter support
3. close the IF statement from line 1

Example: disable Domoticz support

#ifdef USE_DOMOTICZ
#undef USE_DOMOTICZ                              
#endif 

identifier = USE_DOMOTICZ

1. check whether USE_DOMOTICZ is already defined and proceed if it is
2. tell the compiler to remove (#undef) Domoticz support
3. close the IF statement from line 1

Save file, compile the custom binary and flash it