driver_apa102c.c

Go to the documentation of this file.

 
#include "driver_apa102c.h"

#define CHIP_NAME                 "Shiji Lighting APA102C"        
#define MANUFACTURER_NAME         "Shiji Lighting"                
#define SUPPLY_VOLTAGE_MIN        5.0f                            
#define SUPPLY_VOLTAGE_MAX        5.5f                            
#define MAX_CURRENT               200.0f                          
#define TEMPERATURE_MIN           -40.0f                          
#define TEMPERATURE_MAX           70.0f                           
#define DRIVER_VERSION            1000                            

uint8_t apa102c_init(apa102c_handle_t *handle)
{
    if (handle == NULL)                                                  /* check handle */
    {
        return 2;                                                        /* return error */
    }
    if (handle->debug_print == NULL)                                     /* check debug_print */
    {
        return 3;                                                        /* return error */
    }
    if (handle->spi_init == NULL)                                        /* check spi_init */
    {
        handle->debug_print("apa102c: spi_init is null.\n");             /* spi_init is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->spi_deinit == NULL)                                      /* check spi_deinit */
    {
        handle->debug_print("apa102c: spi_deinit is null.\n");           /* spi_deinit is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->spi_write_cmd == NULL)                                   /* check spi_write_cmd */
    {
        handle->debug_print("apa102c: spi_write_cmd is null.\n");        /* spi_write_cmd is null */
       
        return 3;                                                        /* return error */
    }
    if (handle->delay_ms == NULL)                                        /* check delay_ms */
    {
        handle->debug_print("apa102c: delay_ms is null.\n");             /* delay_ms is null */
       
        return 3;                                                        /* return error */
    }
    
    if (handle->spi_init() != 0)                                         /* spi init */
    {
        handle->debug_print("apa102c: spi init failed.\n");              /* spi init failed */
       
        return 1;                                                        /* return error */
    }
    handle->inited = 1;                                                  /* flag finish initialization */
    
    return 0;                                                            /* success return 0 */
}

uint8_t apa102c_write(apa102c_handle_t *handle, uint32_t *color, uint32_t len, uint8_t *temp, uint32_t temp_len)
{
    uint32_t i;
    uint16_t byte_size;
    
    if (handle == NULL)                                                     /* check handle */
    {
        return 2;                                                           /* return error */
    }
    if (handle->inited != 1)                                                /* check handle initialization */
    {
        return 3;                                                           /* return error */
    }
    if (color == NULL)                                                      /* check color */
    {
        handle->debug_print("apa102c: color is null.\n");                   /* color is null */
       
        return 4;                                                           /* return error */
    }
    if (temp == NULL)                                                       /* check temp */
    {
        handle->debug_print("apa102c: temp is null.\n");                    /* temp is null */
       
        return 5;                                                           /* return error */
    }
    
    byte_size = len * 4 + 8;                                                /* get byte size */
    if (byte_size > temp_len)                                               /* check byte size */
    {
        handle->debug_print("apa102c: temp buffer is too small.\n");        /* temp buffer is too small */
       
        return 6;                                                           /* return error */
    }
    temp[0] = 0x00;                                                         /* start frame */
    temp[1] = 0x00;                                                         /* start frame */
    temp[2] = 0x00;                                                         /* start frame */
    temp[3] = 0x00;                                                         /* start frame */
    for (i = 0; i < len; i++)                                               /* set the color frame */
    {
        temp[4 + i * 4 + 0] = (color[i] >> 24) & 0xFF;                      /* set brightness */
        temp[4 + i * 4 + 1] = (color[i] >> 16) & 0xFF;                      /* set blue */
        temp[4 + i * 4 + 2] = (color[i] >> 8) & 0xFF;                       /* set green */
        temp[4 + i * 4 + 3] = (color[i] >> 0) & 0xFF;                       /* set red */
    }
    temp[4 + len * 4 + 0] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 1] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 2] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 3] = 0xFF;                                           /* end frame */
    
    if (handle->spi_write_cmd(temp, (uint16_t)byte_size) != 0)              /* write command */
    {
        handle->debug_print("apa102c: write command failed.\n");            /* write command failed */
        
        return 1;                                                           /* return error */
    }
    
    return 0;                                                               /* success return 0 */
}

uint8_t apa102c_write_off(apa102c_handle_t *handle, uint32_t len, uint8_t *temp, uint32_t temp_len)
{
    uint32_t i;
    uint16_t byte_size;
    
    if (handle == NULL)                                                     /* check handle */
    {
        return 2;                                                           /* return error */
    }
    if (handle->inited != 1)                                                /* check handle initialization */
    {
        return 3;                                                           /* return error */
    }
    if (temp == NULL)                                                       /* check temp */
    {
        handle->debug_print("apa102c: temp is null.\n");                    /* temp is null */
       
        return 4;                                                           /* return error */
    }
    
    byte_size = len * 4 + 8;                                                /* get byte size */
    if (byte_size > temp_len)                                               /* check byte size */
    {
        handle->debug_print("apa102c: temp buffer is too small.\n");        /* temp buffer is too small */
       
        return 5;                                                           /* return error */
    }
    temp[0] = 0x00;                                                         /* start frame */
    temp[1] = 0x00;                                                         /* start frame */
    temp[2] = 0x00;                                                         /* start frame */
    temp[3] = 0x00;                                                         /* start frame */
    for (i = 0; i < len; i++)                                               /* set the color frame */
    {
        temp[4 + i * 4 + 0] = 0xE0;                                         /* set brightness */
        temp[4 + i * 4 + 1] = 0x00;                                         /* set blue */
        temp[4 + i * 4 + 2] = 0x00;                                         /* set green */
        temp[4 + i * 4 + 3] = 0x00;                                         /* set red */
    }
    temp[4 + len * 4 + 0] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 1] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 2] = 0xFF;                                           /* end frame */
    temp[4 + len * 4 + 3] = 0xFF;                                           /* end frame */
    
    if (handle->spi_write_cmd(temp, (uint16_t)byte_size) != 0)              /* write command */
    {
        handle->debug_print("apa102c: write command failed.\n");            /* write command failed */
        
        return 1;                                                           /* return error */
    }
    
    return 0;                                                               /* success return 0 */
}

uint8_t apa102c_deinit(apa102c_handle_t *handle)
{
    uint8_t res;
    
    if (handle == NULL)                                              /* check handle */
    {
        return 2;                                                    /* return error */
    }
    if (handle->inited != 1)                                         /* check handle initialization */
    {
        return 3;                                                    /* return error */
    }
    
    res = handle->spi_deinit();                                      /* spi deinit */
    if (res != 0)                                                    /* check error */
    {
        handle->debug_print("apa102c: spi deinit failed.\n");        /* spi deinit failed */
       
        return 1;                                                    /* return error */
    }
    handle->inited = 0;                                              /* flag closed */
    
    return 0;                                                        /* success return 0 */
}

uint8_t apa102c_set_reg(apa102c_handle_t *handle, uint8_t *buf, uint16_t len)
{
    if (handle == NULL)                            /* check handle */
    {
        return 2;                                  /* return error */
    }
    if (handle->inited != 1)                       /* check handle initialization */
    {
        return 3;                                  /* return error */
    }
    
    return handle->spi_write_cmd(buf, len);        /* write to reg */
}

uint8_t apa102c_info(apa102c_info_t *info)
{
    if (info == NULL)                                               /* check handle */
    {
        return 2;                                                   /* return error */
    }
    
    memset(info, 0, sizeof(apa102c_info_t));                        /* initialize apa102c info structure */
    strncpy(info->chip_name, CHIP_NAME, 32);                        /* copy chip name */
    strncpy(info->manufacturer_name, MANUFACTURER_NAME, 32);        /* copy manufacturer name */
    strncpy(info->interface, "SPI", 8);                             /* copy interface name */
    info->supply_voltage_min_v = SUPPLY_VOLTAGE_MIN;                /* set minimal supply voltage */
    info->supply_voltage_max_v = SUPPLY_VOLTAGE_MAX;                /* set maximum supply voltage */
    info->max_current_ma = MAX_CURRENT;                             /* set maximum current */
    info->temperature_max = TEMPERATURE_MAX;                        /* set minimal temperature */
    info->temperature_min = TEMPERATURE_MIN;                        /* set maximum temperature */
    info->driver_version = DRIVER_VERSION;                          /* set driver version */
    
    return 0;                                                       /* success return 0 */
}