LsHardDevKit.h

Go to the documentation of this file.

#ifndef __LS_HARDDEVKIT_HEADER__
#define __LS_HARDDEVKIT_HEADER__

#include "DHDK_ErrorCode.h"

#if defined _WIN32 || defined __CYGWIN__

#include <windows.h>
#include <stdint.h>

#ifdef DHDK
//we are building in shared mode
#ifdef __GNUC__
#define DHDK_PUBLIC __attribute__ ((dllexport))
#else
#define DHDK_PUBLIC __declspec(dllexport) // Note: actually gcc seems to also supports this syntax.
#endif
#else
//we are loading the DLL
#ifdef __GNUC__
#define DHDK_PUBLIC __attribute__ ((dllimport))
#else
#define DHDK_PUBLIC __declspec(dllimport) // Note: actually gcc seems to also supports this syntax.
#endif
#endif

//#define DLL_PUBLIC
#define DLL_LOCAL
#else

#include <stdint.h>

#define WINAPI

#if __GNUC__ >= 4
#define DHDK_PUBLIC __attribute__ ((visibility ("default")))
#else
#define DHDK_PUBLIC
#endif

#endif

#define DHDK_API_VERSION 1


#ifdef __cplusplus
extern "C" {
#endif


typedef uintptr_t DHDK_UINT;//32 bits integer on 32 bits machine, 64bits integer on 64bits machine


#define DHDK_UINT_ERROR ((DHDK_UINT)((unsigned long)-1))
typedef DHDK_UINT DHDK_HANDLE;
#define DHDK_INVALID_HANDLE ((DHDK_HANDLE)((unsigned long)-1))
typedef DHDK_HANDLE DHDK_DEVICE_HANDLE;         
typedef DHDK_HANDLE DHDK_DMX_UNIVERSE_HANDLE;   
typedef DHDK_HANDLE DHDK_SHOW_HANDLE;           
typedef DHDK_HANDLE DHDK_SCENE_HANDLE;          
typedef DHDK_HANDLE DHDK_TIME_TRIGGER_HANDLE;   
typedef DHDK_HANDLE DHDK_STEP_HANDLE;           


#define DHDK_DASUSB ((DHDK_UINT)1)

#define DHDK_DASNET ((DHDK_UINT)2)

#define DHDK_ALL    ((DHDK_UINT)((unsigned long)-1))


DHDK_PUBLIC void WINAPI DHDK_init(DHDK_UINT protocol, const char *aSoftwareName);

DHDK_PUBLIC void WINAPI DHDK_deinit();

DHDK_PUBLIC bool WINAPI DHDK_enumerate();

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getDeviceCount();

DHDK_PUBLIC DHDK_DEVICE_HANDLE WINAPI DHDK_getDevice(DHDK_UINT iDevice);

DHDK_PUBLIC bool WINAPI DHDK_openDevice(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC void WINAPI DHDK_closeDevice(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getDeviceProtocol(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC bool WINAPI DHDK_getDeviceTypeName(DHDK_DEVICE_HANDLE fhDevice, char *buffer, DHDK_UINT size);

DHDK_PUBLIC bool WINAPI DHDK_getDeviceName(DHDK_DEVICE_HANDLE hDevice, char *buffer, DHDK_UINT size);

DHDK_PUBLIC bool WINAPI DHDK_getProductName(DHDK_DEVICE_HANDLE fhDevice, char *productName, DHDK_UINT size);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getDeviceSerial(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getPort(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getButtonCount(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getMaxPortTriggerCount(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getButtonState(DHDK_DEVICE_HANDLE hDevice, DHDK_UINT iButton);

DHDK_PUBLIC bool WINAPI DHDK_getButtonName(DHDK_DEVICE_HANDLE hDevice, DHDK_UINT iButton, char *buttonName, DHDK_UINT size);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getDmxUniverseCount(DHDK_DEVICE_HANDLE hDdevice);

DHDK_PUBLIC DHDK_DMX_UNIVERSE_HANDLE WINAPI DHDK_getDmxUniverse(DHDK_DEVICE_HANDLE hDevice, DHDK_UINT universeNumber);

#define DHDK_DMXOUT ((DHDK_UINT)1)

#define DHDK_DMXIN ((DHDK_UINT)2)

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getDmxUniverseFeatures(DHDK_DMX_UNIVERSE_HANDLE hDmxUniverse);

DHDK_PUBLIC bool WINAPI DHDK_configureDmxUniverse(DHDK_DMX_UNIVERSE_HANDLE hDmxUniverse, DHDK_UINT mode);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getLiveChannelsCount(DHDK_DMX_UNIVERSE_HANDLE hDmxUniverse);

DHDK_PUBLIC bool WINAPI DHDK_sendDmx(DHDK_DMX_UNIVERSE_HANDLE hDmxUniverse, const unsigned char *dmxBuffer, DHDK_UINT size = 512);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_receiveDmx(DHDK_DMX_UNIVERSE_HANDLE hDmxUniverse, unsigned char *dmxBuffer, DHDK_UINT size = 512);


// NEW FUNCTION

DHDK_PUBLIC bool WINAPI DHDK_isStandAloneSupported(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_SHOW_HANDLE WINAPI DHDK_createCsaShow(DHDK_UINT nbChannels, DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_SCENE_HANDLE WINAPI DHDK_createCsaScene(DHDK_SHOW_HANDLE hShow);

DHDK_PUBLIC DHDK_SCENE_HANDLE WINAPI DHDK_createCsaStep(DHDK_SHOW_HANDLE hShow, DHDK_SCENE_HANDLE scene);

DHDK_PUBLIC bool WINAPI DHDK_deleteCsaScene(DHDK_SHOW_HANDLE hShow, DHDK_UINT aIndex);

DHDK_PUBLIC bool WINAPI DHDK_deleteCsaStep(DHDK_UINT aIndex, DHDK_SCENE_HANDLE hScene);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getMaxChannels(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getMaxStandAloneChannels(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC bool WINAPI DHDK_writeDemoShow(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getCountStep(DHDK_SCENE_HANDLE hScene);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getSceneCount(DHDK_SHOW_HANDLE hShow);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getMaxSceneIndex(DHDK_SHOW_HANDLE hShow);

DHDK_PUBLIC DHDK_SCENE_HANDLE WINAPI DHDK_getScene(DHDK_SHOW_HANDLE hShow, DHDK_UINT index);

DHDK_PUBLIC bool WINAPI DHDK_getEnglishNameForSceneCounter(DHDK_SHOW_HANDLE hShow, DHDK_UINT aIndex, char *sceneName, DHDK_UINT size);

DHDK_PUBLIC DHDK_SCENE_HANDLE WINAPI DHDK_getSceneFromCounter(DHDK_SHOW_HANDLE hShow, DHDK_UINT counter);

DHDK_PUBLIC DHDK_STEP_HANDLE WINAPI DHDK_getStep(DHDK_UINT index, DHDK_SCENE_HANDLE hScene);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getMaxSceneCount(DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC bool WINAPI DHDK_setValueChannel(DHDK_UINT aIndex, uint8_t aValue, DHDK_STEP_HANDLE hStep);

DHDK_PUBLIC bool WINAPI DHDK_setFadeTransitionChannel(DHDK_SHOW_HANDLE hShow, DHDK_UINT aIndex, bool aFade);

DHDK_PUBLIC bool WINAPI DHDK_hasFadeTransitionChannel(DHDK_SHOW_HANDLE hShow, DHDK_UINT aIndex);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getValueChannel(DHDK_UINT aIndex, DHDK_STEP_HANDLE hStep);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_ChannelsCount(DHDK_STEP_HANDLE hStep);

DHDK_PUBLIC bool WINAPI DHDK_deleteShow(DHDK_SHOW_HANDLE hShow);

DHDK_PUBLIC bool WINAPI DHDK_setFadeTime(DHDK_STEP_HANDLE hStep, DHDK_UINT fadeTime);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getFadeTime(DHDK_STEP_HANDLE hStep);

DHDK_PUBLIC bool WINAPI DHDK_setHoldTime(DHDK_STEP_HANDLE hStep, DHDK_UINT holdTime);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getHoldTime(DHDK_STEP_HANDLE hStep);

DHDK_PUBLIC bool WINAPI DHDK_writeShow(DHDK_SHOW_HANDLE hShow, DHDK_DEVICE_HANDLE hDevice);

DHDK_PUBLIC bool WINAPI DHDK_addTriggerPortToScene(DHDK_SCENE_HANDLE hScene, DHDK_UINT port);

DHDK_PUBLIC bool WINAPI DHDK_setTriggerAddressToScene(DHDK_SCENE_HANDLE hScene, DHDK_UINT address);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getAddressTrigger(DHDK_SCENE_HANDLE hScene);


// ------- TIME TRIGGER MANAGEMENT  -----------

DHDK_PUBLIC bool WINAPI DHDK_addTimeTrigger(DHDK_SHOW_HANDLE hShow, DHDK_SCENE_HANDLE hScene, DHDK_TIME_TRIGGER_HANDLE hTimeTrigger);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerPeriodDayPeriodHour(DHDK_UINT fromMonth, DHDK_UINT fromDay, DHDK_UINT fromHour, DHDK_UINT fromMinute, DHDK_UINT toMonth, DHDK_UINT toDay, DHDK_UINT toHour, DHDK_UINT toMinute, DHDK_UINT repeatHour, DHDK_UINT repeatMinute);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerSpecificDayPeriodHour(DHDK_UINT month, DHDK_UINT day, DHDK_UINT fromHour, DHDK_UINT fromMinute, DHDK_UINT toHour, DHDK_UINT toMinute, DHDK_UINT eachHour, DHDK_UINT eachMinute);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerPeriodDaySpecificHour(DHDK_UINT fromMonth, DHDK_UINT fromDay, DHDK_UINT toMonth, DHDK_UINT toDay, DHDK_UINT hour, DHDK_UINT minute);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerSpecificDaySpecificHour(DHDK_UINT month, DHDK_UINT day, DHDK_UINT hour, DHDK_UINT minute);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerEveryDayPeriodHour(DHDK_UINT fromHour, DHDK_UINT fromMinute, DHDK_UINT toHour, DHDK_UINT toMinute, DHDK_UINT eachHour, DHDK_UINT eachMinute);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_createTimeTriggerEveryDayEveryHour(DHDK_UINT hour, DHDK_UINT minute);

DHDK_PUBLIC bool WINAPI DHDK_getTimeTriggerDescription(DHDK_TIME_TRIGGER_HANDLE hTimeTrigger, char *timeTriggerString, DHDK_UINT size);

DHDK_PUBLIC DHDK_TIME_TRIGGER_HANDLE WINAPI DHDK_getTimeTrigger(DHDK_UINT aIndex, DHDK_SCENE_HANDLE hScene);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getCountTimeTrigger(DHDK_SCENE_HANDLE hScene);

DHDK_PUBLIC DHDK_UINT WINAPI DHDK_getLastError();

#ifdef  __cplusplus
}
#endif

#endif // __LS_HARDDEVKIT_HEADER__