Skip to content

Commit a412dfb

Browse files
committed
Updated docs for PR's
1 parent f25ebfb commit a412dfb

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
99
- 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.
1010
- 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.
1111
- Added missing include for S2 in SystemStatus.cpp (#23)
12+
- 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)
1213

1314
### Changed
1415

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

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

2729
### Removed
2830

2931
- Duplicate lines in Systems Settings view.
32+
- Removes duplicate begin (#36)
3033

3134
## [0.3.0] - 2023-02-05
3235

docs/buildprocess.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
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.
44

5+
## Changing the JS package manager
6+
7+
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.
8+
59
## Serving from Flash or Embedding into the Binary
610

711
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:

0 commit comments

Comments
 (0)