DMX512 Engine

Collaboration diagram for DMX512 Engine:

Modules
	Chaser Pool
	Definitions
	Fixture Pool
	Scene Pool

Data Structures
struct	DMX512_engine_s
	Defines a DMX512 engine instance. More...

Macros
#define	DMX512_ENGINE_CONFIG_HEADER_SIZE   0x03U
	size of a QLSF header More...
#define	DMX512_ENGINE_CONFIG_PATCH_DATA_SIZE   0x03U
#define	DMX512_ENGINE_CONFIG_SCENE_HEADER_SIZE   0x02U
#define	DMX512_ENGINE_CONFIG_FIXTURE_PRESET_HEADER_SIZE   0x02U
#define	DMX512_ENGINE_CONFIG_CHASER_HEADER_SIZE   0x04U
#define	DMX512_ENGINE_CONFIG_FILE_EXT   ".qlsf"
#define	DMX512_ENGINE_CONFIG_TEMP_FILE_EXT   ".tmp"
#define	DMX512_ENGINE_THREAD_DELAY   30

Enumerations
enum	DMX512_engine_config_header_byte_indexes_e {   DMX512_ENGINE_CONFIG_HEADER_PATCH_CNT_INDEX ,   DMX512_ENGINE_CONFIG_HEADER_SCENE_CNT_INDEX ,   DMX512_ENGINE_CONFIG_HEADER_CHASE_CNT_INDEX ,   DMX512_ENGINE_CONFIG_HEADER_EFFEX_CNT_INDEX }
	QLSF header byte indexes. More...
enum	DMX512_engine_config_patch_chunk_byte_indexes_e {   DMX512_ENGINE_CONFIG_PATCH_CHUNK_ID_INDEX ,   DMX512_ENGINE_CONFIG_PATCH_CHUNK_ADDR_INDEX ,   DMX512_ENGINE_CONFIG_PATCH_CHUNK_CHN_INDEX }
	QLSF patch chunk byte indexes. More...
enum	DMX512_engine_config_scene_byte_indexes_e {   DMX512_ENGINE_CONFIG_SCENE_ID_INDEX ,   DMX512_ENGINE_CONFIG_SCENE_FIXTURE_PRESET_CNT_INDEX }
	QLSF scene chunk byte indexes. More...
enum	DMX512_engine_config_fixture_preset_byte_indexes_e {   DMX512_ENGINE_CONFIG_FIXTURE_PRESET_ID_INDEX ,   DMX512_ENGINE_CONFIG_FIXTURE_PRESET_CHANNEL_CNT_INDEX }
	QLSF fixture preset chunk byte indexes. More...
enum	DMX512_engine_config_chaser_byte_indexes_e {   DMX512_ENGINE_CONFIG_CHASER_ID_INDEX ,   DMX512_ENGINE_CONFIG_CHASER_DIR_MODE_INDEX ,   DMX512_ENGINE_CONFIG_CHASER_RUN_MODE_INDEX ,   DMX512_ENGINE_CONFIG_CHASER_STEP_COUNT_INDEX }
	QLSF chaser chunk byte indexes. More...
enum	DMX512_engine_config_chaser_step_byte_indexes_e {   DMX512_ENGINE_CONFIG_STEP_ID_INDEX ,   DMX512_ENGINE_CONFIG_STEP_FADEIN_INDEX ,   DMX512_ENGINE_CONFIG_STEP_FADEOUT_INDEX ,   DMX512_ENGINE_CONFIG_STEP_HOLD_INDEX }
	QLSF chaser step chunk byte indexes. More...

Functions
void	DMX512_engine_init (void)
	Initialises the DMX512 engine singleton. More...
void	DMX512_engine_start (void)
	Starts the DMX512 driver and launches the DMX512 engine management thread. More...
void	DMX512_engine_stop (void)
	Stops the DMX512 driver and terminates the DMX512 engine management thread. More...
void	DMX512_engine_reset (void)
DMX512_engine_err_e	DMX512_engine_patch_add (uint16_t fixture_id, uint16_t address, uint16_t ch_count)
	Wrapper for "DMX512_fixture_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_engine_err_e	DMX512_engine_patch_get (uint16_t fixture_id, DMX512_fixture_s **fixture)
	Wrapper for "DMX512_fixture_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_fixture_pool_s *	DMX512_engine_patch_get_all (void)
	Returns the current engine fixture patch. More...
DMX512_engine_err_e	DMX512_engine_patch_delete (uint16_t fixture_id)
	Wrapper for "DMX512_fixture_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_engine_err_e	DMX512_engine_scene_add (uint16_t scene_id, uint16_t fadein_time, uint16_t fadeout_time)
	Wrapper for "DMX512_scene_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_engine_err_e	DMX512_engine_scene_add_preset (uint16_t scene_id, uint16_t fixture_id, uint16_t channel_count, uint16_t *channels, uint8_t *values)
	Wrapper for "DMX512_scene_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_engine_err_e	DMX512_engine_scene_get (uint16_t scene_id, DMX512_scene_s **scene)
	Wrapper for "DMX512_scene_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "scene" as argument. More...
DMX512_scene_pool_s *	DMX512_engine_scene_get_all (void)
	Returns the current engine scenes. More...
DMX512_engine_err_e	DMX512_engine_scene_delete (uint16_t scene_id)
	Wrapper for "DMX512_scene_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "scenes" as argument. More...
DMX512_engine_err_e	DMX512_engine_chaser_add (uint16_t chaser_id, DMX512_chaser_mode_e mode, DMX512_chaser_direction_e direction)
	Wrapper for "DMX512_chaser_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument. More...
DMX512_engine_err_e	DMX512_engine_chaser_get (uint16_t chaser_id, DMX512_chaser_s **chaser)
	Wrapper for "DMX512_chaser_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "chaser" as argument. More...
DMX512_chaser_pool_s *	DMX512_engine_chaser_get_all (void)
	Returns the current engine chasers. More...
DMX512_engine_err_e	DMX512_engine_chaser_delete (uint16_t chaser_id)
	Wrapper for "DMX512_chaser_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "chasers" as argument. More...

Detailed Description

The DMX512 engine is in charge of managing the whole DMX show creation and show playback process. To do so, it wraps the functionalities described throughout the apps' submodules into higher level functions and data structures to provide users with an easy and intuitive way to create and manage DMX512 show instances.

Macro Definition Documentation

DMX512_ENGINE_CONFIG_CHASER_HEADER_SIZE

#define DMX512_ENGINE_CONFIG_CHASER_HEADER_SIZE   0x04U

byte size of a QLSF chaser header

Definition at line 29 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_FILE_EXT

#define DMX512_ENGINE_CONFIG_FILE_EXT   ".qlsf"

QLSF file extension

Definition at line 30 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_FIXTURE_PRESET_HEADER_SIZE

#define DMX512_ENGINE_CONFIG_FIXTURE_PRESET_HEADER_SIZE   0x02U

byte size of a QLSF fixture preset headers

Definition at line 28 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_HEADER_SIZE

#define DMX512_ENGINE_CONFIG_HEADER_SIZE   0x03U

size of a QLSF header

Definition at line 25 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_PATCH_DATA_SIZE

#define DMX512_ENGINE_CONFIG_PATCH_DATA_SIZE   0x03U

DMX512 byte size of a QLSF patch header

Definition at line 26 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_SCENE_HEADER_SIZE

#define DMX512_ENGINE_CONFIG_SCENE_HEADER_SIZE   0x02U

byte size of a QLSF scene header

Definition at line 27 of file DMX512_engine.h.

DMX512_ENGINE_CONFIG_TEMP_FILE_EXT

#define DMX512_ENGINE_CONFIG_TEMP_FILE_EXT   ".tmp"

temporary file extension

Definition at line 31 of file DMX512_engine.h.

DMX512_ENGINE_THREAD_DELAY

#define DMX512_ENGINE_THREAD_DELAY   30

engine thread execution delay

Definition at line 32 of file DMX512_engine.h.

Enumeration Type Documentation

DMX512_engine_config_chaser_byte_indexes_e

enum DMX512_engine_config_chaser_byte_indexes_e

QLSF chaser chunk byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF chaser chunk.

Enumerator
DMX512_ENGINE_CONFIG_CHASER_ID_INDEX	Index of a chaser chunk "chaser id" byte
DMX512_ENGINE_CONFIG_CHASER_DIR_MODE_INDEX	Index of a chaser chunk "run direction" byte
DMX512_ENGINE_CONFIG_CHASER_RUN_MODE_INDEX	Index of a chaser chunk "run mode" byte
DMX512_ENGINE_CONFIG_CHASER_STEP_COUNT_INDEX	Index of a chaser chunk "step count" byte

Definition at line 89 of file DMX512_engine.h.

DMX512_engine_config_chaser_step_byte_indexes_e

enum DMX512_engine_config_chaser_step_byte_indexes_e

QLSF chaser step chunk byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF chaser step.

Enumerator
DMX512_ENGINE_CONFIG_STEP_ID_INDEX	Index of a chaser step chunk "chaser step id" byte
DMX512_ENGINE_CONFIG_STEP_FADEIN_INDEX	Index of a chaser step chunk "fade in time" byte
DMX512_ENGINE_CONFIG_STEP_FADEOUT_INDEX	Index of a chaser step chunk "fade out time" byte
DMX512_ENGINE_CONFIG_STEP_HOLD_INDEX	Index of a chaser step chunk "hold time" byte

Definition at line 102 of file DMX512_engine.h.

DMX512_engine_config_fixture_preset_byte_indexes_e

enum DMX512_engine_config_fixture_preset_byte_indexes_e

QLSF fixture preset chunk byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF fixture preset chunk.

Enumerator
DMX512_ENGINE_CONFIG_FIXTURE_PRESET_ID_INDEX	Index of a fixture preset chunk "fixture id" byte
DMX512_ENGINE_CONFIG_FIXTURE_PRESET_CHANNEL_CNT_INDEX	Index of a fixture preset chunk "channel count" byte

Definition at line 78 of file DMX512_engine.h.

DMX512_engine_config_header_byte_indexes_e

enum DMX512_engine_config_header_byte_indexes_e

QLSF header byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF file.

Enumerator
DMX512_ENGINE_CONFIG_HEADER_PATCH_CNT_INDEX	Index of the patch count byte contained in a QLSF header
DMX512_ENGINE_CONFIG_HEADER_SCENE_CNT_INDEX	Index of the scene count byte contained in a QLSF header
DMX512_ENGINE_CONFIG_HEADER_CHASE_CNT_INDEX	Index of the chaser count byte contained in a QLSF header
DMX512_ENGINE_CONFIG_HEADER_EFFEX_CNT_INDEX	Index of the effect count byte contained in a QLSF header

Definition at line 41 of file DMX512_engine.h.

DMX512_engine_config_patch_chunk_byte_indexes_e

enum DMX512_engine_config_patch_chunk_byte_indexes_e

QLSF patch chunk byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF patch chunk.

Enumerator
DMX512_ENGINE_CONFIG_PATCH_CHUNK_ID_INDEX	Index of a patch chunk "id" byte
DMX512_ENGINE_CONFIG_PATCH_CHUNK_ADDR_INDEX	Index of a patch chunk "address" byte
DMX512_ENGINE_CONFIG_PATCH_CHUNK_CHN_INDEX	Index of a patch chunk "channel count" byte

Definition at line 55 of file DMX512_engine.h.

DMX512_engine_config_scene_byte_indexes_e

enum DMX512_engine_config_scene_byte_indexes_e

QLSF scene chunk byte indexes.

Series of pre-defined constant byte index values to be used during parsing of a QLSF scene chunk.

Enumerator
DMX512_ENGINE_CONFIG_SCENE_ID_INDEX	Index of a scene chunk "id" byte
DMX512_ENGINE_CONFIG_SCENE_FIXTURE_PRESET_CNT_INDEX	Index of a scene chunk "fixture preset count" byte

Definition at line 67 of file DMX512_engine.h.

Function Documentation

DMX512_engine_chaser_add()

DMX512_engine_err_e DMX512_engine_chaser_add	(	uint16_t	chaser_id,
		DMX512_chaser_mode_e	mode,
		DMX512_chaser_direction_e	direction
	)

Wrapper for "DMX512_chaser_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

chaser_id

the chaser identifier (

See also

DMX512_chaser_pool.h)

Parameters

mode	the chaser trigger mode
direction	the chaser step play direction

Returns

DMX512_engine_err_e error code following the function call

See also

DMX512_defs.h for further information regarding DMX512 engin error codes

Definition at line 229 of file DMX512_engine.c.

DMX512_engine_chaser_delete()

DMX512_engine_err_e DMX512_engine_chaser_delete

(

uint16_t

chaser_id

)

Wrapper for "DMX512_chaser_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "chasers" as argument.

Parameters

chaser_id

the chaser's idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 262 of file DMX512_engine.c.

DMX512_engine_chaser_get()

DMX512_engine_err_e DMX512_engine_chaser_get	(	uint16_t	chaser_id,
		DMX512_chaser_s **	chaser
	)

Wrapper for "DMX512_chaser_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "chaser" as argument.

Parameters

chaser_id	the chaser identifier
**chaser	pointer to the chaser

Returns

DMX512_engine_err_e ERR_OK if fixture was found, DMX512_ENGINE_INSTANCE_UNDEFINED otherwise

Definition at line 242 of file DMX512_engine.c.

DMX512_engine_chaser_get_all()

DMX512_chaser_pool_s * DMX512_engine_chaser_get_all

(

void

)

Returns the current engine chasers.

Returns

DMX512_chaser_pool_s* pointer to the engine's chaser pool

Definition at line 251 of file DMX512_engine.c.

DMX512_engine_init()

void DMX512_engine_init

(

void

)

Initialises the DMX512 engine singleton.

Definition at line 61 of file DMX512_engine.c.

DMX512_engine_patch_add()

DMX512_engine_err_e DMX512_engine_patch_add	(	uint16_t	fixture_id,
		uint16_t	address,
		uint16_t	ch_count
	)

Wrapper for "DMX512_fixture_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

fixture_id	the fixture's identifier
address	fixture's first channel address
ch_count	fixture's channel count

Returns

DMX512_engine_err_e error code following the function call

See also

DMX512_defs.h for further information regarding DMX512 engin error codes

Definition at line 111 of file DMX512_engine.c.

DMX512_engine_patch_delete()

DMX512_engine_err_e DMX512_engine_patch_delete

(

uint16_t

fixture_id

)

Wrapper for "DMX512_fixture_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

fixture_id

the fixture's idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 144 of file DMX512_engine.c.

DMX512_engine_patch_get()

DMX512_engine_err_e DMX512_engine_patch_get	(	uint16_t	fixture_id,
		DMX512_fixture_s **	fixture
	)

Wrapper for "DMX512_fixture_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

fixture_id	the fixture's identifier
**fixture	pointer to the fixture

Returns

DMX512_engine_err_e ERR_OK if fixture was found, DMX512_ENGINE_INSTANCE_UNDEFINED otherwise

Definition at line 124 of file DMX512_engine.c.

DMX512_engine_patch_get_all()

DMX512_fixture_pool_s * DMX512_engine_patch_get_all

(

void

)

Returns the current engine fixture patch.

Returns

DMX512_fixture_pool_s* pointer to the engine's fixture pool

Definition at line 133 of file DMX512_engine.c.

DMX512_engine_reset()

void DMX512_engine_reset

(

void

)

@briefs Frees dynamically allocated memory pools and re-initialises the engine

Definition at line 269 of file DMX512_engine.c.

DMX512_engine_scene_add()

DMX512_engine_err_e DMX512_engine_scene_add	(	uint16_t	scene_id,
		uint16_t	fadein_time,
		uint16_t	fadeout_time
	)

Wrapper for "DMX512_scene_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

scene_id	the scene identifier
fadein_time	the scene fade-in time in milliseconds
fadeout_time	the scene fade-out time in milliseconds

Returns

DMX512_engine_err_e error code following the function call

See also

DMX512_defs.h for further information regarding DMX512 engin error codes

Definition at line 158 of file DMX512_engine.c.

DMX512_engine_scene_add_preset()

DMX512_engine_err_e DMX512_engine_scene_add_preset	(	uint16_t	scene_id,
		uint16_t	fixture_id,
		uint16_t	channel_count,
		uint16_t *	channels,
		uint8_t *	values
	)

Wrapper for "DMX512_scene_pool_add" function. Provides context to the specified function using DMX512 engine's singleton parameter "fixtures" as argument.

Parameters

scene_id	the scene identifier
fadein_time	the scene fade-in time in milliseconds
fadeout_time	the scene fade-out time in milliseconds

Returns

DMX512_engine_err_e error code following the function call

See also

DMX512_defs.h for further information regarding DMX512 engin error codes

Definition at line 173 of file DMX512_engine.c.

DMX512_engine_scene_delete()

DMX512_engine_err_e DMX512_engine_scene_delete

(

uint16_t

scene_id

)

Wrapper for "DMX512_scene_pool_del" function. Provides context to the specified function using DMX512 engine's singleton parameter "scenes" as argument.

Parameters

scene_id

the scene's idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 215 of file DMX512_engine.c.

DMX512_engine_scene_get()

DMX512_engine_err_e DMX512_engine_scene_get	(	uint16_t	scene_id,
		DMX512_scene_s **	scene
	)

Wrapper for "DMX512_scene_pool_get" function. Provides context to the specified function using DMX512 engine's singleton parameter "scene" as argument.

Parameters

scene_id	the scene identifier
**scene	pointer to the scene

Returns

DMX512_engine_err_e ERR_OK if fixture was found, DMX512_ENGINE_INSTANCE_UNDEFINED otherwise

Definition at line 195 of file DMX512_engine.c.

DMX512_engine_scene_get_all()

DMX512_scene_pool_s * DMX512_engine_scene_get_all

(

void

)

Returns the current engine scenes.

Returns

DMX512_scene_pool_s* pointer to the engine's scene pool

Definition at line 204 of file DMX512_engine.c.

DMX512_engine_start()

void DMX512_engine_start

(

void

)

Starts the DMX512 driver and launches the DMX512 engine management thread.

Warning

FATTFS TODO: decrease memory usage by modifying configuration file

Definition at line 87 of file DMX512_engine.c.

DMX512_engine_stop()

void DMX512_engine_stop

(

void

)

Stops the DMX512 driver and terminates the DMX512 engine management thread.

Definition at line 96 of file DMX512_engine.c.