dmx 2.0.0.0
Main Page

DMX click

‍DMX Click is a device used to establish communication between the MCU and equipment that uses the DMX512-A communication protocol.

click Product page


Click library

  • Author : MikroE Team
  • Date : Jun 2020.
  • Type : UART type

Software Support

We provide a library for the Dmx Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

‍This library contains API for Dmx Click driver.

Standard key functions :

  • dmx_cfg_setup Config Object Initialization function.
    void dmx_cfg_setup ( dmx_cfg_t *cfg );
    void dmx_cfg_setup(dmx_cfg_t *cfg)
    Config Object Initialization function.
    Click configuration structure definition.
    Definition dmx.h:160
  • dmx_init Initialization function.
    err_t dmx_init ( dmx_t *ctx, dmx_cfg_t *cfg );
    err_t dmx_init(dmx_t *ctx, dmx_cfg_t *cfg)
    Initialization function.
    Click ctx object definition.
    Definition dmx.h:139

Example key functions :

  • dmx_generic_write Generic write function.
    void dmx_generic_write ( dmx_t *ctx, uint8_t *data_buf, uint16_t len );
    void dmx_generic_write(dmx_t *ctx, uint8_t *data_buf, uint16_t len)
    Generic write function.
  • dmx_generic_read Generic read function.
    err_t dmx_generic_read ( dmx_t *ctx, uint8_t *data_buf, uint16_t max_len );
    err_t dmx_generic_read(dmx_t *ctx, uint8_t *data_buf, uint16_t max_len)
    Generic read function.
  • dmx_send_cmd Send command function.
    void dmx_send_cmd ( dmx_t* ctx, uint8_t *cmd );
    void dmx_send_cmd(dmx_t *ctx, uint8_t *cmd)
    Send command function.

Examples Description

‍This example demonstrates the use of the DMX click board by showcasing the control for a 6-channel DMX RGB LED reflector connected to it.

The demo application is composed of two sections :

Application Init

‍Initializes the driver and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
dmx_cfg_t cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
dmx_cfg_setup( &cfg );
DMX_MAP_MIKROBUS( cfg, MIKROBUS_1 );
dmx_init( &dmx, &cfg );
Delay_ms ( 100 );
Delay_ms ( 100 );
dmx_process( );
dmx_clear_app_buf( );
// Clear the internal buffers
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Set start address
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Set input data buffer length
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Set DMX frame length
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Set interrupt pulse duration
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Set a time delay between two frames
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
// Display configuration
dmx_rsp_check( DMX_RSP_OK );
dmx_log_app_buf( );
dmx_clear_app_buf( );
log_info( &logger, " Application Task " );
Delay_ms ( 500 );
}
#define DMX_RSP_OK
Definition dmx.h:88
#define DMX_CMD_SADR
Definition dmx.h:96
#define DMX_CMD_FLEN_MASTER
Definition dmx.h:100
#define DMX_CMD_PURGEBFR
Definition dmx.h:103
#define DMX_CMD_FTMR
Definition dmx.h:99
#define DMX_CMD_DISPLCFG
Definition dmx.h:106
#define DMX_CMD_BLEN
Definition dmx.h:97
#define DMX_CMD_ITMR
Definition dmx.h:98
#define DMX_MASTER
Definition dmx.h:114
#define DMX_CONFIG_MODE
Definition dmx.h:115
#define DMX_RUN_MODE
Definition dmx.h:116
#define DMX_MAP_MIKROBUS(cfg, mikrobus)
Definition dmx.h:66
void dmx_reset(dmx_t *ctx, uint8_t dev_mode)
Reset function.
void dmx_run(dmx_t *ctx, uint8_t run_mode)
Mode Setting function.
void dmx_set_auto_baud_rate(dmx_t *ctx, uint8_t state)
Auto Baud Rate Setting function.
void application_init(void)
Definition main.c:75

Application Task

‍Performs the LEDs dimming control on a 6-channel DMX RGB LED reflector.

void application_task ( void )
{
uint8_t dmx_6_ch_buf[ 6 ] = { 0 };
int16_t cnt = 0;
dmx_6_ch_buf[ 0 ] = 255; // Dimmer
dmx_6_ch_buf[ 1 ] = 0; // Red
dmx_6_ch_buf[ 2 ] = 0; // Green
dmx_6_ch_buf[ 3 ] = 0; // Blue
dmx_6_ch_buf[ 4 ] = 0; // Strobe
dmx_6_ch_buf[ 5 ] = 0; // Macro
log_printf( &logger, "\r\nDimming RED LEDs\r\n" );
for ( cnt = 0; cnt <= 255; cnt++ )
{
dmx_6_ch_buf[ 1 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
for ( cnt = 255; cnt >= 0; cnt-- )
{
dmx_6_ch_buf[ 1 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
log_printf( &logger, "Dimming GREEN LEDs\r\n" );
for ( cnt = 0; cnt <= 255; cnt++ )
{
dmx_6_ch_buf[ 2 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
for ( cnt = 255; cnt >= 0; cnt-- )
{
dmx_6_ch_buf[ 2 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
log_printf( &logger, "Dimming BLUE LEDs\r\n" );
for ( cnt = 0; cnt <= 255; cnt++ )
{
dmx_6_ch_buf[ 3 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
for ( cnt = 255; cnt >= 0; cnt-- )
{
dmx_6_ch_buf[ 3 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
dmx_6_ch_buf[ 1 ] = 255;
dmx_6_ch_buf[ 2 ] = 255;
dmx_6_ch_buf[ 3 ] = 255;
log_printf( &logger, "Dimming all LEDs\r\n" );
for ( cnt = 0; cnt <= 255; cnt++ )
{
dmx_6_ch_buf[ 0 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
for ( cnt = 255; cnt >= 0; cnt-- )
{
dmx_6_ch_buf[ 0 ] = cnt;
dmx_generic_write( &dmx, dmx_6_ch_buf, 6 );
Delay_ms ( 1 );
}
}
void application_task(void)
Definition main.c:150

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Dmx

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.