|
| 1 | + |
| 2 | +## Overview |
| 3 | + |
| 4 | +## Initless drivers |
| 5 | + |
| 6 | +Initless means there is no addLeds (like in FastLed) or initLed (like in physical and virtual driver): |
| 7 | + |
| 8 | +* a Context (see below) will be set |
| 9 | +* Driver.show (see below) will use this context to set the right data to the right output. |
| 10 | +* The context can dynamically change without needing to reboot or recompile! e.g. changes in pin allocations, leds per pin, RGB or RGBW, or DMX lights like moving heads. |
| 11 | + |
| 12 | +The Art-Net driver is currently working like this, to be added to physical and virtual driver and parallel IO (P4). |
| 13 | + |
| 14 | +The advantages of dynamic context change are: |
| 15 | + |
| 16 | +* No need to recompile any changed configs (e.g. colorOrder is fully flexible, not a setting in platformio.ini) |
| 17 | +* No need to restart while setting up a specific installation. Just change layouts until it works as intended. |
| 18 | +* Allows for a flexible mix of different outputs e.g. send the first 1024 leds to physical driver, next to virtual driver, next to spi, next to one Art-Net device, next to another Art-Net device. |
| 19 | + |
| 20 | +### Context |
| 21 | + |
| 22 | +Make sure the following is available before calling driver.show. Note: setup only sets variables the loop will use. |
| 23 | + |
| 24 | +* channels[]: pka leds array (CRGB leds) but we now support any light: not only 3 or 4 channels |
| 25 | +* channelsPerLed: a light in the channels array can be found by index * channelsPerLed. |
| 26 | +* offsets within the channels (RGBW and more like pan and tilt) |
| 27 | +* outputs[]: pins[] for leds drivers, outputs[] for Art-Net. Use generic name outputs[] |
| 28 | +* lengths[]: nr of lights per output |
| 29 | +* driver[]: shows for each output for which driver it is ... 🚧 as currenlty all drivers process all lights which sometimes is what you want (monitor on leds what is on moving heads) but not always |
| 30 | + |
| 31 | +This is the current list of supported lights ranging from 3 channels per light (the classic rgb LEDs) to 32 channels per light. Currently pre defined: lights preset. In the future configurable |
| 32 | + |
| 33 | +* RGB |
| 34 | +* RBG |
| 35 | +* GRB: default WS2812 |
| 36 | +* GBR |
| 37 | +* BRG |
| 38 | +* BGR |
| 39 | +* RGBW: e.g. 4 channel par/dmx light |
| 40 | +* GRBW: rgbw LED eg. SK6812 |
| 41 | +* GRB6: some LED curtains |
| 42 | +* RGBWYP: 6 channel par/dmx light with UV etc |
| 43 | +* MHBeeEyes150W-15 🐺: 15 channels moving head, see https://moonmodules.org/MoonLight/moonlight/drivers/#art-net |
| 44 | +* MHBeTopper19x15W-32 🐺: 32 channels moving head |
| 45 | +* MH19x15W-24: 24 channels moving heads |
| 46 | + |
| 47 | +Based on the choosen value, the channels per light and the offsets will be set e.g. for GRB: header->channelsPerLight = 3; header->offsetRed = 1; header->offsetGreen = 0; header->offsetBlue = 2;. Drivers should not make this mapping, the code calling drivers should do. |
| 48 | + |
| 49 | +The RGB and W offsets needs to be re-ordered and brightness corrected from the channel array. Not only Art-Net but also a LEDs driver need to accept channel arrays with more then 4 channels per light. Eg GRB6 is a type of led curtain some of us have, which a Chinese manufacturer screwed up: 6 channels per light but only rgb is used, 3 channels do nothing |
| 50 | + |
| 51 | +### Driver.show |
| 52 | + |
| 53 | +Called by loop function. |
| 54 | + |
| 55 | +* loop over all outputs (or pins) which are meant for a specific driver (e.g. all outputs for artnet) |
| 56 | + * pre channel actions (...) |
| 57 | + * loop over all lights in the output |
| 58 | + * for each light |
| 59 | + * pre light actions (e.g. setup dma ...) |
| 60 | + * copy all channels to the buffer (for art-net) or to the memory area / dma / parallelIO ... so the driver can process it |
| 61 | + * find them in the channels array |
| 62 | + * correct RGBW offsets when present for brightness using LUT (__red_map etc in Yves his drivers) |
| 63 | + * send the buffer/memory (artnetudp.writeTo sends one universe, Yves drivers ..., Troy drivers ...) |
| 64 | + * post light actions (e.g. increase universe etc) |
| 65 | + * post channel actions (...) |
| 66 | + |
| 67 | +For an example of the loop, see [Artnet loop](https://github.com/MoonModules/MoonLight/blob/fc6c4b6c52bf0a9e9a5de677c1ec5b6536fb7a16/src/MoonLight/Mods.cpp#L260-L293). Not splitten in output loop and lights loop yet (as now all drivers process all lights). Before and after the loop are pre /post output / light actions. |
| 68 | + |
| 69 | +### MoonLight layout nodes |
| 70 | + |
| 71 | +In MoonLight you can define one or more layout nodes telling which position lights have in the real world. E.g. a strip, or a panel (orientation, snake, ...) or a ring or any fantasy shape. |
| 72 | +Each layout nodes addLights and addPins (will be renamed to addOutPut). Layouts can be reordered. The pins and lights arrays will be filled with the Layout nodes in the order they are defined. |
| 73 | + |
| 74 | +Note: Above concept can also be offered in a library and imported in other projects like WLED, FastLED scripts etc. |
| 75 | + |
| 76 | +### Notes on the I2S clockless driver |
| 77 | + |
| 78 | +* nb_components -> channelsPerLed |
| 79 | +* p_r, p_g, p_b, p_w -> offsetRed, Green, Blue, White |
| 80 | +* stripSize[] -> lenghts[] |
| 81 | + |
| 82 | +#### initLed |
| 83 | + |
| 84 | +* setBrightness / setGamma -> done by MoonLight if brightness (or gamma) changes, driver.show expects the LUT to be set right |
| 85 | +* setPins(Pinsq): called by MoonLight as soon as pins changes: add function driver.updatePins which also cleans up previous defined pins (I think there is no cleanup, so can be called repeatedly?) |
| 86 | +* i2sInit(): not using context...: so this (and i2sReset...) can be called once in the setup... |
| 87 | + * i2sReset(): not using context... |
| 88 | + * i2sReset_DMA(): not using context... |
| 89 | + * i2sReset_FIFO(): not using context... |
| 90 | +* initDMABuffers(): uses __NB_DMA_BUFFER, nb_components -> should be called by MoonLight as soon as dma buffer (would be very nice if this is a variable instead of a constant, so can be tweaked in MoonLight without recompiling) or lights preset (channelsPerLed) changes. Add function driver.updateLightsPreset(dma_buffer, channelsPerLight)... |
| 91 | + * putdefaultones: uses nb_components |
| 92 | + |
| 93 | +#### showPixels |
| 94 | + |
| 95 | +* loadAndTranspose(): uses this for all dma buffers. All Okay |
| 96 | + * loop over num_strips (outputs[].length) |
| 97 | + * loop over stripSize (lenghts[]), light by light: triggered by _I2SClocklessLedDriverinterruptHandler |
| 98 | + * fills secondPixel using LUT and RGB(W) offsets |
| 99 | + * transpose16x1_noinline2(secondpixel) |
| 100 | +* i2sStart: uses dma buffers: Okay |
0 commit comments