diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000000..306788b4d6 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,2 @@ +tasks: + - command: pip3 install -U platformio && platformio run -e esp32dev-ble diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 1b91ac912f..fc81178adb 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -69,6 +69,7 @@ module.exports = { 'upload/web-install', 'upload/binaries', 'upload/builds', + 'upload/gitpod', 'upload/portal', 'upload/advanced-configuration', 'upload/troubleshoot' diff --git a/docs/img/OpenMQTTGateway-Build-gitpod-env.png b/docs/img/OpenMQTTGateway-Build-gitpod-env.png new file mode 100644 index 0000000000..5079879b91 Binary files /dev/null and b/docs/img/OpenMQTTGateway-Build-gitpod-env.png differ diff --git a/docs/img/OpenMQTTGateway-Build-gitpod.png b/docs/img/OpenMQTTGateway-Build-gitpod.png new file mode 100644 index 0000000000..775dc2d812 Binary files /dev/null and b/docs/img/OpenMQTTGateway-Build-gitpod.png differ diff --git a/docs/upload/gitpod.md b/docs/upload/gitpod.md new file mode 100644 index 0000000000..7183e3b0f2 --- /dev/null +++ b/docs/upload/gitpod.md @@ -0,0 +1,18 @@ +# (Option 4) Build from the web + +To build OpenMQTTGateway from the web and download the binary, follow these steps: + +1. Use Gitpod by clicking on the link below: +[https://gitpod.io#https://github.com/1technophile/OpenMQTTGateway/tree/development](https://gitpod.io#https://github.com/1technophile/OpenMQTTGateway/tree/development) + +2. This will generate a development environment in your browser and install [platformio](https://platformio.org/) as a build environment. + +3. A first build for `esp32dev-ble` will be launched automatically. To modify the environment configuration, go to the environments.ini file in the root folder and launch the command like the one shown at the bottom of the image below: +`platformio run -e ` + +![](../img/OpenMQTTGateway-Build-gitpod-env.png) + +4. Wait for the server to build the binary. Once you see [SUCCESS], you can go to `.pio/build/` and download `firmware.bin` by right-clicking on it and selecting "Download." +![](../img/OpenMQTTGateway-Build-gitpod.png) + +5. Finally, follow [Option 2](binaries.md) to upload the binary.