NV200 Python Library
Contents:
Introduction
Installation
Connecting to device
Getting Started with the API
PID Controller and Filters
Data Recorder
Waveform Generator
API Reference
Examples
NV200 Python Library
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
|
X
|
Y
|
Z
_
__init__() (DataRecorder method)
,
[1]
(DataRecorder.ChannelRecordingData method)
,
[1]
(DetectedDevice method)
(DeviceError method)
(DeviceInfo method)
(NetworkEndpoint method)
(NV200Device method)
(NV200Device.LowpassFilter method)
(NV200Device.NotchFilter method)
(NV200Device.PIDController method)
(PiezoDeviceBase method)
(ProgressCallback method)
(ResonanceAnalyzer method)
(SerialProtocol method)
(StatusRegister method)
(TelnetProtocol method)
(TimeSeries method)
(TransportProtocol method)
(TransportProtocolInfo method)
(ValueRange method)
(WaveformGenerator method)
,
[1]
__new__() (DataRecorder.RecorderParam static method)
,
[1]
(DiscoverFlags method)
(PCFGains static method)
(PIDGains static method)
(StatusFlags method)
(TransportType method)
_dev (DataRecorder attribute)
,
[1]
_sample_rate (DataRecorder attribute)
,
[1]
A
ABS_POSITION_ERROR (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
acceleration (PCFGains attribute)
ADJUST_COMM_PARAMS (DiscoverFlags attribute)
ALL (DiscoverFlags attribute)
ALL_CHANNELS (DataRecorder attribute)
AnalogMonitorSource (class in nv200.shared_types)
B
backup_parameters() (PiezoDeviceBase method)
baudrate (SerialProtocol attribute)
BUFFER_READ_TIMEOUT_SECS (DataRecorder attribute)
bufsize (DataRecorder.RecorderParam attribute)
,
[1]
C
CACHEABLE_COMMANDS (NV200Device attribute)
(PiezoDeviceBase attribute)
calculate_sampling_time_ms() (in module nv200.waveform_generator)
,
[1]
CAPACITIVE (PostionSensorType attribute)
check_device_type() (PiezoDeviceBase method)
clear_cmd_cache() (PiezoDeviceBase method)
close() (PiezoDeviceBase method)
(SerialProtocol method)
(TelnetProtocol method)
(TransportProtocol method)
CLOSED_LOOP_POS (AnalogMonitorSource attribute)
(SPIMonitorSource attribute)
CMD_CACHE_ENABLED (PiezoDeviceBase attribute)
,
[1]
compute_resonance_spectrum() (ResonanceAnalyzer static method)
configure_flow_control_mode() (TelnetProtocol static method)
configure_waveform_loop() (WaveformGenerator method)
,
[1]
connect() (PiezoDeviceBase method)
(SerialProtocol method)
(SpiBoxDevice method)
(TelnetProtocol method)
(TransportProtocol method)
connect_to_detected_device() (in module nv200.connection_utils)
connect_to_single_device() (in module nv200.connection_utils)
contains() (ValueRange method)
CR (TransportProtocol attribute)
create_device_from_detected_device() (in module nv200.device_factory)
create_device_from_id() (in module nv200.device_factory)
CRLF (TransportProtocol attribute)
CtrlMode (class in nv200.shared_types)
cycle_time_ms (WaveformGenerator.WaveformData property)
,
[1]
D
DataRecorder (class in nv200.data_recorder)
,
[1]
DataRecorder.ChannelRecordingData (class in nv200.data_recorder)
,
[1]
DataRecorder.RecorderParam (class in nv200.data_recorder)
,
[1]
DataRecorderSource (class in nv200.data_recorder)
,
[1]
DEFAULT_TIMEOUT_SECS (PiezoDeviceBase attribute)
(TransportProtocol attribute)
description (DeviceError attribute)
DETECT_ETHERNET (DiscoverFlags attribute)
detect_port() (SerialProtocol method)
DETECT_SERIAL (DiscoverFlags attribute)
DetectedDevice (class in nv200.shared_types)
device_id (DetectedDevice attribute)
(DeviceInfo attribute)
DEVICE_ID (NV200Device attribute)
(PiezoDeviceBase attribute)
(SpiBoxDevice attribute)
device_info (DetectedDevice attribute)
(PiezoDeviceBase property)
DeviceError
DeviceInfo (class in nv200.shared_types)
discover_devices() (in module nv200.device_discovery)
(SerialProtocol static method)
(TelnetProtocol class method)
DiscoverFlags (class in nv200.shared_types)
E
enable() (NV200Device.LowpassFilter method)
(NV200Device.NotchFilter method)
enrich_device_info() (NV200Device method)
(PiezoDeviceBase method)
error_code (DeviceError attribute)
ErrorCode (class in nv200.shared_types)
export_actuator_config() (NV200Device method)
F
flags_for_transport() (DiscoverFlags static method)
flush_input() (SerialProtocol method)
(TelnetProtocol method)
(TransportProtocol method)
from_detected_device() (NV200Device static method)
from_value() (DataRecorderSource class method)
(ErrorCode class method)
G
generate_constant_wave() (WaveformGenerator class method)
,
[1]
generate_sample_times_ms() (TimeSeries method)
generate_sine_wave() (WaveformGenerator class method)
,
[1]
generate_square_wave() (WaveformGenerator class method)
,
[1]
generate_time_samples_array() (WaveformGenerator class method)
,
[1]
generate_time_samples_list() (WaveformGenerator class method)
,
[1]
generate_triangle_wave() (WaveformGenerator class method)
,
[1]
generate_waveform() (WaveformGenerator class method)
,
[1]
get_actuator_description() (NV200Device method)
get_actuator_name() (NV200Device method)
get_actuator_sensor_type() (NV200Device method)
get_actuator_serial_number() (NV200Device method)
get_analog_monitor_source() (NV200Device method)
get_bandwidth() (NV200Device.NotchFilter method)
get_control_mode() (NV200Device method)
get_current_position() (NV200Device method)
get_cutoff() (NV200Device.LowpassFilter method)
get_description() (ErrorCode class method)
get_device_type() (PiezoDeviceBase method)
get_frequency() (NV200Device.NotchFilter method)
get_heat_sink_temperature() (NV200Device method)
get_info() (SerialProtocol method)
(TelnetProtocol method)
(TransportProtocol method)
get_max_position() (NV200Device method)
get_max_voltage() (NV200Device method)
get_min_position() (NV200Device method)
get_min_voltage() (NV200Device method)
get_mode() (NV200Device.PIDController method)
(RecorderAutoStartMode class method)
,
[1]
get_modulation_source() (NV200Device method)
get_pcf_gains() (NV200Device.PIDController method)
get_pid_gains() (NV200Device.PIDController method)
get_position_range() (NV200Device method)
get_position_unit() (NV200Device method)
get_sample_period_ms_for_duration() (DataRecorder class method)
,
[1]
get_sample_rate_for_duration() (DataRecorder class method)
,
[1]
get_sensor_type() (StatusFlags static method)
get_setpoint() (NV200Device method)
get_setpoint_range() (NV200Device method)
get_setpoint_unit() (NV200Device method)
get_slew_rate() (NV200Device method)
get_spi_monitor_source() (NV200Device method)
get_status_register() (NV200Device method)
get_voltage_range() (NV200Device method)
get_voltage_unit() (NV200Device method)
H
has_flag() (StatusRegister method)
help() (PiezoDeviceBase class method)
help_dict() (PiezoDeviceBase class method)
host (TelnetProtocol property)
I
identifier (DetectedDevice attribute)
(DeviceInfo attribute)
ILC_FEEDBACK (CtrlMode attribute)
ILC_FEEDFORWARD (CtrlMode attribute)
ILC_IDENTIFICATION (CtrlMode attribute)
import_actuator_config() (NV200Device method)
INFINITE_RECORDING_DURATION (DataRecorder attribute)
ip (NetworkEndpoint attribute)
is_closed_loop() (NV200Device.PIDController method)
is_enabled() (NV200Device.LowpassFilter method)
(NV200Device.NotchFilter method)
is_recording() (DataRecorder method)
,
[1]
is_running() (WaveformGenerator method)
,
[1]
is_status_flag_set() (NV200Device method)
is_xon_xoff_forwared_to_host() (TelnetProtocol method)
K
kd (PIDGains attribute)
ki (PIDGains attribute)
kp (PIDGains attribute)
L
LF (TransportProtocol attribute)
lock (PiezoDeviceBase property)
LVDT_INDUCTIVE (PostionSensorType attribute)
M
mac (DetectedDevice attribute)
(DeviceInfo attribute)
(NetworkEndpoint attribute)
MAC (TelnetProtocol property)
max (ValueRange attribute)
max_sample_buffer_size (DataRecorder property)
,
[1]
measure_impulse_response() (ResonanceAnalyzer method)
min (ValueRange attribute)
ModulationSource (class in nv200.shared_types)
module
nv200.analysis
nv200.connection_utils
nv200.data_recorder
,
[1]
nv200.device_base
nv200.device_discovery
nv200.device_factory
nv200.nv200_device
nv200.serial_protocol
nv200.shared_types
nv200.spibox_device
nv200.telnet_protocol
nv200.transport_protocol
nv200.utils
nv200.waveform_generator
,
[1]
move() (NV200Device method)
move_to_position() (NV200Device method)
move_to_voltage() (NV200Device method)
N
NetworkEndpoint (class in nv200.shared_types)
NONE (PostionSensorType attribute)
notch_filter (NV200Device attribute)
nv200.analysis
module
nv200.connection_utils
module
nv200.data_recorder
module
,
[1]
nv200.device_base
module
nv200.device_discovery
module
nv200.device_factory
module
nv200.nv200_device
module
nv200.serial_protocol
module
nv200.shared_types
module
nv200.spibox_device
module
nv200.telnet_protocol
module
nv200.transport_protocol
module
nv200.utils
module
nv200.waveform_generator
module
,
[1]
NV200_RECORDER_BUFFER_SIZE (DataRecorder attribute)
NV200_RECORDER_SAMPLE_RATE_HZ (DataRecorder attribute)
NV200Device (class in nv200.nv200_device)
NV200Device.LowpassFilter (class in nv200.nv200_device)
NV200Device.NotchFilter (class in nv200.nv200_device)
NV200Device.PIDController (class in nv200.nv200_device)
O
OFF (RecorderAutoStartMode attribute)
,
[1]
OPEN_LOOP_POS (AnalogMonitorSource attribute)
(SPIMonitorSource attribute)
P
parse_hex_to_floats_percent() (in module nv200.spibox_device)
PCFGains (class in nv200.shared_types)
percent_to_hex() (in module nv200.spibox_device)
PID (CtrlMode attribute)
pid (NV200Device attribute)
PIDGains (class in nv200.shared_types)
PidLoopMode (class in nv200.shared_types)
PIEZO_CURRENT_1 (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
PIEZO_CURRENT_2 (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
PIEZO_POSITION (DataRecorderSource attribute)
,
[1]
PIEZO_VOLTAGE (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
PiezoDeviceBase (class in nv200.device_base)
port (SerialProtocol property)
position (PCFGains attribute)
POSITION_ERROR (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
position_lpf (NV200Device attribute)
PostionSensorType (class in nv200.shared_types)
ProgressCallback (class in nv200.shared_types)
R
read_cached_response_parameters_tring() (PiezoDeviceBase method)
READ_DEVICE_INFO (DiscoverFlags attribute)
read_float_value() (PiezoDeviceBase method)
read_int_value() (PiezoDeviceBase method)
read_message() (TransportProtocol method)
read_recorded_data() (DataRecorder method)
,
[1]
read_recorded_data_of_channel() (DataRecorder method)
,
[1]
read_response() (PiezoDeviceBase method)
read_response_parameters_string() (PiezoDeviceBase method)
read_response_string() (PiezoDeviceBase method)
read_string_value() (PiezoDeviceBase method)
read_stripped_response_string() (PiezoDeviceBase method)
read_until() (SerialProtocol method)
(TelnetProtocol method)
(TransportProtocol method)
read_values() (PiezoDeviceBase method)
RecorderAutoStartMode (class in nv200.data_recorder)
,
[1]
ResonanceAnalyzer (class in nv200.analysis)
restore_parameters() (PiezoDeviceBase method)
S
sample_factor (DataRecorder.ChannelRecordingData attribute)
,
[1]
(WaveformGenerator.WaveformData property)
,
[1]
sample_freq (DataRecorder.RecorderParam attribute)
,
[1]
sample_freq_hz (TimeSeries property)
sample_period_ms (TimeSeries property)
sample_time_ms (TimeSeries property)
sample_time_us (DataRecorder.ChannelRecordingData attribute)
,
[1]
sample_times_ms (TimeSeries property)
serial (SerialProtocol attribute)
(SerialProtocol property)
SERIAL (TransportType attribute)
SerialProtocol (class in nv200.serial_protocol)
set_analog_monitor_source() (NV200Device method)
set_autostart_mode() (DataRecorder method)
,
[1]
set_bandwidth() (NV200Device.NotchFilter method)
set_closed_loop() (NV200Device.PIDController method)
set_control_mode() (NV200Device method)
set_cutoff() (NV200Device.LowpassFilter method)
set_cycles() (WaveformGenerator method)
,
[1]
set_data_source() (DataRecorder method)
,
[1]
set_frequency() (NV200Device.NotchFilter method)
set_loop_end_index() (WaveformGenerator method)
,
[1]
set_loop_start_index() (WaveformGenerator method)
,
[1]
set_mode() (NV200Device.PIDController method)
set_modulation_source() (NV200Device method)
set_output_sampling_time() (WaveformGenerator method)
,
[1]
set_pcf_gains() (NV200Device.PIDController method)
set_pid_gains() (NV200Device.PIDController method)
set_recorder_stride() (DataRecorder method)
,
[1]
set_recording_duration_ms() (DataRecorder method)
,
[1]
set_sample_buffer_size() (DataRecorder method)
,
[1]
set_setpoint() (NV200Device method)
set_setpoints_percent() (SpiBoxDevice method)
set_slew_rate() (NV200Device method)
set_spi_monitor_source() (NV200Device method)
set_start_index() (WaveformGenerator method)
,
[1]
set_value_at_index() (TimeSeries method)
set_waveform() (WaveformGenerator method)
,
[1]
set_waveform_buffer() (WaveformGenerator method)
,
[1]
set_waveform_from_samples() (WaveformGenerator method)
,
[1]
set_waveform_value_percent() (WaveformGenerator method)
,
[1]
set_waveforms() (SpiBoxDevice method)
SETPOINT (AnalogMonitorSource attribute)
(DataRecorderSource attribute)
,
[1]
(SPIMonitorSource attribute)
setpoint_lpf (NV200Device attribute)
source (DataRecorder.ChannelRecordingData property)
,
[1]
SpiBoxDevice (class in nv200.spibox_device)
SPIMonitorSource (class in nv200.shared_types)
start() (WaveformGenerator method)
,
[1]
START_ON_SET_COMMAND (RecorderAutoStartMode attribute)
,
[1]
START_ON_WAVEFORM_GEN_RUN (RecorderAutoStartMode attribute)
,
[1]
start_recording() (DataRecorder method)
,
[1]
StatusFlags (class in nv200.shared_types)
StatusRegister (class in nv200.shared_types)
stop() (WaveformGenerator method)
,
[1]
stop_recording() (DataRecorder method)
,
[1]
STRAIN_GAUGE (PostionSensorType attribute)
stride (DataRecorder.RecorderParam attribute)
,
[1]
T
TELNET (TransportType attribute)
TelnetProtocol (class in nv200.telnet_protocol)
TEST_VALUE_0x5A5A (SPIMonitorSource attribute)
TimeSeries (class in nv200.shared_types)
transport (DetectedDevice attribute)
(DeviceInfo attribute)
transport_protocol (PiezoDeviceBase property)
TransportProtocol (class in nv200.transport_protocol)
TransportProtocolInfo (class in nv200.shared_types)
TransportType (class in nv200.shared_types)
V
ValueRange (class in nv200.shared_types)
values (TimeSeries property)
velocity (PCFGains attribute)
W
wait_until() (in module nv200.utils)
wait_until_finished() (DataRecorder method)
,
[1]
(WaveformGenerator method)
,
[1]
WaveformGenerator (class in nv200.waveform_generator)
,
[1]
WaveformGenerator.WaveformData (class in nv200.waveform_generator)
,
[1]
WaveformType (class in nv200.waveform_generator)
,
[1]
WaveformUnit (class in nv200.waveform_generator)
,
[1]
write() (PiezoDeviceBase method)
(SerialProtocol method)
(TelnetProtocol method)
(TransportProtocol method)
write_string_value() (PiezoDeviceBase method)
write_value() (PiezoDeviceBase method)
X
x_time (DataRecorder.ChannelRecordingData attribute)
,
[1]
XOFF (TransportProtocol attribute)
XON (TransportProtocol attribute)
Y
y_values (DataRecorder.ChannelRecordingData attribute)
,
[1]
Z
ZERO (SPIMonitorSource attribute)