Skip to content

Commit

Permalink
move up installation of webapp prerequisists
Browse files Browse the repository at this point in the history
as the build process now includes building the web app automatically, we
shall move up the instruction to instal the prerequisits, such that they
are ready once vscode is installed.
  • Loading branch information
schlimmchen committed Sep 21, 2024
1 parent 27ed66b commit b5ffe78
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
11 changes: 6 additions & 5 deletions docs/firmware/compile_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@
## Step by Step

1. Install [PlatformIO Core](https://platformio.org/install/cli){target=_blank} (PIO).
2. Clone the [source code repository](https://github.com/helgeerbe/OpenDTU-OnBattery).
1. Install the prerequisits to be able to [build the
WebApp](compile_webapp.md#install-prerequisits).
1. Clone the [source code repository](https://github.com/helgeerbe/OpenDTU-OnBattery).
You really have to clone the source code repository. Do not download and
extract a source ZIP file. During the build process the Git hash is embedded
into the firmware. If you merely download and extract the source ZIP file a
build error will occur, as no Git status can be determined.
3. Adjust the serial port in file `platformio_override.ini` to your setup. The
1. Adjust the serial port in file `platformio_override.ini` to your setup. The
setting occurs twice:
* `upload_port`
* `monitor_port`
4. Mandatory: [Build the WebApp](compile_webapp.md) **before** compiling the firmware.
5. Build the firmware: `platformio run -e generic_esp32s3` (chose a suitable PIO environment)
6. Upload to ESP32 module: `platformio run -e generic_esp32s3 -t upload`
1. Build the firmware: `platformio run -e generic_esp32s3` (chose a suitable PIO environment)
1. Upload to ESP32 module: `platformio run -e generic_esp32s3 -t upload`

## Other Popular PlatformIO Tasks

Expand Down
15 changes: 8 additions & 7 deletions docs/firmware/compile_vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,26 @@
## Step by Step

1. [Download](https://git-scm.com/downloads/){target=_blank} and install Git.
2. Install [Visual Studio Code](https://code.visualstudio.com/download){target=_blank} (vscode).
3. In vscode, install the [PlatformIO
1. Install the prerequisits to be able to [build the
WebApp](compile_webapp.md#install-prerequisits).
1. Install [Visual Studio Code](https://code.visualstudio.com/download){target=_blank} (vscode).
1. In vscode, install the [PlatformIO
Extension](https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide){target=_blank}.
4. ![Clone Source Code](../assets/images/firmware/vscode_clone.png){align=right}
1. ![Clone Source Code](../assets/images/firmware/vscode_clone.png){align=right}
Clone the source code repository. Select the `Source Control` tab on the
left, click `Clone Repository`, and enter the URL
`https://github.com/helgeerbe/OpenDTU-OnBattery`. You really have to clone
the source code repository. Do not download and extract a source ZIP file.
During the build process the Git hash is embedded into the firmware. If you
merely download and extract the source ZIP file a build error will occur, as
no Git status can be determined.
5. Mandatory: [Build the WebApp](compile_webapp.md) **before** compiling the firmware.
6. Adjust the upload and monitoring port to your system by clicking the plug
1. Adjust the upload and monitoring port to your system by clicking the plug
icon in vscode's bottom statusbar and selecting the respective serial port.
![Set Serial Port](../assets/images/firmware/vscode_port.png)
7. Unless you want to compile the default firmware variant, select the
1. Unless you want to compile the default firmware variant, select the
appropriate PlatformIO environment in vscode's bottom statusbar.
![Select Environment](../assets/images/firmware/vscode_environment.png)
8. Click the arrow button in vscode's bottom status bar (PlatformIO: Upload) to
1. Click the arrow button in vscode's bottom status bar (PlatformIO: Upload) to
compile and upload the firmware. During the compilation, all required
libraries are downloaded automatically.

Expand Down

0 comments on commit b5ffe78

Please sign in to comment.