pybpodapi

class pybpod_rotaryencoder_module.module.RotaryEncoder(connected=False, module_name='', firmware_version=0, events_names=[], n_serial_events=0, serial_port=None)

Bases: pybpodapi.bpod_modules.bpod_module.BpodModule

Note

This API was based on the Rotary Encoder board documentation.

create_resetpositions_trigger()

Create a trigger to reset the positions and the threshods :return: trigger_id

activate_outputstream()

Activate module output stream.

deactivate_outputstream()

Deactivate module output stream.

stop_streaming_and_logging()

Stops streaming + logging.

enable_positions_threshold()

Enable all position thresholds.

set_position_zero()

Set current rotary encoder position to zero.

starts_logging()

Start logging position+time data to the microSD card.

stops_logging()

Finish logging position+time data to the microSD card.

timestamp_byte(value)

value as to be a byte

Usage example

#...

bpod = Bpod()

# get the module connected to the first bpod serial port.
rotary_encoder = bpod.modules[0]

# call a function of the module
rotary_encoder.activate_outputstream()

bpod.stop()