Skip to content

Commit 326b983

Browse files
authored
Update gettingstarted.md
1 parent bc89724 commit 326b983

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

docs/general/gettingstarted.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* Select esp32dev for a normal ESP32
1515
* Select esp32-s3-devkitc-1-n16r8v for an ESP32-S3 ([recommended](https://s.click.aliexpress.com/e/_DBAtJ2H) or similar)
1616

17-
<img width="617" alt="image" src="https://github.com/user-attachments/assets/349af246-30c7-45dd-92ed-4f2b3900557f" />
17+
<img width="617" src="https://github.com/user-attachments/assets/349af246-30c7-45dd-92ed-4f2b3900557f" />
1818

1919
* Press PlaformIO:Upload (->) on the statusbar
2020
* The firmware is now flashed to your board, after flashing the board will reboot
@@ -48,15 +48,23 @@ WIP...
4848

4949
## MoonBase specific
5050

51-
* Connect a 256 leds panel to the board
52-
* Search for FastLED.addLeds in the code and update to the pin you use to drive LEDS, reflash the code to the board
51+
At the moment MoonBase is the work in progress repo and temporary also contains LED functionality (MoonLight / Animations), will move later to the MoonLight repo.
52+
53+
* Connect a 256 leds panel to the board on Pin 2 or 16
54+
55+
<img width="350" src="https://github.com/user-attachments/assets/1623a751-5f4b-463b-a6f3-a642c2bc52bf"/>
56+
5357
* Go to the UI in the browser
54-
* Go to Custom / Files and create or upload Live scripts
55-
* Go to Custom / Module Animations and select the 'hardcoded animations' (Random, Sinelon, Rainbow), you should see it on your panel
56-
* Select any of the Live scripts you uploaded, check the Serial Output for results. (No led output in current version, see below)
57-
* Open the Edit area and change things in the code, see the Serial Output for results
58+
* Go to MoonLight / Animations
59+
* Select Pin 2 or 16
60+
* Create a node, select the 'hardcoded animations' (Random, Sinelon, Rainbow, Sinus), you should see it on your panel
61+
* Create more nodes with other animations, they will all run at the same time
62+
* Live Scripts: Go to MoonBase / Files and create or upload Live scripts.
63+
* Examples: [Live scripts](https://github.com/ewowi/MoonBase/tree/main/misc/livescripts)
64+
* Back to Animations, select any of the Live scripts you uploaded, check the Led Panel and / or Serial Output for results
65+
* Open the Edit area and change things in the code, see the Serial Output for results
5866

59-
<img width="350" alt="image" src="https://github.com/user-attachments/assets/56bdd019-927b-40cc-9199-9bc6344f8d8b" />
67+
<img width="350" src="https://github.com/user-attachments/assets/56bdd019-927b-40cc-9199-9bc6344f8d8b" />
6068

6169
## Developing
6270

@@ -74,7 +82,7 @@ WIP...
7482
* Fork: go to [ewowi/MoonBase](https://github.com/ewowi/MoonBase/) and press Fork, uncheck 'Copy the main branch only' and press Create Fork. You will be moved to your fork of MoonBase
7583
* Press Branches, press New Branch, give it a name e.g. background-script and press Create new Branch, click on background-script
7684

77-
<img width="90" alt="image" src="https://github.com/user-attachments/assets/588d0854-bac1-4b70-8931-ba6db4c94248" />
85+
<img width="90" src="https://github.com/user-attachments/assets/588d0854-bac1-4b70-8931-ba6db4c94248" />
7886

7987
* Go to the file you want to change e.g. [ModuleAnimations.h](https://github.com/ewoudwijma/MoonBase/blob/background-script/src/custom/ModuleAnimations.h), press edit and make the changes. E.g. change executable.execute("main") to executable.executeAsTask("main")
8088
* Press Commit Changes..., enter a commit message and an extended description, Press Commit Changes
@@ -87,4 +95,4 @@ WIP...
8795

8896
<img width="350" alt="Screenshot 2025-04-15 at 15 02 33" src="https://github.com/user-attachments/assets/53bc8b2e-a078-46a5-b926-25d581ec8202" />
8997

90-
* The upstream repo can now process this PR
98+
* The upstream repo can now process this PR

0 commit comments

Comments
 (0)