Merge pull request #54 from VektrexElectronicSystems/development-sandbox

Development sandbox 1.9.0

Author: eljayg

application_specific_examples/measuring_wavelength_spectrum/WavelengthSpectrumExample.py

@@ -107,13 +107,13 @@
     cas_spectrometer.casSetOptionsOnOff(deviceId, cas_spectrometer.coAutorangeMeasurement, 0)
 
     # set the CAS4 measurement integration time to 10ms to match the Pulsed Sweep parameters
-    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidIntegrationTime, CAS4_trigger_delay_ms)
+    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidIntegrationTime, CAS4_integration_time_ms)
 
     # set the CAS4 trigger mode to a hardware (i.e. flip-flop) trigger
     cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerSource, cas_spectrometer.trgFlipFlop)
 
     # set the CAS4 trigger delay time to 5ms to match the Pulsed Sweep parameters
-    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerDelayTime, CAS4_integration_time_ms)
+    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerDelayTime, CAS4_trigger_delay_ms)
 
     # set the CAS4 trigger delay time to 10 seconds
     cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerTimeout, 10000)

application_specific_examples/running_liv_sweeps/LIVSweepExample.py

@@ -116,13 +116,13 @@
     cas_spectrometer.casSetOptionsOnOff(deviceId, cas_spectrometer.coAutorangeMeasurement, 0)
 
     # set the CAS4 measurement integration time to 10ms to match the Pulsed Sweep parameters
-    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidIntegrationTime, CAS4_trigger_delay_ms)
+    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidIntegrationTime, CAS4_integration_time_ms)
 
     # set the CAS4 trigger mode to a hardware (i.e. flip-flop) trigger
     cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerSource, cas_spectrometer.trgFlipFlop)
 
     # set the CAS4 trigger delay time to 5ms to match the Pulsed Sweep parameters
-    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerDelayTime, CAS4_integration_time_ms)
+    cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerDelayTime, CAS4_trigger_delay_ms)
 
     # set the CAS4 trigger delay time to 10 seconds
     cas_spectrometer.casSetMeasurementParameter(deviceId, cas_spectrometer.mpidTriggerTimeout, 10000)

getting_started/README.md

@@ -6,6 +6,7 @@ These sequences are primarily intended for first-time users of Vektrex products.
 For first-time users, Vektrex recommends running the sequences in the order shown below:
 
 1. [TCP Sample](tcp_socket_sample) - A more in depth example that connects to the SpikeSafe using a TCP socket. An *IDN? query is sent with more verbose Python commands
+1. [Importing spikesafe-python package](importing_spikesafe_python_package) - Shows how to properly import [spikesafe-python](https://pypi.org/project/spikesafe-python/) package for a smooth development experience
 1. [Read *IDN?](read_idn) - Uses the SCPI Standard "*IDN?" query and following information queries to obtain the model of your SpikeSafe
 1. [Read All Events](read_all_events) - Reads all events from the SpikeSafe event queue 
 1. [Read Memory Table Data](read_memory_table_data) - Reads the SpikeSafe status and obtains current operational information from the SpikeSafe

getting_started/importing_spikesafe_python_package/ImportingSpikeSafePythonPackage.py

@@ -0,0 +1,11 @@
+from spikesafe_python.ChannelData import ChannelData
+from spikesafe_python.DigitizerData import DigitizerData
+from spikesafe_python.DigitizerDataFetch import fetch_voltage_data, wait_for_new_voltage_data
+from spikesafe_python.EventData import EventData
+from spikesafe_python.MemoryTableReadData import log_memory_table_read, MemoryTableReadData
+from spikesafe_python.ReadAllEvents import log_all_events, read_all_events, read_until_event
+from spikesafe_python.SpikeSafeError import SpikeSafeError
+from spikesafe_python.SpikeSafeEvents import SpikeSafeEvents
+from spikesafe_python.TcpSocket import TcpSocket
+from spikesafe_python.TemperatureData import TemperatureData
+from spikesafe_python.Threading import wait

getting_started/importing_spikesafe_python_package/README.md

@@ -0,0 +1,4 @@
+# Importing [spikesafe-python](https://pypi.org/project/spikesafe-python/) package
+
+## Purpose
+Demonstrate properly importing [spikesafe-python](https://pypi.org/project/spikesafe-python/) package for a smooth development experience. After following [Installing spikesafe-python package](/README.md#installing-spikesafe-python-package), copy and paste the import statements from [ImportingSpikeSafePythonPackage.py](/getting_started/importing_spikesafe_python_package/ImportingSpikeSafePythonPackage.py) at the beginning of any script (.py) to use [spikesafe-python](https://pypi.org/project/spikesafe-python/) objects in your code.  

spikesafe_python_lib_docs/Threading/wait/README.md

@@ -1,6 +1,6 @@
 # [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [Threading](/spikesafe_python_lib_docs/Threading/README.md) | wait(wait_time)
 
-## wait(wait_time)
+## wait(wait_time, current_time=time.perf_counter)
 
 ### Definition
 Suspends the current thread for a specified amount of time.
@@ -9,6 +9,9 @@ Suspends the current thread for a specified amount of time.
 wait_time [float](https://docs.python.org/3/library/functions.html#float)  
 Wait time in seconds to suspend the current thread.
 
+current_time [float](https://docs.python.org/3/library/functions.html#float)
+Current time in seconds (time.perf_counter by default).
+
 ### Examples
 The following example demonstrates the wait function. It setups up a SpikeSafe channel, starts it, waits until the event `100, Channel Ready` is returned from the SpikeSafe event queue, and monitors the event queue and readings once per second for 15 seconds.
 ```