Updated spikesafe_python_lib_docs

Author: eljayg

spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_float/README.md

@@ -10,5 +10,29 @@ Return the current reading formatted to matching hardware decimal places.
 Return the current reading formatted to matching hardware decimal places.
 
 ### Examples
+The following example demonstrates the  current_reading attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading_amps_formatted_float()
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading_volts_formatted_float()
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
 
 ### Examples In Action

spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_string/README.md

@@ -10,5 +10,29 @@ Return the current reading formatted to matching hardware decimal places.
 Return the current reading formatted to matching hardware decimal places.
 
 ### Examples
+The following example demonstrates the  current_reading attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading_amps_formatted_string()
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading_volts_formatted_string()
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
 
 ### Examples In Action

spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_float/README.md

@@ -7,4 +7,32 @@ Return the voltage reading formatted to matching hardware decimal places.
 
 ### Returns
 [float](https://docs.python.org/3/library/functions.html#float)  
-Return the voltage reading formatted to matching hardware decimal places.
+Return the voltage reading formatted to matching hardware decimal places.
+
+### Examples
+The following example demonstrates the  current_reading attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading_amps_formatted_float()
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading_volts_formatted_float()
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
+
+### Examples In Action

spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_string/README.md

@@ -7,4 +7,32 @@ Return the voltage reading formatted to matching hardware decimal places.
 
 ### Returns
 [string](https://docs.python.org/3/library/string.html)  
-Return the voltage reading formatted to matching hardware decimal places.
+Return the voltage reading formatted to matching hardware decimal places.
+
+### Examples
+The following example demonstrates the  current_reading attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading_amps_formatted_string()
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading_volts_formatted_string()
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
+
+### Examples In Action

spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_float/README.md

@@ -7,4 +7,24 @@ Return the voltage reading formatted to matching hardware decimal places.
 
 ### Returns
 [float](https://docs.python.org/3/library/functions.html#float)  
-Return the voltage reading formatted to matching hardware decimal places.
+Return the voltage reading formatted to matching hardware decimal places.
+
+### Examples
+The following example demonstrates the voltage_reading attribute. 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.
+```
+# wait for the Digitizer measurements to complete 
+wait_for_new_voltage_data(tcp_socket, 0.5)
+
+# fetch the Digitizer voltage readings using VOLT:FETC? query
+digitizerData = []
+digitizerData = fetch_voltage_data(tcp_socket)
+
+# prepare digitizer voltage data to plot
+samples = []
+voltage_readings = []
+for dd in digitizerData:
+    samples.append(dd.sample_number)
+    voltage_readings.append(dd.voltage_reading.voltage_reading_volts_formatted_float())
+```
+
+### Examples In Action

spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_string/README.md

@@ -7,4 +7,24 @@ Return the voltage reading formatted to matching hardware decimal places.
 
 ### Returns
 [string](https://docs.python.org/3/library/string.html)  
-Return the voltage reading formatted to matching hardware decimal places.
+Return the voltage reading formatted to matching hardware decimal places.
+
+### Examples
+The following example demonstrates the voltage_reading attribute. 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.
+```
+# wait for the Digitizer measurements to complete 
+wait_for_new_voltage_data(tcp_socket, 0.5)
+
+# fetch the Digitizer voltage readings using VOLT:FETC? query
+digitizerData = []
+digitizerData = fetch_voltage_data(tcp_socket)
+
+# prepare digitizer voltage data to plot
+samples = []
+voltage_readings = []
+for dd in digitizerData:
+    samples.append(dd.sample_number)
+    voltage_readings.append(dd.voltage_reading.voltage_reading_volts_formatted_string())
+```
+
+### Examples In Action

spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted_float/README.md

@@ -10,5 +10,29 @@ Return the bulk voltage reading formatted to matching hardware decimal places.
 Return the bulk voltage reading formatted to matching hardware decimal places.
 
 ### Examples
+The following example demonstrates the bulk_voltage attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage_volts_formatted_float()
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
 
 ### Examples In Action

spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted_string/README.md

@@ -10,5 +10,29 @@ Return the bulk voltage reading formatted to matching hardware decimal places.
 Return the bulk voltage reading formatted to matching hardware decimal places.
 
 ### Examples
+The following example demonstrates the bulk_voltage attribute. It initiates the request for SpikeSafe Memory Table Read and extracts bulk voltage, Channel 1's data, and Heat Sink 1's Temperature data from a MemoryTableReadData object.
+```
+# request SpikeSafe memory table
+tcp_socket.send_scpi_command('MEM:TABL:READ')
+
+# read SpikeSafe memory table
+data = tcp_socket.read_data()                                        
+
+# parse SpikeSafe memory table
+memory_table_read = MemoryTableReadData().parse_memory_table_read(data)
+
+# extract Bulk Voltage data
+bulk_voltage = memory_table_read.bulk_voltage_volts_formatted_string()
+
+# extract Channel 1's data
+channel_number = memory_table_read.channel_data[0].channel_number
+current_reading = memory_table_read.channel_data[0].current_reading
+is_on_state = memory_table_read.channel_data[0].is_on_state
+voltage_reading = memory_table_read.channel_data[0].voltage_reading
+
+# extract Heatsink 1's Temperature Data
+heat_sink_number = memory_table_read.temperature_data[0].heat_sink_number
+temperature_reading = memory_table_read.temperature_data[0].temperature_reading
+```
 
 ### Examples In Action

spikesafe_python_lib_docs/ScpiFormatter/get_scpi_format_integer_for_bool/README.md

@@ -10,5 +10,12 @@ Return the SCPI formatted value for a boolean value.
 Return the SCPI formatted value for a boolean value. 1 for True, 0 for False.
 
 ### Examples
+The following example demonstrates the `get_scpi_format_integer_for_bool()` function. It sends the SpikeSafe PSMU current range auto SCPI command.
+```
+# set the SpikeSafe Current Range to Auto
+set_current_range_auto = True
+tcp_socket.send_scpi_command(f'SOUR1:CURR:RANG:AUTO {get_scpi_format_integer_for_bool(set_current_range_auto)}') 
+
+```
 
 ### Examples In Action

spikesafe_python_lib_docs/ScpiFormatter/get_scpi_format_on_state_for_bool/README.md

@@ -10,5 +10,12 @@ Return the SCPI formatted value for a boolean value
 Return the SCPI formatted value for a boolean value. 'ON' for True, 'OFF' for False.
 
 ### Examples
+The following example demonstrates the `get_scpi_format_on_state_for_bool()` function. It sends the SpikeSafe PSMU pulse width adjustment SCPI command.
+```
+# set the SpikeSafe Pulse Width Adjustment to on
+pulse_width_adjustment = True
+tcp_socket.send_scpi_command(f'SOUR1:PULS:AADJ {get_scpi_format_on_state_for_bool(pulse_width_adjustment)}') 
+
+```
 
 ### Examples In Action