configurable hardware beep (#576)

* configurable hardware beep * fix engine_fsm.py * fix control.py
AllYarnsAreBeautiful · Oct 17, 2023 · c31efa5 · c31efa5
1 parent df1111e
commit c31efa5
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 12 deletions.
diff --git a/src/main/python/ayab/engine/communication.py b/src/main/python/ayab/engine/communication.py
@@ -118,13 +118,15 @@ def req_test_API6(self):
         self.__ser.write(data)
 
     def req_start_API6(self, start_needle, stop_needle,
-                       continuous_reporting):
+                       continuous_reporting, disable_hardware_beep):
         """Send a start message to the device."""
         data = bytearray()
         data.append(Token.reqStart.value)
         data.append(start_needle)
         data.append(stop_needle)
-        data.append(continuous_reporting)
+        data.append(
+            1 * continuous_reporting +
+            2 * (not disable_hardware_beep))
         hash = 0
         hash = add_crc(hash, data)
         data.append(hash)

diff --git a/src/main/python/ayab/engine/communication_mock.py b/src/main/python/ayab/engine/communication_mock.py
@@ -84,7 +84,7 @@ def req_test_API6(self) -> None:
         self.rx_msg_list.append(cnfTest)
 
     def req_start_API6(self, start_needle, stop_needle,
-                       continuous_reporting) -> None:
+                       continuous_reporting, disable_hardware_beep) -> None:
         """Send a request to start knitting."""
         self.__is_started = True
         cnfStart = bytes([Token.cnfStart.value, 0])

diff --git a/src/main/python/ayab/engine/control.py b/src/main/python/ayab/engine/control.py
@@ -63,6 +63,7 @@ def start(self, pattern, options, operation):
             self.mode = options.mode
             self.inf_repeat = options.inf_repeat
             self.continuous_reporting = options.continuous_reporting
+            self.prefs = options.prefs
             self.len_pat_expanded = self.pat_height * self.num_colors
             self.passes_per_row = self.mode.row_multiplier(self.num_colors)
             self.start_needle = max(0, self.pattern.pat_start_needle)

diff --git a/src/main/python/ayab/engine/engine_fsm.py b/src/main/python/ayab/engine/engine_fsm.py
@@ -139,7 +139,8 @@ def _API6_request_start(control, operation):
                 # request start
                 control.com.req_start_API6(control.pattern.knit_start_needle,
                                            control.pattern.knit_end_needle - 1,
-                                           control.continuous_reporting)
+                                           control.continuous_reporting,
+                                           control.prefs.value("disable_hardware_beep"))
                 control.state = State.CONFIRM_START
                 control.logger.debug("State CONFIRM_START")
             else:

diff --git a/src/main/python/ayab/preferences.py b/src/main/python/ayab/preferences.py
@@ -64,6 +64,7 @@ class Preferences(SignalSender):
         'default_knit_side_image': bool,
         # 'default_continuous_reporting': bool,
         'quiet_mode': bool,
+        'disable_hardware_beep': bool,
         'language': Language,
     }
 

diff --git a/src/main/python/ayab/tests/test_communication.py b/src/main/python/ayab/tests/test_communication.py
@@ -68,12 +68,17 @@ def test_update_API6(self):
         assert result == expected_result
 
     def test_req_start_API6(self):
-        start_val, end_val, continuous_reporting, crc8 = 0, 10, True, 0x36
+        start_val, end_val, continuous_reporting, disable_hardware_beep, crc8 = 0, 10, True, False, 0x8A
         self.comm_dummy.req_start_API6(start_val, end_val,
-                                       continuous_reporting)
+                                       continuous_reporting,
+                                       disable_hardware_beep)
         byte_array = bytearray([
-            Token.slipFrameEnd.value, Token.reqStart.value,
-            start_val, end_val, continuous_reporting, crc8,
+            Token.slipFrameEnd.value,
+            Token.reqStart.value,
+            start_val,
+            end_val,
+            1 * continuous_reporting + 2 * (not disable_hardware_beep),
+            crc8,
             Token.slipFrameEnd.value
         ])
         bytes_read = self.dummy_serial.read(len(byte_array))

diff --git a/src/main/python/ayab/tests/test_communication_mock.py b/src/main/python/ayab/tests/test_communication_mock.py
@@ -42,10 +42,11 @@ def test_update_API6(self):
         assert self.comm_dummy.update_API6() == (None, Token.none, 0)
 
     def test_req_start_API6(self):
-        start_val, end_val, continuous_reporting, crc8 = 0, 10, True, 0xb9
+        start_val, end_val, continuous_reporting, disable_hardware_beep = 0, 10, True, False
         expected_result = (bytes([Token.cnfStart.value, 0]), Token.cnfStart, 0)
         self.comm_dummy.req_start_API6(start_val, end_val,
-                                       continuous_reporting)
+                                       continuous_reporting,
+                                       disable_hardware_beep)
         bytes_read = self.comm_dummy.update_API6()
         assert bytes_read == expected_result
 
@@ -86,9 +87,10 @@ def test_cnf_line_API6(self):
 
     def test_req_line_API6(self):
         self.comm_dummy.open_serial()
-        start_val, end_val, continuous_reporting = 0, 10, True
+        start_val, end_val, continuous_reporting, disable_hardware_beep = 0, 10, True, False
         self.comm_dummy.req_start_API6(start_val, end_val,
-                                       continuous_reporting)
+                                       continuous_reporting,
+                                       disable_hardware_beep)
         self.comm_dummy.update_API6()  # cnfStart
 
         for i in range(0, 256):