rgbledctrl.h

Go to the documentation of this file.

/*
 * Project: AVR USB RGB LED Controller
 * Author: Zak Kemble, contact@zakkemble.co.uk
 * Copyright: (C) 2013 by Zak Kemble
 * License: GNU GPL v3 (see License.txt)
 * Web: http://blog.zakkemble.co.uk/avr-usb-rgb-led-controller/
 */

#ifndef RGBLEDCTRL_H_
#define RGBLEDCTRL_H_

#ifdef _WIN32
#include <lusb0_usb.h>
#else
#include <usb.h>
#endif
#include <stdbool.h>
#include <stdint.h>

#define RGBLED_IDLETIME_DISABLE 0

typedef unsigned char byte; 
typedef unsigned int uint; 
typedef uint16_t eepAddr_t; 
typedef struct{
    byte red; 
    byte green; 
    byte blue; 
}s_rgbVal;

typedef struct{
    byte idleTime; 
}s_rgbled_deviceSettings;

typedef struct{
    usb_dev_handle* handle; 
    byte version[2]; 
    eepAddr_t eepromSize; 
    s_rgbVal rgb; 
    s_rgbled_deviceSettings settings; 
}s_rgbled_device;

#if defined(__cplusplus)
extern "C" {
#endif

void rgbledctrl_init(void);

uint rgbledctrl_find(void);

bool rgbledctrl_sameDevice(usb_dev_handle* handle1, usb_dev_handle* handle2);

s_rgbled_device* rgbledctrl_open(void);

s_rgbled_device* rgbledctrl_open_byIndex(uint idx);

s_rgbled_device* rgbledctrl_open_byEEPROM(byte value, eepAddr_t address);

void rgbledctrl_close(s_rgbled_device* device);

bool rgbledctrl_poke(s_rgbled_device* device);

bool rgbledctrl_reset(s_rgbled_device* device);

bool rgbledctrl_setIdleTime(s_rgbled_device* device, byte time);

bool rgbledctrl_setRGB(s_rgbled_device* device, s_rgbVal* colour);

bool rgbledctrl_setR(s_rgbled_device* device, byte value);

bool rgbledctrl_setG(s_rgbled_device* device, byte value);

bool rgbledctrl_setB(s_rgbled_device* device, byte value);

bool rgbledctrl_eeprom_write(s_rgbled_device* device, byte data, eepAddr_t address);

bool rgbledctrl_eeprom_read(s_rgbled_device* device, byte* data, eepAddr_t address);

#if defined(__cplusplus)
}
#endif

#if defined(__cplusplus) || defined(DOXYGEN)

class rgbledctrl
{
public:
    static void init();

    static uint find();

    static bool sameDevice(usb_dev_handle* handle1, usb_dev_handle* handle2);

    rgbledctrl();

    ~rgbledctrl();

    bool open();

    bool open(uint idx);

    bool open(byte value, eepAddr_t address);

    void close();

    bool poke();

    bool reset();

    bool setIdleTime(byte time);

    bool setRGB(s_rgbVal& colour);

    bool setR(byte value);

    bool setG(byte value);

    bool setB(byte value);

    bool eeprom_write(byte data, eepAddr_t address);

    bool eeprom_read(byte& data, eepAddr_t address);

    void getVersion(byte (&version)[2]);

    eepAddr_t getEepromSize();

    void getColour(s_rgbVal& colour);

    byte getIdleTime();

    usb_dev_handle* getHandle();

private:
    s_rgbled_device* device;
};
#endif

#endif /* RGBLEDCTRL_H_ */