1
0

_cli.py 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. # python-cc1101 - Python Library to Transmit RF Signals via CC1101 Transceivers
  2. #
  3. # Copyright (C) 2020 Fabian Peter Hammerle <fabian@hammerle.me>
  4. #
  5. # This program is free software: you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation, either version 3 of the License, or
  8. # any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program. If not, see <https://www.gnu.org/licenses/>.
  17. import argparse
  18. import logging
  19. import sys
  20. import typing
  21. import cc1101
  22. import cc1101.options
  23. _LOGGER = logging.getLogger(__name__)
  24. def _add_common_args(argparser: argparse.ArgumentParser) -> None:
  25. argparser.add_argument("-f", "--base-frequency-hertz", type=int)
  26. argparser.add_argument("-r", "--symbol-rate-baud", type=int)
  27. argparser.add_argument(
  28. "-s",
  29. "--sync-mode",
  30. type=str,
  31. choices=[m.name.lower().replace("_", "-") for m in cc1101.options.SyncMode],
  32. )
  33. argparser.add_argument(
  34. "-l",
  35. "--packet-length-mode",
  36. type=str,
  37. choices=[m.name.lower() for m in cc1101.options.PacketLengthMode],
  38. )
  39. argparser.add_argument("--disable-checksum", action="store_true")
  40. argparser.add_argument(
  41. "-p",
  42. "--output-power",
  43. metavar="SETTING",
  44. dest="output_power_settings",
  45. type=int,
  46. nargs="+",
  47. help="Configures output power levels by setting PATABLE and FREND0.PA_POWER."
  48. " Up to 8 bytes may be provided."
  49. # add when making _set_modulation_format() public
  50. # ' "[PATABLE] provides flexible PA power ramp up and ramp down'
  51. # " at the start and end of transmission when using 2-FSK, GFSK,"
  52. # ' 4-FSK, and MSK modulation as well as ASK modulation shaping."'
  53. " For OOK modulation, exactly 2 bytes must be provided:"
  54. " 0 to turn off the transmission for logical 0,"
  55. " and a level > 0 to turn on the transmission for logical 1"
  56. " (e.g., --output-power 0 198)."
  57. ' See "Table 39: Optimum PATABLE Settings for Various Output Power Levels [...]"'
  58. ' and section "24 Output Power Programming".',
  59. )
  60. argparser.add_argument("-d", "--debug", action="store_true")
  61. def _init_logging(args: argparse.Namespace) -> None:
  62. logging.basicConfig(
  63. level=logging.DEBUG if args.debug else logging.INFO,
  64. format=(
  65. "%(asctime)s:%(levelname)s:%(name)s:%(funcName)s:%(message)s"
  66. if args.debug
  67. else "%(message)s"
  68. ),
  69. datefmt="%Y-%m-%dT%H:%M:%S%z",
  70. )
  71. def _configure_via_args(
  72. *,
  73. transceiver: cc1101.CC1101,
  74. args: argparse.Namespace,
  75. packet_length_if_fixed: typing.Optional[int],
  76. ) -> None:
  77. if args.base_frequency_hertz:
  78. transceiver.set_base_frequency_hertz(args.base_frequency_hertz)
  79. if args.symbol_rate_baud:
  80. transceiver.set_symbol_rate_baud(args.symbol_rate_baud)
  81. if args.sync_mode:
  82. transceiver.set_sync_mode(
  83. cc1101.options.SyncMode[args.sync_mode.upper().replace("-", "_")]
  84. )
  85. if args.packet_length_mode:
  86. packet_length_mode = cc1101.options.PacketLengthMode[
  87. args.packet_length_mode.upper()
  88. ]
  89. # default: variable length
  90. transceiver.set_packet_length_mode(packet_length_mode)
  91. # default: 255 (maximum)
  92. if (
  93. packet_length_if_fixed is not None
  94. and packet_length_mode == cc1101.options.PacketLengthMode.FIXED
  95. ):
  96. transceiver.set_packet_length_bytes(packet_length_if_fixed)
  97. if args.disable_checksum:
  98. transceiver.disable_checksum()
  99. if args.output_power_settings:
  100. transceiver.set_output_power(args.output_power_settings)
  101. def _export_config():
  102. argparser = argparse.ArgumentParser(
  103. description="Export values in CC1101's configuration registers"
  104. " after applying settings specified via command-line arguments & options",
  105. allow_abbrev=False,
  106. )
  107. _add_common_args(argparser)
  108. argparser.add_argument("--format", choices=["python-list"], default="python-list")
  109. args = argparser.parse_args()
  110. _init_logging(args)
  111. _LOGGER.debug("args=%r", args)
  112. with cc1101.CC1101(lock_spi_device=True) as transceiver:
  113. _configure_via_args(
  114. transceiver=transceiver, args=args, packet_length_if_fixed=None
  115. )
  116. _LOGGER.info("%s", transceiver)
  117. print("[")
  118. for register_index, (register, value) in enumerate(
  119. transceiver.get_configuration_register_values().items()
  120. ):
  121. assert register_index == register.value
  122. print(
  123. "0b{value:08b}, # 0x{value:02x} {register_name}".format(
  124. value=value, register_name=register.name
  125. )
  126. )
  127. print("]")
  128. print(
  129. # pylint: disable=protected-access; internal function & method
  130. "# PATABLE = "
  131. + cc1101._format_patable(transceiver._get_patable(), insert_spaces=True)
  132. )
  133. def _transmit():
  134. argparser = argparse.ArgumentParser(
  135. description="Transmits the payload provided via standard input (stdin)"
  136. " ASK/OOK-modulated in big-endian bit order.",
  137. allow_abbrev=False,
  138. )
  139. _add_common_args(argparser)
  140. args = argparser.parse_args()
  141. _init_logging(args)
  142. _LOGGER.debug("args=%r", args)
  143. payload = sys.stdin.buffer.read()
  144. # configure transceiver after reading from stdin
  145. # to avoid delay between configuration and transmission if pipe is slow
  146. with cc1101.CC1101(lock_spi_device=True) as transceiver:
  147. _configure_via_args(
  148. transceiver=transceiver, args=args, packet_length_if_fixed=len(payload)
  149. )
  150. _LOGGER.info("%s", transceiver)
  151. transceiver.transmit(payload)