br_stimpy._bstimulator.ResultType

class ResultType(self: br_stimpy._bstimulator.ResultType, value: int)

Bases: pybind11_object

A stimulator object creates a USB connection with the actual CereStim 96 and calls are made to it through the stimulator object. The stimulator object can return an error message (Software Error) or the CereStim 96 can return an error message (Hardware Error).

Members:

return : Software Error: Early returned warning.

success : Successful operation.

not_implemented : Software Error: Not implemented.

unknown : Software Error: Unknown error.

invalid_handle : Software Error: Invalid handle.

null_ptr : Software Error: Null pointer.

invalid_interface : Software Error: Invalid interface specified or interface not supported.

interface_timeout : Software Error: Timeout in creating the interface.

device_registered : Software Error: Device with that address already connected.

invalid_params : Software Error: Invalid parameters.

disconnected : Software Error: Stim is disconnected, invalid operation.

connected : Software Error: Stim is connected, invalid operation.

stim_attached : Software Error: Stim is attached, invalid operation.

stim_detached : Software Error: Stim is detached, invalid operation.

device_notify : Software Error: Cannot register for device change notification.

invalid_command : Software Error: Invalid command.

interface_write : Software Error: Cannot open interface for write.

interface_read : Software Error: Cannot open interface for read.

write_err : Software Error: Cannot write command to the interface.

read_err : Software Error: Cannot read command from the interface.

invalid_module_enum : Software Error: Invalid module number specified.

invalid_callback_type : Software Error: Invalid callback type.

callback_reg_failed : Software Error: Callback register/unregister failed.

library_firmware : Software Error: CereStim Firmware version not supported by SDK Library Version.

freq_period_zero : Software Error: Frequency or Period is zero and unable to be converted.

no_device_selected : Software Error: No physical device has been set. See setDevice() for help.

nok : Hardware Error: Comamnd result not OK.

sequence_error : Hardware Error: Sequence Error.

invalid_trigger : Hardware Error: Invalid Trigger.

invalid_channel : Hardware Error: Invalid Channel.

invalid_config : Hardware Error: Invalid Configuration.

invalid_number : Hardware Error: Invalid Number.

invalid_rwr : Hardware Error: Invalid Read/Write.

invalid_voltage : Hardware Error: Invalid Voltage.

invalid_amplitude : Hardware Error: Invalid Amplitude.

invalid_afcf : Hardware Error: Invalid AF/CF.

invalid_pulses : Hardware Error: Invalid Pulses.

invalid_width : Hardware Error: Invalid Width.

invalid_interpulse : Hardware Error: Invalid Interpulse.

invalid_interphase : Hardware Error: Invalid Interphase.

invalid_fastdisch : Hardware Error: Invalid Fast Discharge.

invalid_module : Hardware Error: Invalid Module.

stimuli_modules : Hardware Error: More Stimuli than Modules.

module_unavailable : Hardware Error: Module not Available.

channel_used_in_group : Hardware Error: Channel already used in Group.

config_not_active : Hardware Error: Configuration not Active.

empty_config : Hardware Error: Empty Config.

phase_not_balanced : Hardware Error: Phases not Balanced.

phase_great_max : Hardware Error: Phase Charge Greater than Max.

amp_great_max : Hardware Error: Amplitude Greater than Max.

width_great_max : Hardware Error: Width Greater than Max.

volt_great_max : Hardware Error: Voltage Greater than Max.

module_disabled : Hardware Error: Module already disabled can’t disable it.

module_enabled : Hardware Error: Module already enabled can’t reenable it.

invalid_frequency : Hardware Error: Invalid Frequency.

frequency_great_max : Hardware Error: The frequency is greater than the max value allowed.

device_locked : Hardware Error: Device locked due to hardware mismatch or not being configured.

echo_error : Hardware Error: Command returned was not the same command sent.

Methods

Attributes

`amp_great_max`
`callback_reg_failed`
`channel_used_in_group`
`config_not_active`
`connected`
`device_locked`
`device_notify`
`device_registered`
`disconnected`
`echo_error`
`empty_config`
`freq_period_zero`
`frequency_great_max`
`interface_read`
`interface_timeout`
`interface_write`
`invalid_afcf`
`invalid_amplitude`
`invalid_callback_type`
`invalid_channel`
`invalid_command`
`invalid_config`
`invalid_fastdisch`
`invalid_frequency`
`invalid_handle`
`invalid_interface`
`invalid_interphase`
`invalid_interpulse`
`invalid_module`
`invalid_module_enum`
`invalid_number`
`invalid_params`
`invalid_pulses`
`invalid_rwr`
`invalid_trigger`
`invalid_voltage`
`invalid_width`
`library_firmware`
`module_disabled`
`module_enabled`
`module_unavailable`
`name`
`no_device_selected`
`nok`
`not_implemented`
`null_ptr`
`phase_great_max`
`phase_not_balanced`
`read_err`
`return`
`sequence_error`
`stim_attached`
`stim_detached`
`stimuli_modules`
`success`
`unknown`
`value`
`volt_great_max`
`width_great_max`
`write_err`

property name