Add a warning about start/stop program which resets sensors and motors

Author: schodet

nxt/brick.py

@@ -356,6 +356,9 @@ def start_program(self, name: str) -> None:
         """Start a program on the brick.
 
         :param name: Program file name (example: ``"myprogram.rxe"``).
+
+        .. warning:: When starting or stopping a program, the NXT firmware resets every
+           sensors and motors.
         """
         tgram = Telegram(Opcode.DIRECT_START_PROGRAM)
         tgram.add_filename(name)
@@ -365,6 +368,9 @@ def stop_program(self) -> None:
         """Stop the running program on the brick.
 
         :raises nxt.error.NoActiveProgramError: When no program is running.
+
+        .. warning:: When starting or stopping a program, the NXT firmware resets every
+           sensors and motors.
         """
         tgram = Telegram(Opcode.DIRECT_STOP_PROGRAM)
         self._cmd(tgram)

nxt/motcont.py

@@ -196,6 +196,9 @@ def start(self, version: int = 22) -> None:
         It needs to already be present on the brick's flash and named
         ``MotorControlXX.rxe``, where `XX` is the version number passed as the version
         argument.
+
+        .. warning:: When starting or stopping a program, the NXT firmware resets every
+           sensors and motors.
         """
         try:
             self._brick.stop_program()
@@ -209,5 +212,8 @@ def stop(self) -> None:
         """Stop the MotorControl program.
 
         All this actually does is to stop the currently running program.
+
+        .. warning:: When starting or stopping a program, the NXT firmware resets every
+           sensors and motors.
         """
         self._brick.stop_program()