-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
split the animation interface out from the BaseAnimation
Renamed the BaseAnimation to simply Base Renamed the LedAnimationManager to simply Manager Renamed the LedAnimator to simply Animator Added module documentation to the LedANimationManager
- Loading branch information
Showing
23 changed files
with
367 additions
and
275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| defmodule Fledex.Animation.Base do | ||
|
|
||
| alias Fledex.Animation.Interface | ||
| alias Fledex.Leds | ||
|
|
||
| defmacro __using__(opts) do | ||
| quote location: :keep, bind_quoted: [opts: opts] do | ||
| use GenServer, opts | ||
| @behaviour Fledex.Animation.Interface | ||
|
|
||
| alias Fledex.Animation.Base | ||
| alias Fledex.Animation.Interface | ||
|
|
||
| # client side | ||
| @doc false | ||
| @spec start_link(config :: config_t, strip_name::atom, animation_name::atom) :: GenServer.on_start() | ||
| def start_link(config, strip_name, animation_name) do | ||
| {:ok, _pid} = GenServer.start_link(__MODULE__, {config, strip_name, animation_name}, | ||
| name: Interface.build_animator_name(strip_name, animation_name)) | ||
| end | ||
|
|
||
| @doc false | ||
| @spec config(atom, atom, config_t) :: :ok | ||
| def config(strip_name, animation_name, config) do | ||
| GenServer.cast(Interface.build_animator_name(strip_name, animation_name), {:config, config}) | ||
| end | ||
|
|
||
| @doc false | ||
| @spec get_info(strip_name :: atom, animation_name :: atom) :: {:ok, any} | ||
| def get_info(strip_name, animation_name) do | ||
| GenServer.call(Interface.build_animator_name(strip_name, animation_name), :info) | ||
| end | ||
|
|
||
| @doc false | ||
| @spec shutdown(atom, atom) :: :ok | ||
| def shutdown(strip_name, animation_name) do | ||
| GenServer.stop(Interface.build_animator_name(strip_name, animation_name), :normal) | ||
| end | ||
|
|
||
| defoverridable start_link: 3, config: 3, get_info: 2, shutdown: 2 | ||
|
|
||
| # server side | ||
| @impl GenServer | ||
| @spec handle_call(:info, {pid, any}, state_t) :: {:reply, {:ok, map}, state_t} | ||
| def handle_call(:info, _from, state) do | ||
| {:reply, {:ok, state}, state} | ||
| end | ||
|
|
||
| defoverridable handle_call: 3 | ||
| end | ||
| end | ||
|
|
||
| @doc false | ||
| @default_leds Leds.leds() | ||
| @spec default_def_func(map) :: Leds.t() | ||
| def default_def_func(_triggers) do | ||
| @default_leds | ||
| end | ||
|
|
||
| @doc false | ||
| @spec default_send_config_func(map) :: %{} | ||
| def default_send_config_func(_triggers) do | ||
| %{} | ||
| end | ||
| end |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| defmodule Fledex.Animation.Interface do | ||
| @moduledoc """ | ||
| The behaviour for animations. | ||
| This behaviour is the interface expected by the `Fledex.Animation.Manager` | ||
| and should be implemented as a GenServer. | ||
| If you implement an animation you will have to implement those functions | ||
| but you can use `Fledex.Animation.Base` to assist you. | ||
| """ | ||
|
|
||
| @doc """ | ||
| Create a new animation (with a given name and configuration) for the led strip | ||
| with the specified name. | ||
| """ | ||
| @callback start_link(config :: any, strip_name :: atom, animation_name :: atom) :: GenServer.on_start() | ||
| @doc """ | ||
| (Re-)Configure this animation. You will have to implement this function on server side. | ||
| This will look something like the following: | ||
| ```elixir | ||
| @spec handle_cast({:config, config_t}, state_t) :: {:noreply, state_t} | ||
| def handle_cast({:config, config}, state) do | ||
| # do something here | ||
| {:noreply, state} | ||
| end | ||
| ``` | ||
| """ | ||
| @callback config(strip_name :: atom, animation_name :: atom, config :: map) :: :ok | ||
| @doc """ | ||
| Retrieve infromation about this animation. This is mainly useful when running some | ||
| tests. By default this function will return the animation state. This is one of the | ||
| few functions that does not need to be implemented | ||
| """ | ||
| @callback get_info(strip_name :: atom, animation_name :: atom) :: any | ||
| @doc """ | ||
| When the animation is no long required, this function should be called. This will | ||
| call (by default) GenServer.stop. The animation can implement the `terminate/2` | ||
| function if necessary. | ||
| """ | ||
| @callback shutdown(strip_name :: atom, animation_name :: atom) :: :ok | ||
|
|
||
| @doc """ | ||
| This utility function will create an atomic name for the combination of strip name and | ||
| animation name. This is used to name the animator. It is important that we do | ||
| have a naming convention, because we would otherwise have a hard time to shutdown | ||
| animators that have been removed. We do not keep a reference, but only a config | ||
| Therefore the animator needs to adhere to this naming convention to properly be shut down. | ||
| It is the responsibility of the Animator to set the servername correctly. The | ||
| `Fledex.Animation.Base` is doing this by default. | ||
| """ | ||
| @spec build_animator_name(atom, atom) :: atom | ||
| def build_animator_name(strip_name, animation_name) | ||
| when is_atom(strip_name) and is_atom(animation_name) do | ||
| String.to_atom("#{strip_name}_#{animation_name}") | ||
| end | ||
| end |
Oops, something went wrong.