Skip to content

Commit 628a286

Browse files
committed
docs: add version notices for new functions
1 parent a5d9760 commit 628a286

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

absscpi/client.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,10 @@ def measure_average_cell_voltage(self, cell: int) -> float:
10761076
At the default sample rate, this is a 10ms window. With filtering on,
10771077
the length of this window will change.
10781078
1079+
.. note::
1080+
1081+
This function requires ABS firmware version 1.2.0 or newer.
1082+
10791083
Args:
10801084
cell: Target cell index, 0-7.
10811085
@@ -1084,6 +1088,8 @@ def measure_average_cell_voltage(self, cell: int) -> float:
10841088
10851089
Raises:
10861090
ScpiClientError: An error occurred while executing the query.
1091+
1092+
.. versionadded:: 1.1.0
10871093
"""
10881094
self.__ensure_ver(1,1,0)
10891095
voltage = c_float()
@@ -1099,11 +1105,17 @@ def measure_all_average_cell_voltages(self) -> list[float]:
10991105
At the default sample rate, this is a 10ms window. With filtering on,
11001106
the length of this window will change.
11011107
1108+
.. note::
1109+
1110+
This function requires ABS firmware version 1.2.0 or newer.
1111+
11021112
Returns:
11031113
Array of average voltages, one per cell.
11041114
11051115
Raises:
11061116
ScpiClientError: An error occurred while executing the query.
1117+
1118+
.. versionadded:: 1.1.0
11071119
"""
11081120
self.__ensure_ver(1,1,0)
11091121
voltages = (c_float * CELL_COUNT)()
@@ -1119,6 +1131,10 @@ def measure_average_cell_current(self, cell: int) -> float:
11191131
At the default sample rate, this is a 10ms window. With filtering on,
11201132
the length of this window will change.
11211133
1134+
.. note::
1135+
1136+
This function requires ABS firmware version 1.2.0 or newer.
1137+
11221138
Args:
11231139
cell: Target cell index, 0-7.
11241140
@@ -1127,6 +1143,8 @@ def measure_average_cell_current(self, cell: int) -> float:
11271143
11281144
Raises:
11291145
ScpiClientError: An error occurred while executing the query.
1146+
1147+
.. versionadded:: 1.1.0
11301148
"""
11311149
self.__ensure_ver(1,1,0)
11321150
current = c_float()
@@ -1142,11 +1160,17 @@ def measure_all_average_cell_currents(self) -> list[float]:
11421160
At the default sample rate, this is a 10ms window. With filtering on,
11431161
the length of this window will change.
11441162
1163+
.. note::
1164+
1165+
This function requires ABS firmware version 1.2.0 or newer.
1166+
11451167
Returns:
11461168
Array of average currents, one per cell.
11471169
11481170
Raises:
11491171
ScpiClientError: An error occurred while executing the query.
1172+
1173+
.. versionadded:: 1.1.0
11501174
"""
11511175
self.__ensure_ver(1,1,0)
11521176
currents = (c_float * CELL_COUNT)()

0 commit comments

Comments
 (0)