USB

class pybpod_rotaryencoder_module.module_api.RotaryEncoderModule(serialport=None)

Constructer of the RotaryEncoderModule object A a serial connection to the Rotary Encoder board is oppened at the construction of the object.

Variables:serialport (str) – PC serial port where the module is connect

open(serialport)

Opens a serial connection to the Rotary Encoder board.

Variables:serialport (str) – PC serial port where the module is connect

close()

Closes the serial connection to the Rotary Encoder board.

enable_evt_transmission()

Enable the transmission of the events.

disable_evt_transmission()

Disable the transmission of the events.

enable_stream()

Enable the streaming of the position and the time measurements to the USB port.

disable_stream()

Disable the streaming of the position and the time measurements to the USB port.

read_stream()

Read the data being streamed through the USB port.

enable_logging()

Enable the logging to the SD Card.

disable_logging()

Disable the logging to the SD Card.

get_logged_data()

Retreave the logged data in the SD Card.

current_position()

Retreave the current position.

set_zero_position()

Set current rotary encoder position to zero.

set_prefix(prefix)

Variables:prefix (char) – One character to be used as prefix.

Set 1-character prefix for module output stream.

set_thresholds(thresholds)

Set the thresholds values to trigger the events.

Variables:thresholds (list(int)) – List, in maximum, of 6 thresholds to trigger events.

set_position(degrees)

Set the current position in degrees.

Variables:degrees (int) – current position in degrees.

set_wrappoint(wrap_point)

Set wrap point (number of tics in a half-rotation)

Variables:wrap_point (int) – number of tics in a half-rotation.

enable_thresholds(thresholds)

Enable the thresholds.

Variables:thresholds (list(boolean)) – list of 6 booleans indicating which thresholds are active to trigger events.

Usage example

from pybpod_rotaryencoder_module.module_api import RotaryEncoderModule

m = RotaryEncoderModule('/dev/ttyACM1')

m.start_logging()

m.enable_stream()

#print the first 100 outputs
count = 0
while count<100:
    data = m.read_stream()
    if len(data)==0:
        continue
    else:
        count += 1
        print(data)

m.disable_stream()

m.stop_logging()

m.set_zero_position()

m.close()