Skip to content

Commit d7d0793

Browse files
eljaygeljayg
committed
Updated Updated spikesafe_python_lib_docs
1 parent 089aeae commit d7d0793

File tree

11 files changed

+70
-13
lines changed

11 files changed

+70
-13
lines changed

‎spikesafe_python_lib_docs/ChannelData/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,7 @@ A class used to store data in a simple accessible object from a SpikeSafe's Memo
1616
### Methods
1717
| Name | Description |
1818
| - | - |
19-
| [current_reading_amps_formatted(self)](/spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted/README.md) | Return the current reading formatted to matching hardware decimal places. |
20-
| [voltage_reading_volts_formatted(self)](/spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted/README.md) | Return the voltage reading formatted to matching hardware decimal places. |
19+
| [current_reading_amps_formatted_float(self)](/spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_float/README.md) | Return the current reading formatted to matching hardware decimal places. |
20+
| [current_reading_amps_formatted_string(self)](/spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_string/README.md) | Return the current reading formatted to matching hardware decimal places. |
21+
| [voltage_reading_volts_formatted_float(self)](/spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_float/README.md) | Return the voltage reading formatted to matching hardware decimal places. |
22+
| [voltage_reading_volts_formatted_string(self)](/spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_string/README.md) | Return the voltage reading formatted to matching hardware decimal places. |

spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted/README.md renamed to spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_float/README.md

Lines changed: 2 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) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | current_reading_amps_formatted
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | current_reading_amps_formatted_float(self)
22

3-
## current_reading_amps_formatted
3+
## current_reading_amps_formatted_float(self)
44

55
### Definition
66
Return the current reading formatted to matching hardware decimal places.

‎spikesafe_python_lib_docs/ChannelData/current_reading_amps_formatted_string/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | current_reading_amps_formatted_string(self)
2+
3+
## current_reading_amps_formatted_string(self)
4+
5+
### Definition
6+
Return the current reading formatted to matching hardware decimal places.
7+
8+
### Returns
9+
[string](https://docs.python.org/3/library/string.html)
10+
Return the current reading formatted to matching hardware decimal places.
11+
12+
### Examples
13+
14+
### Examples In Action

spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted/README.md renamed to spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_float/README.md

Lines changed: 2 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) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | voltage_reading_volts_formatted
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | voltage_reading_volts_formatted_float(self)
22

3-
## voltage_reading_volts_formatted
3+
## voltage_reading_volts_formatted_float(self)
44

55
### Definition
66
Return the voltage reading formatted to matching hardware decimal places.

‎spikesafe_python_lib_docs/ChannelData/voltage_reading_volts_formatted_string/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [ChannelData](/spikesafe_python_lib_docs/ChannelData/README.md) | voltage_reading_volts_formatted_string(self)
2+
3+
## voltage_reading_volts_formatted_string(self)
4+
5+
### Definition
6+
Return the voltage reading formatted to matching hardware decimal places.
7+
8+
### Returns
9+
[string](https://docs.python.org/3/library/string.html)
10+
Return the voltage reading formatted to matching hardware decimal places.

‎spikesafe_python_lib_docs/DigitizerData/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,10 @@ A class used to store data in a simple accessible object from a digitizer fetch
1010
| - | - |
1111
| [sample_number](/spikesafe_python_lib_docs/DigitizerData/sample_number/README.md) | Sample number of the voltage reading. |
1212
| [time_since_start_seconds](/spikesafe_python_lib_docs/DigitizerData/time_since_start_seconds/README.md) | Time since the start of the sampling in seconds. |
13-
| [voltage_reading](/spikesafe_python_lib_docs/DigitizerData/voltage_reading/README.md) | Digitizer voltage reading. |
13+
| [voltage_reading](/spikesafe_python_lib_docs/DigitizerData/voltage_reading/README.md) | Digitizer voltage reading. |
14+
15+
### Functions
16+
| Name | Description |
17+
| - | - |
18+
| [voltage_reading_volts_formatted_float(self)](/spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_float/README.md) | Return the voltage reading formatted to matching hardware decimal places. |
19+
| [voltage_reading_volts_formatted_string(self)](/spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_string/README.md) | Return the voltage reading formatted to matching hardware decimal places. |

spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted/README.md renamed to spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_float/README.md

Lines changed: 2 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) | [DigitizerData](/spikesafe_python_lib_docs/DigitizerData/README.md) | voltage_reading_volts_formatted
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerData](/spikesafe_python_lib_docs/DigitizerData/README.md) | voltage_reading_volts_formatted_float(self)
22

3-
## voltage_reading_volts_formatted
3+
## voltage_reading_volts_formatted_float(self)
44

55
### Definition
66
Return the voltage reading formatted to matching hardware decimal places.

‎spikesafe_python_lib_docs/DigitizerData/voltage_reading_formatted_string/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [DigitizerData](/spikesafe_python_lib_docs/DigitizerData/README.md) | voltage_reading_volts_formatted_string(self)
2+
3+
## voltage_reading_volts_formatted_string(self)
4+
5+
### Definition
6+
Return the voltage reading formatted to matching hardware decimal places.
7+
8+
### Returns
9+
[string](https://docs.python.org/3/library/string.html)
10+
Return the voltage reading formatted to matching hardware decimal places.

‎spikesafe_python_lib_docs/MemoryTableReadData/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ A class used to store data in a simple accessible object from a SpikeSafe's Memo
1515
### Functions
1616
| Name | Description |
1717
| - | - |
18-
| [bulk_voltage_volts_formatted](/spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted/README.md) | Parses SpikeSafe's Memory Table Read response into a simple accessible object. |
19-
| [parse_memory_table_read](/spikesafe_python_lib_docs/MemoryTableReadData/parse_memory_table_read/README.md) | Parses SpikeSafe's Memory Table Read response into a simple accessible object. |
18+
| [bulk_voltage_volts_formatted_float(self)](/spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted_float/README.md) | Return the bulk voltage reading formatted to matching hardware decimal places. |
19+
| [bulk_voltage_volts_formatted_string(self)](/spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted_string/README.md) | Return the bulk voltage reading formatted to matching hardware decimal places. |
20+
| [parse_memory_table_read(self, get_memory_table_read_response)](/spikesafe_python_lib_docs/MemoryTableReadData/parse_memory_table_read/README.md) | Parses SpikeSafe's Memory Table Read response into a simple accessible object. |

spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted/README.md renamed to spikesafe_python_lib_docs/MemoryTableReadData/bulk_voltage_volts_formatted_float/README.md

Lines changed: 2 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) | [MemoryTableReadData](/spikesafe_python_lib_docs/MemoryTableReadData/README.md) | bulk_voltage_volts_formatted
1+
# [spikesafe-python API Overview](/spikesafe_python_lib_docs/README.md) | [MemoryTableReadData](/spikesafe_python_lib_docs/MemoryTableReadData/README.md) | bulk_voltage_volts_formatted_float(self)
22

3-
## bulk_voltage_volts_formatted
3+
## bulk_voltage_volts_formatted_float(self)
44

55
### Definition
66
Return the bulk voltage reading formatted to matching hardware decimal places.

0 commit comments

Comments
 (0)