Skip to content

Commit 1790a67

Browse files
swoboda1337bdraco
andauthored
[sx127x] Add sx127x component (#4278)
Co-authored-by: Jonathan Swoboda <jonathan.swoboda> Co-authored-by: J. Nick Koston <nick@koston.org>
1 parent b27b97a commit 1790a67

File tree

6 files changed

+481
-1
lines changed

6 files changed

+481
-1
lines changed

components/images/sx127x-full.png

500 KB
Loading

components/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1073,6 +1073,7 @@ ESPHome to cellular networks. **Does not encompass Wi-Fi.**
10731073
Remote Transmitter, components/remote_transmitter, remote.svg, dark-invert
10741074
RF Bridge, components/rf_bridge, rf_bridge.jpg
10751075
SIM800L, components/sim800l, sim800l.jpg
1076+
SX127x, components/sx127x, sx127x.png
10761077

10771078
Miscellaneous Components
10781079
------------------------

components/packet_transport/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Packet Transport Component
1111
The purpose of this component is to allow ESPHome nodes to directly communicate with each over a communication channel.
1212
It permits the state of sensors and binary sensors to be transmitted from one node to another, without the need for a
1313
central server or broker. The actual transport channel is provided by another component. Currently the supported
14-
transports are :doc:`/components/udp` and :doc:`/components/uart`.
14+
transports are :doc:`/components/sx127x`, :doc:`/components/uart` and :doc:`/components/udp`.
1515

1616
Nodes may be *providers* which transmit or broadcast sensor data, or *consumers* which receive sensor data from one or more
1717
providers. A node may be both a provider and a consumer. Optional security is provided by one or more of:
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.. sx127x-packet-transport:
2+
3+
SX127x Packet Transport Platform
4+
================================
5+
6+
.. seo::
7+
:description: Instructions for setting up a sx127x packet transport platform on ESPHome
8+
:image: sx127x.png
9+
:keywords: sx127x, packet, transport
10+
11+
The :ref:`packet-transport` platform allows ESPHome nodes to directly communicate with each over a
12+
communication channel. The :doc:`/components/sx127x` implementation of the platform uses FSK, OOK or
13+
LoRa as a communication medium. See the :ref:`packet-transport` and :ref:`sx127x` for more information.
14+
15+
Example Configuration
16+
---------------------
17+
18+
.. code-block:: yaml
19+
20+
# Example configuration entry
21+
sx127x:
22+
dio0_pin: GPIO26
23+
cs_pin: GPIO18
24+
rst_pin: GPIO23
25+
pa_pin: BOOST
26+
pa_power: 8
27+
bandwidth: 125_0kHz
28+
crc_enable: true
29+
frequency: 433920000
30+
modulation: LORA
31+
rx_start: true
32+
sync_value: 0x33
33+
spreading_factor: 7
34+
coding_rate: CR_4_5
35+
36+
packet_transport:
37+
platform: sx127x
38+
sensors:
39+
- dht_temp
40+
41+
sensor:
42+
- platform: dht
43+
id: dht
44+
pin: GPIOXX
45+
temperature:
46+
name: "Temperature"
47+
id: dht_temp
48+
49+
50+
See Also
51+
--------
52+
53+
- :ref:`packet-transport`
54+
- :doc:`/components/sx127x`
55+
- :doc:`/components/binary_sensor/packet_transport`
56+
- :doc:`/components/sensor/packet_transport`
57+
- :ref:`automation`
58+
- :apiref:`packet_transport/packet_transport.h`
59+
- :ghedit:`Edit`

0 commit comments

Comments
 (0)