From 8fae11f230bc49dc20da8aa69ef1b2ddf18a435a Mon Sep 17 00:00:00 2001 From: Sergey Gavrilov Date: Thu, 9 Feb 2023 18:15:44 +0300 Subject: [PATCH] README: required version of esp-idf, development of the web interface (#22) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64a4698..92ee4d9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ You must recursively clone the submodules, which `--recursive` will do for you. # Develop with ESP-IDF -Set up ESP-IDF following [Espressif's instructions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html). Make sure `idf.py` is in your PATH and you can successfully run the program. +Set up __ESP-IDF v4.4__ following [Espressif's instructions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html). Make sure `idf.py` is in your PATH and you can successfully run the program. ## Build with ESP-IDF @@ -41,6 +41,14 @@ idf.py -p monitor You should not see errors in the logs if the firmware is installed and running correctly. +## Web interface development + +Web interface is located in `components/svelte-portal` and written in Svelte. To build it, you need to install Node.js and run `npm install` in `components/svelte-portal` directory. Then you can run `npm run dev` to start development server or `npm run build` to build production version. + +Typical workflow is to fix the board's IP address in `components/svelte-portal/src/App.svelte` and then run `npm run dev`. After that, you can open `http://localhost:5000` in your browser and see changes in the web interface in real time with live reload. + +When you're done, you need to run `npm run build`, `idf.py build` and then `idf.py -p flash`. You can then open `http://blackmagic.local` in your browser and see the changes in the web interface. + ## Schematic [Flipper Zero Wi-Fi Module Schematic](https://cdn.flipperzero.one/Flipper_Zero_WI-FI_Module_V1_Schematic.PDF)