API Reference fledex v0.5.0

View Source

Modules

This module should provide some simple macros that allow to define the led strip and to update it. The code you would write (in livebook) would look something like the following

The client often wants to run some animations. This can of course be done by repeatedly updating the Leds definitions and calling Leds.send() to send it to the driver. This often results in constructs like the following:application

The behaviour for an Animator.

Defines a quantum Scheduler.

The animation manager manages several animations (and potentially serveral led strips at the same time. Usually you don't start the service yoursel, but it gets automatically started when calling use Fledex and gets used by the Fledex macros. Thus, you rarely have to interact with it directly.

Most functions are reimplementations from FastLED. Here is a detailed explanation of those functions: https://github.com/FastLED/FastLED/wiki/High-performance-math

Fledex has an extensive set of predefined colors from

Do not use this module directly, but use Fledex.Color.Names instead

Do not use this module directly, but use Fledex.Color.Names instead

Do not use this module directly, but use Fledex.Color.Names instead

Do not use this module directly, but use Fledex.Color.Names instead

This interface needs to be implemente by a compoenent. It should be noted that a component is always an animation.

This is only an example component to demonstrate how a component could look like. The component is not properly tested no major effort will be spend on getting this to a better state.

This is a dummy implementation of the Driver that dumps the binaries to IO. This can be useful if you want to run some tests without real hardware. The real implementatin probably opens a channel (if not already open) to the bus (like SPI) sends the data to the bus.

This is a dummy implementation of the Driver that doesn't do anything (similar to a /dev/null device). This can be useful if you want to run some tests without getting any output or sending it to hardware.

A driver dispatches the "real" hardware. Differen types of drivers exist. Currently the following drivers exist

This module defines the interface for an LED effect. Effects can be used in Animations. Examples are

This module defines a GenServer that manages the LED strip (be it a real one with the Fledex.Driver.Impl.Spi or a virtual one with e.g. the Fledex.Driver.Impl.Kino).

This module allows to define a sequence of Leds. You first create the new sequence of leds by calling one of the leds functions.

This module collects all useful guards. If you want to use one of them you need to import this module.