DMX512_Chaser

Collaboration diagram for DMX512_Chaser:

Modules
	Chaser Step

Data Structures
struct	DMX512_chaser_s
	DMX512 chaser structure object. More...

Macros
#define	DMX512_CHASER_DEFAULT   {0, NULL, DMX512_CHASER_MODE_LOOP, DMX512_CHASER_DIRECTION_FORWARD, 0, 0, DMX512_CHASER_IDLE, DMX512_CHASER_UNINITIALISED, DMX512_CHASER_PINGPONG_PING}
	chaser instance default values More...

Enumerations
enum	DMX512_chaser_status_e {   DMX512_CHASER_UNINITIALISED ,   DMX512_CHASER_INITIALISED }
	Status of a chaser instance. More...
enum	DMX512_chaser_mode_e {   DMX512_CHASER_MODE_LOOP ,   DMX512_CHASER_MODE_SINGLE_SHOT }
	Playing mode of a chsaer. More...
enum	DMX512_chaser_direction_e {   DMX512_CHASER_DIRECTION_FORWARD ,   DMX512_CHASER_DIRECTION_BACKWARD ,   DMX512_CHASER_DIRECTION_PINGPONG ,   DMX512_CHASER_DIRECTION_RANDOM }
	Playing direction of a chaser. More...
enum	DMX512_chaser_pingpong_state_e {   DMX512_CHASER_PINGPONG_PING ,   DMX512_CHASER_PINGPONG_PONG }
	Current pingpong state. More...
enum	DMX512_chaser_state_e {   DMX512_CHASER_PLAYING ,   DMX512_CHASER_IDLE }
	Current playing state of a chaser. More...

Functions
DMX512_chaser_s	DMX512_chaser_new (uint16_t id, DMX512_chaser_mode_e mode, DMX512_chaser_direction_e direction)
	Creates and initialises a new chaser instance. More...
DMX512_engine_err_e	DMX512_chaser_add_step (DMX512_chaser_s *chaser, DMX512_chaser_step_s step)
	Adds a scene preset instance into the chaser. More...
DMX512_engine_err_e	DMX512_chaser_del_step (DMX512_chaser_s *chaser, uint16_t id)
	Deletes a fixture preset instance from the chaser. More...
DMX512_chaser_step_s *	DMX512_chaser_get_step (DMX512_chaser_s *chaser, uint16_t id)
	Gets a fixture instance from the pool. More...
void	DMX512_chaser_manage (DMX512_chaser_s *chaser)
	Handles step selection and trigger over time. More...
void	DMX512_chaser_start (DMX512_chaser_s *chaser)
	Starts a scene fade-in process. More...

Detailed Description

In a DMX lightshow, scenes may be chained and played back in a sequence called chaser. Scenes contained within a chaser are called "steps" and each individual steps conveys specific information regarding play-timings of the associated scene.

See also

DMX512_chaser_step_s

Macro Definition Documentation

DMX512_CHASER_DEFAULT

#define DMX512_CHASER_DEFAULT   {0, NULL, DMX512_CHASER_MODE_LOOP, DMX512_CHASER_DIRECTION_FORWARD, 0, 0, DMX512_CHASER_IDLE, DMX512_CHASER_UNINITIALISED, DMX512_CHASER_PINGPONG_PING}

chaser instance default values

Used during initialisation of a chaser 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.h.

Enumeration Type Documentation

DMX512_chaser_direction_e

enum DMX512_chaser_direction_e

Playing direction of a chaser.

Defines direction of the playing sequence of a chaser.

Enumerator
DMX512_CHASER_DIRECTION_FORWARD	Play consecutive steps in ascending order
DMX512_CHASER_DIRECTION_BACKWARD	Play consecutive steps in descending order
DMX512_CHASER_DIRECTION_PINGPONG	Play consecutive steps back and forth
DMX512_CHASER_DIRECTION_RANDOM	Randomly pick steps to be played

Definition at line 55 of file DMX512_chaser.h.

DMX512_chaser_mode_e

enum DMX512_chaser_mode_e

Playing mode of a chsaer.

Defines whether or not a chaser should be played in a loop or not

Enumerator
DMX512_CHASER_MODE_LOOP	Chaser is played in a loop
DMX512_CHASER_MODE_SINGLE_SHOT	Chaser is only plaed once

Definition at line 45 of file DMX512_chaser.h.

DMX512_chaser_pingpong_state_e

enum DMX512_chaser_pingpong_state_e

Current pingpong state.

Provides information regarding the current pingpong state of a chaser when DMX512_CHASER_DIRECTION_PINGPONG is enables

Enumerator
DMX512_CHASER_PINGPONG_PING	chaser is playing steps in ascending order
DMX512_CHASER_PINGPONG_PONG	chaser is playing steps in descending order

Definition at line 68 of file DMX512_chaser.h.

DMX512_chaser_state_e

enum DMX512_chaser_state_e

Current playing state of a chaser.

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

Enumerator
DMX512_CHASER_PLAYING	The chaser is playing
DMX512_CHASER_IDLE	The chaser is idle

Definition at line 79 of file DMX512_chaser.h.

DMX512_chaser_status_e

enum DMX512_chaser_status_e

Status of a chaser instance.

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

Enumerator
DMX512_CHASER_UNINITIALISED	The chaser is initialised
DMX512_CHASER_INITIALISED	The chaser is uninitialised

Definition at line 35 of file DMX512_chaser.h.

Function Documentation

DMX512_chaser_add_step()

DMX512_engine_err_e DMX512_chaser_add_step	(	DMX512_chaser_s *	chaser,
		DMX512_chaser_step_s	step
	)

Adds a scene preset instance into the chaser.

Parameters

chaser	pointer to the chaser instance
step	step instance to be added into the chaser

See also

DMX512_step

Returns

DMX512_engine_err_e error code following the function call

Definition at line 112 of file DMX512_chaser.c.

DMX512_chaser_del_step()

DMX512_engine_err_e DMX512_chaser_del_step	(	DMX512_chaser_s *	chaser,
		uint16_t	id
	)

Deletes a fixture preset instance from the chaser.

Parameters

chaser	pointer to the chaser instance
id	the chaser step idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 137 of file DMX512_chaser.c.

DMX512_chaser_get_step()

DMX512_chaser_step_s * DMX512_chaser_get_step	(	DMX512_chaser_s *	chaser,
		uint16_t	id
	)

Gets a fixture instance from the pool.

Parameters

chaser	pointer to the chaser instance
id	the chaser step identifier

Returns

*DMX512_fixture_preset_s pointer to the fixture preset instance

Definition at line 162 of file DMX512_chaser.c.

DMX512_chaser_manage()

void DMX512_chaser_manage

(

DMX512_chaser_s *

chaser

)

Handles step selection and trigger over time.

Parameters

chaser

pointer to the chaser instance

Definition at line 176 of file DMX512_chaser.c.

DMX512_chaser_new()

DMX512_chaser_s DMX512_chaser_new	(	uint16_t	id,
		DMX512_chaser_mode_e	mode,
		DMX512_chaser_direction_e	direction
	)

Creates and initialises a new chaser instance.

Parameters

id	the chaser identifier (

See also

DMX512_chaser_pool.h)

Parameters

mode	the chaser trigger mode
direction	the chaser step play direction

Returns

DMX512_chaser_s the created chaser

Definition at line 92 of file DMX512_chaser.c.

DMX512_chaser_start()

void DMX512_chaser_start

(

DMX512_chaser_s *

chaser

)

Starts a scene fade-in process.

Parameters

chaser

pointer to the scene instance

Definition at line 195 of file DMX512_chaser.c.