Skip to content

Commit 3ae418f

Browse files
author
Jonathan Swoboda
committed
Final pass
1 parent eabf23d commit 3ae418f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

components/sx127x.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@ Configuration variables:
3737

3838
- **rst_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): Reset pin.
3939
- **nss_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): SPI select pin.
40-
- **dio0_pin** (**Optional**, :ref:`Pin Schema <config-pin_schema>`): Digital IO pin 0, required in
40+
- **dio0_pin** (**Optional**, :ref:`Pin Schema <config-pin_schema>`): Digital IO pin 0, only required in
4141
packet mode.
42+
- **dio2_pin** (**Optional**, :ref:`Pin Schema <config-pin_schema>`): Digital IO pin 2, only required for
43+
FSK debug.
4244
- **frequency** (**Required**, int): Frequency in Hz of the transceiver.
4345
- **modulation** (**Required**, enum): Modulation can be ``OOK`` or ``FSK``.
4446
- **payload_length** (**Optional**, int): If greater than zero packet mode is enabled, otherwise
@@ -54,13 +56,11 @@ Configuration variables:
5456
- **preamble_polarity** (**Optional**, int): Polarity of the preamble, either 0xAA or 0x55.
5557
- **preamble_errors** (**Optional**, int): Number of chip errors tolerated in the receiver.
5658
- **sync_value** (**Optional**, list): Synchronization bytes found after the preamble and before the
57-
payload. Required in packet mode.
59+
payload.
5860

5961
Receiver configuration variables:
6062
*********************************
6163

62-
- **dio2_pin** (**Optional**, :ref:`Pin Schema <config-pin_schema>`): Digital IO pin 2, required for
63-
``rx_duration``.
6464
- **rx_start** (**Optional**, bool): Start the receiver automatically on boot.
6565
- **rx_bandwidth** (**Optional**, enum): Receive bandwidth can be ``2_6kHz``, ``3_1kHz``, ``3_9kHz``,
6666
``5_2kHz``, ``6_3kHz``, ``7_8kHz``, ``10_4kHz``, ``12_5kHz``, ``15_6kHz``, ``20_8kHz``, ``25_0kHz``,
@@ -71,9 +71,9 @@ Receiver configuration variables:
7171
(ie closer to -128) too much noise will get through. When receiving FSK without a preamble configured
7272
``rx_floor`` is used to trigger the receiver.
7373
- **rx_duration** (**Optional**, int or :ref:`config-time`): Requires ``dio0_pin`` and ``dio2_pin`` to be
74-
configured in continuous mode. It is recommended to use ``rx_duration`` for FSK debug only. The FSK
75-
demodulator unlike OOK cannot be gated by signal strength. In order isolate the wanted signal DIO2
76-
can be gated until the receiver is triggered by either ``rx_floor`` or preamble detection.
74+
configured in continuous mode. The FSK demodulator, unlike OOK, cannot be gated by signal strength. In
75+
order to isolate the wanted signal DIO2 can be gated until the receiver is triggered by ``rx_floor`` or
76+
preamble detection. Intended for FSK debug, packet mode is recommended for FSK.
7777

7878
Transmit configuration variables:
7979
*********************************

0 commit comments

Comments
 (0)