ws281x.h

Go to the documentation of this file.

/*
 * Copyright 2019 Marian Buschsieweke
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include <stdint.h>
 
#include "color.h"
#include "periph/gpio.h"
#include "ws281x_backend.h"
#include "ws281x_constants.h"
#include "xtimer.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef WS281X_BYTES_PER_DEVICE
#  define WS281X_BYTES_PER_DEVICE       (3U)
#endif

#if WS281X_BYTES_PER_DEVICE == 4
typedef color_rgbw_t ws281x_pixel_t;
#else
typedef color_rgb_t ws281x_pixel_t;
#endif

typedef struct {
    uint8_t *buf;
    uint16_t numof;             
    gpio_t pin;                 
} ws281x_params_t;

typedef struct {
    ws281x_params_t params;   
} ws281x_t;
 
#if defined(WS281X_HAVE_INIT) || defined(DOXYGEN)
int ws281x_init(ws281x_t *dev, const ws281x_params_t *params);
#else
static inline int ws281x_init(ws281x_t *dev, const ws281x_params_t *params) {
    dev->params = *params;
    return 0;
}
#endif

void ws281x_write_buffer(ws281x_t *dev, const void *buf, size_t size);
 
#if defined(WS281X_HAVE_PREPARE_TRANSMISSION) || defined(DOXYGEN)
void ws281x_prepare_transmission(ws281x_t *dev);
#else
static inline void ws281x_prepare_transmission(ws281x_t *dev)
{
    (void)dev;
}
#endif
 
#if defined(WS281X_HAVE_END_TRANSMISSION) || defined(DOXYGEN)
void ws281x_end_transmission(ws281x_t *dev);
#else
static inline void ws281x_end_transmission(ws281x_t *dev)
{
    (void)dev;
    xtimer_usleep(WS281X_T_END_US);
}
#endif

void ws281x_set_buffer(void *dest, uint16_t index, ws281x_pixel_t color);

static inline void ws281x_set(ws281x_t *dev, uint16_t index, ws281x_pixel_t color)
{
    ws281x_set_buffer(dev->params.buf, index, color);
}

static inline void ws281x_write(ws281x_t *dev)
{
    ws281x_prepare_transmission(dev);
    ws281x_write_buffer(dev, dev->params.buf,
                        (size_t)dev->params.numof * WS281X_BYTES_PER_DEVICE);
    ws281x_end_transmission(dev);
}
 
#ifdef __cplusplus
}
#endif