From e5392f36495899a1f64b5d491f1d62d5e25d63ec Mon Sep 17 00:00:00 2001 From: Jan-Petter Gundersen Date: Fri, 12 Jun 2026 19:35:07 +0200 Subject: [PATCH] Documentation iteration --- README.md | 15 +++++++++++---- docs/wiki/Development.md | 30 +++++++++++++++++------------- platformio.ini | 5 ++--- pyproject.toml | 1 + 4 files changed, 31 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 7b839e61..07d0a94e 100644 --- a/README.md +++ b/README.md @@ -214,10 +214,17 @@ If the build fails due to size limits, try disabling features you don’t plan t ### Where is the web UI? -First, ensure that the Web app has been uploaded to the device using the *Upload Filesystem Image* option in PlatformIO. Then enter `frekvens.local` or your custom `HOSTNAME.local` in the browser. If this isn’t working, use the IP address instead. +First, ensure that the Web app has been uploaded to the device using the *Upload Filesystem Image* option in PlatformIO. Then open `frekvens.local`, `obegransad.local`, or your custom `HOSTNAME.local` in a browser. If the page does not open, make sure the device has connected to Wi-Fi. If you know its IP address, try that instead. -### Unexpected Reboots +### Power supply -If the device is rebooting unexpectedly, this is often a symptom of a software or hardware issue. The ESP32’s USB port is suitable for flashing and testing, but it is not designed to supply the high current levels that a display might draw during continuous operation. +Use the correct power source during normal operation. -If terminal logs include error messages, please [report an issue](https://github.com/VIPnytt/Frekvens/issues). +- **IKEA Frekvens**: Use the integrated **4 V / 1.5 A** power supply during normal operation. The ESP32’s USB port should only be used for short setup tasks, such as uploading firmware or checking terminal logs. Otherwise, the display may not function properly. +- **IKEA Obegränsad**: Use a USB power supply rated for at least **5 V / 2 A**, together with the original USB-A cable. The ESP32’s USB port can be used for uploading firmware and short-term testing, but it is usually not rated to handle the full current the display may draw at maximum brightness. + +### Unexpected reboots + +If the device is rebooting unexpectedly, this is often a symptom of a software or hardware issue. + +First, check that the correct power source is being used. If the device still reboots unexpectedly, check the terminal logs. If the logs include error messages, please [report an issue](https://github.com/VIPnytt/Frekvens/issues). diff --git a/docs/wiki/Development.md b/docs/wiki/Development.md index 9596e04f..583b8a0c 100644 --- a/docs/wiki/Development.md +++ b/docs/wiki/Development.md @@ -1,31 +1,35 @@ -# Development +# 👷 Development -## Formatting and linting +## 🚧 Formatting and linting ### Firmware -Clang-format is being used for all C/C++ source code. +Clang-format is being used for all C/C++ code. -### Webapp +### Tools and scripts + +Ruff is being used for all Python code. -The default VS Code Javascript/Typescript formatter is used. +### Webapp -The project supports Biome for linting Typescript files. To check all files run: +Biome is being used for linting and formatting of Typescript files. ```sh cd webapp npm install -npm run lint ``` -Automatic fixes for findings are currently disabled in the script to keep commits clean. - -When working on a specific file run +Check all files: ```sh -npx biome lint --write <./src/path/to/file> +cd webapp +npm biome check ``` -to automatically fix some of the findings in that particular file. +Reformat or apply linter fixes to specific files: -With the [Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) for VS Code you will also get hints in the editor. +```sh +cd webapp +npx biome format --write <./src/path/to/file> +npx biome lint --write <./src/path/to/file> +``` diff --git a/platformio.ini b/platformio.ini index 8bc8d79d..896e23d7 100644 --- a/platformio.ini +++ b/platformio.ini @@ -23,9 +23,8 @@ monitor_filters = log2file time build_flags = - -DCONFIG_ARDUHAL_LOG_COLORS -; -DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE -;build_type = debug +; -DCONFIG_ARDUHAL_LOG_COLORS +; -DCORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_INFO ; NONE, ERROR, WARN, INFO, DEBUG, VERBOSE ;upload_protocol = espota ; Boards diff --git a/pyproject.toml b/pyproject.toml index 0a17ff7a..4484cd56 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,6 +2,7 @@ name = "frekvens" description = "Toolbox for the Frekvens project." version = "2.5.0.dev0" +readme = { file = "README.md", content-type = "text/markdown" } license = "MIT" classifiers = [ "Private :: Do Not Upload",