Fledex.Supervisor.LedStripSupervisor (fledex v0.6.0)
View SourceThis is the supervisor for an led strip and all it's workers, like animations
(start_animation/3) and coordinators (start_coordinator/3).
Summary
Functions
Returns a specification to start this module under a supervisor.
This starts a new animation attached to the specified led strip.
This starts a new coordinator. Which can receive events and react to those by impacting the running annimations.
Start a new supervisor for an led strip.
Stop the supervisor (and all it's children)
Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
@spec start_animation(atom(), atom(), Fledex.Animation.Animator.config_t()) :: GenServer.on_start()
This starts a new animation attached to the specified led strip.
It should be noted that it's expected that the led_strip supervisor is already up and running
@spec start_coordinator(atom(), atom(), Fledex.Animation.Coordinator.config_t()) :: GenServer.on_start()
This starts a new coordinator. Which can receive events and react to those by impacting the running annimations.
@spec start_link(atom(), Fledex.LedStrip.drivers_config_t(), keyword()) :: Supervisor.on_start()
Start a new supervisor for an led strip.
@spec stop(atom()) :: :ok
Stop the supervisor (and all it's children)
@spec supervisor_name(atom()) :: GenServer.name()
@spec workers_name(atom()) :: GenServer.name()