Package Health Score

84 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

ledger
42

Popularity

Recognized

GitHub Stars: 1.34K
Forks: 163
Contributors: 60

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package LedFx, we found that it has been starred 1,344 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Nov 2, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 36
Open PR: 7
Last Release: 7 days ago
Last Commit: 7 days ago

Further analysis of the maintenance status of LedFx based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that LedFx demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 60
Funding: No

With more than 10 contributors for the LedFx repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <3.13,>=3.9

Age: 6 years
Latest Release: 7 days ago
Dependencies: 0 Direct
Versions: 49
Maintainers: 2
Wheels: OS Independent

Not sure how to use LedFx?

To help you get started, we've collected the most common ways that LedFx is being used within popular public projects.

ahodges9 / LedFx / ledfx / effects / audio.py View on Github

self.filterbank.set_mel_coeffs_htk(
                self._config['mic_rate'],
                self._config['min_frequency'],
                self._config['max_frequency'])

            # Frequencies wil be linearly spaced in the mel scale
            melbank_mel = np.linspace(
                aubio.hztomel(self._config['min_frequency']),
                aubio.hztomel(self._config['max_frequency']),
                self._config['samples'])
            self.melbank_frequencies = np.array(
                [aubio.meltohz(mel) for mel in melbank_mel])

        # Coefficients based on Scott's audio reactive led project
        if self._config['coeffs_type'] == 'scott':
            (melmat, center_frequencies_hz, freqs) = mel.compute_melmat(
                num_mel_bands=self._config['samples'],
                freq_min=self._config['min_frequency'],
                freq_max=self._config['max_frequency'],
                num_fft_bands=int(self._config['fft_size'] // 2) + 1,
                sample_rate=self._config['mic_rate'])
            self.filterbank = aubio.filterbank(
                self._config['samples'],
                self._config['fft_size'])
            self.filterbank.set_coeffs(melmat.astype(np.float32))
            self.melbank_frequencies = center_frequencies_hz

        # "Mel"-spacing based on Scott's audio reactive led project. This
        # should in theory be the same as the above, but there seems to be
        # slight differences. Leaving both for science!
        if self._config['coeffs_type'] == 'scott_mel':
            def hertz_to_scott(freq):

View more ways to use LedFx

Welcome to LedFx ✨ Making music come alive!

What is LedFx?

LedFx makes your LEDs dance to audio! What LedFx offers is the ability to take audio input, and instantaneously processes the audio into realtime light show to multiple LED strips/matrix. No need to spend hours on end to program one song to program your LEDs, as LedFx will do this all for you!

LedFx real-time LED strip music visualization effect controller using is a network based devices (ESP8266/ESP32/Raspberry Pi 4) with support for advanced real-time audio effects! LedFx can control multiple devices and works great with cheap ESP8266/ESP32 nodes allowing for cost effective synchronized effects across your entire house!

Demos

Visit and join our Discord where community members show off their projects. Check out the #projects or #show-and-tell channels.

📑 Quick start guide and documentation📖

Head over to releases to get the latest releases for Windows and Mac. For linux, use pip.

Bleeding edge (Experimental)

If you want the absolute bleeding edge and are not afraid of using the terminal, take a look at the detailed installation instructions here: Installation documentation.

Documentation

Documentation for the latest release can be found here: Stable documentation

Documentation built against this repository can be found here: Latest documentation

😍 Show me how to make one!

The below image describes a basic setup - LedFx running on PC, communicating with a WLED Device controlling an LED strip.

Component	Example
Computer running LedFx	Windows 10, LedFx.exe
Networked device controlling LED Strip	ESP8266 NODEMCU v3 running WLED
Addressable LED strip	DC5V WS2812B 5 meters 60LED/m IP67
Power supply for LED Strip and ESP	5V 10 amps LED Power Supply
Something to connect the wires together!	Soldering iron/solder

Build your networked LED Strip.
- For most, this is the difficult step. Don't worry! There's guides here and online, and plenty of people able to help on WLED and LedFx Discord.
- Follow the WLED guide to connect the LED strip and ESP together.
- Flash WLED to the ESP device.
- Ensure all WLED devices are powered on, and connected to your Wi-Fi.
- Test you can access the WLED web interface from your PC. If so, then you're good to go!
Install LedFx.
- For PC and Mac, see our releases, or see the installation documentation for more information.
- For linux, you can use pip to install ledfx - however you may need to install some dependencies first. See the installation documentation for more information.
Direct computer audio output to LedFx.
- By default on Windows LedFx will attempt to listen to your system audio.
- More information for Linux and macOS users here.
- Play some music in the background.
Start LedFx.
- Your WLED devices should appear in LedFx, automagically configured and ready to go! 🎆🔥
- If not, on the bottom click Home, -> Scan for WLED devices button, or click on the big plus sign and Add Device to add them manually.
- If they're still not showing up, make sure they're powered on and properly connected to your WiFi.
Start using effects!
- Click on the device, select an effect eg scroll under Classic
- Your lights should now be reacting realtime to your music! Enjoy the show 🌈

🧑‍💻 Join the LedFx Community

Join the Discord server to discuss everything about LedFx!

To join, click on the Discord button below:

Contributing

Pull requests are welcome. Once tested, contact LedFx developer community on Discord to discuss the next step. We expect and require all contributors to read, understand and follow our code of conduct.

Credits: Contributors-&-About

License

GPL-3

FAQs

What is LedFx?

A network based light effect controller. Visit Snyk Advisor to see a full health score report for LedFx, including popularity, security, maintenance & community analysis.

Is LedFx popular?

The python package LedFx receives a total of 1,531 weekly downloads. As such, LedFx popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is LedFx well maintained?

We found that LedFx demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is LedFx safe to use?

The python package LedFx was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 09:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

LedFx

A network based light effect controller For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Non-Permissive License

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Not sure how to use LedFx?

Welcome to LedFx ✨ Making music come alive!

What is LedFx?

Demos

📑 Quick start guide and documentation📖

😍 Show me how to make one!

🧑‍💻 Join the LedFx Community

Contributing

License

FAQs

What is LedFx?

Is LedFx popular?

Is LedFx well maintained?

Is LedFx safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Not sure how to use LedFx?

Welcome to LedFx ✨ Making music come alive!

What is LedFx?

Demos

📑 Quick start guide and documentation📖

😍 Show me how to make one!

🧑‍💻 Join the LedFx Community

Contributing

License

FAQs

What is LedFx?

Is LedFx popular?

Is LedFx well maintained?

Is LedFx safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues