Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUILD] Add gitpod to build the firmware #1515

Merged
merged 1 commit into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
tasks:
- command: pip3 install -U platformio && platformio run -e esp32dev-ble
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ module.exports = {
'upload/web-install',
'upload/binaries',
'upload/builds',
'upload/gitpod',
'upload/portal',
'upload/advanced-configuration',
'upload/troubleshoot'
Expand Down
Binary file added docs/img/OpenMQTTGateway-Build-gitpod-env.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/OpenMQTTGateway-Build-gitpod.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/upload/gitpod.md
Original file line number Diff line number Diff line change
@@ -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 <environment name>`

![](../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/<environment name>` 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.