Skip to content

Commit 1433b14

Browse files
committed
Doc updates Ethernet, board presets, artnet in
Docs ===== - update Module IO - add ethernet - update drivers (artnetin) Back-end ======== - Ethernet fix - Module IO: comment Penta, add 🚧
1 parent 2db9537 commit 1433b14

File tree

11 files changed

+52
-54
lines changed

11 files changed

+52
-54
lines changed
23.2 KB
Loading
16.8 KB
Loading
11.1 KB
Loading

docs/media/network/ethernet.png

15.3 KB
Loading

docs/moonbase/inputoutput.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# IO Module
22

3-
<img width="320" height="441" alt="io11" src="https://github.com/user-attachments/assets/b5452d8e-400c-4a72-a195-d5b7a7764407" />
4-
<img width="320" height="77" alt="io22" src="https://github.com/user-attachments/assets/99fd135c-8d36-463b-ae3a-f06119cb8ccb" />
3+
<img width="320" height="441" alt="io11" src="/media/moonbase/inputoutput.png" />
54

65
Defines hardware specifics per ESP32 device 🆕
6+
77
Currently the following boards are defined. Not all are supported yet 🚧
88

9-
<Image>
9+
<img width="320" height="441" alt="io11" src="/media/moonbase/inputoutputpresets.png" />
1010

1111
For each board the following presets are defined:
1212

1313
* Modded: if any change to the default preset is made.
14-
* Max Power in Watts: adjust the brightness to approach this max power, depending on the number of LEDs used. Default 10: 5V * 2A = 10W (so it runs fine on USB).
14+
* Max Power in Watts: adjust the brightness to approach this max power, depending on the number of LEDs used. Default 10: 5V * 2A = 10W (so it runs fine on USB). Used by LED drivers, see [Drivers](/moonlight/drivers/)
1515
* Jumper1: If the board contains a jumper, it can define pin behaviour. Eg. select between Infrared and Ethernet.
1616
* Pins: This module is the central place to assign functionality to gpio pins. Other modules and nodes use the pin assignments made here.
17-
18-
* Per pin:
1917
* GPIO = gpio_num;
2018
* Usage: See below
2119
* Index: specify first, second, third, ... usage output, e.g. LED D01 to LED D16
@@ -26,18 +24,15 @@ For each board the following presets are defined:
2624
* Level (HIGH, LOW, N/A)
2725
* DriveCap (WEAK, STRONGER, MEDIUM, STRONGEST, N/A)
2826

29-
<image>
30-
3127
## Pin usage
3228

3329
* Supported
34-
* LEDs
35-
* Voltage
36-
* Current
37-
* Infrared
30+
* LEDs: Used by LED drivers to setup LED outputs, see [Drivers](/moonlight/drivers/)
31+
* Voltage and Current: Sets energy monitoring, see [System status](/system/status) and , see [System Metrics](/system/metrics)
32+
* Infrared: Used by IR driver, see [Drivers](/moonlight/drivers/)
3833
* Button LightsOn: sets on/off in [Light Control](https://moonmodules.org/MoonLight/moonlight/lightscontrol/)
3934
* Relay LightsOn: sets on/off in [Light Control](https://moonmodules.org/MoonLight/moonlight/lightscontrol/)
40-
* SPI_SCK, SPI_MISO, SPI_MOSI, PHY_CS, PHY_IRQ: S3 Ethernet
35+
* SPI_SCK, SPI_MISO, SPI_MOSI, PHY_CS, PHY_IRQ: S3 Ethernet, Used by the Ethernet module, see [Ethernet](/network/ethernet/)
4136
* Planned soon
4237
* Battery
4338
* DMX (in)

docs/moonlight/drivers.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ Want to add a Driver to MoonLight, see [develop](https://moonmodules.org/MoonLig
3636
| Art-Net Out| <img width="100" src="https://github.com/user-attachments/assets/9c65921c-64e9-4558-b6ef-aed2a163fd88"> | <img width="320" alt="Art-Net" src="https://github.com/user-attachments/assets/1428e990-daf7-43ba-9e50-667d51b456eb" /> | Send Art-Net to Drive LEDS and DMX lights over the network. See [below](#art-net-out) |
3737
| Audio Sync | <img width="100" src="https://github.com/user-attachments/assets/bfedf80b-6596-41e7-a563-ba7dd58cc476"/> | No controls | Listens to audio sent over the local network by WLED-AC or WLED-MM and allows audio reactive effects (♪ & ♫) to use audio data (volume and bands (FFT)) |
3838
| HUB75 Driver | <img width="100" src="https://github.com/user-attachments/assets/620f7c41-8078-4024-b2a0-39a7424f9678"/> | <img width="100" src="https://github.com/user-attachments/assets/4d386045-9526-4a5a-aa31-638058b31f32"/> | Drive HUB75 panels<br>Not implemented yet |
39-
| IR Driver | <img width="100" src="../../media/moonlight/IRDriver.jpeg"/> | | Receive IR commands and [Lights Control](https://moonmodules.org/MoonLight/moonlight/lightscontrol/) |
39+
| IR Driver | <img width="100" src="/media/moonlight/IRDriver.jpeg"/> | <img width="100" src="/media/moonlight/irdriverpreset.png"/> | Receive IR commands and [Lights Control](https://moonmodules.org/MoonLight/moonlight/lightscontrol/) |
4040

4141
* The Parallel LED driver uses different hardware peripherals depending on the MCU type: ESP32-D0: I2S, ESP32-S3: LCD_CAM, ESP32-P4: Parallel IO (ParLIO).
4242
* Virtual LED Driver: Driving max 120! outputs (E.g. 48 panels of 256 LEDs each run at 50-100 FPS) using shift registers. Integrated within the Parallel LED Driver architecture. Not implemented yet
4343
<img width="100" src="https://github.com/user-attachments/assets/98fb5010-7192-44db-a5c9-09602681ee15"/><img width="100" src="https://github.com/user-attachments/assets/c81d2f56-00d1-4424-a716-8e3c30e76636"/>
4444

45-
### Max Power and Light Preset
45+
### Light Preset
4646

47-
* **Max Power**: 🆕 moved to [IO Module](https://moonmodules.org/MoonLight/moonbase/inputoutput/) board presets.
47+
* **Max Power**: 🆕 moved to [IO Module](/moonbase/inputoutput/) board presets.
4848

4949
* **Light preset**: Defines the channels per light and color order
5050

@@ -77,6 +77,11 @@ Receives Art-Net data from the network.
7777
* Select physical layer to directly store the received channels into the physical layer
7878
* Select one of the (virtual layers) to take mapping into account (using layout specification and modifiers specified (recommended), see [Modifiers](https://moonmodules.org/MoonLight/moonlight/modifiers/), part of the [Effects Module](https://moonmodules.org/MoonLight/moonlight/effects/))
7979

80+
!!! tip "Other setup"
81+
* Add a Layout driver to specifify the fixture you are displaying on, e.g. Single Line for Tubes or Panel for Matrices
82+
* Add the Parallel LED Driver to enable connected LEDs
83+
* Go to the [IO Module](https://moonmodules.org/MoonLight/moonbase/inputoutput/) to define a board preset.
84+
8085
!!! tip "Running effects and Art-Net In"
8186
Effects can run at the same time, disable or delete them if you only want to run Art-Net In.
8287

docs/network/ethernet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Ethernet
22

3-
🚧
3+
<img width="320" src="/media/network/ethernet.png" />
44

5-
Not implemented yet
5+
See [IO module](/moonbase/inputoutput) to setup pins for Ethernet on S3 boards.

lib/framework/EthernetSettingsService.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ void EthernetSettingsService::configureNetwork(ethernet_settings_t &network)
8787
// (re)start ethernet
8888
// 🌙 compiler directives to variables
8989
#ifdef CONFIG_IDF_TARGET_ESP32S3
90-
if (v_ETH_SPI_SCK != UINT8_MAX) {
90+
if (v_ETH_SPI_SCK != -1) {
9191
// For SPI based ethernet modules like W5500, ENC28J60 etc.
9292
SPI.begin(v_ETH_SPI_SCK, v_ETH_SPI_MISO, v_ETH_SPI_MOSI);
9393
ETH.begin(v_ETH_PHY_TYPE, v_ETH_PHY_ADDR, v_ETH_PHY_CS, v_ETH_PHY_IRQ, v_ETH_PHY_RST, SPI);

lib/framework/EthernetSettingsService.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#include <vector>
2929

3030
#ifndef FACTORY_ETHERNET_HOSTNAME
31-
#define FACTORY_ETHERNET_HOSTNAME "#{platform}-#{unique_id}"
31+
#define FACTORY_ETHERNET_HOSTNAME "ML-#{unique_id}" // 🌙 use ML
3232
#endif
3333

3434
#define ETHERNET_EVENT_DELAY 500

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ nav:
2525
- "Network":
2626
- network/sta.md
2727
- network/ap.md
28-
# - network/ethernet.md
28+
- network/ethernet.md
2929
- network/mqtt.md
3030
- network/ntp.md
3131
- "System":

0 commit comments

Comments
 (0)