API Reference

potentiostat

This module implements the serial interface to the Rodeostat open source Potentiostat Shield.

copyright:
  1. 2017 by IO Rodeo
license:

MIT, see LICENSE.txt for more details.

class potentiostat.potentiostat.Potentiostat(port, timeout=10.0, debug=False)

Provides a high level interface performing serial communications with the Rodeostat.

Parameters:port (str) – serial port associated with the Rodeostat, e.g. /dev/ttyACM0, COM1, etc.
Keyword Arguments:
 
get_all_curr_range()

Gets a list of all current ranges supported by the device.

get_all_volt_range()

Gets a list of voltage ranges supported by the device.

get_curr()

Returns and immediate measurement of electrical current flowing in/out of the working electrode.

get_curr_range()

Gets the current value of the measurement current range (uA).

get_device_id()

Gets the current value of the device identification number

get_firmware_version()

Gets the version string for the firmware on the device.

get_hardware_variant()

Returns a string representing the hardware variant.

get_param(testname)

Returns the current values of the parameters for the specified voltammetric test.

get_ref_volt()

Returns the measurement of the potential between the working and reference electrode.

get_sample_period()

Gets the current value for the sample period (s). The sample period is the time between samples.

get_sample_rate()

Gets the measurement sample period (Hz). Note, the sample rate is 1/sample_period.

get_test_done_time(test, timeunit='ms')

Gets the time in seconds required to complete the specified test including any quietTime, etc.

get_test_names()

Gets the list of the names of all tests which can be performed by the device with the current firmware.

get_volt()

Returns the output voltage setting, i.e, the potential between the working and reference electrode.

get_volt_range()

Gets the current value for the output voltage range (V).

run_test(testname, param=None, filename=None, display='pbar', timeunit='s')

Runs the test with specified test name and returns the time, voltage and current data.

send_cmd(cmd_dict)

Sends a command to the device. Low-level method - command is specified using command dictionary.

set_curr_range(curr_range)

Sets the measurement current range (uA).

set_device_id(device_id)

Sets the current value of the device identification number.

set_param(testname, param)

Sets the parameters for the specified voltammetric test.

set_sample_period(sample_period)

Sets the sample period (s) used for measurements. The sample period is the time between samples.

set_sample_rate(sample_rate)

Sets the measurement sample rate (Hz). Note, this is an alternative way to set the sample period.

set_volt(volt)

Sets the output voltage setting, i.e., the potential between the working and reference electrode.

set_volt_range(volt_range)

Sets the output voltage range (V)- used when setting output voltage manually.

stop_test()

Stops (any) currently running tests.