Skip to content

Commit 639e185

Browse files
committed
Doc updates
1 parent 01753fd commit 639e185

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

docs/general/gettingstarted.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,35 +34,35 @@
3434

3535
<img width="200" alt="Screenshot 2025-06-07 at 20 58 22" src="https://github.com/user-attachments/assets/08894be5-e4ed-4ed8-b2ae-86a6ce5c9ef6" />
3636

37-
* **Step 9**: MoonLight will show up in a **web browser** (all browsers supported). A new install will take some time to show up (up to a minute or sometimes 2). On some browsers, e.g. Safari MoonLight pops up showing Connection to device lost repeatedly. In that case, close this browser window and open MoonLight in a brower using 192.168.4.1 as URL. You will see this screen, select WiFi Station.
37+
* **Step 9**: After connecting, MoonLight will show up in a **web browser** (all browsers supported). A new install will take some time to show up (up to a minute or sometimes 2). On some browsers, e.g. Safari, MoonLight pops up showing Connection to device lost repeatedly (bug). In that case, close this browser window and open MoonLight in a brower using 192.168.4.1 as URL. You will see this screen, select WiFi Station.
3838

3939
<img width="400" alt="Screenshot 2025-06-07 at 20 59 19" src="https://github.com/user-attachments/assets/3d8bddfb-9f95-4317-891c-be8b90880541" />
4040

4141
* **Step 10**: Enter your local **WiFi network credentials**:
4242

4343
<img width="400" alt="Screenshot 2025-06-07 at 20 59 34" src="https://github.com/user-attachments/assets/38f6cb86-e44c-478e-9910-1b0614c99292" />
4444

45-
* **Step 11**: Press **Add Network** and apply settings. After connecting to your local network you will see this screen showing the new IP address of your MoonLight board. If you don't know the IP address of your board anymore you can go to step 3 and 4 and step 7 and check the IP address in the Serial logging. Advanced tip: Use [ESP32Instances](https://github.com/ewowi/ESP32Instances) to discover the ESP32 nodes on your network (using nodeJS and html)
45+
* **Step 11**: Press **Add Network** and apply settings. After connecting to your local WiFi network you will see this screen showing the new IP address of your MoonLight board. If you don't know the IP address of your board anymore you can go to step 3 and 4 and step 7 and check the IP address in the Serial logging. Advanced tip: Use [ESP32Instances](https://github.com/ewowi/ESP32Instances) to discover the ESP32 nodes on your network (using nodeJS and html)
4646

4747
<img width="400" alt="Screenshot 2025-06-07 at 20 59 55" src="https://github.com/user-attachments/assets/3696f3b0-70f7-4be8-a310-948b003450b7" />
4848

49-
* **Step 12**: Go to your WiFi settings and connect to your local network and enter the IP address of your MoonLight board in a browser and go to **MoonLight Animations**. Add a layout Node by pressing the blue + button and select Panel 🚥. Scroll down to the Pin Control field and enter the pin number you connected the strip or panel to in Step 1. After setting the right pin the strip or panel should show lights.
49+
* **Step 12**: Go to your WiFi settings and connect to your local WiFi network and enter the IP address of your MoonLight board in a browser and go to **MoonLight Animations**. Add a layout Node by pressing the blue + button and select Panel 🚥. Scroll down to the Pin Control field and enter the pin number you connected the strip or panel to in Step 1. After setting the right pin the strip or panel should show lights.
5050

5151
<img width="400" alt="Screenshot 2025-06-07 at 21 01 02" src="https://github.com/user-attachments/assets/5d4d581f-5586-43c0-a5ea-02930effc3d8" />
5252

53-
* **Thats it**. Check **MoonLight Docs** (this site for more information), or press the ? in MoonLight to go directly to the relevat information - WIP
53+
* **Thats it**. You can now change effect nodes, or add nodes. For audio add the AudioSync node. Check [MoonLight Docs](https://moonmodules.org/MoonLight/) (this site) for more information, or press the ? in MoonLight to go directly to the relevant information.
5454

5555
* Made using [esp-web-tools](https://esphome.github.io/esp-web-tools/)
5656
* See also [ESP-Web-Tools-Tutorial](https://github.com/witnessmenow/ESP-Web-Tools-Tutorial/blob/main/README.md)
5757

5858
## Installation - Developer
5959

60-
* Open GitKraken Press + / New tab and select Clone a Repo (Or another git management tool)
60+
* Open GitKraken (or any other GitHub client). Press + / New tab and select Clone a Repo (Or another git management tool)
6161
* Select the folder on your local drive where to copy to (e.g. /github/ewowi)
6262
* Copy [MoonLight.git](https://github.com/MoonModules/MoonLight.git) and paste in the URL field of GitKraken
6363
* Press clone the repo
6464
* Open VSCode
65-
* Install the PlatformIO IDE extension
65+
* Install the PlatformIO IDE extension, if not already done so.
6666
* Open the folder created with GitKraken
6767
* Connect an ESP32 or an ESP32-S3 with USB to your computer
6868
* On the status bar select the env to flash and the board to flash to

docs/general/installer/index.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@
77
></script>
88
</head>
99
<body>
10-
<p>Install MoonLight Release 0.5.6</p>
11-
<p>This installer installs <a href="https://github.com/MoonModules/MoonLight">MoonModules/MoonLight</a> on an ESP32 or an ESP32-S3</p>
12-
<p>For a step by step instruction, go to <a href="https://moonmodules.org/MoonLight/general/gettingstarted">MoonLight docs / gettingstarted</a></p>
10+
<h1>MoonLight Web Installer</h1>
11+
<p>Release 0.5.6, June 2025</p>
12+
<p>This installer installs <a href="https://github.com/MoonModules/MoonLight" target="_blank">MoonModules/MoonLight</a> on an ESP32 or an ESP32-S3</p>
13+
<p>For a step-by-step instruction, go to <a href="https://moonmodules.org/MoonLight/general/gettingstarted" target="_blank">MoonLight docs / gettingstarted</a></p>
1314
<esp-web-install-button
1415
manifest="https://raw.githack.com/MoonModules/MoonLight/refs/heads/main/docs/general/installer/manifest.json"
1516
></esp-web-install-button>

docs/general/pull-requests.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,18 @@ Below lists are ordered in terms of likelyhood to be accepted:
3131

3232
## Submitted
3333

34+
* None ATM
35+
36+
## Merged into ESP32-Sveltekit
37+
38+
* [Expands menu on selected subitem](https://github.com/theelims/ESP32-sveltekit/pull/77)
39+
* [Add file.close in fileHandler handleRequest](https://github.com/theelims/ESP32-sveltekit/pull/73)
3440
* [Refactor System Status and Metrics](https://github.com/theelims/ESP32-sveltekit/pull/78)
3541
* Add free_psram, used_psram and psram_size in Analytics (models.ts) and analytics_data (analytics.ts) and show in UI (SystemMetrics.svelte)
3642
* Send psram data only if psramFound (SystemStatus.svelte, AnalyticsService.h, SystemStatus.cpp)
3743
* [Wifi: Multiple edits bug resolved](https://github.com/theelims/ESP32-sveltekit/pull/81)
3844
* [ESPD_LOGx: replace first argument with TAG and define TAG as 🐼](https://github.com/theelims/ESP32-sveltekit/pull/85)
3945

40-
## Accepted
41-
42-
* [Expands menu on selected subitem](https://github.com/theelims/ESP32-sveltekit/pull/77)
43-
* [Add file.close in fileHandler handleRequest](https://github.com/theelims/ESP32-sveltekit/pull/73)
44-
4546
### Other improvements
4647

4748
* Add esp32-s3-devkitc-1-n16r8v and LOLIN_WIFI_FIX in pio.ini (including boards folder)
@@ -57,4 +58,4 @@ Below lists are ordered in terms of likelyhood to be accepted:
5758
* main.cpp: esp_log_set_vprintf(my_vprintf); WIP
5859
* ci pio
5960
* run in loopTask to avoid stack size crashes in httpd
60-
* updatedItems (to see what specifically has been updated)
61+
* updatedItems (to see what specifically has been updated)

0 commit comments

Comments
 (0)