Skip to content

Commit 5508a34

Browse files
committed
Updated spikesafe_python_lib_docs for DigitizerDataFetch functions to include digitizer_number optional parameter
1 parent 6242b50 commit 5508a34

File tree

6 files changed

+30
-15
lines changed

6 files changed

+30
-15
lines changed

spikesafe_python_lib_docs/DigitizerDataFetch/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Provides a collection of helper functions you can use to take PSMU Digitizer mea
88
### Functions
99
| Name | Description |
1010
| - | - |
11-
| [DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data/README.md) | Returns an array of voltage readings from the digitizer obtained through a fetch query. |
12-
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md) | Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query. |
13-
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md) | Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query. |
14-
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md) | Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query. |
11+
| [DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data/README.md) | Returns an array of voltage readings from the digitizer obtained through a fetch query. |
12+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md) | Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query. |
13+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md) | Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query. |
14+
| [DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md) | Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query. |
1515
| [DigitizerDataFetch.get_new_voltage_data_estimated_complete_time(aperture_microseconds, reading_count, hardware_trigger_count=None, hardware_trigger_delay_microseconds=None)](/spikesafe_python_lib_docs/DigitizerDataFetch/get_new_voltage_data_estimated_complete_time/README.md) | Returns the estimated minimum possible time in seconds it will take for the SpikeSafe PSMU digitizer to acquire new voltage readings. If hardware triggering is used, this does not take into account the pulse period, so the actual time may be longer. |
16-
| [DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/wait_for_new_voltage_data/README.md) | Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data. |
16+
| [DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None, digitizer_number = None)](/spikesafe_python_lib_docs/DigitizerDataFetch/wait_for_new_voltage_data/README.md) | Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data. |

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number = None)
22

3-
## DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data(spike_safe_socket, enable_logging = None, digitizer_number = None)
44

55
### Definition
66
Returns an array of voltage readings from the digitizer obtained through a fetch query.
@@ -12,6 +12,9 @@ Socket object used to communicate with SpikeSafe.
1212
enable_logging [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
1313
Overrides spike_safe_socket.enable_logging attribute (None by default, will use spike_safe_socket.enable_logging value).
1414

15+
digitizer_number [int](https://docs.python.org/3/library/functions.html#int) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
16+
The Digitizer number to fetch from. If None, fetches from Digitizer 1.
17+
1518
### Returns
1619
[DigitizerData array](/spikesafe_python_lib_docs/DigitizerData/README.md)
1720
Contains an array of DigitizerData objects which each have a Sample Number and Voltage Reading.

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_custom/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)
22

3-
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_custom(spike_safe_socket, time_sampling_mode, custom_sequence, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)
44

55
### Definition
66
Returns an array of voltage readings using custom sampling mode from the digitizer obtained through a fetch query.
@@ -21,6 +21,9 @@ The hardware trigger delay in microseconds (default to 0us)
2121
enable_logging : [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
2222
Overrides spike_safe_socket.enable_logging attribute (None by default, will use spike_safe_socket.enable_logging value).
2323

24+
digitizer_number [int](https://docs.python.org/3/library/functions.html#int) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
25+
The Digitizer number to fetch from. If None, fetches from Digitizer 1.
26+
2427
### Returns
2528
[DigitizerData array](/spikesafe_python_lib_docs/DigitizerData/README.md)
2629
Contains an array of DigitizerData objects which have a defined voltage_reading, sample_number, and time_since_start_seconds attribute.

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_linear/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number = None)
22

3-
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_linear(spike_safe_socket, time_sampling_mode, aperture_microseconds, reading_count, hardware_trigger_delay_microseconds = 0, pulse_period_seconds = 0, enable_logging = None, digitizer_number = None)
44

55
### Definition
66
Returns an array of voltage readings using linear sampling mode from the digitizer obtained through a fetch query .
@@ -27,6 +27,9 @@ The pulse period in seconds (default to 0s)
2727
enable_logging : [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
2828
Overrides spike_safe_socket.enable_logging attribute (None by default, will use spike_safe_socket.enable_logging value).
2929

30+
digitizer_number [int](https://docs.python.org/3/library/functions.html#int) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
31+
The Digitizer number to fetch from. If None, fetches from Digitizer 1.
32+
3033
### Returns
3134
[DigitizerData array](/spikesafe_python_lib_docs/DigitizerData/README.md)
3235
Contains an array of DigitizerData objects which have a defined voltage_reading, sample_number, and time_since_start_seconds attribute.

spikesafe_python_lib_docs/DigitizerDataFetch/fetch_voltage_data_sampling_mode_logarithmic/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)
22

3-
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None)
3+
## DigitizerDataFetch.fetch_voltage_data_sampling_mode_logarithmic(spike_safe_socket, time_sampling_mode, sampling_mode, hardware_trigger_delay_microseconds = 0, enable_logging = None, digitizer_number = None)
44

55
### Definition
66
Returns an array of voltage readings using logarithmic sampling mode from the digitizer obtained through a fetch query.
@@ -21,6 +21,9 @@ The hardware trigger delay in microseconds (default to 0us)
2121
enable_logging : [bool](https://docs.python.org/3/library/stdtypes.html#boolean-values) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
2222
Overrides spike_safe_socket.enable_logging attribute (None by default, will use spike_safe_socket.enable_logging value).
2323

24+
digitizer_number [int](https://docs.python.org/3/library/functions.html#int) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
25+
The Digitizer number to fetch from. If None, fetches from Digitizer 1.
26+
2427
### Returns
2528
[DigitizerData array](/spikesafe_python_lib_docs/DigitizerData/README.md)
2629
Contains an array of DigitizerData objects which have a defined voltage_reading, sample_number, and time_since_start_seconds attribute.

spikesafe_python_lib_docs/DigitizerDataFetch/wait_for_new_voltage_data/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None)
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerDataFetch](/spikesafe_python_lib_docs/DigitizerDataFetch/README.md) | DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, digitizer_number = None)
22

3-
## DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None)
3+
## DigitizerDataFetch.wait_for_new_voltage_data(spike_safe_socket, wait_time = 0.0, enable_logging = None, timeout = None, digitizer_number = None)
44

55
### Definition
66
Queries the SpikeSafe PSMU digitizer until it responds that it has acquired new data.
@@ -18,6 +18,9 @@ Overrides spike_safe_socket.enable_logging attribute (None by default, will use
1818
timeout [float](https://docs.python.org/3/library/functions.html#float) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
1919
Timeout in seconds for waiting for new data. If None, wait indefinitely.
2020

21+
digitizer_number [int](https://docs.python.org/3/library/functions.html#int) [optional](https://docs.python.org/3/library/typing.html#typing.Optional)
22+
The Digitizer number to fetch from. If None, fetches from Digitizer 1.
23+
2124
### Examples
2225
The following example demonstrates the spikesafe_python.wait_for_new_voltage_data function. It checks if the PSMU Digitizer has finished measuring voltage data every 500 milliseconds, fetches its measuremments, and store thems in sample and voltage arrays to be used for plotting in a graph.
2326
```

0 commit comments

Comments
 (0)