br_stimpy.stimpy

stimpy: a python package to interface with Blackrock Cerestim API.

Quickstart Example:

from br_stimpy import stimpy

stim_obj = stimpy.Stimulator()
print(stim_obj.api_version)
stim_obj.connect()
stim_obj.simple_stimulus(
    electrode=1,
    afcf=stimpy.WFType.wf_cathodic_first,
    pulses=1,
    amp1=10,
    amp2=10,
    width1=200,
    width2=200,
    frequency=100,
    interphase=100,
)
stim_obj.disconnect()

Note that this module imports constants from constants in addition to the classes imported or defined here.

Functions

get_api_version	Get Cerestim API library version
get_enum_docstr	Lookup docstr for a pybind11 enum value and output as string

Classes

ElectrodeChannelMap	The stimulator is capable of sending stimulation up to 96 different electrodes.
GroupStimulusStruct	Group Stimulus Structure
ModuleStatus	The stimulator is capable of housing up to 16 current modules.
OCVolt	The Stimulator is capable of setting different output compliance voltage levels based on the users needs and safety considerations.
PartNumbers	There are many versions of the stimulator.
ResultType	A stimulator object creates a USB connection with the actual CereStim 96 and calls are made to it through the stimulator object.
SeqType	The Stimulator has internal states, and based on those states the stimulator is allowed to perform different functions.
Stimulator	Simple python interface to Blackrock Cerestim 96
TriggerType	The stimulator is able to begin stimulating based on an external TTL logic.
WFType	The Stimulator is capable of outputting a biphasic current pulse.