Skip to content

Commit

Permalink
Updated docs for PR's
Browse files Browse the repository at this point in the history
  • Loading branch information
theelims committed Apr 9, 2024
1 parent f25ebfb commit a412dfb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
- Added build flag `-D SERIAL_INFO` to platformio.ini to enable / disable all `Serial.print()` statements. On some boards with native USB those Serial prints have been reported to block and make the server unresponsive.
- Added a hook handler to StatefulService. Unlike an UPDATE a hook is called every time a state receives and updated, even if the result is UNCHANGED or ERROR.
- Added missing include for S2 in SystemStatus.cpp (#23)
- Added awareness of front end build script for all 3 major JS package managers. The script will auto-identify the package manager by the lock-file. (#40)

### Changed

Expand All @@ -22,11 +23,13 @@ All notable changes to this project will be documented in this file.

- Duplicate method in FeatureService (#18)
- Fixed compile error with FLAG `-D SERVE_CONFIG_FILES`
- Removes duplicate begin (#36)
- Fixed typo in telemetry.ts (#38)
- Fixed the development warning: `Loading /rest/features using `window.fetch`. For best results, use the `fetch`that is passed to your`load` function:`

### Removed

- Duplicate lines in Systems Settings view.
- Removes duplicate begin (#36)

## [0.3.0] - 2023-02-05

Expand Down
4 changes: 4 additions & 0 deletions docs/buildprocess.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

The build process is controlled by [platformio.ini](https://github.com/theelims/ESP32-sveltekit/platformio.ini) and automates the build of the front end website with Vite as well as the binary compilation for the ESP32 firmware. Whenever PlatformIO is building a new binary it will call the python script [build_interface.py](https://github.com/theelims/ESP32-sveltekit/scripts/build_interface.py) to action. It will check the frontend files for changes. If necessary it will start the Vite build and gzip the resulting files either to the `data/` directory or embed them into a header file. In case the WWW files go into a LITTLEFS partition a file system image for the flash is created for the default build environment and upload to the ESP32.

## Changing the JS package manager

This project uses NPM as the default package manager. However, many users might have different preferences and like to use YARN or PNPM instead. Just switch the interface to one of the other package managers. The build script identify the package manager by the presence of its lock-file and start the vite build process accordingly.

## Serving from Flash or Embedding into the Binary

The front end website can be served either from the LITTLEFS partition of the flash, or embedded into the firmware binary (default). Later has the advantage that only one binary needs to be distributed easing the OTA process. Further more this is desirable if you like to preserve the settings stored in the LITTLEFS partition, or have other files there that need to survive a firmware update. To serve from the LITTLEFS partition instead please comment the following build flag out:
Expand Down

0 comments on commit a412dfb

Please sign in to comment.