DMX512

Collaboration diagram for DMX512:

Data Structures
struct	DMX512_driver_s
	Defines a DMX512 driver instance. More...

Macros
#define	DMX512_BREAKMAB_BAUDRATE   0x186A0U
#define	DMX512_FRAME_BAUDRATE   0x3D090U
#define	DMX512_BREAKMAB_BYTESIZE   0x00001U
#define	DMX512_FRAME_BYTESIZE   0x00200U
#define	DMX512_BREAKMAB_BYTEDATA   0x00000U
#define	DEFAULT_DMX512_DRIVER   {{}, {0}, DMX512_DRIVER_UNINITIALISED}
	DMX512 driver object default values. More...

Enumerations
enum	DMX512_driver_err_e {   DMX512_DRIVER_OK ,   DMX512_DRIVER_THREAD_ERR ,   DMX512_DRIVER_ADDRESS_OUT_OF_BOUNDS }
	QLSF DMX512 driver error constants. More...
enum	DMX512_driver_status_e {   DMX512_DRIVER_INITIALISED ,   DMX512_DRIVER_UNINITIALISED }
	Status of the DMX512 driver instance. More...

Functions
void	DMX512_driver_init (void)
	Initialises DMX512 driver periphals. More...
DMX512_driver_status_e	DMX512_driver_get_status (void)
	Returns the status of the DMX512 driver. More...
DMX512_driver_err_e	DMX512_driver_start (void)
	Starts the DMX512 driver thread. More...
DMX512_driver_err_e	DMX512_driver_stop (void)
	Terminates the DMX512 driver thread. More...
DMX512_driver_err_e	DMX512_driver_set_single (uint16_t address, uint8_t value)
	Sets a buffer's address to a given value. More...

Detailed Description

USART protocol Abstraction layer for sending DMX512 frames.

Macro Definition Documentation

DEFAULT_DMX512_DRIVER

#define DEFAULT_DMX512_DRIVER   {{}, {0}, DMX512_DRIVER_UNINITIALISED}

DMX512 driver object default values.

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

Definition at line 29 of file DMX512_driver.h.

DMX512_BREAKMAB_BAUDRATE

#define DMX512_BREAKMAB_BAUDRATE   0x186A0U

USART Baudrate for break-mab transmission

Definition at line 16 of file DMX512_driver.h.

DMX512_BREAKMAB_BYTEDATA

#define DMX512_BREAKMAB_BYTEDATA   0x00000U

BREAK-MAB sequence data

Definition at line 20 of file DMX512_driver.h.

DMX512_BREAKMAB_BYTESIZE

#define DMX512_BREAKMAB_BYTESIZE   0x00001U

Size of a break-mab sequence in bytes

Definition at line 18 of file DMX512_driver.h.

DMX512_FRAME_BAUDRATE

#define DMX512_FRAME_BAUDRATE   0x3D090U

USART Baudrate for DMX512 frame transmission

Definition at line 17 of file DMX512_driver.h.

DMX512_FRAME_BYTESIZE

#define DMX512_FRAME_BYTESIZE   0x00200U

Size of DMX512 fram in bytes

Definition at line 19 of file DMX512_driver.h.

Enumeration Type Documentation

DMX512_driver_err_e

enum DMX512_driver_err_e

QLSF DMX512 driver error constants.

Series of pre-defined constant error values to be used throughout the whole DMX512 driver life-cycle.

Definition at line 39 of file DMX512_driver.h.

DMX512_driver_status_e

enum DMX512_driver_status_e

Status of the DMX512 driver instance.

Defines whether or not a DMX512 driver instance has been correctly initialised.

Definition at line 52 of file DMX512_driver.h.

Function Documentation

DMX512_driver_get_status()

DMX512_driver_status_e DMX512_driver_get_status

(

void

)

Returns the status of the DMX512 driver.

Returns

DMX512_driver_status_e status of the driver

See also

DMX512_driver.h for further information regarding the driver's status enumeration

Definition at line 147 of file DMX512_driver.c.

DMX512_driver_init()

void DMX512_driver_init

(

void

)

Initialises DMX512 driver periphals.

Once initialised the driver may be controlled started or stopped using DMX512_driver_start and DMX512_driver_stop functions

Definition at line 133 of file DMX512_driver.c.

DMX512_driver_set_single()

DMX512_driver_err_e DMX512_driver_set_single	(	uint16_t	address,
		uint8_t	value
	)

Sets a buffer's address to a given value.

Parameters

address	the address concerned.
value	the value of the address to be set.

Returns

DMX512_driver_err_e returns DMX512_driver_OK if the value could be set.

See also

DMX512_defs.h for complementary informations regarding error codes

Definition at line 187 of file DMX512_driver.c.

DMX512_driver_start()

DMX512_driver_err_e DMX512_driver_start

(

void

)

Starts the DMX512 driver thread.

Returns

DMX512_driver_err_e returns DMX512_DRIVER_OK if the thread could be started.

See also

DMX512_driver.h for complementary informations regarding the driver's error codes

Definition at line 157 of file DMX512_driver.c.

DMX512_driver_stop()

DMX512_driver_err_e DMX512_driver_stop

(

void

)

Terminates the DMX512 driver thread.

Returns

DMX512_driver_err_e returns DMX512_DRIVER_OK if the thread could be terminated.

See also

DMX512_defs.h for complementary informations regarding error codes

Definition at line 175 of file DMX512_driver.c.