Chaser Step

Collaboration diagram for Chaser Step:

Data Structures
struct	DMX512_chaser_step_s
	DMX512 chaser step structure object. More...

Macros
#define	DMX512_CHASER_STEP_DEFAULT   {NULL, 0, 0, 0, {}, DMX512_CHASER_STEP_UNINITIALISED, DMX512_CHASER_STEP_IDLE}
	chaser step instance default values More...

Enumerations
enum	DMX512_fixture_chaser_step_status_e {   DMX512_CHASER_STEP_UNINITIALISED ,   DMX512_CHASER_STEP_INITIALISED }
	Status of a chaser step instance. More...
enum	DMX512_fixture_chaser_step_state_e {   DMX512_CHASER_STEP_FADE_IN ,   DMX512_CHASER_STEP_HOLD ,   DMX512_CHASER_STEP_FADE_OUT ,   DMX512_CHASER_STEP_IDLE }
	Current playing state of a chaser step. More...

Functions
DMX512_chaser_step_s	DMX512_chaser_step_init (DMX512_scene_s *scene, uint16_t fadein_time, uint16_t fadeout_time, uint16_t hold_time)
void	DMX512_chaser_step_manage (DMX512_chaser_step_s *this)
	Chaser step state machine. Manage a chaser step's state over time. More...
void	DMX512_chaser_step_start (DMX512_chaser_step_s *this)
	Starts a chaser step by assigning it to its fade_in state. More...
void	DMX512_chaser_step_stop (DMX512_chaser_step_s *this)
	Stops a chaser step by assigning it to its idle state. More...

Detailed Description

A chaser step represents a scene with additional information regarding its timing. Information such as fade in/out and hold time are used by a chaser to affect timings of scene's playing sequence.

Macro Definition Documentation

DMX512_CHASER_STEP_DEFAULT

#define DMX512_CHASER_STEP_DEFAULT   {NULL, 0, 0, 0, {}, DMX512_CHASER_STEP_UNINITIALISED, DMX512_CHASER_STEP_IDLE}

chaser step instance default values

Used during initialisation of a chaser step instance, it lowers the risk of conflicts by ensuring that every parameters which will be set are correctly initialised.

Definition at line 27 of file DMX512_chaser_step.h.

Enumeration Type Documentation

DMX512_fixture_chaser_step_state_e

enum DMX512_fixture_chaser_step_state_e

Current playing state of a chaser step.

Used by the chaser step state machine to determine the current operation to be done on the chaser step based on its current state value.

Enumerator
DMX512_CHASER_STEP_FADE_IN	The chaser step is fading in
DMX512_CHASER_STEP_HOLD	The chaser step is holding its values
DMX512_CHASER_STEP_FADE_OUT	The chaser step is fadeing out
DMX512_CHASER_STEP_IDLE	The chaser step finished playing

Definition at line 48 of file DMX512_chaser_step.h.

DMX512_fixture_chaser_step_status_e

enum DMX512_fixture_chaser_step_status_e

Status of a chaser step instance.

Defines whether or not a chaser step instance has been correctly initialised.

Enumerator
DMX512_CHASER_STEP_UNINITIALISED	The chaser step is initialised
DMX512_CHASER_STEP_INITIALISED	The chaser step is uninitialised

Definition at line 36 of file DMX512_chaser_step.h.

Function Documentation

DMX512_chaser_step_manage()

void DMX512_chaser_step_manage

(

DMX512_chaser_step_s *

chaser_step

)

Chaser step state machine. Manage a chaser step's state over time.

Parameters

*chaser_step

pointer to the chaser step instance to be managed

Definition at line 110 of file DMX512_chaser_step.c.

DMX512_chaser_step_start()

void DMX512_chaser_step_start

(

DMX512_chaser_step_s *

chaser_step

)

Starts a chaser step by assigning it to its fade_in state.

Parameters

*chaser_step

pointer to the chaser step instance to be started

Definition at line 124 of file DMX512_chaser_step.c.

DMX512_chaser_step_stop()

void DMX512_chaser_step_stop

(

DMX512_chaser_step_s *

chaser_step

)

Stops a chaser step by assigning it to its idle state.

Parameters

*chaser_step

pointer to the chaser step instance to be stopped

Definition at line 134 of file DMX512_chaser_step.c.