bta.h

Go to the documentation of this file.

#ifndef BTA_H_INCLUDED
#define BTA_H_INCLUDED

#if (defined(WIN32) || defined(WIN64)) && !defined(PLAT_WINDOWS) && !defined(PLAT_LINUX)
#   define PLAT_WINDOWS
#endif
#if defined(linux) && !defined(PLAT_WINDOWS) && !defined(PLAT_LINUX)
#   define PLAT_LINUX
#endif


#ifdef PLAT_WINDOWS
#   define BTA_CALLCONV __stdcall
#ifdef COMPILING_DLL
#   define DLLEXPORT __declspec(dllexport)
#else
#   define DLLEXPORT __declspec(dllimport)
#endif
#elif defined PLAT_LINUX
    //must be empty
#   define DLLEXPORT
    //must be empty
#   define BTA_CALLCONV
#else
#   error "Please define PLAT_WINDOWS or PLAT_LINUX in your makefile/project"
#endif


typedef void* BTA_Handle;

#include <bta_status.h>
#include <bta_frame.h>
#include <bta_filters.h>
#include <bta_discovery.h>
#include <bta_flash_update.h>


typedef void (BTA_CALLCONV *FN_BTA_InfoEvent)(BTA_Status status, int8_t *msg);


typedef void (BTA_CALLCONV *FN_BTA_InfoEventEx)(BTA_Handle handle, BTA_Status status, int8_t *msg);


typedef void (BTA_CALLCONV *FN_BTA_FrameArrived)(BTA_Frame *frame);


typedef void (BTA_CALLCONV *FN_BTA_FrameArrivedEx)(BTA_Handle handle, BTA_Frame *frame);


typedef int (BTA_CALLCONV *FN_BTA_ProgressReport)(BTA_Status status, uint8_t percentage);





typedef enum BTA_QueueMode {
    BTA_QueueModeDoNotQueue = 0,                
    BTA_QueueModeDropOldest = 1,                
    BTA_QueueModeDropCurrent = 2,               
    BTA_QueueModeAvoidDrop = 3                  
} BTA_QueueMode;



typedef enum BTA_LibParam {
    BTA_LibParamKeepAliveMsgInterval,           
    BTA_LibParamCrcControlEnabled,              

    BTA_LibParamStreamTotalFrameCount,          
    BTA_LibParamStreamAutoPlaybackSpeed,        
    BTA_LibParamStreamPos,                      
    BTA_LibParamStreamPosIncrement,             

    BTA_LibParamEnableTestPattern,              

    BTA_LibParamPauseCaptureThread,             
} BTA_LibParam;



#define BTA_CONFIG_STRUCT_STRIDE 8
#ifdef PLAT_WINDOWS
#define BTA_PRAGMA_ALIGN __declspec(align(BTA_CONFIG_STRUCT_STRIDE))
#elif defined PLAT_LINUX
#define BTA_PRAGMA_ALIGN __attribute__((aligned(BTA_CONFIG_STRUCT_STRIDE)))
#endif
typedef struct BTA_Config {
    BTA_PRAGMA_ALIGN uint8_t *udpDataIpAddr;                
    BTA_PRAGMA_ALIGN uint8_t udpDataIpAddrLen;              
    BTA_PRAGMA_ALIGN uint16_t udpDataPort;                  
    BTA_PRAGMA_ALIGN uint8_t *udpControlOutIpAddr;          
    BTA_PRAGMA_ALIGN uint8_t udpControlOutIpAddrLen;        
    BTA_PRAGMA_ALIGN uint16_t udpControlPort;               
    BTA_PRAGMA_ALIGN uint8_t *udpControlInIpAddr;           
    BTA_PRAGMA_ALIGN uint8_t udpControlInIpAddrLen;         
    BTA_PRAGMA_ALIGN uint16_t udpControlCallbackPort;       
    BTA_PRAGMA_ALIGN uint8_t *tcpDeviceIpAddr;              
    BTA_PRAGMA_ALIGN uint8_t tcpDeviceIpAddrLen;            
    BTA_PRAGMA_ALIGN uint16_t tcpDataPort;                  
    BTA_PRAGMA_ALIGN uint16_t tcpControlPort;               

    BTA_PRAGMA_ALIGN uint8_t *uartPortName;                 
    BTA_PRAGMA_ALIGN uint32_t uartBaudRate;                 
    BTA_PRAGMA_ALIGN uint8_t uartDataBits;                  
    BTA_PRAGMA_ALIGN uint8_t uartStopBits;                  
    BTA_PRAGMA_ALIGN uint8_t uartParity;                    
    BTA_PRAGMA_ALIGN uint8_t uartTransmitterAddress;        
    BTA_PRAGMA_ALIGN uint8_t uartReceiverAddress;           

    BTA_PRAGMA_ALIGN BTA_DeviceType deviceType;             
    BTA_PRAGMA_ALIGN uint8_t *pon;                          
    BTA_PRAGMA_ALIGN uint32_t serialNumber;                 

    BTA_PRAGMA_ALIGN uint8_t *calibFileName;                
    BTA_PRAGMA_ALIGN uint8_t *zFactorsFileName;             
    BTA_PRAGMA_ALIGN uint8_t *wigglingFileName;             

    BTA_PRAGMA_ALIGN BTA_FrameMode frameMode;               

    BTA_PRAGMA_ALIGN FN_BTA_InfoEvent infoEvent;            
    BTA_PRAGMA_ALIGN FN_BTA_InfoEventEx infoEventEx;        
    BTA_PRAGMA_ALIGN uint8_t verbosity;                     
    BTA_PRAGMA_ALIGN FN_BTA_FrameArrived frameArrived;      
    BTA_PRAGMA_ALIGN FN_BTA_FrameArrivedEx frameArrivedEx;  

    BTA_PRAGMA_ALIGN uint16_t frameQueueLength;             
    BTA_PRAGMA_ALIGN BTA_QueueMode frameQueueMode;          
    BTA_PRAGMA_ALIGN uint16_t averageWindowLength;          

    BTA_PRAGMA_ALIGN uint8_t *bltstreamFilename;            
} BTA_Config;



typedef struct BTA_GrabbingConfig {
    uint8_t *filename;                                      
} BTA_GrabbingConfig;



typedef struct BTA_ConfigStructOrg {
    char *variableName;                                     
    uint8_t pointer;                                        
} BTA_ConfigStructOrg;



DLLEXPORT extern BTA_ConfigStructOrg btaConfigStructOrg[];
DLLEXPORT extern const uint32_t btaConfigStructOrgLen;



//----------------------------------------------------------------------------------------------------------------
#ifdef __cplusplus
extern "C"
{
#endif


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetVersion(uint32_t *verMaj, uint32_t *verMin, uint32_t *verNonFun, uint8_t *buildDateTime, uint32_t buildDateTimeLen, uint16_t *supportedDeviceTypes, uint32_t *supportedDeviceTypesLen);



DLLEXPORT BTA_Status BTA_CALLCONV BTAinitDiscoveryConfig(BTA_DiscoveryConfig *config);


DLLEXPORT BTA_Status BTA_CALLCONV BTAstartDiscovery(BTA_DiscoveryConfig *discoveryConfig, FN_BTA_DeviceFound deviceFound, FN_BTA_InfoEvent infoEvent, BTA_Handle *handle);


DLLEXPORT BTA_Status BTA_CALLCONV BTAstopDiscovery(BTA_Handle *handle);



DLLEXPORT BTA_ConfigStructOrg *BTA_CALLCONV BTAgetConfigStructOrg(uint32_t *fieldCount, uint8_t *bytesPerField);


DLLEXPORT BTA_Status BTA_CALLCONV BTAinitConfig(BTA_Config *config);


DLLEXPORT BTA_Status BTA_CALLCONV BTAopen(BTA_Config *config, BTA_Handle *handle);


DLLEXPORT BTA_Status BTA_CALLCONV BTAclose(BTA_Handle *handle);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetDeviceInfo(BTA_Handle handle, BTA_DeviceInfo **deviceInfo);


DLLEXPORT BTA_Status BTA_CALLCONV BTAfreeDeviceInfo(BTA_DeviceInfo *deviceInfo);


DLLEXPORT uint8_t BTA_CALLCONV BTAisRunning(BTA_Handle handle);


DLLEXPORT uint8_t BTA_CALLCONV BTAisConnected(BTA_Handle handle);


DLLEXPORT BTA_Status BTA_CALLCONV BTAsetFrameMode(BTA_Handle handle, BTA_FrameMode frameMode);




DLLEXPORT BTA_Status BTA_CALLCONV BTAcloneFrame(BTA_Frame *frameSrc, BTA_Frame **frameDst);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetFrame(BTA_Handle handle, BTA_Frame **frame, uint32_t timeout);


DLLEXPORT BTA_Status BTA_CALLCONV BTAfreeFrame(BTA_Frame **frame);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetSerializedLength(BTA_Frame *frame, uint32_t *frameSerializedLen);


DLLEXPORT BTA_Status BTA_CALLCONV BTAserializeFrame(BTA_Frame *frame, uint8_t *frameSerialized, uint32_t *frameSerializedLen);


DLLEXPORT BTA_Status BTA_CALLCONV BTAdeserializeFrame(BTA_Frame **frame, uint8_t *frameSerialized, uint32_t *frameSerializedLen);




DLLEXPORT BTA_Status BTA_CALLCONV BTAgetDistances(BTA_Frame *frame, void **distBuffer, BTA_DataFormat *dataFormat, BTA_Unit *unit, uint16_t *xRes, uint16_t *yRes);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetAmplitudes(BTA_Frame *frame, void **ampBuffer, BTA_DataFormat *dataFormat, BTA_Unit *unit, uint16_t *xRes, uint16_t *yRes);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetFlags(BTA_Frame *frame, void **flagBuffer, BTA_DataFormat *dataFormat, BTA_Unit *unit, uint16_t *xRes, uint16_t *yRes);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetXYZcoordinates(BTA_Frame *frame, void **xBuffer, void **yBuffer, void **zBuffer, BTA_DataFormat *dataFormat, BTA_Unit *unit, uint16_t *xRes, uint16_t *yRes);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetColors(BTA_Frame *frame, void **colorBuffer, BTA_DataFormat *dataFormat, BTA_Unit *unit, uint16_t *xRes, uint16_t *yRes);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetMetadata(BTA_Channel *channel, uint32_t metadataId, void **metadata, uint32_t *metadataLen);



DLLEXPORT BTA_Status BTA_CALLCONV BTAsetIntegrationTime(BTA_Handle handle, uint32_t integrationTime);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetIntegrationTime(BTA_Handle handle, uint32_t *integrationTime);


DLLEXPORT BTA_Status BTA_CALLCONV BTAsetFrameRate(BTA_Handle handle, float frameRate);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetFrameRate(BTA_Handle handle, float *frameRate);


DLLEXPORT BTA_Status BTA_CALLCONV BTAsetModulationFrequency(BTA_Handle handle, uint32_t modulationFrequency);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetModulationFrequency(BTA_Handle handle, uint32_t *modulationFrequency);


DLLEXPORT BTA_Status BTA_CALLCONV BTAsetGlobalOffset(BTA_Handle handle, float globalOffset);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetGlobalOffset(BTA_Handle handle, float *globalOffset);




DLLEXPORT BTA_Status BTA_CALLCONV BTAreadRegister(BTA_Handle handle, uint32_t address, uint32_t *data, uint32_t *registerCount);


DLLEXPORT BTA_Status BTA_CALLCONV BTAwriteRegister(BTA_Handle handle, uint32_t address, uint32_t *data, uint32_t *registerCount);




DLLEXPORT BTA_Status BTA_CALLCONV BTAsetLibParam(BTA_Handle handle, BTA_LibParam libParam, float value);


DLLEXPORT BTA_Status BTA_CALLCONV BTAgetLibParam(BTA_Handle handle, BTA_LibParam libParam, float *value);




DLLEXPORT BTA_Status BTA_CALLCONV BTAsendReset(BTA_Handle handle);




DLLEXPORT BTA_Status BTA_CALLCONV BTAflashUpdate(BTA_Handle handle, BTA_FlashUpdateConfig *flashUpdateConfig, FN_BTA_ProgressReport progressReport);


DLLEXPORT BTA_Status BTA_CALLCONV BTAfirmwareUpdate(BTA_Handle handle, const uint8_t *filename, FN_BTA_ProgressReport progressReport);


DLLEXPORT BTA_Status BTA_CALLCONV BTAwigglingUpdate(BTA_Handle handle, const uint8_t *filename, FN_BTA_ProgressReport progressReport);


DLLEXPORT BTA_Status BTA_CALLCONV BTAfpnUpdate(BTA_Handle handle, const uint8_t *filename, FN_BTA_ProgressReport progressReport);


DLLEXPORT BTA_Status BTA_CALLCONV BTAfppnUpdate(BTA_Handle handle, const uint8_t *filename, FN_BTA_ProgressReport progressReport);


DLLEXPORT BTA_Status BTA_CALLCONV BTAflashRead(BTA_Handle handle, BTA_FlashUpdateConfig *flashUpdateConfig, FN_BTA_ProgressReport progressReport);




DLLEXPORT BTA_Status BTA_CALLCONV BTAwriteCurrentConfigToNvm(BTA_Handle handle);


DLLEXPORT BTA_Status BTA_CALLCONV BTArestoreDefaultConfig(BTA_Handle handle);




DLLEXPORT BTA_Status BTA_CALLCONV BTAaddFilter(BTA_Handle handle, BTA_FltConfig *fltConfig, BTA_FltType fltType, BTA_FltHandle *fltHandle);


DLLEXPORT BTA_Status BTA_CALLCONV BTAremoveFilter(BTA_Handle handle, BTA_FltHandle fltHandle);




DLLEXPORT BTA_Status BTA_CALLCONV BTAinitGrabbingConfig(BTA_GrabbingConfig *config);


DLLEXPORT BTA_Status BTA_CALLCONV BTAstartGrabbing(BTA_Handle handle, BTA_GrabbingConfig *config);




DLLEXPORT BTA_Status BTA_CALLCONV BTAstatusToString(BTA_Status status, char* statusString, uint16_t statusStringLen);

DLLEXPORT BTA_Status BTA_CALLCONV BTAeventIdToString(BTA_EventId eventId, char *eventIdString, uint16_t eventIdStringLen);



DLLEXPORT BTA_Status BTA_CALLCONV BTAsetKeepAliveMsgInterval(BTA_Handle handle, float interval);
DLLEXPORT BTA_Status BTA_CALLCONV BTAsetControlCrcEnabled(BTA_Handle handle, uint8_t enabled);


#ifdef __cplusplus
}
#endif

#endif