Introduce Garland module #2408

ElderJoy · 2020-12-12T00:16:48Z

Port of https://github.com/Vasil-Pahomov/ArWs2812 from Arduino to ESP8266
Implementing garland of WS2812
Features for now:

8 animation modes
Web control of ON/OFF and brightness
env:garland setup

In plans:

add more animations
add more controls to web

It is quite raw but works for me on wemos-d1mini. Hope with community help it can be useful. New Year is coming... :)

…ed binaries

# Conflicts: # code/espurna/data/index.all.html.gz # code/espurna/data/index.light.html.gz # code/espurna/data/index.lightfox.html.gz # code/espurna/data/index.rfbridge.html.gz # code/espurna/data/index.rfm69.html.gz # code/espurna/data/index.sensor.html.gz # code/espurna/data/index.small.html.gz # code/espurna/data/index.thermostat.html.gz # code/espurna/espurna.ino # code/espurna/static/index.all.html.gz.h # code/espurna/static/index.light.html.gz.h # code/espurna/static/index.lightfox.html.gz.h # code/espurna/static/index.rfbridge.html.gz.h # code/espurna/static/index.rfm69.html.gz.h # code/espurna/static/index.sensor.html.gz.h # code/espurna/static/index.small.html.gz.h # code/espurna/static/index.thermostat.html.gz.h # code/html/index.html # code/platformio.ini

ElderJoy · 2020-12-12T11:13:26Z

Check failed on env:esp8266-4m-latest-base. Checked locally, build for env:esp8266-4m-latest-base failed with error:
espurna\config/hardware.h:5078:6: error: #error "UNSUPPORTED HARDWARE!!"
Does anybody know if it is my fault? What's wrong and what can I do to fix this issue?

code/espurna/garland/scene.h

mcspr · 2020-12-12T11:40:11Z

Also note it merges every .cpp file into one when building in CI. static / namespace { ... } might still have name collisions. I also noticed end-of-file line-endings are missing for some of the .cpp files.

Do you think it is possible to move Anim code into a library? i.e. you can just use a separate repo ElderJoy/GarlandESP8266 or something like that

…ARLAND_SUPPORT macro.

mcspr · 2020-12-12T12:45:16Z

Checked locally, build for env:esp8266-4m-latest-base failed with error:
espurna\config/hardware.h:5078:6: error: #error "UNSUPPORTED HARDWARE!!"

...I missed the question about local builds. You can check out the travis log above the error, since it's just a shell script and it shows every step it does. The -base environments are mission DEVICE and MANUFACTURER pair of build flags somehow, either custom.h, src_build_flags of the custom env, ESPURNA_FLAGS=... environ, PLATFORMIO_SRC_BUILD_FLAGS=... environ, etc.

You can try adding test/build/garland.h with the GARLAND_SUPPORT=1 (+ any additional flags), so the CI can try to build it

ElderJoy · 2020-12-12T12:45:27Z

Hi @mcspr,
Thank you for pointing out my mistakes. I fixed slashes, add end-of-file where it was missed and wrap code that belongs to garland into macro to exclude it from build in other configurations.

As for separate garland-dedicated code into separate library. I supposed this functionality as extendable. Anyone can easily add and modify animations. Hope with community help we will have much more animations soon.
It would be not so easy with external library. But it is possible of cause.
So, should I separate this code in library?

ElderJoy · 2020-12-12T12:51:59Z

The -base environments are mission DEVICE and MANUFACTURER pair of build flags somehow, either custom.h, src_build_flags of the custom env, ESPURNA_FLAGS=... environ, PLATFORMIO_SRC_BUILD_FLAGS=... environ, etc.

Yes, I noticed that base envs missed that flags, but not clearly understand how supposed to build them in this way.

You can try adding test/build/garland.h with the GARLAND_SUPPORT=1 (+ any additional flags), so the CI can try to build it

I added env:garland with correspondent flags. Ok, will add configuration for CI also.

mcspr · 2020-12-12T13:13:19Z

See https://github.com/xoseperez/espurna/wiki/PlatformIO#building
The idea is to preserve the build environment when changing build flags. Locally or in CI, effectively it skips the framework + libs build, only rebuilding the relevant project source

As for separate garland-dedicated code into separate library. I supposed this functionality as extendable. Anyone can easily add and modify animations. Hope with community help we will have much more animations soon.
It would be not so easy with external library. But it is possible of cause.
So, should I separate this code in library?

Let me get back on that...

code/espurna/garland/anim.cpp

code/espurna/garland/anim_assemble.cpp

code/espurna/garland/anim_comets.cpp

…instead of vector in top level; Remove generics from scene.h

…nim objects.

ElderJoy · 2020-12-20T23:28:01Z

Ok, next attempt. Fixed all pointed places.
New features:

possibility to control common animation speed from UI
reset brightness and speed to the default
each animation can tune self speed factor
calculate average frame rate for animation and output with debug info
Tune some animations
Please take a look on it now.

mcspr

Something have been bothering me... sorry that I missed this when initially reading the description

Original project does not specify any license. And, based on the Github's explanation from here:
https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#choosing-the-right-license

However, without a license, the default copyright laws apply, meaning that you retain all rights to your source code and no one may reproduce, distribute, or create derivative works from your work. If you're creating an open source project, we strongly encourage you to include an open source license.
...
If you publish your source code in a public repository on GitHub, according to the Terms of Service, other users of GitHub have the right to view and fork your repository.

It is not really clear if with the changes here it is 'derivative work' or something else. We are not commercially distributed software though, so there's that. But, I wonder if we could at least make the author aware of the inclusion to receive an ok that we can use it?
(there is also a continued work, as the project deemed deprecated, but it still lacks any license there as well)

mcspr · 2020-12-21T13:24:38Z

code/espurna/garland/palette.h

+        if (!_cache[i].empty())
+            return _cache[i];
+
+        Color col = getPalColor((float)i / 256);


Was 256 meant to be cache size?

Yes. And it takes 256*3 bytes per palette. But dramatically reduce processing time. And some animations use this actively.
Parameter (byte i) has 256 possible variants. So, there are 256 variants of interpolated colors for the palette doesn't matter how many different static colors it has. Any animation that produce smooth color sequence for palette use this for each pixel each Run cycle.

code/espurna/garland/scene.h

ElderJoy · 2020-12-21T16:16:37Z

It is not really clear if with the changes here it is 'derivative work' or something else. We are not commercially distributed software though, so there's that. But, I wonder if we could at least make the author aware of the inclusion to receive an ok that we can use it?
(there is also a continued work, as the project deemed deprecated, but it still lacks any license there as well)

Yes, you're right. It is better to contact to Author of library that I used as base one. Unfortunately, I didn't found any contact information neither in GitHub account nor in the code. So, I found a bit weird way - I created issue in the currently maintained project. Hope Author will contact to me or write here.

ElderJoy · 2020-12-23T11:16:11Z

@mcspr Ok, what we can do more regarding License? Version that I used is deprecated now (I used Arduino version) and I rewrite it mostly. But of cause base version was that I pointed out and most animations from there. So, can we use it based on GitHub licensing politics?

mcspr · 2020-12-23T17:36:08Z

It may be a stretch, but assuming we follow the chain to the https://github.com/bportaluri/ALA, it is GPLv3 still even without an explicit statement that it is.
I'd add attribution as 'inspired / based on the code from ... and ...' to the files though.

edit: Github docs are only meant to point out that the author holds the rights, but does not tell us what our rights are and what we could do with the code (besides just looking at it)

ElderJoy · 2020-12-24T08:51:48Z

Added header with reference to the project garland based on

mcspr · 2020-12-24T14:59:18Z

Just in time :) sry for delays

I also wanted to point out that Adafruit's neopixel lib might not be the most efficient one on the platform, you might want to check out either:

and esp8266 code there was not really updated since august of 2015
https://github.com/adafruit/Adafruit_NeoPixel/commits/master/esp8266.c

mcspr · 2020-12-24T14:59:36Z

Could you update the wiki describing the module?

ElderJoy · 2020-12-24T15:09:37Z

Well, it works not so bad with Adafruit's Neopixel currently. However, it eat most time for showing pixels inside library and if it can be speed up, than it worth to do. So, sure, I will check both mentioned libs and adapt library to better one. But my proposition to make it with next pull request. I going to add couple animations also.

ElderJoy · 2020-12-24T15:10:08Z

Could you update the wiki describing the module?

Yep, will do.

ElderJoy and others added 22 commits January 25, 2020 01:02

initial garland commit

49ed4c0

Add animations

af81e30

Fix glow

f4e1d5b

All animations, period, palettes

dae4684

Merge remote-tracking branch 'xoseperez/dev' into garland

7322bcf

Add Web Ui

c1c6cd7

Implement brightness slider

ec75398

Update brightness

35919c3

Preparing to refactoring

d29ba45

Renamed Anim to Scene. Sreate Scene::Anim, Implement AnimRun. It works!

a939deb

Remove friends

c2a0157

Add Fly and PixelDust

c0009be

All anims transferred to classes

f988637

Remove anim functions from scene

dd47457

Update project files; Add Adafruit Neopixes deps, update ui precompil…

c410613

…ed binaries

Prepare for merde with dev

6d3d8b6

Adapt garland to latest dev

9bee42f

Updates for scene and garland

704300c

Add anim name into debug print

6964a18

Reset package.json up to dev

53ff937

Set default brightness to 255

da5bd0f

mcspr reviewed Dec 12, 2020

View reviewed changes

code/espurna/garland/scene.h Outdated Show resolved Hide resolved

Fixed slashes, end-of-file, wrap garland-dedicated sources with #if G…

aa56373

…ARLAND_SUPPORT macro.

mcspr reviewed Dec 16, 2020

View reviewed changes

code/espurna/garland/anim.cpp Outdated Show resolved Hide resolved

mcspr reviewed Dec 16, 2020

View reviewed changes

code/espurna/garland/anim_assemble.cpp Outdated Show resolved Hide resolved

code/espurna/garland/anim_comets.cpp Outdated Show resolved Hide resolved

Dmitry Blinov added 10 commits December 17, 2020 23:48

Improvements part1. Add .cpp, .h to .gitattributes; Use simple array …

bebb2eb

…instead of vector in top level; Remove generics from scene.h

Improvements part 2. Use const char* instead of const String inside A…

6b2f983

…nim objects.

Improvements part 3.Remove commonSetup() from garland, add eol's

74f7e44

Implement speed control from UI

ab57678

Move animations to garland/animations

034edc7

Add cycleFactor for animations to allow individual speed tuning

da16167

Refine AnimSpread

d4b170c

Add frame rate

287d96d

Move scene.cpp and anim.cpp to garland.cpp

9c220bb

Extract common anim helper functions, tune anim_assemble

1d5dd4b

mcspr reviewed Dec 21, 2020

View reviewed changes

ElderJoy mentioned this pull request Dec 21, 2020

@Vasil-Pahomov Need your approve to use your code in the expurna project Vasil-Pahomov/Liana#24

Closed

Add header with reference to the base project

8c23f67

mcspr added 5 commits December 24, 2020 16:23

Merge remote-tracking branch 'origin/dev' into pr/ElderJoy/2408

edf59af

More headers

ac056be

spaces

448af81

capture already constructed vector into palette

4adf6ea

Merge remote-tracking branch 'origin/dev' into pr/ElderJoy/2408

45f9a6c

mcspr merged commit 5aeb24f into xoseperez:dev Dec 24, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce Garland module #2408

Introduce Garland module #2408

ElderJoy commented Dec 12, 2020 •

edited

Loading

ElderJoy commented Dec 12, 2020

mcspr commented Dec 12, 2020 •

edited

Loading

mcspr commented Dec 12, 2020

ElderJoy commented Dec 12, 2020

ElderJoy commented Dec 12, 2020

mcspr commented Dec 12, 2020

ElderJoy commented Dec 20, 2020

mcspr left a comment

mcspr Dec 21, 2020

ElderJoy Dec 21, 2020

ElderJoy commented Dec 21, 2020 •

edited

Loading

ElderJoy commented Dec 23, 2020

mcspr commented Dec 23, 2020 •

edited

Loading

ElderJoy commented Dec 24, 2020

mcspr commented Dec 24, 2020

mcspr commented Dec 24, 2020

ElderJoy commented Dec 24, 2020

ElderJoy commented Dec 24, 2020

Introduce Garland module #2408

Introduce Garland module #2408

Conversation

ElderJoy commented Dec 12, 2020 • edited Loading

ElderJoy commented Dec 12, 2020

mcspr commented Dec 12, 2020 • edited Loading

mcspr commented Dec 12, 2020

ElderJoy commented Dec 12, 2020

ElderJoy commented Dec 12, 2020

mcspr commented Dec 12, 2020

ElderJoy commented Dec 20, 2020

mcspr left a comment

Choose a reason for hiding this comment

mcspr Dec 21, 2020

Choose a reason for hiding this comment

ElderJoy Dec 21, 2020

Choose a reason for hiding this comment

ElderJoy commented Dec 21, 2020 • edited Loading

ElderJoy commented Dec 23, 2020

mcspr commented Dec 23, 2020 • edited Loading

ElderJoy commented Dec 24, 2020

mcspr commented Dec 24, 2020

mcspr commented Dec 24, 2020

ElderJoy commented Dec 24, 2020

ElderJoy commented Dec 24, 2020

ElderJoy commented Dec 12, 2020 •

edited

Loading

mcspr commented Dec 12, 2020 •

edited

Loading

ElderJoy commented Dec 21, 2020 •

edited

Loading

mcspr commented Dec 23, 2020 •

edited

Loading