diff --git a/Compiling-Tasmota-on-GitPod.md b/Compiling-Tasmota-on-GitPod.md new file mode 100644 index 00000000..cdb3d1d9 --- /dev/null +++ b/Compiling-Tasmota-on-GitPod.md @@ -0,0 +1,56 @@ +Even if we offer various Tasmota flavors, sometimes the ready-to-flash binary aren't enough. +DO you want to enable or disable some features, or simply change some parameters? Then you need to compile yourself a binary. +If you are not skilled enough or don't want to install an IDE (Integrated Development Environment) like PlatforIO or Arduino IDE on your computer, you can compile yourself in a breeze on [GitPod](https://www.gitpod.io/). + +Gitpod is a One-Click Online IDE, running on any recent browser, all you need to work with is link your GitHub account (or make a new one [here](https://github.com/join?source=header)) to start with. + +![Gitpod login](https://i.imgur.com/irTdi4A.png) + +After you successfully sign in you can start your personal project. +The fastest way to load Tasmota on gitpod is with the following link + +[https://gitpod.io#https://github.com/arendst/Sonoff-Tasmota](https://gitpod.io#https://github.com/arendst/Sonoff-Tasmota) + +Gitpod will take care of all the dependency needed for you. + +After loading the project, you will be greeted by the main windows, with three main sections: + +1. Explorer +2. Editor +3. Terminal + +![Gitpod main screen](https://i.imgur.com/nfAYnwM.png) + +Explorer is the first place you need to look if you want edit your configuration. + +#### :warning: ATTENTION: +Users are strongly advised to use the user_config_override.h file for most changes and not the config my_user_config.h located under /sonoff folder. +To modify the stock configuration without changing the my_user_config.h file: + +1. Copy this file to "user_config_override.h" (It will be ignored by Git) +2. Define your own settings below +3. On Gitpod: + * open the file platformio.ini (on root directory) + * find [common] section and uncomment -DUSE_CONFIG_OVERRIDE (remove the semicolon ';' at the beginning of the line) and save. + +You are now ready to change your configuration. + +Change, add or remove all you need on your config file and save. +Now you're ready to compile. + +#### COMPILING YOUR BINARY: +This action is done on terminal window with very simple commands. +The straight one is + +`platformio run -e sonoff` + +With this command Gitpod will compile sonoff.bin for you. +If you like another flavor, we get you covered! +Just use the following syntax: + +`platformio run -e [sonoff-flavor-you-like-here]` + +Here [link to builds] you can find a list of Tasmota builds with respective futures supported. +Compiling time normally takes a couple of minutes, this time is directly related to the configuration you made: more future added means more time needed to compile. +When done, you will find you binary on /Sonoff-Tasmota/.pioenvs/[name of the build]/scr/ +You just need to download the file firmware.bin to your computer, you are now ready to flash with [Esptool] or any other compatible flasher. \ No newline at end of file