rename "output_power_setting" to "power_setting"

CHANGELOG.md

@@ -6,9 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- constant `DEFAULT_OUTPUT_POWER_SETTING`
-- methods `RemoteControl.turn_on/off`: optional keyword argument `output_power_setting`
-- command `intertechno-cc1101`: added option `-p` / `--power-setting`
+- constant `DEFAULT_POWER_SETTING`
+- methods `RemoteControl.turn_on/off`: optional keyword argument `power_setting`
+- command `intertechno-cc1101`: option `-p` / `--power-setting`
 
 ### Changed
 - command `intertechno-cc1101`: no longer allow abbreviation of options / flags

intertechno_cc1101/__init__.py

@@ -12,14 +12,12 @@ _MESSAGE_LENGTH_BITS = (
 
 # > [...] default PATABLE setting (0xC6).
 # "24 Output Power Programming" in CC1101's docs
-DEFAULT_OUTPUT_POWER_SETTING = 0xC6
+DEFAULT_POWER_SETTING = 0xC6
 
 _LOGGER = logging.getLogger(__name__)
 
 
-def _cc1101_transmit(
-    payload: bytes, output_power_setting: int, repeats: int = 3
-) -> None:
+def _cc1101_transmit(payload: bytes, power_setting: int, repeats: int = 3) -> None:
     with cc1101.CC1101(lock_spi_device=True) as transceiver:
         transceiver.set_base_frequency_hertz(433.93e6)
         transceiver.set_symbol_rate_baud(3942)
@@ -27,7 +25,7 @@ def _cc1101_transmit(
         transceiver.set_packet_length_mode(cc1101.PacketLengthMode.FIXED)
         transceiver.set_packet_length_bytes(len(payload))
         transceiver.disable_checksum()
-        transceiver.set_output_power((0, output_power_setting))  # OOK
+        transceiver.set_output_power((0, power_setting))  # OOK
         _LOGGER.info("%s", transceiver)
         for _ in range(repeats):
             transceiver.transmit(payload)
@@ -65,7 +63,7 @@ class RemoteControl:
         self._address = address
 
     def _send_command(
-        self, command: int, button_index: int, output_power_setting: int
+        self, command: int, button_index: int, power_setting: int
     ) -> None:
         assert 0 <= command < 2 ** _COMMAND_LENGTH_BITS
         if not isinstance(button_index, int):
@@ -92,32 +90,32 @@ class RemoteControl:
                 << _BUTTON_INDEX_LENGTH_BITS
                 | button_index
             ),
-            output_power_setting=output_power_setting,
+            power_setting=power_setting,
         )
 
     def turn_on(
         self,
         button_index: int,
-        output_power_setting: int = DEFAULT_OUTPUT_POWER_SETTING,
+        power_setting: int = DEFAULT_POWER_SETTING,
     ) -> None:
         """
         Consult section "Table 39: Optimum PATABLE Settings
         for Various Output Power Levels and Frequency Bands [...]"
-        in CC1101's official documentation for `output_power_setting`.
+        in CC1101's official documentation for `power_setting`.
         """
         self._send_command(
             command=0b01,
             button_index=button_index,
-            output_power_setting=output_power_setting,
+            power_setting=power_setting,
         )
 
     def turn_off(
         self,
         button_index: int,
-        output_power_setting: int = DEFAULT_OUTPUT_POWER_SETTING,
+        power_setting: int = DEFAULT_POWER_SETTING,
     ) -> None:
         self._send_command(
             command=0b00,
             button_index=button_index,
-            output_power_setting=output_power_setting,
+            power_setting=power_setting,
         )

intertechno_cc1101/_cli.py

@@ -39,7 +39,7 @@ def _main():
         "-p",
         "--power-setting",
         type=int,
-        default=intertechno_cc1101.DEFAULT_OUTPUT_POWER_SETTING,
+        default=intertechno_cc1101.DEFAULT_POWER_SETTING,
         help='see "Table 39: Optimum PATABLE Settings for Various Output Power Levels […]"'
         " in CC1101's docs (default: %(default)d / 0x%(default)X)",
     )
@@ -56,9 +56,9 @@ def _main():
     remote_control = intertechno_cc1101.RemoteControl(address=args.address)
     if args.turn_on:
         remote_control.turn_on(
-            button_index=args.button_index, output_power_setting=args.power_setting
+            button_index=args.button_index, power_setting=args.power_setting
         )
     elif args.turn_off:
         remote_control.turn_off(
-            button_index=args.button_index, output_power_setting=args.power_setting
+            button_index=args.button_index, power_setting=args.power_setting
         )

tests/test_cc1101_config.py

@@ -15,11 +15,11 @@ import intertechno_cc1101
         b"\xa0\xa0\x82\xa0\x82\xa0\xa0\x82\x82\x82\xa0\xa0\x82\xa0\xa0\xa0\xa0\x80",
     ),
 )
-@pytest.mark.parametrize("output_power_setting", (0xC6, 0xC0))
-def test__cc1101_transmit(payload, output_power_setting):
+@pytest.mark.parametrize("power_setting", (0xC6, 0xC0))
+def test__cc1101_transmit(payload, power_setting):
     with unittest.mock.patch("cc1101.CC1101") as transceiver_class_mock:
         intertechno_cc1101._cc1101_transmit(
-            payload=payload, output_power_setting=output_power_setting
+            payload=payload, power_setting=power_setting
         )
     transceiver_class_mock.assert_called_once_with(lock_spi_device=True)
     method_calls = transceiver_class_mock().__enter__().mock_calls
@@ -30,7 +30,7 @@ def test__cc1101_transmit(payload, output_power_setting):
         unittest.mock.call.set_packet_length_mode(cc1101.PacketLengthMode.FIXED),
         unittest.mock.call.set_packet_length_bytes(35),
         unittest.mock.call.disable_checksum(),
-        unittest.mock.call.set_output_power((0, output_power_setting)),
+        unittest.mock.call.set_output_power((0, power_setting)),
     ]
     transmit_call = method_calls[-3]
     assert transmit_call == ("transmit", (payload,), {})

tests/test_cli.py

@@ -27,11 +27,11 @@ def test__main(argv, address, button_index, turn_on, power_setting):
     remote_control_class_mock.assert_called_once_with(address=address)
     if turn_on:
         remote_control_class_mock().turn_on.assert_called_once_with(
-            button_index=button_index, output_power_setting=power_setting
+            button_index=button_index, power_setting=power_setting
         )
         remote_control_class_mock().turn_off.assert_not_called()
     else:
         remote_control_class_mock().turn_off.assert_called_once_with(
-            button_index=button_index, output_power_setting=power_setting
+            button_index=button_index, power_setting=power_setting
         )
         remote_control_class_mock().turn_on.assert_not_called()

tests/test_remote_control.py

@@ -17,10 +17,8 @@ def test___init___invalid_address(address):
     ("address", "button_index", "command", "expected_message"),
     ((12345678, 0, 0b00, 790123392), (2 ** 26 - 1, 0b1111, 0b01, 4294967263)),
 )
-@pytest.mark.parametrize("output_power_setting", (0xC6, 0x84))
-def test__send_command(
-    address, button_index, command, expected_message, output_power_setting
-):
+@pytest.mark.parametrize("power_setting", (0xC6, 0x84))
+def test__send_command(address, button_index, command, expected_message, power_setting):
     remote_control = intertechno_cc1101.RemoteControl(address=address)
     with unittest.mock.patch(
         "intertechno_cc1101._encode_message", return_value=b"dummy"
@@ -30,12 +28,10 @@ def test__send_command(
         remote_control._send_command(
             button_index=button_index,
             command=command,
-            output_power_setting=output_power_setting,
+            power_setting=power_setting,
         )
     encode_message_mock.assert_called_once_with(expected_message)
-    transmit_mock.assert_called_once_with(
-        b"dummy", output_power_setting=output_power_setting
-    )
+    transmit_mock.assert_called_once_with(b"dummy", power_setting=power_setting)
 
 
 @pytest.mark.parametrize("button_index", (-1, 2 ** 6, 8.15))
@@ -43,7 +39,7 @@ def test__send_command_invalid_button_index(button_index):
     remote_control = intertechno_cc1101.RemoteControl(address=12345678)
     with pytest.raises(ValueError):
         remote_control._send_command(
-            button_index=button_index, command=0b01, output_power_setting=0xC6
+            button_index=button_index, command=0b01, power_setting=0xC6
         )
 
 
@@ -56,25 +52,23 @@ def test_turn_on(address, button_index):
     ) as send_command_mock:
         remote_control.turn_on(button_index=button_index)
     send_command_mock.assert_called_once_with(
-        button_index=button_index, command=0b01, output_power_setting=0xC6
+        button_index=button_index, command=0b01, power_setting=0xC6
     )
 
 
 @pytest.mark.parametrize("address", [12345678])
 @pytest.mark.parametrize("button_index", [7])
-@pytest.mark.parametrize("output_power_setting", [0x60])
-def test_turn_on_custom_output_power(address, button_index, output_power_setting):
+@pytest.mark.parametrize("power_setting", [0x60])
+def test_turn_on_custom_power(address, button_index, power_setting):
     remote_control = intertechno_cc1101.RemoteControl(address=address)
     with unittest.mock.patch.object(
         remote_control, "_send_command"
     ) as send_command_mock:
-        remote_control.turn_on(
-            button_index=button_index, output_power_setting=output_power_setting
-        )
+        remote_control.turn_on(button_index=button_index, power_setting=power_setting)
     send_command_mock.assert_called_once_with(
         button_index=button_index,
         command=0b01,
-        output_power_setting=output_power_setting,
+        power_setting=power_setting,
     )
 
 
@@ -87,23 +81,21 @@ def test_turn_off(address, button_index):
     ) as send_command_mock:
         remote_control.turn_off(button_index=button_index)
     send_command_mock.assert_called_once_with(
-        button_index=button_index, command=0b00, output_power_setting=0xC6
+        button_index=button_index, command=0b00, power_setting=0xC6
     )
 
 
 @pytest.mark.parametrize("address", [12345678])
 @pytest.mark.parametrize("button_index", [7])
-@pytest.mark.parametrize("output_power_setting", [0x60])
-def test_turn_off_custom_output_power(address, button_index, output_power_setting):
+@pytest.mark.parametrize("power_setting", [0x60])
+def test_turn_off_custom_power(address, button_index, power_setting):
     remote_control = intertechno_cc1101.RemoteControl(address=address)
     with unittest.mock.patch.object(
         remote_control, "_send_command"
     ) as send_command_mock:
-        remote_control.turn_off(
-            button_index=button_index, output_power_setting=output_power_setting
-        )
+        remote_control.turn_off(button_index=button_index, power_setting=power_setting)
     send_command_mock.assert_called_once_with(
         button_index=button_index,
         command=0b00,
-        output_power_setting=output_power_setting,
+        power_setting=power_setting,
     )