CereStim 96 API  RS-0075 Rev 3.00
BStimulator.h File Reference

CereStim 96 API Primary Header File. More...

#include <vector>

Go to the source code of this file.

Classes

struct  BDeviceInfo
 CereStim 96 Device Specific Information. More...
 
struct  BElectrodeChannelMap
 Map Channels to Electrodes. More...
 
struct  BGroupStimulus
 Group Stimulus. More...
 
struct  BMaximumValues
 Admin Max Values. More...
 
struct  BMaxOutputVoltage
 Measured Output Voltaged. More...
 
struct  BOutputMeasurement
 Measured Stimulus Voltage. More...
 
struct  BReadEEpromOutput
 CereStim 96 Motherboard EEprom. More...
 
struct  BReadHardwareValuesOutput
 Hardware Values of the CereStim 96. More...
 
struct  BSequenceStatus
 Status of the Stimulator. More...
 
class  BStimulator
 Creates a Stimulator Object. More...
 
struct  BStimulusConfiguration
 Components of the Stimulus Configurations. More...
 
struct  BTestElectrodes
 Electrode Diagnostics. More...
 
struct  BTestModules
 Module Diagnostics. More...
 
struct  BUsbParams
 USB Parameters. More...
 
struct  BVersion
 API Version. More...
 

Macros

#define BSTIMAPI   __declspec(dllimport)
 

Typedefs

typedef void(* BCallback) (BEventType type, void *pCallbackData)
 Callback function. More...
 
typedef UINT32 BStimHandle
 Handle to the Blackrock Stimulator object.
 
typedef signed short INT16
 -32,768 to 32,767
 
typedef signed int INT32
 -2,147,483,648 to 2,147,483,647
 
typedef signed char INT8
 -128 to 127
 
typedef unsigned short UINT16
 0 to 65,535
 
typedef unsigned int UINT32
 0 to 4,294,967,296
 
typedef unsigned char UINT8
 0 to 255
 

Enumerations

enum  BCallbackType { BCALLBACK_ALL = 0, BCALLBACK_DEVICE_ATTACHMENT, BCALLBACK_COUNT }
 Event Monitoring. More...
 
enum  BConfig {
  BCONFIG_0 = 0, BCONFIG_1, BCONFIG_2, BCONFIG_3,
  BCONFIG_4, BCONFIG_5, BCONFIG_6, BCONFIG_7,
  BCONFIG_8, BCONFIG_9, BCONFIG_10, BCONFIG_11,
  BCONFIG_12, BCONFIG_13, BCONFIG_14, BCONFIG_15,
  BCONFIG_COUNT
}
 The Configured Stimulus Waveforms. More...
 
enum  BEventType { BEVENT_DEVICE_ATTACHED = 0, BEVENT_DEVICE_DETACHED, BEVENT_COUNT }
 USB Events. More...
 
enum  BInterfaceType { BINTERFACE_DEFAULT = 0, BINTERFACE_WUSB, BINTERFACE_COUNT }
 Interface Types for connecting to the Stimulator. More...
 
enum  BModuleStatus {
  BMODULE_UNAVAILABLE = 0, BMODULE_ENABLED, BMODULE_DISABLED, BMODULE_OK,
  BMODULE_VOLTAGELIMITATION, BMODULE_COUNT
}
 Status of the Current Modules. More...
 
enum  BOCVolt {
  BOCVOLT4_7 = 7, BOCVOLT5_3, BOCVOLT5_9, BOCVOLT6_5,
  BOCVOLT7_1, BOCVOLT7_7, BOCVOLT8_3, BOCVOLT8_9,
  BOCVOLT9_5, BOCVOLT_INVALID
}
 Output Compliance Voltage Level of the Stimulator. More...
 
enum  BPartNumbers {
  PN6425 = 0, PN7008, PN7039, PN7169,
  PN8543, PN7655, PN7656, PN7875,
  PN8544, PN_INVALID
}
 Stimulator Part Numbers. More...
 
enum  BResult {
  BRETURN = 1, BSUCCESS = 0, BNOTIMPLEMENTED = -1, BUNKNOWN = -2,
  BINVALIDHANDLE = -3, BNULLPTR = -4, BINVALIDINTERFACE = -5, BINTERFACETIMEOUT = -6,
  BDEVICEREGISTERED = -7, BINVALIDPARAMS = -8, BDISCONNECTED = -9, BCONNECTED = -10,
  BSTIMATTACHED = -11, BSTIMDETACHED = -12, BDEVICENOTIFY = -13, BINVALIDCOMMAND = -14,
  BINTERFACEWRITE = -15, BINTERFACEREAD = -16, BWRITEERR = -17, BREADERR = -18,
  BINVALIDMODULENUM = -19, BINVALIDCALLBACKTYPE = -20, BCALLBACKREGFAILED = -21, BLIBRARYFIRMWARE = -22,
  BFREQPERIODZERO = -23, BNODEVICESELECTED = -24, BNOK = -100, BSEQUENCEERROR = -102,
  BINVALIDTRIGGER = -103, BINVALIDCHANNEL = -104, BINVALIDCONFIG = -105, BINVALIDNUMBER = -106,
  BINVALIDRWR = -107, BINVALIDVOLTAGE = -108, BINVALIDAMPLITUDE = -109, BINVALIDAFCF = -110,
  BINVALIDPULSES = -111, BINVALIDWIDTH = -112, BINVALIDINTERPULSE = -113, BINVALIDINTERPHASE = -114,
  BINVALIDFASTDISCH = -115, BINVALIDMODULE = -116, BSTIMULIMODULES = -117, BMODULEUNAVAILABLE = -118,
  BCHANNELUSEDINGROUP = -119, BCONFIGNOTACTIVE = -120, BEMPTYCONFIG = -121, BPHASENOTBALANCED = -122,
  BPHASEGREATMAX = -123, BAMPGREATMAX = -124, BWIDTHGREATMAX = -125, BVOLTGREATMAX = -126,
  BMODULEDISABLED = -127, BMODULEENABLED = -128, BINVALIDFREQUENCY = -129, BFREQUENCYGREATMAX = -130,
  BDEVICELOCKED = -131, BECHOERROR = -132
}
 Return values from calls to the Stimulator object. More...
 
enum  BSeqType {
  BSEQ_STOP = 0, BSEQ_PAUSE, BSEQ_PLAYING, BSEQ_WRITING,
  BSEQ_TRIGGER, BSEQ_INVALID
}
 Stimulators Internal Status. More...
 
enum  BStimulatorType { MICRO_STIM = 0, MACRO_STIM, INVALID_STIM }
 
enum  BTriggerType {
  BTRIGGER_DISABLED = 0, BTRIGGER_RISING, BTRIGGER_FALLING, BTRIGGER_CHANGE,
  BTRIGGER_INVALID
}
 Possible Triggering Modes. More...
 
enum  BWFType { BWF_ANODIC_FIRST = 0, BWF_CATHODIC_FIRST, BWF_INVALID }
 Polarity of First Stimulus Phase. More...
 

Variables

const UINT8 BANKSIZE =32
 Maximum number of channels per bank.
 
const INT32 EEPROM_SIZE =256
 Size of EEProm on the Microcontroller is 256.
 
const UINT8 MAXCHANNELS =97
 Maximum number of channels in the CereStim 96, Channel 0 is internal and 1-96 are external.
 
const UINT8 MAXCONFIGURATIONS =16
 Maximum number of stimulation waveforms that can be stored on the device is 16. More...
 
const UINT8 MAXMODULES =16
 The maximum number of current modules in a CereStim 96.
 
const UINT8 NUMBER_VOLT_MEAS =5
 Number of voltage measurements taken for every stimulation pulse.
 

Detailed Description

The Main Header file for the CereStim 96 API. User code will need to include this file. The file Declares all Structures, Enums, macros, class, and functions that the user will need in order to interface with Blackrock Microsystems CereStim 96

Author
Rudy Wilcox & Sylvana Alpert
Version
5.00.00
Date
3.31.2016