Implement ftdi led device #1595

nurikk · 2023-03-25T19:41:48Z

Hello! This PR introduces ftdilib1 led device implementation. FTDI chips are common usb2serial/spi/whatever chips, and are available for 5-10$ from Chinese website as various breakout boards.

(This is the back port from awawa-dev/HyperHDR#521)

My wiring is following:

FTDI  |  APA102 
AD0 -> CLOCK
AD1 -> DATA

AD3 -> CS (active low) // can be used to drive logic shifter OE pins


FTDI  |  WS2812 or SK6812
AD1 -> DATA

AD3 -> CS (active low) // can be used to drive logic shifter OE pins

I've tested my code on MacOS and webos7(lg tv c2), no extra drivers required.

This implementation is tested against APA102, WS1218 and SK6812.

Requires libftdi1 dependency hyperion-project/hyperion.docker-ci#6

Test webOS builds available here https://github.com/nurikk/hyperion.ng-webos-loader/actions/runs/4520870590

What kind of change does this PR introduce? (check at least one)

If changing the UI of web configuration, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

Yes
No

hyperion-project · 2023-03-25T19:42:14Z

Hello @nurikk 👋

I'm the Hyperion Project Bot and I want to thank you for
contributing to Hyperion with your pull requests!

To help you and other users test your pull requests faster,
I'll create a link for you to your workflow artifacts.

🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4520879701

Of course, if you make changes to your PR, I will create a new link.

Best regards,
Hyperion Project

hyperion-project · 2023-03-25T23:32:51Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4521703611

hyperion-project · 2023-03-26T12:55:05Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4524686424

hyperion-project · 2023-03-26T14:45:41Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4525152198

hyperion-project · 2023-03-26T15:27:07Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4525325491

Lord-Grey

Hi @nurikk
many thanks for your contribution!

Thanks for the PR backporting FTDI support from HyperHDR.
In some areas hyperion works a bit differently.
Therefore, please find some review comments below and related to the files.
I am happy to support you in getting it aligned.

Following additional comments:

The content_leds.js code does not support the discovery mechanism.
Ping me privately on discord and I share a updated version with you or provide access to your repository and I push a commit with some updates...
Would you mind adding libftdi1-dev to doc/development/CompileHowto.md
I am still wondering, if it would make sense changing the backend code that way, that e.g. apa102 can work via SPI or FTDI.
i.e. having common LED type code but working via a different way of communication.
Currently, the e.g. APA SPI and APA FTDI is not consistent any longer.

CMakeLists.txt

assets/webconfig/js/content_leds.js

include/utils/RgbToRgbw.h

libsrc/leddevice/schemas/schema-apa102_ftdi.json

libsrc/leddevice/dev_ftdi/LedDeviceSk6812_ftdi.h

libsrc/leddevice/dev_ftdi/ProviderFtdi.cpp

hyperion-project · 2023-03-26T19:37:47Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4526282386

nurikk · 2023-03-26T19:41:27Z

Hi @Lord-Grey, thanks for a great review! I've addressed all questions.

I am still wondering, if it would make sense changing the backend code that way, that e.g. apa102 can work via SPI or FTDI.

I'd love to do that, but I'm afraid I'm not competent enough in cpp and overall project structure to start such refactoring.

hyperion-project · 2023-03-26T19:59:37Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4526347635

nurikk · 2023-03-26T22:05:36Z

@Lord-Grey can you help me with linker issues? It compiled right for mac os, but it fails on linux https://github.com/nurikk/hyperion.ng/actions/runs/4526347559/jobs/7971453468

Lord-Grey

Thanks for turning the previous feedback round quickly!

@Lord-Grey can you help me with linker issues? It compiled right for mac os, but it fails on linux https://github.com/nurikk/hyperion.ng/actions/runs/4526347559/jobs/7971453468

Please see some feedback below. It should address to issue.

You can also run unix docker compiles with local codes to test before running the docker on Git
For the failing Stretch build you would execute in the local code directory:

sudo ./bin/scripts/docker-compile.sh -i x86_64 -t stretch -b Debug -p false -l

Look at the script and you can easily cross-compile for testing on other platforms too.

libsrc/leddevice/CMakeLists.txt

assets/webconfig/js/content_leds.js

libsrc/leddevice/dev_ftdi/LedDeviceWs2812_ftdi.cpp

Lord-Grey · 2023-03-27T15:24:44Z

libsrc/leddevice/schemas/schema-sk6812_ftdi.json

+			"required": true,
+			"propertyOrder": 1
+		},
+		"rate": {


Ist the baud rate totally dynamic or does it follow the USB serial baud rates?
If it follows the baud rate, I suggest you use a rateList as in
https://github.com/hyperion-project/hyperion.ng/blob/master/libsrc/leddevice/schemas/schema-adalight.json
to avoid user misconfiguration.

it's not abut serial baud rate, since sk6812 is pwm driven and we simulate pwm signal using spi, allowing users to manually adjust baud rate will help to fix any troubles with dodgy strings. same for ws2812

libsrc/leddevice/schemas/schema-sk6812_ftdi.json

libsrc/leddevice/schemas/schema-ws2812_ftdi.json

libsrc/leddevice/schemas/schema-apa102_ftdi.json

hyperion-project · 2023-03-27T15:43:29Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4533883364

Lord-Grey · 2023-03-27T15:46:57Z

@nurikk Sorry, I missed one thing,

Could you adding libftdi1-dev to doc/development/CompileHowto.md

and to

hyperion.ng/.github/workflows/codeql.yml

Line 35 in e0060eb

    
                     sudo apt-get install --yes git cmake build-essential qtbase5-dev libqt5serialport5-dev libqt5sql5-sqlite libqt5svg5-dev libqt5x11extras5-dev libusb-1.0-0-dev python3-dev libcec-dev libxcb-image0-dev libxcb-util0-dev libxcb-shm0-dev libxcb-render0-dev libxcb-randr0-dev libxrandr-dev libxrender-dev libavahi-core-dev libavahi-compat-libdnssd-dev libasound2-dev libturbojpeg0-dev libjpeg-dev libssl-dev

Otherwise the Code-Checker will fail to build.

nurikk · 2023-03-27T16:01:04Z

Done

nurikk · 2023-03-27T16:03:45Z

@Lord-Grey can you advise me on how to refactor spi and ftdi led devices to adhere DRY? I don't quite like the inheritance here

Lord-Grey · 2023-03-27T17:12:36Z

Done

Maybe you missed to push the commits.
I do not see the updates for codeql.yml and HowTo in the PR…

nurikk · 2023-03-27T17:16:40Z

Done

Maybe you missed to push the commits. I do not see the updates for codeql.yml and HowTo in the PR…

Oh yeah, I forgot to push:) I’ll push once get back home

hyperion-project · 2023-03-27T18:36:46Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4535397801

nurikk · 2023-03-27T18:50:49Z

Pushed :)

asturel · 2023-03-27T19:08:54Z

Many thanks, it's not possible to support windows platform (too)?

Lord-Grey · 2023-03-27T19:15:34Z

Pushed :)

Great. Thank you!
Codeanalysis is already running.

nurikk · 2023-03-27T19:17:12Z

Many thanks, it's not possible to support windows platform (too)?

This should be possible, but I have no idea how to install libraries on windows.

Lord-Grey · 2023-03-27T19:19:11Z

@Lord-Grey can you advise me on how to refactor spi and ftdi led devices to adhere DRY? I don't quite like the inheritance here

I am not a Cpp-Pro and would need to investigate about it. There are different options, but not limited to, like a bridging class, multiple inheritance, using templates, etc…

hyperion-project · 2023-03-31T14:05:22Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4575891089

hyperion-project · 2023-04-02T12:56:49Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4588817630

assets/webconfig/js/content_leds.js

hyperion-project · 2023-04-11T19:59:58Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4671482336

hyperion-project · 2023-04-13T11:12:09Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4688562541

hyperion-project · 2023-04-13T11:32:39Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4688729370

hyperion-project · 2023-04-13T11:34:56Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4688751219

hyperion-project · 2023-04-13T11:36:01Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4688759522

hyperion-project · 2023-04-13T11:43:00Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4688811504

satgit62 · 2023-04-17T18:04:35Z

Hello, is there any chance to implement the Hyperion FTDI for Windows?

hyperion-project · 2023-04-17T19:10:52Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4724908872

nurikk · 2023-04-17T19:12:13Z

Hello, is there any chance to implement the Hyperion FTDI for Windows?

Hi, it's definitely possible, but not the top priority atm

asturel · 2023-04-19T11:25:43Z

I really liked the previously white calc. algorithms ("auto", "auto_max", "auto_accurate"), could we have them back (or they get removed not intentionally) ?

hyperion-project · 2023-04-19T11:35:22Z

Hey @nurikk I created a new link to your workflow artifacts:
🔗 https://github.com/hyperion-project/hyperion.ng/actions/runs/4742822044

nurikk · 2023-04-19T12:01:58Z

I really liked the previously white calc. algorithms ("auto", "auto_max", "auto_accurate"), could we have them back (or they get removed not intentionally) ?

added them back

github-advanced-security

CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

asturel · 2023-04-25T21:26:37Z

Is it possible that very low led color causes the led flashing between on/off? I used the same length cable /5cm?/ + level shifter /sn74ahct/ (even hooked OE to GND instead of CS /AD3/) as used for esp32 where this problem doesn't occurs. I captured short footage of the issue (the movie was paused):
https://youtube.com/shorts/y1rV8DnI5q0
https://youtube.com/shorts/yPuYVCJ0Oe0
It's totally (source) content related, i couldn't reproduce with effects/colors, also have some 'random' (occurs around some white 'area') white flashes.

Any idea what can cause this? I tried different baud rates, latch time, slower led update rate, but the problem persist :/.
I don't think the problem is related to my hw (everything is kinda the same as I mentioned above) and switching (on the fly -- just changing the controller type) to esp32 + hyperserial fixes the issue.

p.s.: SK6812 RGBW strip

satgit62 · 2023-04-26T08:02:43Z

@asturel
I have connected the FTDI without level shifter and I do not have this error. I also use SK6812RGBW.

asturel · 2023-04-28T23:06:17Z

Is the reset time typo or lowered on purpose based on some tests? const int SPI_FRAME_END_LATCH_BYTES = 3; https://github.com/nurikk/hyperion.ng/blob/ftdi/libsrc/leddevice/dev_spi/LedDeviceSk6812SPI.cpp#L45
According to SK6812's datasheet https://cdn-shop.adafruit.com/product-files/2757/p2757_SK6812RGBW_REV01.pdf the reset time is 80µs, so with 3000000 baud rate it should be 30 (?). I have bumped to 32 at first (calculated with 3200000 baud) and seems like the issue is gone, but from a short test i haven't run into issues with 5 either.

btw it shouldn't be dependent on leds count? (the datasheet applies to 300 leds (?))

m4rkusxxl · 2023-08-28T17:09:11Z

I use a FT232H without a level shifter and tried this patch, but I had to do some adjustments:

Mixture of ENABLE_DEV_FTDI / ENABLE_FTDIDEV
After opening the device I had to add a 1s sleep for it to work.
Not sure why, but ftdi_usb_get_strings failed hard. I removed it but thats of course not a good solution ;)
As I applied it to the current master, I needed to adapt the deviceList keys to systemLocation and deviceName.

With that being said, its driving my old 189 APA102 setup without any problems for two weeks now.
So thank you for the work and looking forward to get it merged.

Lord-Grey · 2024-05-27T18:14:53Z

@nurikk / @nurikk-sa It has been a very long time that this PR is open. Too long!
Due to some long term illness and other priorities, I have never manged to properly follow up on your great contribution.

As I do not have the time to fully and conceptually separate LED protocols from communication ones holistically.
I thought having separated SPI and ftdi devices is still a good start to go with (and later clean this up).
As this PR starts already with the merged SPI/ftdi refactored code, I started a new ftdi_basic branch in your repository replaying the commits until the refactoring. Some extra changes/fixes, I applied on top.

I put your work as #1746 to make it available to the community.
I am hoping this finds your understanding and you are ok with it.

You might want to check, if I missed some critical updated when pulling everything together.

Many thanks again for your contribution and really sorry it took toooooo long!

Lord-Grey · 2024-05-30T11:45:30Z

Client ng as replaced by #1746

nurikk force-pushed the ftdi branch from b54f0a1 to 78462a5 Compare March 25, 2023 23:32

This was referenced Mar 26, 2023

Add libftdi1-dev for ftdi led device hyperion-project/hyperion.docker-ci#5

Closed

Add libftdi1 hyperion-project/hyperion.docker-ci#6

Merged

Lord-Grey reviewed Mar 26, 2023

View reviewed changes

nurikk mentioned this pull request Mar 27, 2023

Ftdi led device awawa-dev/HyperHDR#521

Draft

9 tasks

Lord-Grey reviewed Mar 27, 2023

View reviewed changes

github-advanced-security bot found potential problems Apr 2, 2023

View reviewed changes

assets/webconfig/js/content_leds.js Fixed Show fixed Hide fixed

nurikk force-pushed the ftdi branch from 95698cb to dee253d Compare April 13, 2023 11:11

Implement ftdi led device

913d636

nurikk force-pushed the ftdi branch from dee253d to 913d636 Compare April 13, 2023 11:32

Refactor to IS_FTDI_DEVICE_NAME

a119b24

Remove extra fields from discovery response

33769ce

Add _ftdic(nullptr)

e40c283

nurikk-sa added 2 commits April 13, 2023 13:36

Rm junk

97538fb

Refactor spidev and ftdi spi providers into separate classes

43b864b

Add missing white algo options

f650d07

github-advanced-security bot found potential problems Apr 19, 2023

View reviewed changes

Lord-Grey mentioned this pull request May 27, 2024

Implement ftdi led device - 2 #1746

Merged

14 tasks

Lord-Grey closed this May 30, 2024

Implement ftdi led device #1595

Implement ftdi led device #1595

Conversation

nurikk commented Mar 25, 2023 • edited Loading

hyperion-project bot commented Mar 25, 2023

hyperion-project bot commented Mar 25, 2023

hyperion-project bot commented Mar 26, 2023

hyperion-project bot commented Mar 26, 2023

hyperion-project bot commented Mar 26, 2023

Lord-Grey left a comment

Choose a reason for hiding this comment

hyperion-project bot commented Mar 26, 2023

nurikk commented Mar 26, 2023 • edited Loading

hyperion-project bot commented Mar 26, 2023

nurikk commented Mar 26, 2023

Lord-Grey left a comment • edited Loading

Choose a reason for hiding this comment

Lord-Grey Mar 27, 2023

Choose a reason for hiding this comment

nurikk-sa Mar 27, 2023

Choose a reason for hiding this comment

hyperion-project bot commented Mar 27, 2023

Lord-Grey commented Mar 27, 2023

nurikk commented Mar 27, 2023

nurikk commented Mar 27, 2023

Lord-Grey commented Mar 27, 2023 • edited Loading

nurikk commented Mar 27, 2023

hyperion-project bot commented Mar 27, 2023

nurikk commented Mar 27, 2023

asturel commented Mar 27, 2023

Lord-Grey commented Mar 27, 2023

nurikk commented Mar 27, 2023

Lord-Grey commented Mar 27, 2023

hyperion-project bot commented Mar 31, 2023

hyperion-project bot commented Apr 2, 2023

hyperion-project bot commented Apr 11, 2023

hyperion-project bot commented Apr 13, 2023

hyperion-project bot commented Apr 13, 2023

hyperion-project bot commented Apr 13, 2023

hyperion-project bot commented Apr 13, 2023

hyperion-project bot commented Apr 13, 2023

satgit62 commented Apr 17, 2023

hyperion-project bot commented Apr 17, 2023

nurikk commented Apr 17, 2023

asturel commented Apr 19, 2023

hyperion-project bot commented Apr 19, 2023

nurikk commented Apr 19, 2023

github-advanced-security bot left a comment

Choose a reason for hiding this comment

asturel commented Apr 25, 2023 • edited Loading

satgit62 commented Apr 26, 2023

asturel commented Apr 28, 2023 • edited Loading

m4rkusxxl commented Aug 28, 2023 • edited Loading

Lord-Grey commented May 27, 2024 • edited Loading

Lord-Grey commented May 30, 2024

nurikk commented Mar 25, 2023 •

edited

Loading

nurikk commented Mar 26, 2023 •

edited

Loading

Lord-Grey left a comment •

edited

Loading

Lord-Grey commented Mar 27, 2023 •

edited

Loading

asturel commented Apr 25, 2023 •

edited

Loading

asturel commented Apr 28, 2023 •

edited

Loading

m4rkusxxl commented Aug 28, 2023 •

edited

Loading

Lord-Grey commented May 27, 2024 •

edited

Loading