Cheatsheet

Installation

Before you can use Fledex, you need to install the library. Either as a dependency in your mix.exs file, or as part of your setup in your livebook by calling

Mix.install([
  {:fledex, "~>0.6"}
])

Example

use Fledex

Description

By use-ing the library, it is possible to use the structures specified below. It is safe to use this even in a functional context, i.e. it does not need to be part of a module.

In addition, the following modules will be imported:

• Crontab.CronExpression: used to define job intervals
• Fledex.Leds: used to define LEDs
• Fledex.Color.Names: used to specify colors
• Fledex.Utils.PubSub: used to publish events/data towards animations

In addition a Fledex.Animation.Manager will be started in the background (if there is none running) which will manage all animations.

Example

led_strip :name, Kino do
  animation :seconds do
    %{seconds: seconds} -> leds(60) |> light(:red, offset: seconds)
    _ -> leds()
  end
  static :indicators do
    leds(5) |> light(:white) |> repeat(12)
    end
  end
  job :clock, ~e[* * * * * * *]e do
    date_time = DateTime.utc_now()
    broadcast_trigger(%{seconds: date_time.seconds})
  end
end

Parameters

The led_strip takes the following parameters:

The do ... end block

The following structures inside the do ... end block are allowed:

See below for more details about them

Example

animation name, options do
  leds(10)
end

Parameters

The animation takes the following paramerters

The do ... end block

The structure inside the do ... end block can be any Elixir code, but it needs to return (at least) an Fledex.Leds structure (see below).

Caution: This function gets executed quite frequently and you need to ensure to keep it lightweight.

The code block is actually a function and it is possible to pattern match on a parameter (which is a map) and to extract information from the paramerter:

animation :name do
  %{trigger_name: value} -> leds(value)
  _ -> leds()
end

Note: it's important to notice that the map might not contain the information you expect especially during initialization phase. Make sure you have a "catch all" clause.

Example

static name, options do
  leds(10) |> light(:red)
end

Parameters

The static structure takes the following parameters:

The do ... end block

The structure inside the do ... end block can be any Elixir code, but it needs to return (at least) an Leds structure (see below).

Contrary to the animation the static structure only get called once and does not get called repeatedly.

Example

effect Fledex.Effect.Rotation, trigger_name: :john do
  animation :seconds do:
    ...
  end
  animation :minutes do:
    ...
  end
end

As can be seen in the example, the effect encapsulates one (or more) animations that it will impact.

Parameters

The do ... end block

The do ... end block can contain, similar to the led_strip any of the fledex macros, but it only has a real effect on animations. Effects can even be nested, i.e. to have a Dimming around a Rotation effect which contains an animation.

Example

job :name, ~e[* * * * * * *]e do
  date_time = DateTime.utc_now()
  broadcast_trigger(%{seconds: date_time.seconds})
end

Parameters

The job takes a couple of parameters:

Options

The following options are recognized:

The do ... end block

The do ... end block can consist of any valid Elixir code. The code will be called without any arguments. Usually you want to use at the end a broadcast_trigger/1 call to publish data towards the animations that react to data and change their look.

Example

  component(:thermo, Thermometer,
    range: -20..40,
    trigger: :temperature,
    negative: :blue,
    null: :may_green,
    positive: :red,
    marker: :davy_s_grey
  )

Parameters

The component takes the following parameters:

Example

leds(3)
  |> light(:red)
  |> light(:green)
  |> light(:blue)
  |> repeat(5)

Creation

Lights

Other Functions

The above functions would be enough, but some special functions make life easier:

Examples

Usage

There are several ways on how a color can be applied to an Fledex.Leds struct:

Atom

leds(1) |> light(:red)

Function

leds(1) |> red()