You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
LoRa-RF Python is a library for basic transmitting and receiving data using LoRa module with Semtech SX126x series or LLCC68. The library works by interfacing SPI port and some GPIO pins under linux kernel. Support configuring frequency, modulation parameter, transmit power, receive gain and other RF parameters on both LoRa and FSK modulation also support handling transmit and receive using interrupt signal.
12
12
13
-
This readme written for quick start guide. Visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki) for complete documentation.
13
+
This readme is written for quick start guide. Visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki) for complete documentation.
14
14
15
15
## Hardware Compatibility
16
16
@@ -45,9 +45,9 @@ python3 setup.py bdist_wheel
45
45
pip3 install dist/LoRaRF-1.3.0-py3-none-any.whl
46
46
```
47
47
48
-
## Using LoRaRF Library
48
+
## Initialization
49
49
50
-
First you must include`SX126x` python module depending LoRa module you use. Then create an object from module you just import.
50
+
To work with the library, first you must import`SX126x` python module. Then initialize the module by creating an object.
51
51
52
52
```python
53
53
from LoRaRF import SX126x
@@ -102,7 +102,7 @@ LoRa.begin()
102
102
103
103
## Modem Configuration
104
104
105
-
Before transmit or receive operation you can configure transmit power and receive gain or matching frequency, modulation parameter, packet parameter, and synchronize word with other LoRa device you want connect.
105
+
Before transmit or receive operation you can configure transmit power and receive gain or matching frequency, modulation parameter, packet parameter, and synchronize word with other LoRa device you want communicate.
106
106
107
107
### Transmit Power
108
108
@@ -165,7 +165,7 @@ LoRa.wait()
165
165
counter +=1
166
166
```
167
167
168
-
For more detail about transmit operation, please visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki).
168
+
For more detail about transmit operation, please visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki/Transmit-Operation).
169
169
170
170
## Receive Operation
171
171
@@ -182,12 +182,16 @@ while LoRa.available() > 1 :
182
182
counter = LoRa.read() # read single byte
183
183
```
184
184
185
-
For more detail about receive operation, please visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki).
185
+
For more detail about receive operation, please visit this [link](https://github.com/chandrawi/LoRaRF-Python/wiki/Receive-Operation).
186
186
187
187
## Examples
188
188
189
-
See examples for [SX126x](https://github.com/chandrawi/LoRaRF-Python/tree/main/examples/SX126x), [SX127x](https://github.com/chandrawi/LoRaRF-Python/tree/main/examples/SX127x), and [simple network implementation](https://github.com/chandrawi/LoRaRF-Python/tree/main/examples/network).
189
+
See examples for [SX126x](https://github.com/chandrawi/LoRaRF-Python/tree/main/examples/SX126x) and [simple network implementation](https://github.com/chandrawi/LoRaRF-Python/tree/main/examples/network).
190
190
191
-
## Licence
191
+
## License
192
192
193
-
This library published under [MIT licence](https://github.com/chandrawi/LoRaRF-Python/blob/main/LICENSE).
193
+
This library published under [MIT license](https://github.com/chandrawi/LoRaRF-Python/blob/main/LICENSE).
0 commit comments