@@ -184,8 +184,10 @@ def execute_instruction(self, packet: NPCPacket) -> ComResult: # dead: disable
184
184
185
185
:param packet: A tuple containing the uint8 npc packet for the UOS instruction.
186
186
:returns: ComResult object.
187
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
188
- :raises: UOSCommunicationError if there is a problem completing the action.
187
+ :raises: UOSUnsupportedError if the interface hasn't been built
188
+ correctly.
189
+ :raises: UOSCommunicationError if there is a problem completing
190
+ the action.
189
191
"""
190
192
raise UOSUnsupportedError (
191
193
f"UOSInterfaces must over-ride { UOSInterface .execute_instruction .__name__ } prototype."
@@ -200,8 +202,10 @@ def read_response(
200
202
:param expect_packets: How many packets including ACK to expect
201
203
:param timeout_s: The maximum time this function will wait for data.
202
204
:return: COM Result object.
203
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
204
- :raises: UOSCommunicationError if there is a problem completing the action.
205
+ :raises: UOSUnsupportedError if the interface hasn't been built
206
+ correctly.
207
+ :raises: UOSCommunicationError if there is a problem completing
208
+ the action.
205
209
"""
206
210
raise UOSUnsupportedError (
207
211
f"UOSInterfaces must over-ride { UOSInterface .read_response .__name__ } prototype."
@@ -212,8 +216,10 @@ def hard_reset(self) -> ComResult:
212
216
"""UOS loop reset functionality should be as hard a reset as possible.
213
217
214
218
:return: COM Result object.
215
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
216
- :raises: UOSCommunicationError if there is a problem completing the action.
219
+ :raises: UOSUnsupportedError if the interface hasn't been built
220
+ correctly.
221
+ :raises: UOSCommunicationError if there is a problem completing
222
+ the action.
217
223
"""
218
224
raise UOSUnsupportedError (
219
225
f"UOSInterfaces must over-ride { UOSInterface .hard_reset .__name__ } prototype"
@@ -223,8 +229,10 @@ def hard_reset(self) -> ComResult:
223
229
def open (self ):
224
230
"""Abstract method for opening a connection to a UOSInterface.
225
231
226
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
227
- :raises: UOSCommunicationError if there is a problem completing the action.
232
+ :raises: UOSUnsupportedError if the interface hasn't been built
233
+ correctly.
234
+ :raises: UOSCommunicationError if there is a problem completing
235
+ the action.
228
236
"""
229
237
raise UOSUnsupportedError (
230
238
f"UOSInterfaces must over-ride { UOSInterface .open .__name__ } prototype."
@@ -234,8 +242,10 @@ def open(self):
234
242
def close (self ):
235
243
"""Abstract method for closing a connection to a UOSInterface.
236
244
237
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
238
- :raises: UOSCommunicationError if there is a problem completing the action.
245
+ :raises: UOSUnsupportedError if the interface hasn't been built
246
+ correctly.
247
+ :raises: UOSCommunicationError if there is a problem completing
248
+ the action.
239
249
"""
240
250
raise UOSUnsupportedError (
241
251
f"UOSInterfaces must over-ride { UOSInterface .close .__name__ } prototype."
@@ -246,7 +256,8 @@ def is_active(self) -> bool:
246
256
"""Abstract method for checking if a connection is being held active.
247
257
248
258
:return: Success boolean.
249
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
259
+ :raises: UOSUnsupportedError if the interface hasn't been built
260
+ correctly.
250
261
"""
251
262
raise UOSUnsupportedError (
252
263
f"UOSInterfaces must over-ride { UOSInterface .close .__name__ } prototype."
@@ -258,7 +269,8 @@ def enumerate_devices() -> list:
258
269
"""Return a list of UOSDevices visible to the driver.
259
270
260
271
:return: A list of possible UOSInterfaces on the server.
261
- :raises: UOSUnsupportedError if the interface hasn't been built correctly.
272
+ :raises: UOSUnsupportedError if the interface hasn't been built
273
+ correctly.
262
274
"""
263
275
raise UOSUnsupportedError (
264
276
f"UOSInterfaces must over-ride { UOSInterface .enumerate_devices .__name__ } prototype."
0 commit comments