Programmer's Guide

RaDeKL Radar API Programmer’s Guide 41
© Multispectral Solutions, Inc. 2006
RaDeKLAPI.H Header File Listing
//##############################################################################
//##############################################################################
//
// RaDeKL API.h
//
// (header file)
//
// The RaDeKL API provides access to the functions of the Multispectral
// Solutions, Inc. (MSSI) RaDeKL Radar product. Please refer to the
// "RaDeKL Radar API Programmer's Guide" for details.
//
//##############################################################################
//##############################################################################
// Include only ONCE
#pragma once
// Include Windows stuff
#include <windows.h>
#include <stdio.h>
#include <math.h>
#include <sys/timeb.h>
// Include the FTDI USB Chip API header
#include "FTD2XX.h"
//
//
// Constant declarations
//
//
// Max sizes for device serial number and description strings
#define SIZE_SERIAL_NUMBER 16
#define SIZE_DESCRIPTION 64
// This string must occur somewhere within the device DESCRIPTION string
#define RaDeKL_DESCRIPTION "RaDeKL WBT Radar B"
// Status message codes (used in conjunction with the codes from FTD2XX.h)
// --- FTDI specicific status codes
#define RaDeKL_OK FT_OK // Currently 0
#define RaDeKL_INVALID_HANDLE FT_INVALID_HANDLE // Currently 1
#define RaDeKL_DEVICE_NOT_FOUND FT_DEVICE_NOT_FOUND // Currently 2
#define RaDeKL_DEVICE_NOT_OPENED FT_DEVICE_NOT_OPENED // Currently 3
#define RaDeKL_IO_ERROR FT_IO_ERROR // Currently 4
#define RaDeKL_INSUFFICIENT_RESOURCES FT_INSUFFICIENT_RESOURCES // Currently 5
#define RaDeKL_INVALID_PARAMETER FT_INVALID_PARAMETER // Currently 6
#define RaDeKL_INVALID_BAUD_RATE FT_INVALID_BAUD_RATE // Currently 7
#define RaDeKL_DEVICE_NOT_OPENED_FOR_ERASE FT_DEVICE_NOT_OPENED_FOR_ERASE // Currently 8
#define RaDeKL_DEVICE_NOT_OPENED_FOR_WRITE FT_DEVICE_NOT_OPENED_FOR_WRITE // Currently 9
#define RaDeKL_FAILED_TO_WRITE_DEVICE FT_FAILED_TO_WRITE_DEVICE // Currently 10
#define RaDeKL_EEPROM_READ_FAILED FT_EEPROM_READ_FAILED // Currently 11
#define RaDeKL_EEPROM_WRITE_FAILED FT_EEPROM_WRITE_FAILED // Currently 12
#define RaDeKL_EEPROM_ERASE_FAILED FT_EEPROM_ERASE_FAILED // Currently 13
#define RaDeKL_EEPROM_NOT_PRESENT FT_EEPROM_NOT_PRESENT // Currently 14
#define RaDeKL_EEPROM_NOT_PROGRAMMED FT_EEPROM_NOT_PROGRAMMED // Currently 15
#define RaDeKL_INVALID_ARGS FT_INVALID_ARGS // Currently 16
#define RaDeKL_NOT_SUPPORTED FT_NOT_SUPPORTED // Currently 17
#define RaDeKL_OTHER_ERROR FT_OTHER_ERROR // Currently 18
// --- RaDeKL API specific status codes
#define RaDeKL_READ_TIMEOUT 201
#define RaDeKL_WRITE_TIMEOUT 202
#define RaDeKL_INCORRECT_SERIAL_NUMBER 203
#define RaDeKL_WRITE_REGISTER_FAILED 204
#define RaDeKL_READ_REGISTER_FAILED 205
#define RaDeKL_READ_DETECTION_FAILED 206