Compare commits

..

1 commit

Author SHA1 Message Date
jgromes
78220ca665 [CC1101] Added WIP stream mode (#1122) 2024-06-12 19:54:26 +02:00
268 changed files with 8850 additions and 14629 deletions

View file

@ -7,35 +7,15 @@ assignees: ''
--- ---
**IMPORTANT: Check the docs** **IMPORTANT: Check the wiki**
Before submitting new issue, please check the [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and the [API documentation](https://jgromes.github.io/RadioLib/). If you are seeing an error code, we have [online status code decoder](https://radiolib-org.github.io/status_decoder/decode.html). Before submitting new issue, please check the [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and the [API documentation](https://jgromes.github.io/RadioLib/). You might find a solution to your issue there.
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. When applicable, please include [debug mode output](https://github.com/jgromes/RadioLib/wiki/Debug-mode) **using the appropriate debug mode**. A clear and concise description of what the bug is. When applicable, please include [debug mode output](https://github.com/jgromes/RadioLib/wiki/Debug-mode) **using the appropriate debug mode**.
<details><summary>Debug mode output</summary>
<p>
```
paste the debug output here
```
</p>
</details>
**To Reproduce** **To Reproduce**
Minimal Arduino sketch to reproduce the behavior. Please use Markdown to style the code to make it readable (see [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code)). Minimal Arduino sketch to reproduce the behavior. Please use Markdown to style the code to make it readable (see [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code)).
<details><summary>Sketch that is causing the module fail</summary>
<p>
```c++
paste the sketch here, even if it is an unmodified example code
```
</p>
</details>
**Expected behavior** **Expected behavior**
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
@ -47,4 +27,4 @@ If applicable, add screenshots to help explain your problem.
- Link to Arduino core: [e.g. https://github.com/stm32duino/Arduino_Core_STM32 when using official STM32 core. See readme for links to all supported cores] - Link to Arduino core: [e.g. https://github.com/stm32duino/Arduino_Core_STM32 when using official STM32 core. See readme for links to all supported cores]
- Wireless module type [e.g. CC1101, SX1268, etc.] - Wireless module type [e.g. CC1101, SX1268, etc.]
- Arduino IDE version [e.g. 1.8.5] - Arduino IDE version [e.g. 1.8.5]
- Library version [e.g. 3.0.0 or git hash] - Library version [e.g. 3.0.0]

View file

@ -7,8 +7,8 @@ assignees: ''
--- ---
**IMPORTANT: Check the docs** **IMPORTANT: Check the wiki**
Before submitting new issue, please check the [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and the [API documentation](https://jgromes.github.io/RadioLib/). If you are seeing an error code, we have [online status code decoder](https://radiolib-org.github.io/status_decoder/decode.html). Before submitting new issue, please check the [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and the [API documentation](https://jgromes.github.io/RadioLib/). You might find a solution to your issue there.
**Is your feature request related to a problem? Please describe.** **Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

View file

@ -9,40 +9,26 @@ assignees: ''
**IMPORTANT: Before submitting an issue, please check the following:** **IMPORTANT: Before submitting an issue, please check the following:**
1. **Read [CONTRIBUTING.md](https://github.com/jgromes/RadioLib/blob/master/CONTRIBUTING.md)!** Issues that do not follow this document will be closed/locked/deleted/ignored. 1. **Read [CONTRIBUTING.md](https://github.com/jgromes/RadioLib/blob/master/CONTRIBUTING.md)!** Issues that do not follow this document will be closed/locked/deleted/ignored.
2. RadioLib has a [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and an extensive [API documentation](https://jgromes.github.io/RadioLib/). If you are seeing an error code, we have [online status code decoder](https://radiolib-org.github.io/status_decoder/decode.html). 2. RadioLib has a [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and an extensive [API documentation](https://jgromes.github.io/RadioLib/). You might find a solution to your issue there.
3. Make sure you're using the latest release of the library! Releases can be found [here](https://github.com/jgromes/RadioLib/releases). 3. Make sure you're using the latest release of the library! Releases can be found [here](https://github.com/jgromes/RadioLib/releases).
4. Use [Arduino forums](https://forum.arduino.cc/) to ask generic questions about wireless modules, wiring, usage, etc. Only create issues for problems specific to RadioLib! 4. Use [Arduino forums](https://forum.arduino.cc/) to ask generic questions about wireless modules, wiring, usage, etc. Only create issues for problems specific to RadioLib!
5. Error codes, their meaning and how to fix them can be found on [this page](https://jgromes.github.io/RadioLib/group__status__codes.html). 5. Error codes, their meaning and how to fix them can be found on [this page](https://jgromes.github.io/RadioLib/group__status__codes.html).
<details><summary>Sketch that is causing the module fail</summary> **Sketch that is causing the module fail**
<p>
```c++ ```c++
paste the sketch here, even if it is an unmodified example code paste the sketch here, even if it is an unmodified example code
``` ```
</p>
</details>
**Hardware setup** **Hardware setup**
Wiring diagram, schematic, pictures etc. Wiring diagram, schematic, pictures etc.
**Debug mode output** **Debug mode output**
Enable the appropriate [debug levels](https://github.com/jgromes/RadioLib/wiki/Debug-mode) and paste the Serial monitor output here. For debugging protocols, enable `RADIOLIB_DEBUG_PROTOCOL`. For debugging issues with the radio module itself, enable `RADIOLIB_DEBUG_SPI`. Enable the appropriate [debug levels](https://github.com/jgromes/RadioLib/wiki/Debug-mode) and paste the Serial monitor output here. For debugging protocols, enable `RADIOLIB_DEBUG_PROTOCOL`. For debugging issues with the radio module itself, enable `RADIOLIB_DEBUG_SPI`.
<details><summary>Debug mode output</summary>
<p>
```
paste the debug output here
```
</p>
</details>
**Additional info (please complete):** **Additional info (please complete):**
- MCU: [e.g. Arduino Uno, ESP8266 etc.] - MCU: [e.g. Arduino Uno, ESP8266 etc.]
- Link to Arduino core: [e.g. https://github.com/stm32duino/Arduino_Core_STM32 when using official STM32 core. See readme for links to all supported cores] - Link to Arduino core: [e.g. https://github.com/stm32duino/Arduino_Core_STM32 when using official STM32 core. See readme for links to all supported cores]
- Wireless module type [e.g. CC1101, SX1268, etc.] - Wireless module type [e.g. CC1101, SX1268, etc.]
- Arduino IDE version [e.g. 1.8.5] - Arduino IDE version [e.g. 1.8.5]
- Library version [e.g. 3.0.0 or git hash] - Library version [e.g. 3.0.0]

View file

@ -9,7 +9,7 @@ assignees: ''
**IMPORTANT: Before submitting an issue, please check the following:** **IMPORTANT: Before submitting an issue, please check the following:**
1. **Read [CONTRIBUTING.md](https://github.com/jgromes/RadioLib/blob/master/CONTRIBUTING.md)!** Issues that do not follow this document will be closed/locked/deleted/ignored. 1. **Read [CONTRIBUTING.md](https://github.com/jgromes/RadioLib/blob/master/CONTRIBUTING.md)!** Issues that do not follow this document will be closed/locked/deleted/ignored.
2. RadioLib has a [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and an extensive [API documentation](https://jgromes.github.io/RadioLib/). If you are seeing an error code, we have [online status code decoder](https://radiolib-org.github.io/status_decoder/decode.html). 2. RadioLib has a [Troubleshooting Guide](https://github.com/jgromes/RadioLib/wiki/Troubleshooting-Guide) Wiki page and an extensive [API documentation](https://jgromes.github.io/RadioLib/). You might find a solution to your issue there.
3. Make sure you're using the latest release of the library! Releases can be found [here](https://github.com/jgromes/RadioLib/releases). 3. Make sure you're using the latest release of the library! Releases can be found [here](https://github.com/jgromes/RadioLib/releases).
4. Use [Arduino forums](https://forum.arduino.cc/) to ask generic questions about wireless modules, wiring, usage, etc. Only create issues for problems specific to RadioLib! 4. Use [Arduino forums](https://forum.arduino.cc/) to ask generic questions about wireless modules, wiring, usage, etc. Only create issues for problems specific to RadioLib!
5. Error codes, their meaning and how to fix them can be found on [this page](https://jgromes.github.io/RadioLib/group__status__codes.html). 5. Error codes, their meaning and how to fix them can be found on [this page](https://jgromes.github.io/RadioLib/group__status__codes.html).

View file

@ -54,7 +54,7 @@ jobs:
- name: Build example - name: Build example
run: run:
arduino-cli compile --libraries /home/runner/work/RadioLib --fqbn arduino:avr:uno $PWD/examples/SX123x/SX123x_Transmit_Blocking/SX123x_Transmit_Blocking.ino --warnings=all arduino-cli compile --libraries /home/runner/work/RadioLib --fqbn arduino:avr:uno $PWD/examples/SX126x/SX126x_Transmit_Blocking/SX126x_Transmit_Blocking.ino --warnings=all
- name: Perform CodeQL Analysis - name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3 uses: github/codeql-action/analyze@v3

View file

@ -10,11 +10,12 @@ on:
id: id:
description: The ID of the platform on which the build is run description: The ID of the platform on which the build is run
required: true required: true
default: arduino:avr:mega default: arduino:avr:uno
type: choice type: choice
options: options:
- all - all
- none - none
- arduino:avr:uno
- arduino:avr:mega - arduino:avr:mega
- arduino:mbed:nano33ble - arduino:mbed:nano33ble
- arduino:mbed:envie_m4 - arduino:mbed:envie_m4
@ -26,6 +27,7 @@ on:
- esp32:esp32:esp32 - esp32:esp32:esp32
- esp8266:esp8266:generic - esp8266:esp8266:generic
- Intel:arc32:arduino_101 - Intel:arc32:arduino_101
- SparkFun:apollo3:sfe_artemis
- STMicroelectronics:stm32:GenF3:pnum=BLACKPILL_F303CC - STMicroelectronics:stm32:GenF3:pnum=BLACKPILL_F303CC
- STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_WL55JC1 - STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_WL55JC1
- stm32duino:STM32F1:mapleMini - stm32duino:STM32F1:mapleMini
@ -36,7 +38,6 @@ on:
- MegaCore:avr:1281 - MegaCore:avr:1281
- teensy:avr:teensy41 - teensy:avr:teensy41
- arduino:renesas_uno:minima - arduino:renesas_uno:minima
- SiliconLabs:silabs:xg24explorerkit
jobs: jobs:
build: build:
@ -44,6 +45,8 @@ jobs:
matrix: matrix:
# platform-dependent settings - extra board options, board index URLs, skip patterns etc. # platform-dependent settings - extra board options, board index URLs, skip patterns etc.
include: include:
- id: arduino:avr:uno
run: echo "skip-pattern=(STM32WL|SSTV|LoRaWAN|LR11x0_Firmware_Update|Pager)" >> $GITHUB_OUTPUT
- id: arduino:avr:mega - id: arduino:avr:mega
run: | run: |
echo "options=':cpu=atmega2560'" >> $GITHUB_OUTPUT echo "options=':cpu=atmega2560'" >> $GITHUB_OUTPUT
@ -76,23 +79,24 @@ jobs:
- id: esp32:esp32:esp32 - id: esp32:esp32:esp32
run: | run: |
python -m pip install pyserial python -m pip install pyserial
echo "version=2.0.17" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" >> $GITHUB_OUTPUT echo "index-url=--additional-urls https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" >> $GITHUB_OUTPUT
- id: esp8266:esp8266:generic - id: esp8266:esp8266:generic
run: | run: |
echo "skip-pattern=(STM32WL|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT
echo "options=':xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K'" >> $GITHUB_OUTPUT echo "options=':xtal=80,ResetMethod=ck,CrystalFreq=26,FlashFreq=40,FlashMode=qio,eesz=512K'" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json" >> $GITHUB_OUTPUT echo "index-url=--additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json" >> $GITHUB_OUTPUT
- id: STMicroelectronics:stm32:GenF3 - id: SparkFun:apollo3:sfe_artemis
run: |
echo "skip-pattern=(STM32WL|LoRaWAN)" >> $GITHUB_OUTPUT
echo "warnings='none'" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls https://raw.githubusercontent.com/sparkfun/Arduino_Apollo3/master/package_sparkfun_apollo3_index.json" >> $GITHUB_OUTPUT
- id: STMicroelectronics:stm32:GenF3:pnum=BLACKPILL_F303CC
run: | run: |
echo "options=':pnum=BLACKPILL_F303CC'" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json" >> $GITHUB_OUTPUT echo "index-url=--additional-urls https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json" >> $GITHUB_OUTPUT
echo "skip-pattern=(STM32WL|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT echo "skip-pattern=(STM32WL|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT
- id: STMicroelectronics:stm32:Nucleo_64 - id: STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_WL55JC1
run: | run: |
echo "options=':pnum=NUCLEO_WL55JC1'" >> $GITHUB_OUTPUT
# Do *not* skip STM32WL examples # Do *not* skip STM32WL examples
echo "skip-pattern=(LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT echo "skip-pattern='LR11x0_Firmware_Update'" >> $GITHUB_OUTPUT
echo "index-url=--additional-urls https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json" >> $GITHUB_OUTPUT echo "index-url=--additional-urls https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json" >> $GITHUB_OUTPUT
- id: stm32duino:STM32F1:mapleMini - id: stm32duino:STM32F1:mapleMini
run: | run: |
@ -102,7 +106,7 @@ jobs:
- id: MegaCoreX:megaavr:4809 - id: MegaCoreX:megaavr:4809
run: | run: |
echo "index-url=--additional-urls https://mcudude.github.io/MegaCoreX/package_MCUdude_MegaCoreX_index.json" >> $GITHUB_OUTPUT echo "index-url=--additional-urls https://mcudude.github.io/MegaCoreX/package_MCUdude_MegaCoreX_index.json" >> $GITHUB_OUTPUT
echo "skip-pattern=(STM32WL|LR11x0_Firmware_Update|LoRaWAN)" >> $GITHUB_OUTPUT echo "skip-pattern=(STM32WL|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT
- id: arduino:mbed_rp2040:pico - id: arduino:mbed_rp2040:pico
- id: rp2040:rp2040:rpipico - id: rp2040:rp2040:rpipico
run: echo "index-url=--additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json" >> $GITHUB_OUTPUT run: echo "index-url=--additional-urls https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json" >> $GITHUB_OUTPUT
@ -121,19 +125,13 @@ jobs:
- id: arduino:renesas_uno:minima - id: arduino:renesas_uno:minima
run: | run: |
echo "skip-pattern=(STM32WL|LoRaWAN|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT echo "skip-pattern=(STM32WL|LoRaWAN|LR11x0_Firmware_Update)" >> $GITHUB_OUTPUT
- id: SiliconLabs:silabs:xg24explorerkit
run: |
echo "index-url=--additional-urls https://siliconlabs.github.io/arduino/package_arduinosilabs_index.json" >> $GITHUB_OUTPUT
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: ${{ matrix.id }} name: ${{ matrix.id }}
env: env:
run-build: ${{ (inputs.id != 'none' && matrix.id == 'arduino:avr:mega') || contains(github.event.head_commit.message, 'CI_BUILD_ALL') || contains(github.event.head_commit.message, 'Bump version to') || contains(github.event.head_commit.message, format('{0}', matrix.id)) || inputs.id == 'all' || inputs.id == matrix.id }} run-build: ${{ (inputs.id != 'none' && matrix.id == 'arduino:avr:uno') || contains(github.event.head_commit.message, 'CI_BUILD_ALL') || contains(github.event.head_commit.message, 'Bump version to') || contains(github.event.head_commit.message, format('{0}', matrix.id)) || inputs.id == 'all' || inputs.id == matrix.id }}
steps: steps:
- name: Free Disk Space (Ubuntu)
uses: jlumbroso/free-disk-space@v1.3.1
- name: Install arduino-cli - name: Install arduino-cli
if: ${{ env.run-build == 'true' }} if: ${{ env.run-build == 'true' }}
run: run:
@ -168,11 +166,7 @@ jobs:
run: run:
| |
arduino-cli core update-index ${{ format('{0}', steps.prep.outputs.index-url) }} arduino-cli core update-index ${{ format('{0}', steps.prep.outputs.index-url) }}
if [ -z '${{ steps.prep.outputs.version }}' ]; then arduino-cli core install ${{ format('{0}:{1} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url) }}
arduino-cli core install ${{ format('{0}:{1} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url) }}
else
arduino-cli core install ${{ format('{0}:{1}@{3} {2}', steps.split.outputs._0, steps.split.outputs._1, steps.prep.outputs.index-url, steps.prep.outputs.version) }}
fi
- name: Checkout repository - name: Checkout repository
if: ${{ env.run-build == 'true' }} if: ${{ env.run-build == 'true' }}
@ -182,64 +176,28 @@ jobs:
if: ${{ env.run-build == 'true' }} if: ${{ env.run-build == 'true' }}
run: run:
| |
cd $PWD/extras/test/ci for example in $(find $PWD/examples -name '*.ino' | sort); do
./build_examples.sh ${{ matrix.id }} "${{ steps.prep.outputs.skip-pattern }}" ${{ steps.prep.outputs.options }} # check whether to skip this sketch
if [ ! -z '${{ steps.prep.outputs.skip-pattern }}' ] && [[ ${example} =~ ${{ steps.prep.outputs.skip-pattern }} ]]; then
- name: Extract short commit hash # skip sketch
id: short-hash echo -e "\n\033[1;33mSkipped ${example##*/} (matched with ${{ steps.prep.outputs.skip-pattern }})\033[0m";
run: echo "::set-output name=short_sha::$(git rev-parse --short HEAD)" else
# apply special flags for LoRaWAN
- name: Parse sizes if [[ ${example} =~ "LoRaWAN" ]]; then
if: ${{ env.run-build == 'true' }} flags="-DRADIOLIB_LORAWAN_DEV_ADDR=0 -DRADIOLIB_LORAWAN_FNWKSINT_KEY=0 -DRADIOLIB_LORAWAN_SNWKSINT_KEY=0 -DRADIOLIB_LORAWAN_NWKSENC_KEY=0 -DRADIOLIB_LORAWAN_APPS_KEY=0 -DRADIOLIB_LORAWAN_APP_KEY=0 -DRADIOLIB_LORAWAN_NWK_KEY=0 -DRADIOLIB_LORAWAN_DEV_EUI=0 -DARDUINO_TTGO_LORA32_V1"
run: fi
|
cd $PWD/extras/test/ci
./parse_size.sh ${{ matrix.id }}
cat size_${{ steps.short-hash.outputs.short_sha }}_${{ steps.split.outputs._0 }}-${{ steps.split.outputs._1 }}-${{ steps.split.outputs._2 }}.csv
- name: Upload size report as artifact
uses: actions/upload-artifact@v4
with:
name: size-file-${{ steps.split.outputs._0 }}-${{ steps.split.outputs._1 }}-${{ steps.split.outputs._2 }}
path: extras/test/ci/size_${{ steps.short-hash.outputs.short_sha }}_${{ steps.split.outputs._0 }}-${{ steps.split.outputs._1 }}-${{ steps.split.outputs._2 }}.csv
metrics: # build sketch
runs-on: ubuntu-latest echo -e "\n\033[1;33mBuilding ${example##*/} ... \033[0m";
needs: build arduino-cli compile --libraries /home/runner/work/RadioLib --fqbn ${{ matrix.id }}${{ steps.prep.outputs.options }} --build-property compiler.cpp.extra_flags="$flags" $example --warnings=${{ steps.prep.outputs.warnings }}
if: github.ref == 'refs/heads/master' if [ $? -ne 0 ]; then
steps: echo -e "\033[1;31m${example##*/} build FAILED\033[0m\n";
- name: Set up SSH exit 1;
run: | else
mkdir -p ~/.ssh echo -e "\033[1;32m${example##*/} build PASSED\033[0m\n";
echo "${{ secrets.ACTIONS_METRICS_DEPLOY_KEY }}" > ~/.ssh/id_rsa fi
chmod 600 ~/.ssh/id_rsa fi
ssh-keyscan github.com >> ~/.ssh/known_hosts done
- name: Clone artifact repo
run:
|
cd $PWD/..
git clone git@github.com:radiolib-org/artifacts.git
cd artifacts
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
- name: Download size artifacts
uses: actions/download-artifact@v4
with:
path: aggregated-sizes
- name: Push size files
run:
|
ls -R aggregated-sizes
mkdir -p $PWD/../artifacts/radiolib-ci/l0
cp aggregated-sizes/*/size_*.csv $PWD/../artifacts/radiolib-ci/l0/.
cd $PWD/../artifacts/radiolib-ci
git add .
COMMIT_URL="https://github.com/jgromes/RadioLib/commit/$GITHUB_SHA"
git commit -m "Push artifacts from $COMMIT_URL"
git push origin main
esp-build: esp-build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -289,11 +247,10 @@ jobs:
run: | run: |
cd $PWD/examples/NonArduino/Tock cd $PWD/examples/NonArduino/Tock
git clone https://github.com/tock/libtock-c.git git clone https://github.com/tock/libtock-c.git
cd libtock-c; git checkout c0202f9ab78da4a6e95f136cf5250701e3778f63; cd ../ cd libtock-c; git checkout dbee65a56d74b4bad166317f199e80b959f7c82c; cd ../
LIBTOCK_C_DIRECTORY="$(pwd)/libtock-c" ./build.sh LIBTOCK_C_DIRECTORY="$(pwd)/libtock-c" ./build.sh
rpi-build: rpi-build:
if: false # self-hosted runner temporarily disabled
runs-on: [self-hosted, ARM64] runs-on: [self-hosted, ARM64]
steps: steps:
- name: Checkout repository - name: Checkout repository
@ -302,14 +259,7 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: | run: |
sudo apt-get update sudo apt-get update
sudo apt-get install -y cmake wget swig python-dev python3-dev python-setuptools python3-setuptools sudo apt-get install -y pigpio cmake
wget http://abyz.me.uk/lg/lg.zip
unzip lg.zip
cd lg
make
sudo make install
cd ..
sudo rm -rf lg
- name: Install the library - name: Install the library
run: | run: |
@ -325,7 +275,6 @@ jobs:
./build.sh ./build.sh
rpi-test: rpi-test:
if: false # self-hosted runner temporarily disabled
needs: rpi-build needs: rpi-build
runs-on: [self-hosted, ARM64] runs-on: [self-hosted, ARM64]
steps: steps:

View file

@ -1,37 +0,0 @@
name: "Release"
on: workflow_dispatch
jobs:
release:
name: Release RadioLib update
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Checkout latest tag
run: git checkout $(git describe --tags $(git rev-list --tags --max-count=1))
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install PlatformIO and ESP-IDF
run: |
pip install --upgrade platformio
pip install --upgrade idf-component-manager
- name: PlatformIO publish
env:
PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }}
run: pio pkg publish --no-interactive
- name: ESP-IDF publish
env:
IDF_COMPONENT_API_TOKEN: ${{ secrets.IDF_COMPONENT_API_TOKEN }}
run: compote component upload --name RadioLib --namespace jgromes

View file

@ -1,48 +0,0 @@
name: "Unit test"
on:
push:
branches: [master]
pull_request:
branches: [master]
workflow_dispatch:
jobs:
unit-test:
name: Build and run unit test
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y libboost-all-dev libfmt-dev lcov
- name: Run unit test
run: |
cd extras/test/unit
./test.sh
- name: Measure test coverage
run: |
cd extras/test/unit
./coverage.sh
- name: Upload coverage report as artifact
uses: actions/upload-artifact@v4
with:
name: coverage_report
path: extras/test/unit/lcov.report
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/master'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: extras/test/unit/lcov.report
destination_dir: coverage
keep_files: true

7
.gitignore vendored
View file

@ -11,6 +11,13 @@
# Jetbrain IDEs # Jetbrain IDEs
.idea .idea
# Debug decoder
extras/decoder/log.txt
extras/decoder/out.txt
# Spectrum scan
extras/SX126x_Spectrum_Scan/out/*
# PlatformIO # PlatformIO
.pio* .pio*

View file

@ -36,7 +36,7 @@ target_include_directories(RadioLib
set_property(TARGET RadioLib PROPERTY CXX_STANDARD 20) set_property(TARGET RadioLib PROPERTY CXX_STANDARD 20)
# enable most warnings # enable most warnings
target_compile_options(RadioLib PRIVATE -Wall -Wextra -Wpedantic -Wdouble-promotion) target_compile_options(RadioLib PRIVATE -Wall -Wextra)
include(GNUInstallDirs) include(GNUInstallDirs)

View file

@ -4,6 +4,8 @@
## Universal wireless communication library for embedded devices ## Universal wireless communication library for embedded devices
## See the [Wiki](https://github.com/jgromes/RadioLib/wiki) and [FAQ](https://github.com/jgromes/RadioLib/wiki/Frequently-Asked-Questions) for further information. See the [GitHub Pages](https://jgromes.github.io/RadioLib) for detailed and up-to-date API reference.
RadioLib allows its users to integrate all sorts of different wireless communication modules, protocols and even digital modes into a single consistent system. RadioLib allows its users to integrate all sorts of different wireless communication modules, protocols and even digital modes into a single consistent system.
Want to add a Bluetooth interface to your LoRa network? Sure thing! Do you just want to go really old-school and play around with radio teletype, slow-scan TV, or even Hellschreiber using nothing but a cheap radio module? Why not! Want to add a Bluetooth interface to your LoRa network? Sure thing! Do you just want to go really old-school and play around with radio teletype, slow-scan TV, or even Hellschreiber using nothing but a cheap radio module? Why not!
@ -11,13 +13,6 @@ RadioLib natively supports Arduino, but can run in non-Arduino environments as w
RadioLib was originally created as a driver for [__RadioShield__](https://github.com/jgromes/RadioShield), but it can be used to control as many different wireless modules as you like - or at least as many as your microcontroller can handle! RadioLib was originally created as a driver for [__RadioShield__](https://github.com/jgromes/RadioShield), but it can be used to control as many different wireless modules as you like - or at least as many as your microcontroller can handle!
### Quick links:
* [__Wiki__](https://github.com/jgromes/RadioLib/wiki) - contains useful general information on using this library
* [__FAQ__](https://github.com/jgromes/RadioLib/wiki/Frequently-Asked-Questions) - frequently asked questions, and answers
* [__API Reference__](https://jgromes.github.io/RadioLib) - full API reference, automatically generated from the source code
* [__Status Code Decoder__](https://radiolib-org.github.io/status_decoder/decode.html) - decoder for status codes returned by RadioLib methods
* [__Debug Log Decoder__](https://radiolib-org.github.io/debug_decoder/decode.html) - decoder for RadioLib SPI debug logs
### Supported modules: ### Supported modules:
* __CC1101__ FSK radio module * __CC1101__ FSK radio module
* __LLCC68__ LoRa module * __LLCC68__ LoRa module
@ -48,13 +43,13 @@ SX127x, RFM9x, SX126x, RF69, SX1231, CC1101, nRF24L01, RFM2x, Si443x, LR11x0 and
SX127x, RFM9x, SX126x, RF69, SX1231, CC1101, nRF24L01, RFM2x, Si443x and SX128x SX127x, RFM9x, SX126x, RF69, SX1231, CC1101, nRF24L01, RFM2x, Si443x and SX128x
* [__POCSAG__](https://www.sigidwiki.com/wiki/POCSAG) using 2-FSK for modules: * [__POCSAG__](https://www.sigidwiki.com/wiki/POCSAG) using 2-FSK for modules:
SX127x, RFM9x, RF69, SX1231, CC1101, nRF24L01, RFM2x and Si443x SX127x, RFM9x, RF69, SX1231, CC1101, nRF24L01, RFM2x and Si443x
* [__LoRaWAN__](https://lora-alliance.org/) using LoRa and FSK for modules: * [__LoRaWAN__](https://lora-alliance.org/) using LoRa for modules:
SX127x, RFM9x, SX126x, LR11x0 and SX128x SX127x, RFM9x, SX126x, LR11x0 and SX128x
* NOTE: LoRaWAN support is currently in beta, feedback via [Issues](https://github.com/jgromes/RadioLib/issues) and [Discussions](https://github.com/jgromes/RadioLib/discussions) is appreciated!
### Supported Arduino platforms: ### Supported Arduino platforms:
* __Arduino__ * __Arduino__
* [__AVR__](https://github.com/arduino/ArduinoCore-avr) - Arduino Uno, Mega, Leonardo, Pro Mini, Nano etc. * [__AVR__](https://github.com/arduino/ArduinoCore-avr) - Arduino Uno, Mega, Leonardo, Pro Mini, Nano etc.
* NOTE: Arduino boards based on ATmega328 (Uno, Pro Mini, Nano etc.) and smaller are NOT recommended. This is because the ATmega328 MCU is very constrained in terms of program and memory size, so the library will end up taking most of the space available.
* [__mbed__](https://github.com/arduino/ArduinoCore-mbed) - Arduino Nano 33 BLE and Arduino Portenta H7 * [__mbed__](https://github.com/arduino/ArduinoCore-mbed) - Arduino Nano 33 BLE and Arduino Portenta H7
* [__megaAVR__](https://github.com/arduino/ArduinoCore-megaavr) - Arduino Uno WiFi Rev.2 and Nano Every * [__megaAVR__](https://github.com/arduino/ArduinoCore-megaavr) - Arduino Uno WiFi Rev.2 and Nano Every
* [__SAM__](https://github.com/arduino/ArduinoCore-sam) - Arduino Due * [__SAM__](https://github.com/arduino/ArduinoCore-sam) - Arduino Due
@ -94,7 +89,4 @@ SX127x, RFM9x, SX126x, LR11x0 and SX128x
* __PJRC__ * __PJRC__
* [__Teensy__](https://github.com/PaulStoffregen/cores) - Teensy 2.x, 3.x and 4.x boards * [__Teensy__](https://github.com/PaulStoffregen/cores) - Teensy 2.x, 3.x and 4.x boards
* __Silicon Labs__
* [__EFR32__](https://github.com/SiliconLabs/arduino) - Silicon Labs xG24, xG27 and other boards
The list above is by no means exhaustive - RadioLib code is independent of the used platform! Compilation of all examples is tested for all platforms officially supported prior to releasing new version. In addition, RadioLib includes an internal hardware abstraction layer, which allows it to be easily ported even to non-Arduino environments. The list above is by no means exhaustive - RadioLib code is independent of the used platform! Compilation of all examples is tested for all platforms officially supported prior to releasing new version. In addition, RadioLib includes an internal hardware abstraction layer, which allows it to be easily ported even to non-Arduino environments.

View file

@ -1,19 +1,19 @@
/* /*
RadioLib AFSK External Radio example RadioLib AFSK External Radio example
This example shows how to use your Arduino This example shows how to use your Arduino
as modulator for an external analogue FM radio. as modulator for an external analogue FM radio.
The example sends APRS position reports with The example sends APRS position reports with
audio modulated as AFSK at 1200 baud using audio modulated as AFSK at 1200 baud using
Bell 202 tones. However, any other AFSK Bell 202 tones. However, any other AFSK
protocol (RTTY, SSTV, etc.) may be used as well. protocol (RTTY, SSTV, etc.) may be used as well.
DO NOT transmit in APRS bands unless DO NOT transmit in APRS bands unless
you have a ham radio license! you have a ham radio license!
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -46,7 +46,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize APRS client // initialize APRS client
@ -58,7 +58,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }
@ -66,20 +66,15 @@ void loop() {
Serial.print(F("[APRS] Sending position ... ")); Serial.print(F("[APRS] Sending position ... "));
// send a location without message or timestamp // send a location without message or timestamp
char destination[] = "N0CALL"; int state = aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E");
char latitude[] = "4911.67N";
char longitude[] = "01635.96E";
int state = aprs.sendPosition(destination, 0, latitude, longitude);
delay(500); delay(500);
// send a location with message and without timestamp // send a location with message and without timestamp
char message[] = "I'm here!"; state |= aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E", "I'm here!");
state |= aprs.sendPosition(destination, 0, latitude, longitude, message);
delay(500); delay(500);
// send a location with message and timestamp // send a location with message and timestamp
char timestamp[] = "093045z"; state |= aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E", "I'm here!", "093045z");
state |= aprs.sendPosition(destination, 0, latitude, longitude, message, timestamp);
delay(500); delay(500);
if(state == RADIOLIB_ERR_NONE) { if(state == RADIOLIB_ERR_NONE) {

View file

@ -1,21 +1,21 @@
/* /*
RadioLib AFSK Imperial March Example RadioLib AFSK Imperial March Example
This example shows how to EXECUTE ORDER 66 This example shows how to EXECUTE ORDER 66
Other modules that can be used for AFSK: Other modules that can be used for AFSK:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -58,7 +58,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AFSK client // initialize AFSK client
@ -69,7 +69,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,7 +1,7 @@
/* /*
Note definitions, melody and melody-related functions Note definitions, melody and melody-related functions
adapted from https://github.com/robsoncouto/arduino-songs adapted from https://github.com/robsoncouto/arduino-songs
by Robson Couto, 2019 by Robson Couto, 2019
*/ */
#define NOTE_B0 31 #define NOTE_B0 31

View file

@ -1,22 +1,22 @@
/* /*
RadioLib AFSK Example RadioLib AFSK Example
This example shows hot to send audio FSK tones This example shows hot to send audio FSK tones
using SX1278's FSK modem. using SX1278's FSK modem.
Other modules that can be used for AFSK: Other modules that can be used for AFSK:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -56,7 +56,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AFSK client // initialize AFSK client
@ -67,7 +67,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,20 +1,20 @@
/* /*
RadioLib AM-modulated AFSK Example RadioLib AM-modulated AFSK Example
This example shows hot to send AM-modulated This example shows hot to send AM-modulated
audio FSK tones using SX1278's OOK modem. audio FSK tones using SX1278's OOK modem.
Other modules that can be used for AFSK: Other modules that can be used for AFSK:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -51,7 +51,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AFSK client // initialize AFSK client
@ -62,7 +62,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// after that, set mode to OOK // after that, set mode to OOK
@ -73,7 +73,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,28 +1,28 @@
/* /*
RadioLib APRS Mic-E Example RadioLib APRS Mic-E Example
This example sends APRS position reports This example sends APRS position reports
encoded in the Mic-E format using SX1278's encoded in the Mic-E format using SX1278's
FSK modem. The data is modulated as AFSK FSK modem. The data is modulated as AFSK
at 1200 baud using Bell 202 tones. at 1200 baud using Bell 202 tones.
DO NOT transmit in APRS bands unless DO NOT transmit in APRS bands unless
you have a ham radio license! you have a ham radio license!
Other modules that can be used for APRS: Other modules that can be used for APRS:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -35,13 +35,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -78,7 +74,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AX.25 client // initialize AX.25 client
@ -92,7 +88,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize APRS client // initialize APRS client
@ -104,7 +100,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,28 +1,28 @@
/* /*
RadioLib APRS Position Example RadioLib APRS Position Example
This example sends APRS position reports This example sends APRS position reports
using SX1278's FSK modem. The data is using SX1278's FSK modem. The data is
modulated as AFSK at 1200 baud using Bell modulated as AFSK at 1200 baud using Bell
202 tones. 202 tones.
DO NOT transmit in APRS bands unless DO NOT transmit in APRS bands unless
you have a ham radio license! you have a ham radio license!
Other modules that can be used for APRS: Other modules that can be used for APRS:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -35,13 +35,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -78,7 +74,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AX.25 client // initialize AX.25 client
@ -92,7 +88,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize APRS client // initialize APRS client
@ -104,54 +100,32 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }
void loop() { void loop() {
Serial.println(F("[APRS] Sending location reports")); Serial.print(F("[APRS] Sending position ... "));
// send a location without message or timestamp // send a location without message or timestamp
char destination[] = "N0CALL"; int state = aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E");
char latitude[] = "4911.67N";
char longitude[] = "01635.96E";
int state = aprs.sendPosition(destination, 0, latitude, longitude);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("[APRS] Failed to send location, code "));
Serial.println(state);
}
delay(500); delay(500);
// send a location with message and without timestamp // send a location with message and without timestamp
char message[] = "I'm here!"; state |= aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E", "I'm here!");
state = aprs.sendPosition(destination, 0, latitude, longitude, message);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("[APRS] Failed to send location and message code "));
Serial.println(state);
}
delay(500); delay(500);
// you can also set repeater callsigns and SSIDs
// up to 8 repeaters may be used
// sendPosition will be sent with "WIDE2-2" path
char* repeaterCallsigns[] = { "WIDE2" };
uint8_t repeaterSSIDs[] = { 2 };
aprs.useRepeaters(repeaterCallsigns, repeaterSSIDs, 1);
// send a location with message and timestamp // send a location with message and timestamp
char timestamp[] = "093045z"; state |= aprs.sendPosition("N0CALL", 0, "4911.67N", "01635.96E", "I'm here!", "093045z");
state = aprs.sendPosition(destination, 0, latitude, longitude, message, timestamp);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("[APRS] Failed to send location, message and timestamp code "));
Serial.println(state);
}
delay(500); delay(500);
// when repeaters are no longer needed, they can be dropped if(state == RADIOLIB_ERR_NONE) {
aprs.dropRepeaters(); Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
}
// wait one minute before transmitting again // wait one minute before transmitting again
Serial.println(F("[APRS] All done!"));
delay(60000); delay(60000);
} }

View file

@ -1,20 +1,20 @@
/* /*
RadioLib APRS Position over LoRa Example RadioLib APRS Position over LoRa Example
This example sends APRS position reports This example sends APRS position reports
using SX1278's LoRa modem. using SX1278's LoRa modem.
Other modules that can be used for APRS: Other modules that can be used for APRS:
- SX127x/RFM9x - SX127x/RFM9x
- SX126x/LLCC68 - SX126x/LLCC68
- SX128x - SX128x
- LR11x0 - LR11x0
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -27,13 +27,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create APRS client instance using the LoRa radio // create APRS client instance using the LoRa radio
APRSClient aprs(&radio); APRSClient aprs(&radio);
@ -58,7 +54,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize APRS client // initialize APRS client
@ -66,14 +62,13 @@ void setup() {
// symbol: '>' (car) // symbol: '>' (car)
// callsign "N7LEM" // callsign "N7LEM"
// SSID 1 // SSID 1
char source[] = "N7LEM"; state = aprs.begin('>', "N7LEM", 1);
state = aprs.begin('>', source, 1);
if(state == RADIOLIB_ERR_NONE) { if(state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!")); Serial.println(F("success!"));
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }
@ -82,12 +77,7 @@ void loop() {
// send a location with message and timestamp // send a location with message and timestamp
// SSID is set to 1, as APRS over LoRa uses WIDE1-1 path by default // SSID is set to 1, as APRS over LoRa uses WIDE1-1 path by default
char destination[] = "GPS"; int state = aprs.sendPosition("GPS", 1, "4911.67N", "01635.96E", "I'm here!", "093045z");
char latitude[] = "4911.67N";
char longitude[] = "01635.96E";
char message[] = "I'm here!";
char timestamp[] = "093045z";
int state = aprs.sendPosition(destination, 1, latitude, longitude, message, timestamp);
delay(500); delay(500);
// you can also send Mic-E encoded messages // you can also send Mic-E encoded messages

View file

@ -1,31 +1,31 @@
/* /*
RadioLib AX.25 Frame Example RadioLib AX.25 Frame Example
This example shows how to send various This example shows how to send various
AX.25 frames using SX1278's FSK modem. AX.25 frames using SX1278's FSK modem.
Other modules that can be used for AX.25: Other modules that can be used for AX.25:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- LR11x0 - LR11x0
Using raw AX.25 frames requires some Using raw AX.25 frames requires some
knowledge of the protocol, refer to knowledge of the protocol, refer to
AX25_Transmit for basic operation. AX25_Transmit for basic operation.
Frames shown in this example are not Frames shown in this example are not
exhaustive; all possible AX.25 frames exhaustive; all possible AX.25 frames
should be supported. should be supported.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -38,13 +38,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AX.25 client instance using the FSK module // create AX.25 client instance using the FSK module
AX25Client ax25(&radio); AX25Client ax25(&radio);
@ -68,7 +64,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AX.25 client // initialize AX.25 client
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,24 +1,24 @@
/* /*
RadioLib AX.25 Transmit Example RadioLib AX.25 Transmit Example
This example sends AX.25 messages using This example sends AX.25 messages using
SX1278's FSK modem. SX1278's FSK modem.
Other modules that can be used for AX.25: Other modules that can be used for AX.25:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- LR11x0 - LR11x0
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -31,13 +31,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AX.25 client instance using the FSK module // create AX.25 client instance using the FSK module
AX25Client ax25(&radio); AX25Client ax25(&radio);
@ -60,7 +56,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AX.25 client // initialize AX.25 client
@ -74,7 +70,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,25 +1,25 @@
/* /*
RadioLib AX.25 Transmit AFSK Example RadioLib AX.25 Transmit AFSK Example
This example sends AX.25 messages using This example sends AX.25 messages using
SX1278's FSK modem. The data is modulated SX1278's FSK modem. The data is modulated
as AFSK at 1200 baud using Bell 202 tones. as AFSK at 1200 baud using Bell 202 tones.
Other modules that can be used for AX.25 Other modules that can be used for AX.25
with AFSK modulation: with AFSK modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -32,13 +32,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -70,7 +66,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize AX.25 client // initialize AX.25 client
@ -84,7 +80,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// Sometimes, it may be required to adjust audio // Sometimes, it may be required to adjust audio
@ -99,7 +95,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -1,18 +1,18 @@
/* /*
RadioLib Bell Modem Transmit Example RadioLib Bell Modem Transmit Example
This example shows how to transmit binary data This example shows how to transmit binary data
using audio Bell 202 tones. using audio Bell 202 tones.
Other implemented Bell modems Other implemented Bell modems
- Bell 101 - Bell 101
- Bell 103 - Bell 103
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -33,7 +33,7 @@ SX1278 radio = new Module(10, 2, 9, 3);
// SX1231: DIO2 // SX1231: DIO2
// CC1101: GDO2 // CC1101: GDO2
// Si443x/RFM2x: GPIO // Si443x/RFM2x: GPIO
// SX126x/LLCC68: DIO2 // SX126x/LLCC68: DIO2 (only devices without TCXO!)
BellClient bell(&radio, 5); BellClient bell(&radio, 5);
void setup() { void setup() {
@ -52,7 +52,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Bell 202 modem // initialize Bell 202 modem
@ -63,7 +63,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,17 +1,17 @@
/* /*
RadioLib CC1101 Receive with Address Example RadioLib CC1101 Receive with Address Example
This example receives packets using CC1101 FSK radio This example receives packets using CC1101 FSK radio
module. Packets can have 1-byte address of the module. Packets can have 1-byte address of the
destination node. After setting node address, this node destination node. After setting node address, this node
will automatically filter out any packets that do not will automatically filter out any packets that do not
contain either node address or broadcast addresses. contain either node address or broadcast addresses.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101 https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -24,13 +24,9 @@
// GDO2 pin: 3 (optional) // GDO2 pin: 3 (optional)
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -43,7 +39,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set node address // set node address
@ -60,7 +56,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// address filtering can also be disabled // address filtering can also be disabled
@ -74,7 +70,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -31,13 +31,9 @@
// GDO2 pin: 3 (optional) // GDO2 pin: 3 (optional)
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -50,7 +46,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,22 +1,22 @@
/* /*
RadioLib CC1101 Receive with Interrupts Example RadioLib CC1101 Receive with Interrupts Example
This example listens for FSK transmissions and tries to This example listens for FSK transmissions and tries to
receive them. Once a packet is received, an interrupt is receive them. Once a packet is received, an interrupt is
triggered. triggered.
To successfully receive data, the following settings have to be the same To successfully receive data, the following settings have to be the same
on both transmitter and receiver: on both transmitter and receiver:
- carrier frequency - carrier frequency
- bit rate - bit rate
- frequency deviation - frequency deviation
- sync word - sync word
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101 https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -29,28 +29,9 @@
// GDO2 pin: 3 (optional) // GDO2 pin: 3 (optional)
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -63,7 +44,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -78,7 +59,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, 'listen' mode can be disabled by calling // if needed, 'listen' mode can be disabled by calling
@ -91,6 +72,21 @@ void setup() {
// radio.readData(); // radio.readData();
} }
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(receivedFlag) { if(receivedFlag) {

View file

@ -1,21 +1,21 @@
/* /*
RadioLib CC1101 Settings Example RadioLib CC1101 Settings Example
This example shows how to change all the properties of RF69 radio. This example shows how to change all the properties of RF69 radio.
RadioLib currently supports the following settings: RadioLib currently supports the following settings:
- pins (SPI slave select, digital IO 0, digital IO 1) - pins (SPI slave select, digital IO 0, digital IO 1)
- carrier frequency - carrier frequency
- bit rate - bit rate
- receiver bandwidth - receiver bandwidth
- allowed frequency deviation - allowed frequency deviation
- output power during transmission - output power during transmission
- sync word - sync word
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101 https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -35,13 +35,9 @@ CC1101 radio1 = new Module(10, 2, RADIOLIB_NC, 3);
// GDO2 pin: 5 (optional) // GDO2 pin: 5 (optional)
CC1101 radio2 = new Module(9, 4, RADIOLIB_NC, 5); CC1101 radio2 = new Module(9, 4, RADIOLIB_NC, 5);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio3 = RadioShield.ModuleB;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio3 = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -54,7 +50,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// initialize CC1101 with non-default settings // initialize CC1101 with non-default settings
@ -71,7 +67,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// you can also change the settings at runtime // you can also change the settings at runtime
@ -80,42 +76,42 @@ void setup() {
// set carrier frequency to 433.5 MHz // set carrier frequency to 433.5 MHz
if (radio1.setFrequency(433.5) == RADIOLIB_ERR_INVALID_FREQUENCY) { if (radio1.setFrequency(433.5) == RADIOLIB_ERR_INVALID_FREQUENCY) {
Serial.println(F("[CC1101] Selected frequency is invalid for this module!")); Serial.println(F("[CC1101] Selected frequency is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// set bit rate to 100.0 kbps // set bit rate to 100.0 kbps
state = radio1.setBitRate(100.0); state = radio1.setBitRate(100.0);
if (state == RADIOLIB_ERR_INVALID_BIT_RATE) { if (state == RADIOLIB_ERR_INVALID_BIT_RATE) {
Serial.println(F("[CC1101] Selected bit rate is invalid for this module!")); Serial.println(F("[CC1101] Selected bit rate is invalid for this module!"));
while (true) { delay(10); } while (true);
} else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) { } else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) {
Serial.println(F("[CC1101] Selected bit rate to bandwidth ratio is invalid!")); Serial.println(F("[CC1101] Selected bit rate to bandwidth ratio is invalid!"));
Serial.println(F("[CC1101] Increase receiver bandwidth to set this bit rate.")); Serial.println(F("[CC1101] Increase receiver bandwidth to set this bit rate."));
while (true) { delay(10); } while (true);
} }
// set receiver bandwidth to 250.0 kHz // set receiver bandwidth to 250.0 kHz
if (radio1.setRxBandwidth(250.0) == RADIOLIB_ERR_INVALID_RX_BANDWIDTH) { if (radio1.setRxBandwidth(250.0) == RADIOLIB_ERR_INVALID_RX_BANDWIDTH) {
Serial.println(F("[CC1101] Selected receiver bandwidth is invalid for this module!")); Serial.println(F("[CC1101] Selected receiver bandwidth is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// set allowed frequency deviation to 10.0 kHz // set allowed frequency deviation to 10.0 kHz
if (radio1.setFrequencyDeviation(10.0) == RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION) { if (radio1.setFrequencyDeviation(10.0) == RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION) {
Serial.println(F("[CC1101] Selected frequency deviation is invalid for this module!")); Serial.println(F("[CC1101] Selected frequency deviation is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// set output power to 5 dBm // set output power to 5 dBm
if (radio1.setOutputPower(5) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) { if (radio1.setOutputPower(5) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) {
Serial.println(F("[CC1101] Selected output power is invalid for this module!")); Serial.println(F("[CC1101] Selected output power is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// 2 bytes can be set as sync word // 2 bytes can be set as sync word
if (radio1.setSyncWord(0x01, 0x23) == RADIOLIB_ERR_INVALID_SYNC_WORD) { if (radio1.setSyncWord(0x01, 0x23) == RADIOLIB_ERR_INVALID_SYNC_WORD) {
Serial.println(F("[CC1101] Selected sync word is invalid for this module!")); Serial.println(F("[CC1101] Selected sync word is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,17 +1,17 @@
/* /*
RadioLib CC1101 Transmit to Address Example RadioLib CC1101 Transmit to Address Example
This example transmits packets using CC1101 FSK radio This example transmits packets using CC1101 FSK radio
module. Packets can have 1-byte address of the module. Packets can have 1-byte address of the
destination node. After setting node address, this node destination node. After setting node address, this node
will automatically filter out any packets that do not will automatically filter out any packets that do not
contain either node address or broadcast addresses. contain either node address or broadcast addresses.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101 https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -24,13 +24,9 @@
// GDO2 pin: 3 (optional) // GDO2 pin: 3 (optional)
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -43,7 +39,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set node address // set node address
@ -60,7 +56,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// address filtering can also be disabled // address filtering can also be disabled
@ -74,7 +70,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }
@ -82,11 +78,10 @@ void setup() {
void loop() { void loop() {
Serial.print(F("[CC1101] Transmitting packet ... ")); Serial.print(F("[CC1101] Transmitting packet ... "));
// you can transmit C-string or Arduino string up to 255 characters long // you can transmit C-string or Arduino string up to 63 characters long
int state = radio.transmit("Hello World!"); int state = radio.transmit("Hello World!");
// you can also transmit byte array up to 255 bytes long // you can also transmit byte array up to 63 bytes long
// With some limitations see here: https://github.com/jgromes/RadioLib/discussions/1138
/* /*
byte byteArr[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF}; byte byteArr[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF};
int state = radio.transmit(byteArr, 8); int state = radio.transmit(byteArr, 8);

View file

@ -2,7 +2,7 @@
RadioLib CC1101 Blocking Transmit Example RadioLib CC1101 Blocking Transmit Example
This example transmits packets using CC1101 FSK radio module. This example transmits packets using CC1101 FSK radio module.
Each packet contains up to 255 bytes of data with some limitations (https://github.com/jgromes/RadioLib/discussions/1138), in the form of: Each packet contains up to 64 bytes of data, in the form of:
- Arduino String - Arduino String
- null-terminated char array (C-string) - null-terminated char array (C-string)
- arbitrary binary data (byte array) - arbitrary binary data (byte array)
@ -28,13 +28,9 @@
// GDO2 pin: 3 // GDO2 pin: 3
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -47,7 +43,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }
@ -57,11 +53,11 @@ int count = 0;
void loop() { void loop() {
Serial.print(F("[CC1101] Transmitting packet ... ")); Serial.print(F("[CC1101] Transmitting packet ... "));
// you can transmit C-string or Arduino string up to 255 characters long // you can transmit C-string or Arduino string up to 63 characters long
String str = "Hello World! #" + String(count++); String str = "Hello World! #" + String(count++);
int state = radio.transmit(str); int state = radio.transmit(str);
// you can also transmit byte array up to 255 bytes long with some limitations; https://github.com/jgromes/RadioLib/discussions/1138 // you can also transmit byte array up to 63 bytes long
/* /*
byte byteArr[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF}; byte byteArr[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF};
int state = radio.transmit(byteArr, 8); int state = radio.transmit(byteArr, 8);
@ -72,7 +68,7 @@ void loop() {
Serial.println(F("success!")); Serial.println(F("success!"));
} else if (state == RADIOLIB_ERR_PACKET_TOO_LONG) { } else if (state == RADIOLIB_ERR_PACKET_TOO_LONG) {
// the supplied packet was longer than 255 bytes // the supplied packet was longer than 64 bytes
Serial.println(F("too long!")); Serial.println(F("too long!"));
} else { } else {

View file

@ -1,18 +1,18 @@
/* /*
RadioLib CC1101 Transmit with Interrupts Example RadioLib CC1101 Transmit with Interrupts Example
This example transmits packets using CC1101 FSK radio module. This example transmits packets using CC1101 FSK radio module.
Once a packet is transmitted, an interrupt is triggered. Once a packet is transmitted, an interrupt is triggered.
Each packet contains up to 255 bytes of data with some limitations (https://github.com/jgromes/RadioLib/discussions/1138), in the form of: Each packet contains up to 64 bytes of data, in the form of:
- Arduino String - Arduino String
- null-terminated char array (C-string) - null-terminated char array (C-string)
- arbitrary binary data (byte array) - arbitrary binary data (byte array)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101 https://github.com/jgromes/RadioLib/wiki/Default-configuration#cc1101
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -25,17 +25,46 @@
// GDO2 pin: 3 // GDO2 pin: 3
CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3); CC1101 radio = new Module(10, 2, RADIOLIB_NC, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //CC1101 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// save transmission state between loops // save transmission state between loops
int transmissionState = RADIOLIB_ERR_NONE; int transmissionState = RADIOLIB_ERR_NONE;
void setup() {
Serial.begin(9600);
// initialize CC1101 with default settings
Serial.print(F("[CC1101] Initializing ... "));
int state = radio.begin();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true);
}
// set the function that will be called
// when packet transmission is finished
radio.setPacketSentAction(setFlag);
// start transmitting the first packet
Serial.print(F("[CC1101] Sending first packet ... "));
// you can transmit C-string or Arduino string up to
// 64 characters long
transmissionState = radio.startTransmit("Hello World!");
// you can also transmit byte array up to 64 bytes long
/*
byte byteArr[] = {0x01, 0x23, 0x45, 0x56,
0x78, 0xAB, 0xCD, 0xEF};
state = radio.startTransmit(byteArr, 8);
*/
}
// flag to indicate that a packet was sent // flag to indicate that a packet was sent
volatile bool transmittedFlag = false; volatile bool transmittedFlag = false;
@ -51,41 +80,6 @@ void setFlag(void) {
transmittedFlag = true; transmittedFlag = true;
} }
void setup() {
Serial.begin(9600);
// initialize CC1101 with default settings
Serial.print(F("[CC1101] Initializing ... "));
int state = radio.begin();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// set the function that will be called
// when packet transmission is finished
radio.setPacketSentAction(setFlag);
// start transmitting the first packet
Serial.print(F("[CC1101] Sending first packet ... "));
// you can transmit C-string or Arduino string up to
// 255 characters long
transmissionState = radio.startTransmit("Hello World!");
// you can also transmit byte array up to 255 bytes long
// When transmitting more than 64 bytes startTransmit blocks to refill the FIFO.
// Blocking ceases once the last bytes have been placed in the FIFO
/*
byte byteArr[] = {0x01, 0x23, 0x45, 0x56,
0x78, 0xAB, 0xCD, 0xEF};
state = radio.startTransmit(byteArr, 8);
*/
}
// counter to keep track of transmitted packets // counter to keep track of transmitted packets
int count = 0; int count = 0;
@ -121,11 +115,11 @@ void loop() {
Serial.print(F("[CC1101] Sending another packet ... ")); Serial.print(F("[CC1101] Sending another packet ... "));
// you can transmit C-string or Arduino string up to // you can transmit C-string or Arduino string up to
// 255 characters long // 256 characters long
String str = "Hello World! #" + String(count++); String str = "Hello World! #" + String(count++);
transmissionState = radio.startTransmit(str); transmissionState = radio.startTransmit(str);
// you can also transmit byte array up to 255 bytes long with limitations https://github.com/jgromes/RadioLib/discussions/1138 // you can also transmit byte array up to 256 bytes long
/* /*
byte byteArr[] = {0x01, 0x23, 0x45, 0x67, byte byteArr[] = {0x01, 0x23, 0x45, 0x67,
0x89, 0xAB, 0xCD, 0xEF}; 0x89, 0xAB, 0xCD, 0xEF};

View file

@ -1,27 +1,27 @@
/* /*
RadioLib FSK4 Transmit Example RadioLib FSK4 Transmit Example
This example sends an example FSK-4 'Horus Binary' message This example sends an example FSK-4 'Horus Binary' message
using SX1278's FSK modem. using SX1278's FSK modem.
This signal can be demodulated using a SSB demodulator (SDR or otherwise), This signal can be demodulated using a SSB demodulator (SDR or otherwise),
and horusdemodlib: https://github.com/projecthorus/horusdemodlib/wiki and horusdemodlib: https://github.com/projecthorus/horusdemodlib/wiki
Other modules that can be used for FSK4: Other modules that can be used for FSK4:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX128x - SX128x
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -34,13 +34,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create FSK4 client instance using the FSK module // create FSK4 client instance using the FSK module
FSK4Client fsk4(&radio); FSK4Client fsk4(&radio);
@ -77,7 +73,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize FSK4 client // initialize FSK4 client
@ -101,7 +97,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// sometimes, it may be needed to set some manual corrections // sometimes, it may be needed to set some manual corrections
@ -117,7 +113,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -1,25 +1,25 @@
/* /*
RadioLib FSK4 Transmit AFSK Example RadioLib FSK4 Transmit AFSK Example
This example sends an example FSK-4 'Horus Binary' message This example sends an example FSK-4 'Horus Binary' message
using SX1278's FSK modem. The data is modulated as AFSK. using SX1278's FSK modem. The data is modulated as AFSK.
This signal can be demodulated using an FM demodulator (SDR or otherwise), This signal can be demodulated using an FM demodulator (SDR or otherwise),
and horusdemodlib: https://github.com/projecthorus/horusdemodlib/wiki and horusdemodlib: https://github.com/projecthorus/horusdemodlib/wiki
Other modules that can be used for FSK4: Other modules that can be used for FSK4:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -32,13 +32,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -86,7 +82,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize FSK4 client // initialize FSK4 client
@ -102,7 +98,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// sometimes, it may be needed to set some manual corrections // sometimes, it may be needed to set some manual corrections
@ -118,7 +114,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -1,25 +1,25 @@
/* /*
RadioLib Hellschreiber Transmit Example RadioLib Hellschreiber Transmit Example
This example sends Hellschreiber message using This example sends Hellschreiber message using
SX1278's FSK modem. SX1278's FSK modem.
Other modules that can be used for Hellschreiber: Other modules that can be used for Hellschreiber:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX128x - SX128x
- LR11x0 - LR11x0
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -32,13 +32,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create Hellschreiber client instance using the FSK module // create Hellschreiber client instance using the FSK module
HellClient hell(&radio); HellClient hell(&radio);
@ -59,7 +55,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Hellschreiber client // initialize Hellschreiber client
@ -72,7 +68,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,24 +1,24 @@
/* /*
RadioLib Hellschreiber Transmit AFSK Example RadioLib Hellschreiber Transmit AFSK Example
This example sends Hellschreiber message using This example sends Hellschreiber message using
SX1278's FSK modem. The data is modulated SX1278's FSK modem. The data is modulated
as AFSK. as AFSK.
Other modules that can be used for Hellschreiber Other modules that can be used for Hellschreiber
with AFSK modulation: with AFSK modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -31,13 +31,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -69,7 +65,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Hellschreiber client // initialize Hellschreiber client
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -34,14 +34,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -65,6 +57,10 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -73,11 +69,8 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
} }
void loop() { void loop() {

View file

@ -29,14 +29,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -57,24 +49,13 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
END_OF_MODE_TABLE, END_OF_MODE_TABLE,
}; };
// flag to indicate that a packet was detected or CAD timed out
volatile bool scanFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// something happened, set the flag
scanFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -83,12 +64,9 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// set the function that will be called // set the function that will be called
// when LoRa packet or timeout is detected // when LoRa packet or timeout is detected
radio.setIrqAction(setFlag); radio.setIrqAction(setFlag);
@ -104,6 +82,21 @@ void setup() {
} }
} }
// flag to indicate that a packet was detected or CAD timed out
volatile bool scanFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// something happened, set the flag
scanFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(scanFlag) { if(scanFlag) {

View file

@ -48,13 +48,9 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //LR1110 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -67,7 +63,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// print the firmware versions before the update // print the firmware versions before the update
@ -89,7 +85,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// print the firmware versions after the update // print the firmware versions after the update
@ -125,7 +121,7 @@ void printVersions() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }

View file

@ -26,13 +26,9 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //LR1110 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -45,7 +41,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, you can switch between any of the modems // if needed, you can switch between any of the modems
@ -67,7 +63,7 @@ void setup() {
if (state != RADIOLIB_ERR_NONE) { if (state != RADIOLIB_ERR_NONE) {
Serial.print(F("Unable to set configuration, code ")); Serial.print(F("Unable to set configuration, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// GFSK modem on LR11x0 can handle the sync word setting in bits, not just // GFSK modem on LR11x0 can handle the sync word setting in bits, not just

View file

@ -1,182 +0,0 @@
/*
RadioLib LR11x0 GNSS Almanac Update Example
This example updates the LR11x0 GNSS almanac.
Almanac is a database of orbital predictions of
GNSS satellites, which allows the module to predict
when different satellites will appear in the sky,
and frequency of their signal.
Up-to-date almanac is necessary for operation!
After an update, data will remain valid for 30 days.
All GNSS examples require at least limited
visibility of the sky!
NOTE: This example will only work for LR11x0 devices
with sufficiently recent firmware!
LR1110: 4.1
LR1120: 2.1
If your device firmware reports older firmware,
update it using the LR11x0_Firmware_Update example.
For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/
*/
// include the library
#include <RadioLib.h>
// LR1110 has the following connections:
// NSS pin: 10
// DIO1 pin: 2
// NRST pin: 3
// BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different!
static const uint32_t rfswitch_dio_pins[] = {
RADIOLIB_LR11X0_DIO5, RADIOLIB_LR11X0_DIO6,
RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC
};
static const Module::RfSwitchMode_t rfswitch_table[] = {
// mode DIO5 DIO6
{ LR11x0::MODE_STBY, { LOW, LOW } },
{ LR11x0::MODE_RX, { HIGH, LOW } },
{ LR11x0::MODE_TX, { HIGH, HIGH } },
{ LR11x0::MODE_TX_HP, { LOW, HIGH } },
{ LR11x0::MODE_TX_HF, { LOW, LOW } },
{ LR11x0::MODE_GNSS, { LOW, LOW } },
{ LR11x0::MODE_WIFI, { LOW, LOW } },
END_OF_MODE_TABLE,
};
// structure to save information about the GNSS almanac
LR11x0GnssAlmanacStatus_t almStatus;
void setup() {
Serial.begin(9600);
// initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... "));
int state = radio.beginGNSS(RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS);
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// check the firmware version
Serial.print(F("[LR1110] Checking firmware version ... "));
state = radio.isGnssScanCapable();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("check passed!"));
} else {
Serial.println(F("check failed, firmware update needed."));
while (true) { delay(10); }
}
// run GNSS scans until we get at least the time
// NOTE: Depending on visibility of satellites,
// this may take multiple attempts!
while(true) {
// run GNSS scan
Serial.print(F("[LR1110] Running GNSS scan ... "));
state = radio.gnssScan(NULL);
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// check almanac status
Serial.print(F("[LR1110] Checking GNSS almanac ... "));
state = radio.getGnssAlmanacStatus(&almStatus);
if (state != RADIOLIB_ERR_NONE) {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// we have the status, check if we have demodulated time
if(almStatus.gps.status < RADIOLIB_LR11X0_GNSS_ALMANAC_STATUS_UP_TO_DATE) {
Serial.println(F("time unknown, another scan needed."));
} else if(almStatus.gps.numUpdateNeeded > 0) {
Serial.print(almStatus.gps.numUpdateNeeded);
Serial.println(F(" satellites out-of-date."));
break;
} else {
Serial.println(F("no update needed!"));
while (true) { delay(10); }
}
}
}
void loop() {
// wait until almanac data is available in the signal
// multiple attempts are needed for this
Serial.print(F("[LR1110] Waiting for subframe ... "));
int state = radio.gnssDelayUntilSubframe(&almStatus, RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS);
if(state == RADIOLIB_ERR_GNSS_SUBFRAME_NOT_AVAILABLE) {
Serial.println(F("not enough time left."));
// wait until the next update window
delay(2000);
} else {
Serial.println(F("done!"));
// we have enough time to start the update
Serial.print(F("[LR1110] Starting update ... "));
state = radio.updateGnssAlmanac(RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("failed, code "));
Serial.println(state);
} else {
Serial.println(F("done!"));
}
}
// check whether another update is needed
Serial.print(F("[LR1110] Checking GNSS almanac ... "));
state = radio.getGnssAlmanacStatus(&almStatus);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// check if we have completed the update
if(almStatus.gps.numUpdateNeeded == 0) {
Serial.println(F("all satellites up-to-date!"));
while (true) { delay(10); }
} else {
Serial.print(almStatus.gps.numUpdateNeeded);
Serial.println(F(" satellites out-of-date."));
}
// wait a bit before the next update attempt
delay(1000);
}

View file

@ -1,134 +0,0 @@
/*
RadioLib LR11x0 GNSS Autonomous Position Example
This example performs GNSS scans and calculates
position of the device using autonomous mode.
In this mode, scan data does not need to be uploaded
to LoRaCloud, however, it requires up-to-date almanac
data. Run the LR11x0_Almanac_Update example to update
the device almanac.
NOTE: This example will only work for LR11x0 devices
with sufficiently recent firmware!
LR1110: 4.1
LR1120: 2.1
If your device firmware reports older firmware,
update it using the LR11x0_Firmware_Update example.
For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/
*/
// include the library
#include <RadioLib.h>
// LR1110 has the following connections:
// NSS pin: 10
// DIO1 pin: 2
// NRST pin: 3
// BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different!
static const uint32_t rfswitch_dio_pins[] = {
RADIOLIB_LR11X0_DIO5, RADIOLIB_LR11X0_DIO6,
RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC
};
static const Module::RfSwitchMode_t rfswitch_table[] = {
// mode DIO5 DIO6
{ LR11x0::MODE_STBY, { LOW, LOW } },
{ LR11x0::MODE_RX, { HIGH, LOW } },
{ LR11x0::MODE_TX, { HIGH, HIGH } },
{ LR11x0::MODE_TX_HP, { LOW, HIGH } },
{ LR11x0::MODE_TX_HF, { LOW, LOW } },
{ LR11x0::MODE_GNSS, { LOW, LOW } },
{ LR11x0::MODE_WIFI, { LOW, LOW } },
END_OF_MODE_TABLE,
};
// structure to save information about the GNSS scan result
LR11x0GnssResult_t gnssResult;
// structure to save information about the calculated GNSS position
LR11x0GnssPosition_t gnssPosition;
void setup() {
Serial.begin(9600);
// initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... "));
int state = radio.beginGNSS(RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS);
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// check the firmware version
Serial.print(F("[LR1110] Checking firmware version ... "));
state = radio.isGnssScanCapable();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("check passed!"));
} else {
Serial.println(F("check failed, firmware update needed."));
while (true) { delay(10); }
}
Serial.println(F("Scan result\t| Latitude\t| Longitude\t| Accuracy\t| Number of satellites"));
}
void loop() {
// run GNSS scan
int state = radio.gnssScan(&gnssResult);
if(state == RADIOLIB_ERR_NONE) {
// success!
Serial.print(gnssResult.demodStat); Serial.print("\t\t| ");
// get the actual data
state = radio.getGnssPosition(&gnssPosition);
if(state == RADIOLIB_ERR_NONE) {
// print the position
Serial.print(gnssPosition.latitude, 6);
Serial.print("\t| ");
Serial.print(gnssPosition.longitude, 6);
Serial.print("\t| ");
Serial.print(gnssPosition.accuracy);
Serial.print("\t\t| ");
Serial.println(gnssPosition.numSatsUsed);
} else {
Serial.print(F("Failed to read result, code "));
Serial.print(state);
Serial.print(F(" (solver error "));
Serial.print(RADIOLIB_GET_GNSS_SOLVER_ERROR(state));
Serial.println(F(")"));
}
} else {
Serial.print(F("Scan failed, code "));
Serial.print(state);
Serial.print(F(" (demodulator error "));
Serial.print(RADIOLIB_GET_GNSS_DEMOD_ERROR(state));
Serial.println(F(")"));
}
// wait a bit before the next scan
delay(1000);
}

View file

@ -1,133 +0,0 @@
/*
RadioLib LR11x0 GNSS Satellites Example
This example performs GNSS scans and shows the satellites
currently in view. It is mostly useful to verify
visibility and antenna setup.
NOTE: This example will only work for LR11x0 devices
with sufficiently recent firmware!
LR1110: 4.1
LR1120: 2.1
If your device firmware reports older firmware,
update it using the LR11x0_Firmware_Update example.
For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#lr11x0---wifi-scan
For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/
*/
// include the library
#include <RadioLib.h>
// LR1110 has the following connections:
// NSS pin: 10
// DIO1 pin: 2
// NRST pin: 3
// BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different!
static const uint32_t rfswitch_dio_pins[] = {
RADIOLIB_LR11X0_DIO5, RADIOLIB_LR11X0_DIO6,
RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC
};
static const Module::RfSwitchMode_t rfswitch_table[] = {
// mode DIO5 DIO6
{ LR11x0::MODE_STBY, { LOW, LOW } },
{ LR11x0::MODE_RX, { HIGH, LOW } },
{ LR11x0::MODE_TX, { HIGH, HIGH } },
{ LR11x0::MODE_TX_HP, { LOW, HIGH } },
{ LR11x0::MODE_TX_HF, { LOW, LOW } },
{ LR11x0::MODE_GNSS, { LOW, LOW } },
{ LR11x0::MODE_WIFI, { LOW, LOW } },
END_OF_MODE_TABLE,
};
// structure to save information about the GNSS scan result
LR11x0GnssResult_t gnssResult;
void setup() {
Serial.begin(9600);
// initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... "));
int state = radio.beginGNSS(RADIOLIB_LR11X0_GNSS_CONSTELLATION_GPS);
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// check the firmware version
Serial.print(F("[LR1110] Checking firmware version ... "));
state = radio.isGnssScanCapable();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("check passed!"));
} else {
Serial.println(F("check failed, firmware update needed."));
while (true) { delay(10); }
}
}
void loop() {
Serial.print(F("[LR1110] Running GNSS scan ... "));
int state = radio.gnssScan(&gnssResult);
if(state != RADIOLIB_ERR_NONE) {
// some error occurred
Serial.print(F("failed, code "));
Serial.print(state);
Serial.print(F(" (demodulator error "));
Serial.print(RADIOLIB_GET_GNSS_DEMOD_ERROR(state));
Serial.println(F(")"));
} else {
Serial.println(F("success!"));
// print the table header
Serial.print(F("[LR1110] Detected "));
Serial.print(gnssResult.numSatsDet);
Serial.println(F(" satellite(s):"));
Serial.println(F(" # | ID | C/N0 [dB]\t| Doppler [Hz]"));
// read all results at once
LR11x0GnssSatellite_t satellites[32];
state = radio.getGnssSatellites(satellites, gnssResult.numSatsDet);
if(state != RADIOLIB_ERR_NONE) {
Serial.print(F("Failed to read results, code "));
Serial.println(state);
} else {
// print all the results
for(int i = 0; i < gnssResult.numSatsDet; i++) {
if(i < 10) { Serial.print(" "); } Serial.print(i); Serial.print(" | ");
Serial.print(satellites[i].svId); Serial.print(" | ");
Serial.print(satellites[i].c_n0); Serial.print("\t\t| ");
Serial.println(satellites[i].doppler);
}
}
}
// wait for a second before scanning again
delay(1000);
}

View file

@ -2,7 +2,6 @@
RadioLib LR11x0 LR-FHSS Modem Example RadioLib LR11x0 LR-FHSS Modem Example
This example shows how to use LR-FHSS modem in LR11x0 chips. This example shows how to use LR-FHSS modem in LR11x0 chips.
This modem can only transmit data, and is not able to receive.
NOTE: The sketch below is just a guide on how to use NOTE: The sketch below is just a guide on how to use
LR-FHSS modem, so this code should not be run directly! LR-FHSS modem, so this code should not be run directly!
@ -27,13 +26,9 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //LR1110 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -46,7 +41,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, you can switch between any of the modems // if needed, you can switch between any of the modems
@ -62,19 +57,20 @@ void setup() {
3, // header count 3, // header count
0x13A); // hopping sequence seed 0x13A); // hopping sequence seed
state = radio.setOutputPower(10.0); state = radio.setOutputPower(10.0);
uint8_t syncWord[] = {0x01, 0x23, 0x45, 0x67}; state = radio.setSyncWord(0x12345678);
state = radio.setSyncWord(syncWord, 4);
if (state != RADIOLIB_ERR_NONE) { if (state != RADIOLIB_ERR_NONE) {
Serial.print(F("Unable to set configuration, code ")); Serial.print(F("Unable to set configuration, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
#warning "This sketch is just an API guide! Read the note at line 6." #warning "This sketch is just an API guide! Read the note at line 6."
} }
void loop() { void loop() {
// LR-FHSS modem can only transmit! // LR-FHSS modem can use the same transmit/receive methods
// as the LoRa modem, even their interrupt-driven versions
// transmit LR-FHSS packet // transmit LR-FHSS packet
int state = radio.transmit("Hello World!"); int state = radio.transmit("Hello World!");
/* /*
@ -93,4 +89,22 @@ void loop() {
Serial.println(state); Serial.println(state);
} }
// receive LR-FHSS packet
String str;
state = radio.receive(str);
/*
byte byteArr[8];
int state = radio.receive(byteArr, 8);
*/
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("[LR1110] Received packet!"));
Serial.print(F("[LR1110] Data:\t"));
Serial.println(str);
} else if (state == RADIOLIB_ERR_RX_TIMEOUT) {
Serial.println(F("[LR1110] Timed out while waiting for packet!"));
} else {
Serial.print(F("[LR1110] Failed to receive packet, code "));
Serial.println(state);
}
} }

View file

@ -1,173 +0,0 @@
/*
RadioLib LR11x0 Ping-Pong Example
For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#lr11x0---lora-modem
For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/
*/
// include the library
#include <RadioLib.h>
// uncomment the following only on one
// of the nodes to initiate the pings
//#define INITIATING_NODE
// LR1110 has the following connections:
// NSS pin: 10
// IRQ pin: 2
// NRST pin: 3
// BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different!
static const uint32_t rfswitch_dio_pins[] = {
RADIOLIB_LR11X0_DIO5, RADIOLIB_LR11X0_DIO6,
RADIOLIB_NC, RADIOLIB_NC, RADIOLIB_NC
};
static const Module::RfSwitchMode_t rfswitch_table[] = {
// mode DIO5 DIO6
{ LR11x0::MODE_STBY, { LOW, LOW } },
{ LR11x0::MODE_RX, { HIGH, LOW } },
{ LR11x0::MODE_TX, { HIGH, HIGH } },
{ LR11x0::MODE_TX_HP, { LOW, HIGH } },
{ LR11x0::MODE_TX_HF, { LOW, LOW } },
{ LR11x0::MODE_GNSS, { LOW, LOW } },
{ LR11x0::MODE_WIFI, { LOW, LOW } },
END_OF_MODE_TABLE,
};
// save transmission states between loops
int transmissionState = RADIOLIB_ERR_NONE;
// flag to indicate transmission or reception state
bool transmitFlag = false;
// flag to indicate that a packet was sent or received
volatile bool operationDone = false;
// this function is called when a complete packet
// is transmitted or received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we sent or received a packet, set the flag
operationDone = true;
}
void setup() {
Serial.begin(9600);
// initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// set the function that will be called
// when new packet is received
radio.setIrqAction(setFlag);
#if defined(INITIATING_NODE)
// send the first packet on this node
Serial.print(F("[LR1110] Sending first packet ... "));
transmissionState = radio.startTransmit("Hello World!");
transmitFlag = true;
#else
// start listening for LoRa packets on this node
Serial.print(F("[LR1110] Starting to listen ... "));
state = radio.startReceive();
if (state == RADIOLIB_ERR_NONE) {
Serial.println(F("success!"));
} else {
Serial.print(F("failed, code "));
Serial.println(state);
while (true) { delay(10); }
}
#endif
}
void loop() {
// check if the previous operation finished
if(operationDone) {
// reset flag
operationDone = false;
if(transmitFlag) {
// the previous operation was transmission, listen for response
// print the result
if (transmissionState == RADIOLIB_ERR_NONE) {
// packet was successfully sent
Serial.println(F("transmission finished!"));
} else {
Serial.print(F("failed, code "));
Serial.println(transmissionState);
}
// listen for response
radio.startReceive();
transmitFlag = false;
} else {
// the previous operation was reception
// print data and send another packet
String str;
int state = radio.readData(str);
if (state == RADIOLIB_ERR_NONE) {
// packet was successfully received
Serial.println(F("[LR1110] Received packet!"));
// print data of the packet
Serial.print(F("[LR1110] Data:\t\t"));
Serial.println(str);
// print RSSI (Received Signal Strength Indicator)
Serial.print(F("[LR1110] RSSI:\t\t"));
Serial.print(radio.getRSSI());
Serial.println(F(" dBm"));
// print SNR (Signal-to-Noise Ratio)
Serial.print(F("[LR1110] SNR:\t\t"));
Serial.print(radio.getSNR());
Serial.println(F(" dB"));
}
// wait a second before transmitting again
delay(1000);
// send another one
Serial.print(F("[LR1110] Sending another packet ... "));
transmissionState = radio.startTransmit("Hello World!");
transmitFlag = true;
}
}
}

View file

@ -39,14 +39,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -70,6 +62,10 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -78,11 +74,8 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
} }
void loop() { void loop() {

View file

@ -35,14 +35,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -63,24 +55,13 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
END_OF_MODE_TABLE, END_OF_MODE_TABLE,
}; };
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -89,12 +70,9 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// set the function that will be called // set the function that will be called
// when new packet is received // when new packet is received
radio.setPacketReceivedAction(setFlag); radio.setPacketReceivedAction(setFlag);
@ -107,7 +85,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, 'listen' mode can be disabled by calling // if needed, 'listen' mode can be disabled by calling
@ -120,6 +98,21 @@ void setup() {
// radio.scanChannel(); // radio.scanChannel();
} }
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(receivedFlag) { if(receivedFlag) {

View file

@ -30,14 +30,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -61,6 +53,10 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -70,11 +66,8 @@ void setup() {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
delay(1000); delay(1000);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
} }
// counter to keep track of transmitted packets // counter to keep track of transmitted packets

View file

@ -31,14 +31,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -62,24 +54,13 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
// save transmission state between loops // save transmission state between loops
int transmissionState = RADIOLIB_ERR_NONE; int transmissionState = RADIOLIB_ERR_NONE;
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -88,12 +69,9 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// set the function that will be called // set the function that will be called
// when packet transmission is finished // when packet transmission is finished
radio.setPacketSentAction(setFlag); radio.setPacketSentAction(setFlag);
@ -113,6 +91,21 @@ void setup() {
*/ */
} }
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
// counter to keep track of transmitted packets // counter to keep track of transmitted packets
int count = 0; int count = 0;

View file

@ -32,14 +32,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -63,6 +55,10 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -71,11 +67,8 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
} }
void loop() { void loop() {

View file

@ -32,14 +32,6 @@
// BUSY pin: 9 // BUSY pin: 9
LR1110 radio = new Module(10, 2, 3, 9); LR1110 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// set RF switch configuration for Wio WM1110 // set RF switch configuration for Wio WM1110
// Wio WM1110 uses DIO5 and DIO6 for RF switching // Wio WM1110 uses DIO5 and DIO6 for RF switching
// NOTE: other boards may be different! // NOTE: other boards may be different!
@ -60,23 +52,13 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
END_OF_MODE_TABLE, END_OF_MODE_TABLE,
}; };
// flag to indicate that a scan was completed
volatile bool scanFlag = false;
// this function is called when a scan is completed
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// scan is complete, set the flag
scanFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
// set RF switch control configuration
// this has to be done prior to calling begin()
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// initialize LR1110 with default settings // initialize LR1110 with default settings
Serial.print(F("[LR1110] Initializing ... ")); Serial.print(F("[LR1110] Initializing ... "));
int state = radio.begin(); int state = radio.begin();
@ -85,12 +67,9 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set RF switch control configuration
radio.setRfSwitchTable(rfswitch_dio_pins, rfswitch_table);
// set the function that will be called // set the function that will be called
// when WiFi scan is complete // when WiFi scan is complete
radio.setIrqAction(setFlag); radio.setIrqAction(setFlag);
@ -106,6 +85,20 @@ void setup() {
} }
} }
// flag to indicate that a scan was completed
volatile bool scanFlag = false;
// this function is called when a scan is completed
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// scan is complete, set the flag
scanFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(scanFlag) { if(scanFlag) {

View file

@ -10,12 +10,12 @@
After your device is registered, you can run this example. After your device is registered, you can run this example.
The device will join the network and start uploading data. The device will join the network and start uploading data.
LoRaWAN v1.0.4/v1.1 requires the use of persistent storage. LoRaWAN v1.1 requires the use of persistent storage.
As this example does not use persistent storage, running this As this example does not use persistent storage, running this
examples REQUIRES you to check "Resets frame counters" examples REQUIRES you to check "Resets frame counters"
on your LoRaWAN dashboard. Refer to the notes or the on your LoRaWAN dashboard. Refer to the notes or the
network's documentation on how to do this. network's documentation on how to do this.
To comply with LoRaWAN's persistent storage, refer to To comply with LoRaWAN v1.1's persistent storage, refer to
https://github.com/radiolib-org/radiolib-persistence https://github.com/radiolib-org/radiolib-persistence
For default module settings, see the wiki page For default module settings, see the wiki page
@ -66,20 +66,8 @@ void loop() {
// Perform an uplink // Perform an uplink
int state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload)); int state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload));
debug(state < RADIOLIB_ERR_NONE, F("Error in sendReceive"), state, false); debug((state != RADIOLIB_LORAWAN_NO_DOWNLINK) && (state != RADIOLIB_ERR_NONE), F("Error in sendReceive"), state, false);
// Check if a downlink was received
// (state 0 = no downlink, state 1/2 = downlink in window Rx1/Rx2)
if(state > 0) {
Serial.println(F("Received a downlink"));
} else {
Serial.println(F("No downlink received"));
}
Serial.print(F("Next uplink in "));
Serial.print(uplinkIntervalSeconds);
Serial.println(F(" seconds\n"));
// Wait until next uplink - observing legal & TTN FUP constraints // Wait until next uplink - observing legal & TTN FUP constraints
delay(uplinkIntervalSeconds * 1000UL); // delay needs milli-seconds delay(uplinkIntervalSeconds * 1000UL);
} }

View file

@ -1,21 +1,8 @@
#ifndef _RADIOLIB_EX_LORAWAN_CONFIG_H #ifndef _CONFIG_H
#define _RADIOLIB_EX_LORAWAN_CONFIG_H #define _CONFIG_H
#include <RadioLib.h> #include <RadioLib.h>
// first you have to set your radio model and pin configuration
// this is provided just as a default example
SX1278 radio = new Module(10, 2, 9, 3);
// if you have RadioBoards (https://github.com/radiolib-org/RadioBoards)
// and are using one of the supported boards, you can do the following:
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// how often to send an uplink - consider legal & FUP constraints - see notes // how often to send an uplink - consider legal & FUP constraints - see notes
const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
@ -41,15 +28,102 @@ const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
// for the curious, the #ifndef blocks allow for automated testing &/or you can // for the curious, the #ifndef blocks allow for automated testing &/or you can
// put your EUI & keys in to your platformio.ini - see wiki for more tips // put your EUI & keys in to your platformio.ini - see wiki for more tips
// regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN470 // regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN500
const LoRaWANBand_t Region = EU868; const LoRaWANBand_t Region = EU868;
const uint8_t subBand = 0; // For US915, change this to 2, otherwise leave on 0
// subband choice: for US915/AU915 set to 2, for CN470 set to 1, otherwise leave on 0
const uint8_t subBand = 0;
// ============================================================================ // ============================================================================
// Below is to support the sketch - only make changes if the notes say so ... // Below is to support the sketch - only make changes if the notes say so ...
// Auto select MCU <-> radio connections
// If you get an error message when compiling, it may be that the
// pinmap could not be determined - see the notes for more info
// Adafruit
#if defined(ARDUINO_SAMD_FEATHER_M0)
#pragma message ("Adafruit Feather M0 with RFM95")
#pragma message ("Link required on board")
SX1276 radio = new Module(8, 3, 4, 6);
// LilyGo
#elif defined(ARDUINO_TTGO_LORA32_V1)
#pragma message ("Using TTGO LoRa32 v1 - no Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TTGO_LORA32_V2)
#pragma message ("Using TTGO LoRa32 v2 + Display")
SX1276 radio = new Module(18, 26, 12, RADIOLIB_NC);
#elif defined(ARDUINO_TTGO_LoRa32_v21new) // T3_V1.6.1
#pragma message ("Using TTGO LoRa32 v2.1 marked T3_V1.6.1 + Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1262)
#pragma error ("ARDUINO_TBEAM_USE_RADIO_SX1262 awaiting pin map")
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1276)
#pragma message ("Using TTGO T-Beam")
SX1276 radio = new Module(18, 26, 23, 33);
// HelTec: https://github.com/espressif/arduino-esp32/blob/master/variants/heltec_*/pins_arduino.h
#elif defined(ARDUINO_HELTEC_WIFI_LORA_32)
#pragma message ("Using Heltec WiFi LoRa32")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_heltec_wifi_lora_32_V2)
#pragma message ("Using Heltec WiFi LoRa32 v2")
SX1278 radio = new Module(14, 4, 12, 16);
// Pending verfication of which radio is shipped
// #elif defined(ARDUINO_heltec_wifi_lora_32_V2)
// #pragma message ("ARDUINO_heltec_wifi_kit_32_V2 awaiting pin map")
// SX1276 radio = new Module(18, 26, 14, 35);
#elif defined(ARDUINO_heltec_wifi_lora_32_V3)
#pragma message ("Using Heltec WiFi LoRa32 v3 - Display + USB-C")
SX1262 radio = new Module(8, 14, 12, 13);
// Following not verified
#elif defined (ARDUINO_heltec_wireless_stick)
#pragma message ("Using Heltec Wireless Stick")
SX1278 radio = new Module(14, 4, 12, 16);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK)
#pragma message ("Using Heltec Wireless Stick")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_V3)
#pragma message ("Using Heltec Wireless Stick v3")
SX1262 radio = new Module(8, 14, 12, 13);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE)
#pragma message ("Using Heltec Wireless Stick Lite")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE_V3)
#pragma message ("Using Heltec Wireless Stick Lite v3")
SX1262 radio = new Module(34, 14, 12, 13);
// If we don't recognise the board
#else
#pragma message ("Unknown board - no automagic pinmap available")
// SX1262 pin order: Module(NSS/CS, DIO1, RESET, BUSY);
// SX1262 radio = new Module(8, 14, 12, 13);
// SX1278 pin order: Module(NSS/CS, DIO0, RESET, DIO1);
// SX1278 radio = new Module(10, 2, 9, 3);
// For Pi Pico + Waveshare HAT - work in progress
// SX1262 radio = new Module(3, 20, 15, 2, SPI1, RADIOLIB_DEFAULT_SPI_SETTINGS);
#endif
// copy over the keys in to the something that will not compile if incorrectly formatted // copy over the keys in to the something that will not compile if incorrectly formatted
uint32_t devAddr = RADIOLIB_LORAWAN_DEV_ADDR; uint32_t devAddr = RADIOLIB_LORAWAN_DEV_ADDR;
uint8_t fNwkSIntKey[] = { RADIOLIB_LORAWAN_FNWKSINT_KEY }; uint8_t fNwkSIntKey[] = { RADIOLIB_LORAWAN_FNWKSINT_KEY };
@ -60,8 +134,8 @@ uint8_t appSKey[] = { RADIOLIB_LORAWAN_APPS_KEY };
// create the LoRaWAN node // create the LoRaWAN node
LoRaWANNode node(&radio, &Region, subBand); LoRaWANNode node(&radio, &Region, subBand);
// result code to text - these are error codes that can be raised when using LoRaWAN
// however, RadioLib has many more - see https://jgromes.github.io/RadioLib/group__status__codes.html for a complete list // result code to text ...
String stateDecode(const int16_t result) { String stateDecode(const int16_t result) {
switch (result) { switch (result) {
case RADIOLIB_ERR_NONE: case RADIOLIB_ERR_NONE:
@ -86,6 +160,7 @@ String stateDecode(const int16_t result) {
return "ERR_INVALID_OUTPUT_POWER"; return "ERR_INVALID_OUTPUT_POWER";
case RADIOLIB_ERR_NETWORK_NOT_JOINED: case RADIOLIB_ERR_NETWORK_NOT_JOINED:
return "RADIOLIB_ERR_NETWORK_NOT_JOINED"; return "RADIOLIB_ERR_NETWORK_NOT_JOINED";
case RADIOLIB_ERR_DOWNLINK_MALFORMED: case RADIOLIB_ERR_DOWNLINK_MALFORMED:
return "RADIOLIB_ERR_DOWNLINK_MALFORMED"; return "RADIOLIB_ERR_DOWNLINK_MALFORMED";
case RADIOLIB_ERR_INVALID_REVISION: case RADIOLIB_ERR_INVALID_REVISION:
@ -112,33 +187,34 @@ String stateDecode(const int16_t result) {
return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED"; return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED";
case RADIOLIB_ERR_CHECKSUM_MISMATCH: case RADIOLIB_ERR_CHECKSUM_MISMATCH:
return "RADIOLIB_ERR_CHECKSUM_MISMATCH"; return "RADIOLIB_ERR_CHECKSUM_MISMATCH";
case RADIOLIB_ERR_NO_JOIN_ACCEPT: case RADIOLIB_LORAWAN_NO_DOWNLINK:
return "RADIOLIB_ERR_NO_JOIN_ACCEPT"; return "RADIOLIB_LORAWAN_NO_DOWNLINK";
case RADIOLIB_LORAWAN_SESSION_RESTORED: case RADIOLIB_LORAWAN_SESSION_RESTORED:
return "RADIOLIB_LORAWAN_SESSION_RESTORED"; return "RADIOLIB_LORAWAN_SESSION_RESTORED";
case RADIOLIB_LORAWAN_NEW_SESSION: case RADIOLIB_LORAWAN_NEW_SESSION:
return "RADIOLIB_LORAWAN_NEW_SESSION"; return "RADIOLIB_LORAWAN_NEW_SESSION";
case RADIOLIB_ERR_NONCES_DISCARDED: case RADIOLIB_LORAWAN_NONCES_DISCARDED:
return "RADIOLIB_ERR_NONCES_DISCARDED"; return "RADIOLIB_LORAWAN_NONCES_DISCARDED";
case RADIOLIB_ERR_SESSION_DISCARDED: case RADIOLIB_LORAWAN_SESSION_DISCARDED:
return "RADIOLIB_ERR_SESSION_DISCARDED"; return "RADIOLIB_LORAWAN_SESSION_DISCARDED";
} }
return "See https://jgromes.github.io/RadioLib/group__status__codes.html"; return "See TypeDef.h";
} }
// helper function to display any issues // helper function to display any issues
void debug(bool failed, const __FlashStringHelper* message, int state, bool halt) { void debug(bool isFail, const __FlashStringHelper* message, int state, bool Freeze) {
if(failed) { if (isFail) {
Serial.print(message); Serial.print(message);
Serial.print(" - "); Serial.print(" - ");
Serial.print(stateDecode(state)); Serial.print(stateDecode(state));
Serial.print(" ("); Serial.print(" (");
Serial.print(state); Serial.print(state);
Serial.println(")"); Serial.println(")");
while(halt) { delay(1); } while (Freeze);
} }
} }
// helper function to display a byte array // helper function to display a byte array
void arrayDump(uint8_t *buffer, uint16_t len) { void arrayDump(uint8_t *buffer, uint16_t len) {
for(uint16_t c = 0; c < len; c++) { for(uint16_t c = 0; c < len; c++) {

View file

@ -10,11 +10,11 @@
Also, most of the possible and available functions are Also, most of the possible and available functions are
shown here for reference. shown here for reference.
LoRaWAN v1.0.4/v1.1 requires the use of EEPROM (persistent storage). LoRaWAN v1.1 requires the use of EEPROM (persistent storage).
Running this examples REQUIRES you to check "Resets DevNonces" Running this examples REQUIRES you to check "Resets DevNonces"
on your LoRaWAN dashboard. Refer to the notes or the on your LoRaWAN dashboard. Refer to the notes or the
network's documentation on how to do this. network's documentation on how to do this.
To comply with LoRaWAN's persistent storage, refer to To comply with LoRaWAN v1.1's persistent storage, refer to
https://github.com/radiolib-org/radiolib-persistence https://github.com/radiolib-org/radiolib-persistence
For default module settings, see the wiki page For default module settings, see the wiki page
@ -48,9 +48,6 @@ void setup() {
// Override the default join rate // Override the default join rate
uint8_t joinDR = 4; uint8_t joinDR = 4;
// Optionally provide a custom sleep function - see config.h
//node.setSleepFunction(customDelay);
// Setup the OTAA session information // Setup the OTAA session information
node.beginOTAA(joinEUI, devEUI, nwkKey, appKey); node.beginOTAA(joinEUI, devEUI, nwkKey, appKey);
@ -62,16 +59,16 @@ void setup() {
Serial.print("[LoRaWAN] DevAddr: "); Serial.print("[LoRaWAN] DevAddr: ");
Serial.println((unsigned long)node.getDevAddr(), HEX); Serial.println((unsigned long)node.getDevAddr(), HEX);
// Enable the ADR algorithm (on by default which is preferable) // Disable the ADR algorithm (on by default which is preferable)
node.setADR(true); node.setADR(false);
// Set a datarate to start off with // Set a fixed datarate
node.setDatarate(5); node.setDatarate(4);
// Manages uplink intervals to the TTN Fair Use Policy // Manages uplink intervals to the TTN Fair Use Policy
node.setDutyCycle(true, 1250); node.setDutyCycle(true, 1250);
// Update dwell time limits - 400ms is the limit for the US // Enable the dwell time limits - 400ms is the limit for the US
node.setDwellTime(true, 400); node.setDwellTime(true, 400);
Serial.println(F("Ready!\n")); Serial.println(F("Ready!\n"));
@ -108,28 +105,25 @@ void loop() {
LoRaWANEvent_t uplinkDetails; LoRaWANEvent_t uplinkDetails;
LoRaWANEvent_t downlinkDetails; LoRaWANEvent_t downlinkDetails;
uint8_t fPort = 10; uint8_t Port = 10;
// Retrieve the last uplink frame counter // Retrieve the last uplink frame counter
uint32_t fCntUp = node.getFCntUp(); uint32_t fcntUp = node.getFCntUp();
// Send a confirmed uplink on the second uplink // Send a confirmed uplink every 64th frame
// and also request the LinkCheck and DeviceTime MAC commands // and also request the LinkCheck and DeviceTime MAC commands
Serial.println(F("Sending uplink")); if(fcntUp % 64 == 0) {
if(fCntUp == 1) { Serial.println(F("[LoRaWAN] Requesting LinkCheck and DeviceTime"));
Serial.println(F("and requesting LinkCheck and DeviceTime"));
node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_LINK_CHECK); node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_LINK_CHECK);
node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_DEVICE_TIME); node.sendMacCommandReq(RADIOLIB_LORAWAN_MAC_DEVICE_TIME);
state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload), fPort, downlinkPayload, &downlinkSize, true, &uplinkDetails, &downlinkDetails); state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload), Port, downlinkPayload, &downlinkSize, true, &uplinkDetails, &downlinkDetails);
} else { } else {
state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload), fPort, downlinkPayload, &downlinkSize, false, &uplinkDetails, &downlinkDetails); state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload), Port, downlinkPayload, &downlinkSize);
} }
debug(state < RADIOLIB_ERR_NONE, F("Error in sendReceive"), state, false); debug((state != RADIOLIB_LORAWAN_NO_DOWNLINK) && (state != RADIOLIB_ERR_NONE), F("Error in sendReceive"), state, false);
// Check if a downlink was received // Check if downlink was received
// (state 0 = no downlink, state 1/2 = downlink in window Rx1/Rx2) if(state != RADIOLIB_LORAWAN_NO_DOWNLINK) {
if(state > 0) {
Serial.println(F("Received a downlink"));
// Did we get a downlink with data for us // Did we get a downlink with data for us
if(downlinkSize > 0) { if(downlinkSize > 0) {
Serial.println(F("Downlink data: ")); Serial.println(F("Downlink data: "));
@ -148,6 +142,11 @@ void loop() {
Serial.print(radio.getSNR()); Serial.print(radio.getSNR());
Serial.println(F(" dB")); Serial.println(F(" dB"));
// print frequency error
Serial.print(F("[LoRaWAN] Frequency error:\t"));
Serial.print(radio.getFrequencyError());
Serial.println(F(" Hz"));
// print extra information about the event // print extra information about the event
Serial.println(F("[LoRaWAN] Event information:")); Serial.println(F("[LoRaWAN] Event information:"));
Serial.print(F("[LoRaWAN] Confirmed:\t")); Serial.print(F("[LoRaWAN] Confirmed:\t"));
@ -159,15 +158,13 @@ void loop() {
Serial.print(F("[LoRaWAN] Frequency:\t")); Serial.print(F("[LoRaWAN] Frequency:\t"));
Serial.print(downlinkDetails.freq, 3); Serial.print(downlinkDetails.freq, 3);
Serial.println(F(" MHz")); Serial.println(F(" MHz"));
Serial.print(F("[LoRaWAN] Output power:\t"));
Serial.print(downlinkDetails.power);
Serial.println(F(" dBm"));
Serial.print(F("[LoRaWAN] Frame count:\t")); Serial.print(F("[LoRaWAN] Frame count:\t"));
Serial.println(downlinkDetails.fCnt); Serial.println(downlinkDetails.fCnt);
Serial.print(F("[LoRaWAN] Port:\t\t")); Serial.print(F("[LoRaWAN] Port:\t\t"));
Serial.println(downlinkDetails.fPort); Serial.println(downlinkDetails.fPort);
Serial.print(F("[LoRaWAN] Time-on-air: \t"));
Serial.print(node.getLastToA());
Serial.println(F(" ms"));
Serial.print(F("[LoRaWAN] Rx window: \t"));
Serial.println(state);
uint8_t margin = 0; uint8_t margin = 0;
uint8_t gwCnt = 0; uint8_t gwCnt = 0;
@ -187,8 +184,6 @@ void loop() {
Serial.println(fracSecond); Serial.println(fracSecond);
} }
} else {
Serial.println(F("[LoRaWAN] No downlink received"));
} }
// wait before sending another packet // wait before sending another packet
@ -198,7 +193,7 @@ void loop() {
Serial.print(F("[LoRaWAN] Next uplink in ")); Serial.print(F("[LoRaWAN] Next uplink in "));
Serial.print(delayMs/1000); Serial.print(delayMs/1000);
Serial.println(F(" seconds\n")); Serial.println(F("s"));
delay(delayMs); delay(delayMs);
} }

View file

@ -1,21 +1,8 @@
#ifndef _RADIOLIB_EX_LORAWAN_CONFIG_H #ifndef _CONFIG_H
#define _RADIOLIB_EX_LORAWAN_CONFIG_H #define _CONFIG_H
#include <RadioLib.h> #include <RadioLib.h>
// first you have to set your radio model and pin configuration
// this is provided just as a default example
SX1278 radio = new Module(10, 2, 9, 3);
// if you have RadioBoards (https://github.com/radiolib-org/RadioBoards)
// and are using one of the supported boards, you can do the following:
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// how often to send an uplink - consider legal & FUP constraints - see notes // how often to send an uplink - consider legal & FUP constraints - see notes
const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
@ -37,15 +24,101 @@ const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
// for the curious, the #ifndef blocks allow for automated testing &/or you can // for the curious, the #ifndef blocks allow for automated testing &/or you can
// put your EUI & keys in to your platformio.ini - see wiki for more tips // put your EUI & keys in to your platformio.ini - see wiki for more tips
// regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN470 // regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN500
const LoRaWANBand_t Region = EU868; const LoRaWANBand_t Region = EU868;
const uint8_t subBand = 0; // For US915, change this to 2, otherwise leave on 0
// subband choice: for US915/AU915 set to 2, for CN470 set to 1, otherwise leave on 0
const uint8_t subBand = 0;
// ============================================================================ // ============================================================================
// Below is to support the sketch - only make changes if the notes say so ... // Below is to support the sketch - only make changes if the notes say so ...
// Auto select MCU <-> radio connections
// If you get an error message when compiling, it may be that the
// pinmap could not be determined - see the notes for more info
// Adafruit
#if defined(ARDUINO_SAMD_FEATHER_M0)
#pragma message ("Adafruit Feather M0 with RFM95")
#pragma message ("Link required on board")
SX1276 radio = new Module(8, 3, 4, 6);
// LilyGo
#elif defined(ARDUINO_TTGO_LORA32_V1)
#pragma message ("Using TTGO LoRa32 v1 - no Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TTGO_LORA32_V2)
#pragma message ("Using TTGO LoRa32 v2 + Display")
SX1276 radio = new Module(18, 26, 12, RADIOLIB_NC);
#elif defined(ARDUINO_TTGO_LoRa32_v21new) // T3_V1.6.1
#pragma message ("Using TTGO LoRa32 v2.1 marked T3_V1.6.1 + Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1262)
#pragma error ("ARDUINO_TBEAM_USE_RADIO_SX1262 awaiting pin map")
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1276)
#pragma message ("Using TTGO T-Beam")
SX1276 radio = new Module(18, 26, 23, 33);
// HelTec: https://github.com/espressif/arduino-esp32/blob/master/variants/heltec_*/pins_arduino.h
#elif defined(ARDUINO_HELTEC_WIFI_LORA_32)
#pragma message ("Using Heltec WiFi LoRa32")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_heltec_wifi_lora_32_V2)
#pragma message ("Using Heltec WiFi LoRa32 v2")
SX1278 radio = new Module(14, 4, 12, 16);
// Pending verfication of which radio is shipped
// #elif defined(ARDUINO_heltec_wifi_lora_32_V2)
// #pragma message ("ARDUINO_heltec_wifi_kit_32_V2 awaiting pin map")
// SX1276 radio = new Module(18, 26, 14, 35);
#elif defined(ARDUINO_heltec_wifi_lora_32_V3)
#pragma message ("Using Heltec WiFi LoRa32 v3 - Display + USB-C")
SX1262 radio = new Module(8, 14, 12, 13);
// Following not verified
#elif defined (ARDUINO_heltec_wireless_stick)
#pragma message ("Using Heltec Wireless Stick")
SX1278 radio = new Module(14, 4, 12, 16);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK)
#pragma message ("Using Heltec Wireless Stick")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_V3)
#pragma message ("Using Heltec Wireless Stick v3")
SX1262 radio = new Module(8, 14, 12, 13);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE)
#pragma message ("Using Heltec Wireless Stick Lite")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE_V3)
#pragma message ("Using Heltec Wireless Stick Lite v3")
SX1262 radio = new Module(34, 14, 12, 13);
// If we don't recognise the board
#else
#pragma message ("Unknown board - no automagic pinmap available")
// SX1262 pin order: Module(NSS/CS, DIO1, RESET, BUSY);
// SX1262 radio = new Module(8, 14, 12, 13);
// SX1278 pin order: Module(NSS/CS, DIO0, RESET, DIO1);
// SX1278 radio = new Module(10, 2, 9, 3);
// For Pi Pico + Waveshare HAT - work in progress
// SX1262 radio = new Module(3, 20, 15, 2, SPI1, RADIOLIB_DEFAULT_SPI_SETTINGS);
#endif
// copy over the EUI's & keys in to the something that will not compile if incorrectly formatted // copy over the EUI's & keys in to the something that will not compile if incorrectly formatted
uint64_t joinEUI = RADIOLIB_LORAWAN_JOIN_EUI; uint64_t joinEUI = RADIOLIB_LORAWAN_JOIN_EUI;
uint64_t devEUI = RADIOLIB_LORAWAN_DEV_EUI; uint64_t devEUI = RADIOLIB_LORAWAN_DEV_EUI;
@ -55,8 +128,8 @@ uint8_t nwkKey[] = { RADIOLIB_LORAWAN_NWK_KEY };
// create the LoRaWAN node // create the LoRaWAN node
LoRaWANNode node(&radio, &Region, subBand); LoRaWANNode node(&radio, &Region, subBand);
// result code to text - these are error codes that can be raised when using LoRaWAN
// however, RadioLib has many more - see https://jgromes.github.io/RadioLib/group__status__codes.html for a complete list // result code to text ...
String stateDecode(const int16_t result) { String stateDecode(const int16_t result) {
switch (result) { switch (result) {
case RADIOLIB_ERR_NONE: case RADIOLIB_ERR_NONE:
@ -81,6 +154,7 @@ String stateDecode(const int16_t result) {
return "ERR_INVALID_OUTPUT_POWER"; return "ERR_INVALID_OUTPUT_POWER";
case RADIOLIB_ERR_NETWORK_NOT_JOINED: case RADIOLIB_ERR_NETWORK_NOT_JOINED:
return "RADIOLIB_ERR_NETWORK_NOT_JOINED"; return "RADIOLIB_ERR_NETWORK_NOT_JOINED";
case RADIOLIB_ERR_DOWNLINK_MALFORMED: case RADIOLIB_ERR_DOWNLINK_MALFORMED:
return "RADIOLIB_ERR_DOWNLINK_MALFORMED"; return "RADIOLIB_ERR_DOWNLINK_MALFORMED";
case RADIOLIB_ERR_INVALID_REVISION: case RADIOLIB_ERR_INVALID_REVISION:
@ -107,33 +181,34 @@ String stateDecode(const int16_t result) {
return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED"; return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED";
case RADIOLIB_ERR_CHECKSUM_MISMATCH: case RADIOLIB_ERR_CHECKSUM_MISMATCH:
return "RADIOLIB_ERR_CHECKSUM_MISMATCH"; return "RADIOLIB_ERR_CHECKSUM_MISMATCH";
case RADIOLIB_ERR_NO_JOIN_ACCEPT: case RADIOLIB_LORAWAN_NO_DOWNLINK:
return "RADIOLIB_ERR_NO_JOIN_ACCEPT"; return "RADIOLIB_LORAWAN_NO_DOWNLINK";
case RADIOLIB_LORAWAN_SESSION_RESTORED: case RADIOLIB_LORAWAN_SESSION_RESTORED:
return "RADIOLIB_LORAWAN_SESSION_RESTORED"; return "RADIOLIB_LORAWAN_SESSION_RESTORED";
case RADIOLIB_LORAWAN_NEW_SESSION: case RADIOLIB_LORAWAN_NEW_SESSION:
return "RADIOLIB_LORAWAN_NEW_SESSION"; return "RADIOLIB_LORAWAN_NEW_SESSION";
case RADIOLIB_ERR_NONCES_DISCARDED: case RADIOLIB_LORAWAN_NONCES_DISCARDED:
return "RADIOLIB_ERR_NONCES_DISCARDED"; return "RADIOLIB_LORAWAN_NONCES_DISCARDED";
case RADIOLIB_ERR_SESSION_DISCARDED: case RADIOLIB_LORAWAN_SESSION_DISCARDED:
return "RADIOLIB_ERR_SESSION_DISCARDED"; return "RADIOLIB_LORAWAN_SESSION_DISCARDED";
} }
return "See https://jgromes.github.io/RadioLib/group__status__codes.html"; return "See TypeDef.h";
} }
// helper function to display any issues // helper function to display any issues
void debug(bool failed, const __FlashStringHelper* message, int state, bool halt) { void debug(bool isFail, const __FlashStringHelper* message, int state, bool Freeze) {
if(failed) { if (isFail) {
Serial.print(message); Serial.print(message);
Serial.print(" - "); Serial.print(" - ");
Serial.print(stateDecode(state)); Serial.print(stateDecode(state));
Serial.print(" ("); Serial.print(" (");
Serial.print(state); Serial.print(state);
Serial.println(")"); Serial.println(")");
while(halt) { delay(1); } while (Freeze);
} }
} }
// helper function to display a byte array // helper function to display a byte array
void arrayDump(uint8_t *buffer, uint16_t len) { void arrayDump(uint8_t *buffer, uint16_t len) {
for(uint16_t c = 0; c < len; c++) { for(uint16_t c = 0; c < len; c++) {
@ -144,19 +219,5 @@ void arrayDump(uint8_t *buffer, uint16_t len) {
Serial.println(); Serial.println();
} }
// Custom delay function:
// Communication over LoRaWAN includes a lot of delays.
// By default, RadioLib will use the Arduino delay() function,
// which will waste a lot of power. However, you can put your
// microcontroller to sleep instead by customizing the function below,
// and providing it to RadioLib via "node.setSleepFunction".
// NOTE: You ahve to ensure that this function is timed precisely, and
// does actually wait for the amount of time specified!
// Failure to do so will result in missed downlinks or failed join!
void customDelay(RadioLibTime_t ms) {
// this is just an example, so we use the Arduino delay() function,
// but you can put your microcontroller to sleep here
::delay(ms);
}
#endif #endif

View file

@ -1,8 +1,6 @@
/* /*
RadioLib LoRaWAN Starter Example RadioLib LoRaWAN Starter Example
! Please refer to the included notes to get started !
This example joins a LoRaWAN network and will send This example joins a LoRaWAN network and will send
uplink packets. Before you start, you will have to uplink packets. Before you start, you will have to
register your device at https://www.thethingsnetwork.org/ register your device at https://www.thethingsnetwork.org/
@ -37,8 +35,7 @@ void setup() {
debug(state != RADIOLIB_ERR_NONE, F("Initialise radio failed"), state, true); debug(state != RADIOLIB_ERR_NONE, F("Initialise radio failed"), state, true);
// Setup the OTAA session information // Setup the OTAA session information
state = node.beginOTAA(joinEUI, devEUI, nwkKey, appKey); node.beginOTAA(joinEUI, devEUI, nwkKey, appKey);
debug(state != RADIOLIB_ERR_NONE, F("Initialise node failed"), state, true);
Serial.println(F("Join ('login') the LoRaWAN Network")); Serial.println(F("Join ('login') the LoRaWAN Network"));
state = node.activateOTAA(); state = node.activateOTAA();
@ -63,19 +60,11 @@ void loop() {
// Perform an uplink // Perform an uplink
int16_t state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload)); int16_t state = node.sendReceive(uplinkPayload, sizeof(uplinkPayload));
debug(state < RADIOLIB_ERR_NONE, F("Error in sendReceive"), state, false); debug((state != RADIOLIB_LORAWAN_NO_DOWNLINK) && (state != RADIOLIB_ERR_NONE), F("Error in sendReceive"), state, false);
// Check if a downlink was received Serial.print(F("Uplink complete, next in "));
// (state 0 = no downlink, state 1/2 = downlink in window Rx1/Rx2)
if(state > 0) {
Serial.println(F("Received a downlink"));
} else {
Serial.println(F("No downlink received"));
}
Serial.print(F("Next uplink in "));
Serial.print(uplinkIntervalSeconds); Serial.print(uplinkIntervalSeconds);
Serial.println(F(" seconds\n")); Serial.println(F(" seconds"));
// Wait until next uplink - observing legal & TTN FUP constraints // Wait until next uplink - observing legal & TTN FUP constraints
delay(uplinkIntervalSeconds * 1000UL); // delay needs milli-seconds delay(uplinkIntervalSeconds * 1000UL); // delay needs milli-seconds

View file

@ -1,21 +1,8 @@
#ifndef _RADIOLIB_EX_LORAWAN_CONFIG_H #ifndef _CONFIG_H
#define _RADIOLIB_EX_LORAWAN_CONFIG_H #define _CONFIG_H
#include <RadioLib.h> #include <RadioLib.h>
// first you have to set your radio model and pin configuration
// this is provided just as a default example
SX1278 radio = new Module(10, 2, 9, 3);
// if you have RadioBoards (https://github.com/radiolib-org/RadioBoards)
// and are using one of the supported boards, you can do the following:
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// how often to send an uplink - consider legal & FUP constraints - see notes // how often to send an uplink - consider legal & FUP constraints - see notes
const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
@ -37,15 +24,101 @@ const uint32_t uplinkIntervalSeconds = 5UL * 60UL; // minutes x seconds
// for the curious, the #ifndef blocks allow for automated testing &/or you can // for the curious, the #ifndef blocks allow for automated testing &/or you can
// put your EUI & keys in to your platformio.ini - see wiki for more tips // put your EUI & keys in to your platformio.ini - see wiki for more tips
// regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN470 // regional choices: EU868, US915, AU915, AS923, AS923_2, AS923_3, AS923_4, IN865, KR920, CN500
const LoRaWANBand_t Region = EU868; const LoRaWANBand_t Region = EU868;
const uint8_t subBand = 0; // For US915, change this to 2, otherwise leave on 0
// subband choice: for US915/AU915 set to 2, for CN470 set to 1, otherwise leave on 0
const uint8_t subBand = 0;
// ============================================================================ // ============================================================================
// Below is to support the sketch - only make changes if the notes say so ... // Below is to support the sketch - only make changes if the notes say so ...
// Auto select MCU <-> radio connections
// If you get an error message when compiling, it may be that the
// pinmap could not be determined - see the notes for more info
// Adafruit
#if defined(ARDUINO_SAMD_FEATHER_M0)
#pragma message ("Adafruit Feather M0 with RFM95")
#pragma message ("Link required on board")
SX1276 radio = new Module(8, 3, 4, 6);
// LilyGo
#elif defined(ARDUINO_TTGO_LORA32_V1)
#pragma message ("Using TTGO LoRa32 v1 - no Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TTGO_LORA32_V2)
#pragma message ("Using TTGO LoRa32 v2 + Display")
SX1276 radio = new Module(18, 26, 12, RADIOLIB_NC);
#elif defined(ARDUINO_TTGO_LoRa32_v21new) // T3_V1.6.1
#pragma message ("Using TTGO LoRa32 v2.1 marked T3_V1.6.1 + Display")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1262)
#pragma error ("ARDUINO_TBEAM_USE_RADIO_SX1262 awaiting pin map")
#elif defined(ARDUINO_TBEAM_USE_RADIO_SX1276)
#pragma message ("Using TTGO T-Beam")
SX1276 radio = new Module(18, 26, 23, 33);
// HelTec: https://github.com/espressif/arduino-esp32/blob/master/variants/heltec_*/pins_arduino.h
#elif defined(ARDUINO_HELTEC_WIFI_LORA_32)
#pragma message ("Using Heltec WiFi LoRa32")
SX1276 radio = new Module(18, 26, 14, 33);
#elif defined(ARDUINO_heltec_wifi_lora_32_V2)
#pragma message ("Using Heltec WiFi LoRa32 v2")
SX1278 radio = new Module(14, 4, 12, 16);
// Pending verfication of which radio is shipped
// #elif defined(ARDUINO_heltec_wifi_lora_32_V2)
// #pragma message ("ARDUINO_heltec_wifi_kit_32_V2 awaiting pin map")
// SX1276 radio = new Module(18, 26, 14, 35);
#elif defined(ARDUINO_heltec_wifi_lora_32_V3)
#pragma message ("Using Heltec WiFi LoRa32 v3 - Display + USB-C")
SX1262 radio = new Module(8, 14, 12, 13);
// Following not verified
#elif defined (ARDUINO_heltec_wireless_stick)
#pragma message ("Using Heltec Wireless Stick")
SX1278 radio = new Module(14, 4, 12, 16);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK)
#pragma message ("Using Heltec Wireless Stick")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_V3)
#pragma message ("Using Heltec Wireless Stick v3")
SX1262 radio = new Module(8, 14, 12, 13);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE)
#pragma message ("Using Heltec Wireless Stick Lite")
SX1276 radio = new Module(18, 26, 14, 35);
#elif defined (ARDUINO_HELTEC_WIRELESS_STICK_LITE_V3)
#pragma message ("Using Heltec Wireless Stick Lite v3")
SX1262 radio = new Module(34, 14, 12, 13);
// If we don't recognise the board
#else
#pragma message ("Unknown board - no automagic pinmap available")
// SX1262 pin order: Module(NSS/CS, DIO1, RESET, BUSY);
// SX1262 radio = new Module(8, 14, 12, 13);
// SX1278 pin order: Module(NSS/CS, DIO0, RESET, DIO1);
// SX1278 radio = new Module(10, 2, 9, 3);
// For Pi Pico + Waveshare HAT - work in progress
// SX1262 radio = new Module(3, 20, 15, 2, SPI1, RADIOLIB_DEFAULT_SPI_SETTINGS);
#endif
// copy over the EUI's & keys in to the something that will not compile if incorrectly formatted // copy over the EUI's & keys in to the something that will not compile if incorrectly formatted
uint64_t joinEUI = RADIOLIB_LORAWAN_JOIN_EUI; uint64_t joinEUI = RADIOLIB_LORAWAN_JOIN_EUI;
uint64_t devEUI = RADIOLIB_LORAWAN_DEV_EUI; uint64_t devEUI = RADIOLIB_LORAWAN_DEV_EUI;
@ -55,8 +128,8 @@ uint8_t nwkKey[] = { RADIOLIB_LORAWAN_NWK_KEY };
// create the LoRaWAN node // create the LoRaWAN node
LoRaWANNode node(&radio, &Region, subBand); LoRaWANNode node(&radio, &Region, subBand);
// result code to text - these are error codes that can be raised when using LoRaWAN
// however, RadioLib has many more - see https://jgromes.github.io/RadioLib/group__status__codes.html for a complete list // result code to text ...
String stateDecode(const int16_t result) { String stateDecode(const int16_t result) {
switch (result) { switch (result) {
case RADIOLIB_ERR_NONE: case RADIOLIB_ERR_NONE:
@ -81,6 +154,7 @@ String stateDecode(const int16_t result) {
return "ERR_INVALID_OUTPUT_POWER"; return "ERR_INVALID_OUTPUT_POWER";
case RADIOLIB_ERR_NETWORK_NOT_JOINED: case RADIOLIB_ERR_NETWORK_NOT_JOINED:
return "RADIOLIB_ERR_NETWORK_NOT_JOINED"; return "RADIOLIB_ERR_NETWORK_NOT_JOINED";
case RADIOLIB_ERR_DOWNLINK_MALFORMED: case RADIOLIB_ERR_DOWNLINK_MALFORMED:
return "RADIOLIB_ERR_DOWNLINK_MALFORMED"; return "RADIOLIB_ERR_DOWNLINK_MALFORMED";
case RADIOLIB_ERR_INVALID_REVISION: case RADIOLIB_ERR_INVALID_REVISION:
@ -107,33 +181,34 @@ String stateDecode(const int16_t result) {
return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED"; return "RADIOLIB_ERR_DWELL_TIME_EXCEEDED";
case RADIOLIB_ERR_CHECKSUM_MISMATCH: case RADIOLIB_ERR_CHECKSUM_MISMATCH:
return "RADIOLIB_ERR_CHECKSUM_MISMATCH"; return "RADIOLIB_ERR_CHECKSUM_MISMATCH";
case RADIOLIB_ERR_NO_JOIN_ACCEPT: case RADIOLIB_LORAWAN_NO_DOWNLINK:
return "RADIOLIB_ERR_NO_JOIN_ACCEPT"; return "RADIOLIB_LORAWAN_NO_DOWNLINK";
case RADIOLIB_LORAWAN_SESSION_RESTORED: case RADIOLIB_LORAWAN_SESSION_RESTORED:
return "RADIOLIB_LORAWAN_SESSION_RESTORED"; return "RADIOLIB_LORAWAN_SESSION_RESTORED";
case RADIOLIB_LORAWAN_NEW_SESSION: case RADIOLIB_LORAWAN_NEW_SESSION:
return "RADIOLIB_LORAWAN_NEW_SESSION"; return "RADIOLIB_LORAWAN_NEW_SESSION";
case RADIOLIB_ERR_NONCES_DISCARDED: case RADIOLIB_LORAWAN_NONCES_DISCARDED:
return "RADIOLIB_ERR_NONCES_DISCARDED"; return "RADIOLIB_LORAWAN_NONCES_DISCARDED";
case RADIOLIB_ERR_SESSION_DISCARDED: case RADIOLIB_LORAWAN_SESSION_DISCARDED:
return "RADIOLIB_ERR_SESSION_DISCARDED"; return "RADIOLIB_LORAWAN_SESSION_DISCARDED";
} }
return "See https://jgromes.github.io/RadioLib/group__status__codes.html"; return "See TypeDef.h";
} }
// helper function to display any issues // helper function to display any issues
void debug(bool failed, const __FlashStringHelper* message, int state, bool halt) { void debug(bool isFail, const __FlashStringHelper* message, int state, bool Freeze) {
if(failed) { if (isFail) {
Serial.print(message); Serial.print(message);
Serial.print(" - "); Serial.print(" - ");
Serial.print(stateDecode(state)); Serial.print(stateDecode(state));
Serial.print(" ("); Serial.print(" (");
Serial.print(state); Serial.print(state);
Serial.println(")"); Serial.println(")");
while(halt) { delay(1); } while (Freeze);
} }
} }
// helper function to display a byte array // helper function to display a byte array
void arrayDump(uint8_t *buffer, uint16_t len) { void arrayDump(uint8_t *buffer, uint16_t len) {
for(uint16_t c = 0; c < len; c++) { for(uint16_t c = 0; c < len; c++) {
@ -144,4 +219,5 @@ void arrayDump(uint8_t *buffer, uint16_t len) {
Serial.println(); Serial.println();
} }
#endif #endif

View file

@ -52,7 +52,7 @@ You are making your own device using a third party LoRaWAN stack so there will n
Choose the Frequency plan appropriate for your region. Consider that almost all countries have laws relating to what frequencies you use so don't get creative. For Europe please use the recommended option. For other regions use the entry marked 'used by TTN'. Choose the Frequency plan appropriate for your region. Consider that almost all countries have laws relating to what frequencies you use so don't get creative. For Europe please use the recommended option. For other regions use the entry marked 'used by TTN'.
Choose LoRaWAN 1.1.0 - the last one in the list - the latest specfication. RadioLib uses RP001 Regional Parameters 1.1 revision B. Choose LoRaWAN 1.1.0 - the last one in the list - the latest specfication. RadioLib uses RP001 Regional Parameters 1.1 revision A.
At this point you will be asked for your JoinEUI. As this is a DIY device and we are using RadioLib, you can use all zero's as recommended by The LoRa Alliance TR007 Technical Recommendations document. Once you've put in all zeros and clicked confirm you will be asked for a DevEUI, AppKey and NwkKey. It is preferable to have the console generate them so they are properly formatted. At this point you will be asked for your JoinEUI. As this is a DIY device and we are using RadioLib, you can use all zero's as recommended by The LoRa Alliance TR007 Technical Recommendations document. Once you've put in all zeros and clicked confirm you will be asked for a DevEUI, AppKey and NwkKey. It is preferable to have the console generate them so they are properly formatted.
@ -141,12 +141,31 @@ If you are using US915 or AU915 then you should change the subBand const to 2.
### The pinmap ### The pinmap
This is the connection between your microcontroller (ESP32, ATmega, SAMD etc.) and the radio (SX1276, SX1262, LR1110 etc.). This is the connection between the MCU (ESP32/ATmega/SAMD) and the LoRa radio (SX1276/SX1262).
You have to select the correct module and set the correct pins.
Pin maps for commonly used radio modules are kept in a separate library, called RadioBoards: https://github.com/radiolib-org/RadioBoards Prebuilt modules are easy - we can detect the board and setup the pinmap for you. These boards are:
* TTGO_LoRa32
* TTGO_LoRa32_V1
* TTGO_LORA32_V2
* TTGO_LORA32_v21NEW
* HELTEC_WIFI_LORA_32
* HELTEC_WIFI_LORA_32_V2
* HELTEC_WIFI_LORA_32_V3
* HELTEC_WIRELESS_STICK
* HELTEC_WIRELESS_STICK_V3
* HELTEC_WIRELESS_STICK_LITE
* HELTEC_WIRELESS_STICK_LITE_V3
If you have a TTGO T-Beam, you must choose the correct radio from the Board Revision sub-menu found under the main Tools menu.
* TBEAM_USE_RADIO_SX1262
* TBEAM_USE_RADIO_SX1276
Auto-setup for the Adafruit Feather M0 with RFM95 is included but you must solder a wire or use a jumper to link from pin 6 to io1: https://learn.adafruit.com/the-things-network-for-feather/arduino-wiring
If you have a module that's not on this list, please go to the "Pinmap How-To" below.
It can automatically detect your microcontroller platform and radio, and configure things for you. If you have a board that is not supported by RadioBoards, feel free to suggest it in the RadioBoards issues, or better yet - open a pull request there!
## Observations on the main sketch ## Observations on the main sketch
@ -178,3 +197,8 @@ Coming soon
### Device testing ### Device testing
The LoRaWAN code base works to a specification and once you are happy your device is able to join & send a few dozen uplinks, continuing to sit around waiting for an uplink to test your sensor code & payload format is a waste of your time. The solution is to write everything else in a different sketch, output the array to the serial console and then you can copy & paste the hex array in to the TTN console Payload Formatters section to test the decoding. The LoRaWAN code base works to a specification and once you are happy your device is able to join & send a few dozen uplinks, continuing to sit around waiting for an uplink to test your sensor code & payload format is a waste of your time. The solution is to write everything else in a different sketch, output the array to the serial console and then you can copy & paste the hex array in to the TTN console Payload Formatters section to test the decoding.
## Pinmap How-To
Coming soon

View file

@ -1,34 +1,17 @@
# LoRaWAN examples # LoRaWAN examples
RadioLib LoRaWAN examples. RadioLib LoRaWAN v1.1 examples.
* [LoRaWAN_Starter](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_Starter): this is the recommended entry point for new users. Please read the [`notes`](https://github.com/jgromes/RadioLib/blob/master/examples/LoRaWAN/LoRaWAN_Starter/notes.md) that come with this example to learn more about LoRaWAN and how to use it in RadioLib! * [LoRaWAN_Starter](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_Starter): this is the recommended entry point for new users. Please read the [`notes`](https://github.com/jgromes/RadioLib/blob/master/examples/LoRaWAN/LoRaWAN_Starter/notes.md) that come with this example to learn more about LoRaWAN and how to use it in RadioLib!
* [LoRaWAN_Reference](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_Reference): this sketch showcases most of the available API for LoRaWAN in RadioLib. Be frightened by the possibilities! It is recommended you have read all the [`notes`](https://github.com/jgromes/RadioLib/blob/master/examples/LoRaWAN/LoRaWAN_Starter/notes.md) for the Starter sketch first, as well as the [Learn section on The Things Network](https://www.thethingsnetwork.org/docs/lorawan/)! * [LoRaWAN_Reference](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_Reference): this sketch showcases most of the available API for LoRaWAN in RadioLib. Be frightened by the possibilities! It is recommended you have read all the [`notes`](https://github.com/jgromes/RadioLib/blob/master/examples/LoRaWAN/LoRaWAN_Starter/notes.md) for the Starter sketch first, as well as the [Learn section on The Things Network](https://www.thethingsnetwork.org/docs/lorawan/)!
* [LoRaWAN_ABP](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_ABP): if you wish to use ABP instead of OTAA (but why?), this example shows how you can do this using RadioLib. * [LoRaWAN_ABP](https://github.com/jgromes/RadioLib/tree/master/examples/LoRaWAN/LoRaWAN_ABP): if you wish to use ABP instead of OTAA (but why?), this example shows how you can do this using RadioLib.
## LoRaWAN versions & regional parameters ---
RadioLib implements both LoRaWAN Specification 1.1 and 1.0.4. Confusingly, 1.0.4 is newer than 1.1, but 1.1 includes more security checks and as such **LoRaWAN 1.1 is preferred**.
The catch is in the Regional Parameters: as RP002 1.0.4 is newer than RP001 1.1, it is more up to date regarding local laws & regulations. Therefore, RadioLib implements 1.0.4 as baseline and 1.1 (revision B) as fallback, and as such **RP002 Regional Parameters 1.0.4 is preferred**.
_Note: the CN470 band is implemented as specified in RP001 1.1 revision B, as the RP002 1.0.4 version is much too complex._
To activate a LoRaWAN 1.1 session, supply all the required keys:
```cpp
node.beginOTAA(joinEUI, devEUI, nwkKey, appKey);
node.beginABP(devAddr, fNwkSIntKey, sNwkSIntKey, nwkSEncKey, appSKey);
```
To activate a LoRaWAN 1.0.4 session, set the keys that are not available to `NULL`:
```cpp
node.beginOTAA(joinEUI, devEUI, NULL, appKey);
node.beginABP(devAddr, NULL, NULL, nwkSEncKey, appSKey);
```
The device doesn't need to know the Regional Parameters version - that is of importance on the console.
## LoRaWAN persistence
> [!WARNING] > [!WARNING]
> These examples do not actually comply with LoRaWAN 1.0.4/1.1: for that, persistent storage is necessary. As the implementation of persistent storage differs between different platforms, these are not given here, but in a separate repository, see below: > These examples do not fully comply with LoRaWAN v1.1: for that, persistent storage is necessary. As the implementation of persistent storage differs between different platforms, these are not given here, but in a separate repository, see below:
In [this repository](https://github.com/radiolib-org/radiolib-persistence), examples are provided that do comply with the required persistence of certain parameters for LoRaWAN 1.1. Examples are (or will become) available for some of the most popular platforms. **These examples assume you have successfully used the Starter sketch and understood (most of) the accompanying notes!** ## RadioLib persistence
In [this repository](https://github.com/radiolib-org/radiolib-persistence), examples are provided that do comply with the required persistence of certain parameters for LoRaWAN v1.1. Examples are (or will become) available for some of the most popular platforms. **These examples assume you have successfully used the Starter sketch and understood (most of) the accompanying notes!**
Currently, examples are available for the following platforms: Currently, examples are available for the following platforms:
* [LoRaWAN for ESP32](https://github.com/radiolib-org/radiolib-persistence/tree/main/examples/LoRaWAN_ESP32) * [LoRaWAN for ESP32](https://github.com/radiolib-org/radiolib-persistence/tree/main/examples/LoRaWAN_ESP32)

View file

@ -1,23 +1,23 @@
/* /*
RadioLib SX127x Morse Receive AM Example RadioLib SX127x Morse Receive AM Example
This example receives Morse code message using This example receives Morse code message using
SX1278's FSK modem. The signal is expected to be SX1278's FSK modem. The signal is expected to be
modulated as OOK, to be demodulated in AM mode. modulated as OOK, to be demodulated in AM mode.
Other modules that can be used for Morse Code Other modules that can be used for Morse Code
with AFSK modulation: with AFSK modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -30,13 +30,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// pin 5 is connected to SX1278 DIO2 // pin 5 is connected to SX1278 DIO2
@ -56,7 +52,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// when using one of the non-LoRa modules for Morse code // when using one of the non-LoRa modules for Morse code
@ -73,7 +69,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// after that, set mode to OOK to emulate AM modulation // after that, set mode to OOK to emulate AM modulation
@ -84,7 +80,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// start direct mode reception // start direct mode reception

View file

@ -1,23 +1,23 @@
/* /*
RadioLib Morse Transmit AM Example RadioLib Morse Transmit AM Example
This example sends Morse code message using This example sends Morse code message using
SX1278's FSK modem. The signal is modulated SX1278's FSK modem. The signal is modulated
as OOK, and may be demodulated in AM mode. as OOK, and may be demodulated in AM mode.
Other modules that can be used for Morse Code Other modules that can be used for Morse Code
with AM modulation: with AM modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -30,13 +30,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// pin 5 is connected to SX1278 DIO2 // pin 5 is connected to SX1278 DIO2
@ -61,7 +57,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Morse client // initialize Morse client
@ -74,7 +70,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// after that, set mode to OOK to emulate AM modulation // after that, set mode to OOK to emulate AM modulation
@ -85,7 +81,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,24 +1,24 @@
/* /*
RadioLib Morse Transmit AFSK Example RadioLib Morse Transmit AFSK Example
This example sends Morse code message using This example sends Morse code message using
SX1278's FSK modem. The signal is modulated SX1278's FSK modem. The signal is modulated
as AFSK, and may be demodulated in FM mode. as AFSK, and may be demodulated in FM mode.
Other modules that can be used for Morse Code Other modules that can be used for Morse Code
with AFSK modulation: with AFSK modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -31,13 +31,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -69,7 +65,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Morse client // initialize Morse client
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,26 +1,26 @@
/* /*
RadioLib Morse Transmit SSB Example RadioLib Morse Transmit SSB Example
This example sends Morse code message using This example sends Morse code message using
SX1278's FSK modem. The signal is an unmodulated SX1278's FSK modem. The signal is an unmodulated
carrier wave, and may be demodulated in SSB mode. carrier wave, and may be demodulated in SSB mode.
Other modules that can be used for Morse Code: Other modules that can be used for Morse Code:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX128x - SX128x
- LR11x0 - LR11x0
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -33,13 +33,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create Morse client instance using the FSK module // create Morse client instance using the FSK module
MorseClient morse(&radio); MorseClient morse(&radio);
@ -60,7 +56,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Morse client // initialize Morse client
@ -73,7 +69,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,10 +0,0 @@
# RadioLib ESP-IDF example
This example shows how to use RadioLib as ESP-IDF component, without the Arduino framework. To run in ESP-IDF (or on any other platform), RadioLib includes an internal hardware abstraction layer (HAL). This software layer takes care of basic interaction with the hardware, such as performing SPI transaction or GPIO operations. To run on your chosen ESP microcontroller, you will likely have to customize the example HAL for your specific ESP type.
## Structure of the example
* `main/CMakeLists.txt` - IDF component CMake file
* `main/EspHal.h` - RadioLib HAL example implementation
* `main/idf_component.yml` - declaration of the RadioLib dependency for this example
* `main/main.cpp` - the example source code

View file

@ -7,7 +7,7 @@
// this example only works on ESP32 and is unlikely to work on ESP32S2/S3 etc. // this example only works on ESP32 and is unlikely to work on ESP32S2/S3 etc.
// if you need high portability, you should probably use Arduino anyway ... // if you need high portability, you should probably use Arduino anyway ...
#if CONFIG_IDF_TARGET_ESP32 == 0 #if CONFIG_IDF_TARGET_ESP32 == 0
#error This example HAL only supports ESP32 targets. Support for ESP32S2/S3 etc. can be added by adjusting this file to user needs. #error Target is not ESP32!
#endif #endif
// include all the dependencies // include all the dependencies

View file

@ -1,7 +1,7 @@
dependencies: dependencies:
RadioLib: RadioLib:
# referenced locally because the example is a part of the repository itself # referenced locally because the example is a part of the repository itself
# under normal circumstances, it's preferable to reference the repository instead # under normal circumstances, it's preferrable to reference the repository instead
# for other options, see https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html # for other options, see https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html
path: ../../../../../RadioLib path: ../../../../../RadioLib
#git: https://github.com/jgromes/RadioLib.git #git: https://github.com/jgromes/RadioLib.git

View file

@ -23,11 +23,11 @@ add_executable(${PROJECT_NAME}
) )
# Pull in common dependencies # Pull in common dependencies
target_link_libraries(${PROJECT_NAME} pico_stdlib hardware_spi hardware_gpio hardware_timer pico_multicore hardware_pwm RadioLib) target_link_libraries(${PROJECT_NAME} pico_stdlib hardware_spi hardware_gpio hardware_timer RadioLib)
pico_enable_stdio_usb(${PROJECT_NAME} 1) pico_enable_stdio_usb(${PROJECT_NAME} 1)
pico_enable_stdio_uart(${PROJECT_NAME} 0) pico_enable_stdio_uart(${PROJECT_NAME} 0)
# Create map/bin/hex file etc. # Create map/bin/hex file etc.
pico_add_extra_outputs(${PROJECT_NAME}) pico_add_extra_outputs(${PROJECT_NAME})

View file

@ -8,45 +8,6 @@
#include <pico/stdlib.h> #include <pico/stdlib.h>
#include "hardware/spi.h" #include "hardware/spi.h"
#include "hardware/timer.h" #include "hardware/timer.h"
#include "hardware/pwm.h"
#include "hardware/clocks.h"
#include "pico/multicore.h"
uint32_t toneLoopPin;
unsigned int toneLoopFrequency;
unsigned long toneLoopDuration;
// pre-calculated pulse-widths for 1200 and 2200Hz
// we do this to save calculation time (see https://github.com/khoih-prog/RP2040_PWM/issues/6)
#define SLEEP_1200 416.666
#define SLEEP_2200 227.272
// === NOTE ===
// The tone(...) implementation uses the second core on the RPi Pico. This is to diminish as much
// jitter in the output tones as possible.
void toneLoop(){
gpio_set_dir(toneLoopPin, GPIO_OUT);
uint32_t sleep_dur;
if (toneLoopFrequency == 1200) {
sleep_dur = SLEEP_1200;
} else if (toneLoopFrequency == 2200) {
sleep_dur = SLEEP_2200;
} else {
sleep_dur = 500000 / toneLoopFrequency;
}
// tone bitbang
while(1){
gpio_put(toneLoopPin, 1);
sleep_us(sleep_dur);
gpio_put(toneLoopPin, 0);
sleep_us(sleep_dur);
tight_loop_contents();
}
}
// create a new Raspberry Pi Pico hardware abstraction // create a new Raspberry Pi Pico hardware abstraction
// layer using the Pico SDK // layer using the Pico SDK
@ -60,7 +21,8 @@ public:
_spiSpeed(spiSpeed), _spiSpeed(spiSpeed),
_misoPin(misoPin), _misoPin(misoPin),
_mosiPin(mosiPin), _mosiPin(mosiPin),
_sckPin(sckPin){} _sckPin(sckPin) {
}
void init() override { void init() override {
stdio_init_all(); stdio_init_all();
@ -148,19 +110,6 @@ public:
return (this->micros() - start); return (this->micros() - start);
} }
void tone(uint32_t pin, unsigned int frequency, unsigned long duration = 0) override {
// tones on the Pico are generated using bitbanging. This process is offloaded to the Pico's second core
multicore_reset_core1();
toneLoopPin = pin;
toneLoopFrequency = frequency;
toneLoopDuration = duration;
multicore_launch_core1(toneLoop);
}
void noTone(uint32_t pin) override {
multicore_reset_core1();
}
void spiBegin() { void spiBegin() {
spi_init(_spiChannel, _spiSpeed); spi_init(_spiChannel, _spiSpeed);
spi_set_format(_spiChannel, 8, SPI_CPOL_0, SPI_CPHA_0, SPI_MSB_FIRST); spi_set_format(_spiChannel, 8, SPI_CPOL_0, SPI_CPHA_0, SPI_MSB_FIRST);
@ -176,10 +125,6 @@ public:
spi_write_read_blocking(_spiChannel, out, in, len); spi_write_read_blocking(_spiChannel, out, in, len);
} }
void yield() override {
tight_loop_contents();
}
void spiEndTransaction() {} void spiEndTransaction() {}
void spiEnd() { void spiEnd() {
@ -195,4 +140,4 @@ private:
uint32_t _sckPin; uint32_t _sckPin;
}; };
#endif #endif

View file

@ -41,7 +41,7 @@
#include <RadioLib.h> #include <RadioLib.h>
// include the hardware abstraction layer // include the hardware abstraction layer
#include "hal/RPiPico/PicoHal.h" #include "PicoHal.h"
// create a new instance of the HAL class // create a new instance of the HAL class
PicoHal* hal = new PicoHal(SPI_PORT, SPI_MISO, SPI_MOSI, SPI_SCK); PicoHal* hal = new PicoHal(SPI_PORT, SPI_MISO, SPI_MOSI, SPI_SCK);

View file

@ -15,7 +15,7 @@ add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/../../../../RadioLib" "${CMAKE_CUR
add_executable(${PROJECT_NAME} main.cpp) add_executable(${PROJECT_NAME} main.cpp)
# link both libraries # link both libraries
target_link_libraries(${PROJECT_NAME} RadioLib lgpio) target_link_libraries(${PROJECT_NAME} RadioLib pigpio)
# you can also specify RadioLib compile-time flags here # you can also specify RadioLib compile-time flags here
#target_compile_definitions(RadioLib PUBLIC RADIOLIB_DEBUG_BASIC RADIOLIB_DEBUG_SPI) #target_compile_definitions(RadioLib PUBLIC RADIOLIB_DEBUG_BASIC RADIOLIB_DEBUG_SPI)

View file

@ -0,0 +1,194 @@
#ifndef PI_HAL_H
#define PI_HAL_H
// include RadioLib
#include <RadioLib.h>
// include the library for Raspberry GPIO pins
#include "pigpio.h"
// these should really be swapped, but for some reason,
// it seems like the change directions are inverted in gpioSetAlert functions
#define PI_RISING (FALLING_EDGE)
#define PI_FALLING (RISING_EDGE)
// forward declaration of alert handler that will be used to emulate interrupts
static void pigpioAlertHandler(int event, int level, uint32_t tick, void *userdata);
// create a new Raspberry Pi hardware abstraction layer
// using the pigpio library
// the HAL must inherit from the base RadioLibHal class
// and implement all of its virtual methods
class PiHal : public RadioLibHal {
public:
// default constructor - initializes the base HAL and any needed private members
PiHal(uint8_t spiChannel, uint32_t spiSpeed = 2000000)
: RadioLibHal(PI_INPUT, PI_OUTPUT, PI_LOW, PI_HIGH, PI_RISING, PI_FALLING),
_spiChannel(spiChannel),
_spiSpeed(spiSpeed) {
}
void init() override {
// first initialise pigpio library
gpioInitialise();
// now the SPI
spiBegin();
// Waveshare LoRaWAN Hat also needs pin 18 to be pulled high to enable the radio
gpioSetMode(18, PI_OUTPUT);
gpioWrite(18, PI_HIGH);
}
void term() override {
// stop the SPI
spiEnd();
// pull the enable pin low
gpioSetMode(18, PI_OUTPUT);
gpioWrite(18, PI_LOW);
// finally, stop the pigpio library
gpioTerminate();
}
// GPIO-related methods (pinMode, digitalWrite etc.) should check
// RADIOLIB_NC as an alias for non-connected pins
void pinMode(uint32_t pin, uint32_t mode) override {
if(pin == RADIOLIB_NC) {
return;
}
gpioSetMode(pin, mode);
}
void digitalWrite(uint32_t pin, uint32_t value) override {
if(pin == RADIOLIB_NC) {
return;
}
gpioWrite(pin, value);
}
uint32_t digitalRead(uint32_t pin) override {
if(pin == RADIOLIB_NC) {
return(0);
}
return(gpioRead(pin));
}
void attachInterrupt(uint32_t interruptNum, void (*interruptCb)(void), uint32_t mode) override {
if((interruptNum == RADIOLIB_NC) || (interruptNum > PI_MAX_USER_GPIO)) {
return;
}
// enable emulated interrupt
interruptEnabled[interruptNum] = true;
interruptModes[interruptNum] = mode;
interruptCallbacks[interruptNum] = interruptCb;
// set pigpio alert callback
gpioSetAlertFuncEx(interruptNum, pigpioAlertHandler, (void*)this);
}
void detachInterrupt(uint32_t interruptNum) override {
if((interruptNum == RADIOLIB_NC) || (interruptNum > PI_MAX_USER_GPIO)) {
return;
}
// clear emulated interrupt
interruptEnabled[interruptNum] = false;
interruptModes[interruptNum] = 0;
interruptCallbacks[interruptNum] = NULL;
// disable pigpio alert callback
gpioSetAlertFuncEx(interruptNum, NULL, NULL);
}
void delay(RadioLibTime_t ms) override {
gpioDelay(ms * 1000);
}
void delayMicroseconds(RadioLibTime_t us) override {
gpioDelay(us);
}
RadioLibTime_t millis() override {
return(gpioTick() / 1000);
}
RadioLibTime_t micros() override {
return(gpioTick());
}
long pulseIn(uint32_t pin, uint32_t state, RadioLibTime_t timeout) override {
if(pin == RADIOLIB_NC) {
return(0);
}
this->pinMode(pin, PI_INPUT);
uint32_t start = this->micros();
uint32_t curtick = this->micros();
while(this->digitalRead(pin) == state) {
if((this->micros() - curtick) > timeout) {
return(0);
}
}
return(this->micros() - start);
}
void spiBegin() {
if(_spiHandle < 0) {
_spiHandle = spiOpen(_spiChannel, _spiSpeed, 0);
}
}
void spiBeginTransaction() {}
void spiTransfer(uint8_t* out, size_t len, uint8_t* in) {
spiXfer(_spiHandle, (char*)out, (char*)in, len);
}
void spiEndTransaction() {}
void spiEnd() {
if(_spiHandle >= 0) {
spiClose(_spiHandle);
_spiHandle = -1;
}
}
// interrupt emulation
bool interruptEnabled[PI_MAX_USER_GPIO + 1];
uint32_t interruptModes[PI_MAX_USER_GPIO + 1];
typedef void (*RadioLibISR)(void);
RadioLibISR interruptCallbacks[PI_MAX_USER_GPIO + 1];
private:
// the HAL can contain any additional private members
const unsigned int _spiSpeed;
const uint8_t _spiChannel;
int _spiHandle = -1;
};
// this handler emulates interrupts
static void pigpioAlertHandler(int event, int level, uint32_t tick, void *userdata) {
if((event > PI_MAX_USER_GPIO) || (!userdata)) {
return;
}
// PiHal isntance is passed via the user data
PiHal* hal = (PiHal*)userdata;
// check the interrupt is enabled, the level matches and a callback exists
if((hal->interruptEnabled[event]) &&
(hal->interruptModes[event] == level) &&
(hal->interruptCallbacks[event])) {
hal->interruptCallbacks[event]();
}
}
#endif

View file

@ -3,8 +3,7 @@
This example shows how to use RadioLib without Arduino. This example shows how to use RadioLib without Arduino.
In this case, a Raspberry Pi with WaveShare SX1302 LoRaWAN Hat In this case, a Raspberry Pi with WaveShare SX1302 LoRaWAN Hat
using the lgpio library using the pigpio library.
https://abyz.me.uk/lg/lgpio.html
Can be used as a starting point to port RadioLib to any platform! Can be used as a starting point to port RadioLib to any platform!
See this API reference page for details on the RadioLib hardware abstraction See this API reference page for details on the RadioLib hardware abstraction
@ -18,7 +17,7 @@
#include <RadioLib.h> #include <RadioLib.h>
// include the hardware abstraction layer // include the hardware abstraction layer
#include "hal/RPi/PiHal.h" #include "PiHal.h"
// create a new instance of the HAL class // create a new instance of the HAL class
// use SPI channel 1, because on Waveshare LoRaWAN Hat, // use SPI channel 1, because on Waveshare LoRaWAN Hat,
@ -45,13 +44,10 @@ int main(int argc, char** argv) {
printf("success!\n"); printf("success!\n");
// loop forever // loop forever
int count = 0;
for(;;) { for(;;) {
// send a packet // send a packet
printf("[SX1261] Transmitting packet ... "); printf("[SX1261] Transmitting packet ... ");
char str[64]; state = radio.transmit("Hello World!");
sprintf(str, "Hello World! #%d", count++);
state = radio.transmit(str);
if(state == RADIOLIB_ERR_NONE) { if(state == RADIOLIB_ERR_NONE) {
// the packet was successfully transmitted // the packet was successfully transmitted
printf("success!\n"); printf("success!\n");

View file

@ -50,21 +50,7 @@ add_executable(${PROJECT_NAME} main.cpp)
# The build system for libtock-c is a bit odd and the version of libraries # The build system for libtock-c is a bit odd and the version of libraries
# built changes based on compiler version. # built changes based on compiler version.
if (RISCV_BUILD) if (RISCV_BUILD)
if(EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0") if(EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-13.2.0")
target_link_libraries(${PROJECT_NAME} PUBLIC
RadioLib
$ENV{LIBTOCK_C_DIRECTORY}/libtock/build/rv32imc/libtock.a
$ENV{LIBTOCK_C_DIRECTORY}/libtock-sync/build/rv32imc/libtocksync.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0/riscv/lib/gcc/riscv64-unknown-elf/14.1.0/rv32i/ilp32/libgcc.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0/riscv/riscv64-unknown-elf/lib/rv32i/ilp32/libstdc++.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-newlib-4.4.0.20231231/riscv/riscv64-unknown-elf/lib/rv32i/ilp32/libc.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-newlib-4.4.0.20231231/riscv/riscv64-unknown-elf/lib/rv32i/ilp32/libm.a
)
target_include_directories(RadioLib AFTER PUBLIC
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-newlib-4.3.0.20230120/riscv/riscv64-unknown-elf/include/
)
elseif(EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-13.2.0")
target_link_libraries(${PROJECT_NAME} PUBLIC target_link_libraries(${PROJECT_NAME} PUBLIC
RadioLib RadioLib
$ENV{LIBTOCK_C_DIRECTORY}/libtock/build/rv32imc/libtock.a $ENV{LIBTOCK_C_DIRECTORY}/libtock/build/rv32imc/libtock.a
@ -94,17 +80,7 @@ if (RISCV_BUILD)
) )
endif() endif()
else() else()
if (EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0") if(EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-13.2.0")
target_link_libraries(${PROJECT_NAME} PUBLIC
RadioLib
$ENV{LIBTOCK_C_DIRECTORY}/libtock/build/cortex-m4/libtock.a
$ENV{LIBTOCK_C_DIRECTORY}/libtock-sync/build/cortex-m4/libtocksync.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0/arm/lib/gcc/arm-none-eabi/14.1.0/libgcc.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-14.1.0/arm/arm-none-eabi/lib/libstdc++.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-newlib-4.4.0.20231231/arm/arm-none-eabi/lib/libc.a
$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-newlib-4.4.0.20231231/arm/arm-none-eabi/lib/libm.a
)
elseif(EXISTS "$ENV{LIBTOCK_C_DIRECTORY}/lib/libtock-libc++-13.2.0")
target_link_libraries(${PROJECT_NAME} PUBLIC target_link_libraries(${PROJECT_NAME} PUBLIC
RadioLib RadioLib
$ENV{LIBTOCK_C_DIRECTORY}/libtock/build/cortex-m4/libtock.a $ENV{LIBTOCK_C_DIRECTORY}/libtock/build/cortex-m4/libtock.a

View file

@ -23,7 +23,7 @@ The RadioLib example can be built with:
$ git clone https://github.com/jgromes/RadioLib.git $ git clone https://github.com/jgromes/RadioLib.git
$ cd RadioLib/examples/NonArduino/Tock/ $ cd RadioLib/examples/NonArduino/Tock/
$ git clone https://github.com/tock/libtock-c.git $ git clone https://github.com/tock/libtock-c.git
$ cd libtock-c; git checkout c0202f9ab78da4a6e95f136cf5250701e3778f63; cd ../ $ cd libtock-c; git checkout dbee65a56d74b4bad166317f199e80b959f7c82c; cd ../
$ LIBTOCK_C_DIRECTORY="$(pwd)/libtock-c" ./build.sh $ LIBTOCK_C_DIRECTORY="$(pwd)/libtock-c" ./build.sh
``` ```

View file

@ -3,9 +3,9 @@ set -e
rm -rf ./build-* rm -rf ./build-*
pushd ${LIBTOCK_C_DIRECTORY}/examples/cxx_hello cd libtock-c/examples/cxx_hello
make -j4 make -j4
popd cd ../../../
mkdir -p build-arm mkdir -p build-arm
cd build-arm cd build-arm

View file

@ -0,0 +1,202 @@
/*
RadioLib Non-Arduino Tock Library helper functions
Licensed under the MIT License
Copyright (c) 2023 Alistair Francis <alistair@alistair23.me>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#ifndef TOCK_HAL_H
#define TOCK_HAL_H
// include RadioLib
#include <RadioLib.h>
// include all the dependencies
#include "libtock/net/lora_phy.h"
#include "libtock/net/syscalls/lora_phy_syscalls.h"
#include "libtock-sync/net/lora_phy.h"
#include "libtock/peripherals/gpio.h"
#include "libtock-sync/services/alarm.h"
#include "libtock/kernel/read_only_state.h"
#define RADIO_BUSY 1
#define RADIO_DIO_1 2
#define RADIO_DIO_3 3
#define RADIO_RESET 4
// Skip the chips select as Tock handles this for us
#define RADIO_NSS RADIOLIB_NC
// define Arduino-style macros
#define PIN_LOW (0x0)
#define PIN_HIGH (0x1)
#define PIN_INPUT (0x01)
#define PIN_OUTPUT (0x03)
#define PIN_RISING (0x01)
#define PIN_FALLING (0x02)
typedef void (*gpioIrqFn)(void);
/*
* Get the the timer frequency in Hz.
*/
int alarm_internal_frequency(uint32_t* frequency) {
syscall_return_t rval = command(0x0, 1, 0, 0);
return tock_command_return_u32_to_returncode(rval, frequency);
}
int alarm_internal_read(uint32_t* time) {
syscall_return_t rval = command(0x0, 2, 0, 0);
return tock_command_return_u32_to_returncode(rval, time);
}
static void lora_phy_gpio_Callback (int gpioPin,
__attribute__ ((unused)) int arg2,
__attribute__ ((unused)) int arg3,
void* userdata)
{
gpioIrqFn fn = *(gpioIrqFn*)(&userdata);
if (fn != NULL ) {
fn();
}
}
class TockHal : public RadioLibHal {
public:
// default constructor - initializes the base HAL and any needed private members
TockHal()
: RadioLibHal(PIN_INPUT, PIN_OUTPUT, PIN_LOW, PIN_HIGH, PIN_RISING, PIN_FALLING) {
}
void init() override {
}
void term() override {
}
// GPIO-related methods (pinMode, digitalWrite etc.) should check
// RADIOLIB_NC as an alias for non-connected pins
void pinMode(uint32_t pin, uint32_t mode) override {
if(pin == RADIOLIB_NC) {
return;
}
if (mode == PIN_OUTPUT) {
libtock_lora_phy_gpio_enable_output(pin);
} else if (mode == PIN_INPUT) {
libtock_lora_phy_gpio_enable_input(pin, libtock_pull_down);
}
}
void digitalWrite(uint32_t pin, uint32_t value) override {
if(pin == RADIOLIB_NC) {
return;
}
if (value) {
libtock_lora_phy_gpio_set(pin);
} else {
libtock_lora_phy_gpio_clear(pin);
}
}
uint32_t digitalRead(uint32_t pin) override {
int value;
if(pin == RADIOLIB_NC) {
return 0;
}
libtock_lora_phy_gpio_read(pin, &value);
return value;
}
void attachInterrupt(uint32_t interruptNum, gpioIrqFn interruptCb, uint32_t mode) override {
if(interruptNum == RADIOLIB_NC) {
return;
}
libtock_lora_phy_gpio_command_interrupt_callback(lora_phy_gpio_Callback, &interruptCb);
// set GPIO as input and enable interrupts on it
libtock_lora_phy_gpio_enable_input(interruptNum, libtock_pull_down);
libtock_lora_phy_gpio_enable_interrupt(interruptNum, libtock_change);
}
void detachInterrupt(uint32_t interruptNum) override {
if(interruptNum == RADIOLIB_NC) {
return;
}
libtock_lora_phy_gpio_disable_interrupt(interruptNum);
}
void delay(unsigned long ms) override {
libtocksync_alarm_delay_ms( ms );
}
void delayMicroseconds(unsigned long us) override {
libtocksync_alarm_delay_ms( us / 1000 );
}
unsigned long millis() override {
uint32_t frequency, now;
alarm_internal_frequency(&frequency);
alarm_internal_read(&now);
return (now / frequency) / 1000;
}
unsigned long micros() override {
return millis() / 1000;
}
long pulseIn(uint32_t pin, uint32_t state, unsigned long timeout) override {
return 0;
}
void spiBegin() {
}
void spiBeginTransaction() {
}
void spiTransfer(uint8_t* out, size_t len, uint8_t* in) {
libtocksync_lora_phy_read_write(out, in, len);
}
void spiEndTransaction() {
}
void spiEnd() {
}
void yield() {
::yield_no_wait();
}
private:
};
#endif

View file

@ -28,14 +28,14 @@
#include <RadioLib.h> #include <RadioLib.h>
// include the hardware abstraction layer // include the hardware abstraction layer
#include "RadioLib/libtockHal.h" #include "libtockHal.h"
// the entry point for the program // the entry point for the program
int main(void) { int main(void) {
printf("[SX1261] Initialising Radio ... \r\n"); printf("[SX1261] Initialising Radio ... \r\n");
// create a new instance of the HAL class // create a new instance of the HAL class
TockRadioLibHal* hal = new TockRadioLibHal(); TockHal* hal = new TockHal();
// now we can create the radio module // now we can create the radio module
// pinout corresponds to the SparkFun LoRa Thing Plus - expLoRaBLE // pinout corresponds to the SparkFun LoRa Thing Plus - expLoRaBLE
@ -43,7 +43,7 @@ int main(void) {
// DIO1 pin: 2 // DIO1 pin: 2
// NRST pin: 4 // NRST pin: 4
// BUSY pin: 1 // BUSY pin: 1
Module* tock_module = new Module(hal, RADIOLIB_RADIO_NSS, RADIOLIB_RADIO_DIO_1, RADIOLIB_RADIO_RESET, RADIOLIB_RADIO_BUSY); Module* tock_module = new Module(hal, RADIO_NSS, RADIO_DIO_1, RADIO_RESET, RADIO_BUSY);
SX1262* radio = new SX1262(tock_module); SX1262* radio = new SX1262(tock_module);
// Setup the radio // Setup the radio

View file

@ -1,24 +1,24 @@
/* /*
RadioLib Pager (POCSAG) Receive Example RadioLib Pager (POCSAG) Receive Example
This example shows how to receive FSK packets without using This example shows how to receive FSK packets without using
SX127x packet engine. SX127x packet engine.
This example receives POCSAG messages using SX1278's This example receives POCSAG messages using SX1278's
FSK modem in direct mode. FSK modem in direct mode.
Other modules that can be used to receive POCSAG: Other modules that can be used to receive POCSAG:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx127xrfm9x---lora-modem https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx127xrfm9x---lora-modem
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -45,13 +45,9 @@ const int pin = 5;
// create Pager client instance using the FSK module // create Pager client instance using the FSK module
PagerClient pager(&radio); PagerClient pager(&radio);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -69,7 +65,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// initialize Pager client // initialize Pager client
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// start receiving POCSAG messages // start receiving POCSAG messages
@ -94,7 +90,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,24 +1,24 @@
/* /*
RadioLib Pager (POCSAG) Transmit Example RadioLib Pager (POCSAG) Transmit Example
This example sends POCSAG messages using SX1278's This example sends POCSAG messages using SX1278's
FSK modem. FSK modem.
Other modules that can be used to send POCSAG: Other modules that can be used to send POCSAG:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX128x - SX128x
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -31,13 +31,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create Pager client instance using the FSK module // create Pager client instance using the FSK module
PagerClient pager(&radio); PagerClient pager(&radio);
@ -58,7 +54,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize Pager client // initialize Pager client
@ -71,7 +67,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
} }

View file

@ -1,12 +1,12 @@
/* /*
RadioLib PhysicalLayer Interface Example RadioLib PhysicalLayer Interface Example
This example shows how to use the common PhysicalLayer This example shows how to use the common PhysicalLayer
to interface with different radio modules using the same to interface with different radio modules using the same
methods. methods.
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -23,14 +23,6 @@
// extra GPIO/interrupt pin: 3 (unused on some modules) // extra GPIO/interrupt pin: 3 (unused on some modules)
RADIO_TYPE radio = new Module(10, 2, 9, 3); RADIO_TYPE radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards
// https://github.com/radiolib-org/RadioBoards
/*
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// get pointer to the common layer // get pointer to the common layer
PhysicalLayer* phy = (PhysicalLayer*)&radio; PhysicalLayer* phy = (PhysicalLayer*)&radio;
@ -50,7 +42,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// or we can use the "phy" pointer to access the common layer // or we can use the "phy" pointer to access the common layer
@ -62,7 +54,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// PhysicalLayer also contains basic functionality // PhysicalLayer also contains basic functionality
@ -74,7 +66,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// try to receive now - this will almost certainly timeout // try to receive now - this will almost certainly timeout
@ -90,7 +82,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// interrupt-driven versions of Rx/Tx are supported as well // interrupt-driven versions of Rx/Tx are supported as well
@ -113,7 +105,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// ... or standby // ... or standby
@ -124,7 +116,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// there are also common SNR/RSSI measurement functions // there are also common SNR/RSSI measurement functions

View file

@ -1,15 +1,15 @@
/* /*
RadioLib RF69 Receive with AES Example RadioLib RF69 Receive with AES Example
This example receives packets using RF69 FSK radio module. This example receives packets using RF69 FSK radio module.
Packets are decrypted using hardware AES. Packets are decrypted using hardware AES.
NOTE: When using address filtering, the address byte is NOT encrypted! NOTE: When using address filtering, the address byte is NOT encrypted!
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -21,13 +21,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -40,7 +36,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set AES key that will be used to decrypt the packet // set AES key that will be used to decrypt the packet

View file

@ -1,17 +1,17 @@
/* /*
RadioLib RF69 Receive with Address Example RadioLib RF69 Receive with Address Example
This example receives packets using RF69 FSK radio module. This example receives packets using RF69 FSK radio module.
Packets can have 1-byte address of the destination node. Packets can have 1-byte address of the destination node.
After setting node (or broadcast) address, this node will After setting node (or broadcast) address, this node will
automatically filter out any packets that do not contain automatically filter out any packets that do not contain
either node address or broadcast address. either node address or broadcast address.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -23,13 +23,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -42,7 +38,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set node address // set node address
@ -55,7 +51,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set broadcast address // set broadcast address
@ -68,7 +64,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// address filtering can also be disabled // address filtering can also be disabled
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -30,13 +30,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -49,7 +45,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,15 +1,15 @@
/* /*
RadioLib RF69 Receive with Interrupts Example RadioLib RF69 Receive with Interrupts Example
This example listens for FSK transmissions and tries to This example listens for FSK transmissions and tries to
receive them. Once a packet is received, an interrupt is receive them. Once a packet is received, an interrupt is
triggered. triggered.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -21,28 +21,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -55,7 +36,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -70,7 +51,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, 'listen' mode can be disabled by calling // if needed, 'listen' mode can be disabled by calling
@ -83,6 +64,21 @@ void setup() {
// radio.readData(); // radio.readData();
} }
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(receivedFlag) { if(receivedFlag) {

View file

@ -1,21 +1,21 @@
/* /*
RadioLib RF69 Settings Example RadioLib RF69 Settings Example
This example shows how to change all the properties of RF69 radio. This example shows how to change all the properties of RF69 radio.
RadioLib currently supports the following settings: RadioLib currently supports the following settings:
- pins (SPI slave select, digital IO 0, digital IO 1) - pins (SPI slave select, digital IO 0, digital IO 1)
- carrier frequency - carrier frequency
- bit rate - bit rate
- receiver bandwidth - receiver bandwidth
- allowed frequency deviation - allowed frequency deviation
- output power during transmission - output power during transmission
- sync word - sync word
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -33,13 +33,9 @@ RF69 radio1 = new Module(10, 2, 3);
// RESET pin: 5 // RESET pin: 5
RF69 radio2 = new Module(9, 4, 5); RF69 radio2 = new Module(9, 4, 5);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio3 = RadioShield.ModuleB;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio3 = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -52,7 +48,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// initialize RF69 with non-default settings // initialize RF69 with non-default settings
@ -69,7 +65,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// you can also change the settings at runtime // you can also change the settings at runtime
@ -78,41 +74,41 @@ void setup() {
// set carrier frequency to 433.5 MHz // set carrier frequency to 433.5 MHz
if (radio1.setFrequency(433.5) == RADIOLIB_ERR_INVALID_FREQUENCY) { if (radio1.setFrequency(433.5) == RADIOLIB_ERR_INVALID_FREQUENCY) {
Serial.println(F("[RF69] Selected frequency is invalid for this module!")); Serial.println(F("[RF69] Selected frequency is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// set bit rate to 100.0 kbps // set bit rate to 100.0 kbps
state = radio1.setBitRate(100.0); state = radio1.setBitRate(100.0);
if (state == RADIOLIB_ERR_INVALID_BIT_RATE) { if (state == RADIOLIB_ERR_INVALID_BIT_RATE) {
Serial.println(F("[RF69] Selected bit rate is invalid for this module!")); Serial.println(F("[RF69] Selected bit rate is invalid for this module!"));
while (true) { delay(10); } while (true);
} else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) { } else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) {
Serial.println(F("[RF69] Selected bit rate to bandwidth ratio is invalid!")); Serial.println(F("[RF69] Selected bit rate to bandwidth ratio is invalid!"));
Serial.println(F("[RF69] Increase receiver bandwidth to set this bit rate.")); Serial.println(F("[RF69] Increase receiver bandwidth to set this bit rate."));
while (true) { delay(10); } while (true);
} }
// set receiver bandwidth to 250.0 kHz // set receiver bandwidth to 250.0 kHz
state = radio1.setRxBandwidth(250.0); state = radio1.setRxBandwidth(250.0);
if (state == RADIOLIB_ERR_INVALID_RX_BANDWIDTH) { if (state == RADIOLIB_ERR_INVALID_RX_BANDWIDTH) {
Serial.println(F("[RF69] Selected receiver bandwidth is invalid for this module!")); Serial.println(F("[RF69] Selected receiver bandwidth is invalid for this module!"));
while (true) { delay(10); } while (true);
} else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) { } else if (state == RADIOLIB_ERR_INVALID_BIT_RATE_BW_RATIO) {
Serial.println(F("[RF69] Selected bit rate to bandwidth ratio is invalid!")); Serial.println(F("[RF69] Selected bit rate to bandwidth ratio is invalid!"));
Serial.println(F("[RF69] Decrease bit rate to set this receiver bandwidth.")); Serial.println(F("[RF69] Decrease bit rate to set this receiver bandwidth."));
while (true) { delay(10); } while (true);
} }
// set allowed frequency deviation to 10.0 kHz // set allowed frequency deviation to 10.0 kHz
if (radio1.setFrequencyDeviation(10.0) == RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION) { if (radio1.setFrequencyDeviation(10.0) == RADIOLIB_ERR_INVALID_FREQUENCY_DEVIATION) {
Serial.println(F("[RF69] Selected frequency deviation is invalid for this module!")); Serial.println(F("[RF69] Selected frequency deviation is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// set output power to 2 dBm // set output power to 2 dBm
if (radio1.setOutputPower(2) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) { if (radio1.setOutputPower(2) == RADIOLIB_ERR_INVALID_OUTPUT_POWER) {
Serial.println(F("[RF69] Selected output power is invalid for this module!")); Serial.println(F("[RF69] Selected output power is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
// up to 8 bytes can be set as sync word // up to 8 bytes can be set as sync word
@ -121,7 +117,7 @@ void setup() {
uint8_t syncWord[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF}; uint8_t syncWord[] = {0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF};
if (radio1.setSyncWord(syncWord, 8) == RADIOLIB_ERR_INVALID_SYNC_WORD) { if (radio1.setSyncWord(syncWord, 8) == RADIOLIB_ERR_INVALID_SYNC_WORD) {
Serial.println(F("[RF69] Selected sync word is invalid for this module!")); Serial.println(F("[RF69] Selected sync word is invalid for this module!"));
while (true) { delay(10); } while (true);
} }
Serial.println(F("[RF69] All settings changed successfully!")); Serial.println(F("[RF69] All settings changed successfully!"));

View file

@ -1,15 +1,15 @@
/* /*
RadioLib RF69 Transmit with AES Example RadioLib RF69 Transmit with AES Example
This example transmits packets using RF69 FSK radio module. This example transmits packets using RF69 FSK radio module.
Packets are encrypted using hardware AES. Packets are encrypted using hardware AES.
NOTE: When using address filtering, the address byte is NOT encrypted! NOTE: When using address filtering, the address byte is NOT encrypted!
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -21,13 +21,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -40,7 +36,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set AES key to encrypt the packet // set AES key to encrypt the packet

View file

@ -1,17 +1,17 @@
/* /*
RadioLib RF69 Transmit to Address Example RadioLib RF69 Transmit to Address Example
This example transmits packets using RF69 FSK radio module. This example transmits packets using RF69 FSK radio module.
Packets can have 1-byte address of the destination node. Packets can have 1-byte address of the destination node.
After setting node (or broadcast) address, this node will After setting node (or broadcast) address, this node will
automatically filter out any packets that do not contain automatically filter out any packets that do not contain
either node address or broadcast address. either node address or broadcast address.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -23,13 +23,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -42,7 +38,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set node address // set node address
@ -55,7 +51,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set broadcast address // set broadcast address
@ -68,7 +64,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// address filtering can also be disabled // address filtering can also be disabled
@ -82,7 +78,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
*/ */
} }

View file

@ -27,13 +27,9 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -46,7 +42,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// NOTE: some RF69 modules use high power output, // NOTE: some RF69 modules use high power output,
@ -62,7 +58,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
*/ */
} }

View file

@ -1,18 +1,18 @@
/* /*
RadioLib RF69 Transmit with Interrupts Example RadioLib RF69 Transmit with Interrupts Example
This example transmits FSK packets with one second delays This example transmits FSK packets with one second delays
between them. Each packet contains up to 64 bytes between them. Each packet contains up to 64 bytes
of data, in the form of: of data, in the form of:
- Arduino String - Arduino String
- null-terminated char array (C-string) - null-terminated char array (C-string)
- arbitrary binary data (byte array) - arbitrary binary data (byte array)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231 https://github.com/jgromes/RadioLib/wiki/Default-configuration#rf69sx1231
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -24,32 +24,13 @@
// RESET pin: 3 // RESET pin: 3
RF69 radio = new Module(10, 2, 3); RF69 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //RF69 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// save transmission state between loops // save transmission state between loops
int transmissionState = RADIOLIB_ERR_NONE; int transmissionState = RADIOLIB_ERR_NONE;
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -61,7 +42,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -81,7 +62,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
*/ */
@ -100,6 +81,21 @@ void setup() {
*/ */
} }
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
#if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR
#endif
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
// counter to keep track of transmitted packets // counter to keep track of transmitted packets
int count = 0; int count = 0;

View file

@ -1,25 +1,25 @@
/* /*
RadioLib RTTY Transmit Example RadioLib RTTY Transmit Example
This example sends RTTY message using SX1278's This example sends RTTY message using SX1278's
FSK modem. FSK modem.
Other modules that can be used for RTTY: Other modules that can be used for RTTY:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- SX126x - SX126x
- nRF24 - nRF24
- Si443x/RFM2x - Si443x/RFM2x
- SX128x - SX128x
- LR11x0 - LR11x0
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -32,13 +32,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create RTTY client instance using the FSK module // create RTTY client instance using the FSK module
RTTYClient rtty(&radio); RTTYClient rtty(&radio);
@ -59,7 +55,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize RTTY client // initialize RTTY client
@ -85,7 +81,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
/* /*

View file

@ -1,22 +1,22 @@
/* /*
RadioLib RTTY Transmit AFSK Example RadioLib RTTY Transmit AFSK Example
This example sends RTTY message using SX1278's This example sends RTTY message using SX1278's
FSK modem. The data is modulated as AFSK. FSK modem. The data is modulated as AFSK.
Other modules that can be used for RTTY: Other modules that can be used for RTTY:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -29,13 +29,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -67,7 +63,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// initialize RTTY client // initialize RTTY client
@ -85,7 +81,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
/* /*

View file

@ -1,35 +1,35 @@
/* /*
RadioLib SSTV Transmit Example RadioLib SSTV Transmit Example
The following example sends SSTV picture using The following example sends SSTV picture using
SX1278's FSK modem. SX1278's FSK modem.
Other modules that can be used for SSTV: Other modules that can be used for SSTV:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- SX126x - SX126x
NOTE: SSTV is an analog modulation, and NOTE: SSTV is an analog modulation, and
requires precise frequency control. requires precise frequency control.
Some of the above modules can only Some of the above modules can only
set their frequency in rough steps, set their frequency in rough steps,
so the result can be distorted. so the result can be distorted.
Using high-precision radio with TCXO Using high-precision radio with TCXO
(like SX126x) is recommended. (like SX126x) is recommended.
NOTE: Some platforms (such as Arduino Uno) NOTE: Some platforms (such as Arduino Uno)
might not be fast enough to correctly might not be fast enough to correctly
send pictures via high-speed modes send pictures via high-speed modes
like Scottie2 or Martin2. For those, like Scottie2 or Martin2. For those,
lower speed modes such as Wrasse, lower speed modes such as Wrasse,
Scottie1 or Martin1 are recommended. Scottie1 or Martin1 are recommended.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -42,13 +42,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create SSTV client instance using the FSK module // create SSTV client instance using the FSK module
SSTVClient sstv(&radio); SSTVClient sstv(&radio);
@ -100,7 +96,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// when using one of the non-LoRa modules for SSTV // when using one of the non-LoRa modules for SSTV
@ -117,7 +113,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// set correction factor // set correction factor
@ -136,7 +132,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// to help tune the receiver, SSTVClient can send // to help tune the receiver, SSTVClient can send
@ -145,7 +141,7 @@ void setup() {
// (SSTV header "leader tone") // (SSTV header "leader tone")
/* /*
sstv.idle(); sstv.idle();
while (true) { delay(10); } while(true);
*/ */
} }

View file

@ -1,31 +1,31 @@
/* /*
RadioLib SSTV Transmit AFSK Example RadioLib SSTV Transmit AFSK Example
The following example sends SSTV picture using The following example sends SSTV picture using
SX1278's FSK modem. The data is modulated SX1278's FSK modem. The data is modulated
as AFSK. as AFSK.
Other modules that can be used for SSTV: Other modules that can be used for SSTV:
with AFSK modulation: with AFSK modulation:
- SX127x/RFM9x - SX127x/RFM9x
- RF69 - RF69
- SX1231 - SX1231
- CC1101 - CC1101
- Si443x/RFM2x - Si443x/RFM2x
- SX126x/LLCC68 - SX126x/LLCC68 (only devices without TCXO!)
NOTE: Some platforms (such as Arduino Uno) NOTE: Some platforms (such as Arduino Uno)
might not be fast enough to correctly might not be fast enough to correctly
send pictures via high-speed modes send pictures via high-speed modes
like Scottie2 or Martin2. For those, like Scottie2 or Martin2. For those,
lower speed modes such as Wrasse, lower speed modes such as Wrasse,
Scottie1 or Martin1 are recommended. Scottie1 or Martin1 are recommended.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration https://github.com/jgromes/RadioLib/wiki/Default-configuration
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -38,13 +38,9 @@
// DIO1 pin: 3 // DIO1 pin: 3
SX1278 radio = new Module(10, 2, 9, 3); SX1278 radio = new Module(10, 2, 9, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1278 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
// create AFSK client instance using the FSK module // create AFSK client instance using the FSK module
// this requires connection to the module direct // this requires connection to the module direct
@ -107,7 +103,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// when using one of the non-LoRa modules for SSTV // when using one of the non-LoRa modules for SSTV
@ -123,7 +119,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// set correction factor // set correction factor
@ -142,14 +138,14 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while(true);
} }
// to help tune the receiver, SSTVClient can send // to help tune the receiver, SSTVClient can send
// continuous 1900 Hz beep // continuous 1900 Hz beep
/* /*
sstv.idle(); sstv.idle();
while (true) { delay(10); } while(true);
*/ */
} }

View file

@ -1,16 +1,16 @@
/* /*
RadioLib STM32WLx Channel Activity Detection Example RadioLib STM32WLx Channel Activity Detection Example
This example uses STM32WLx to scan the current LoRa This example uses STM32WLx to scan the current LoRa
channel and detect ongoing LoRa transmissions. channel and detect ongoing LoRa transmissions.
Unlike SX127x CAD, SX126x/STM32WLx can detect any part Unlike SX127x CAD, SX126x/STM32WLx can detect any part
of LoRa transmission, not just the preamble. of LoRa transmission, not just the preamble.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -48,7 +48,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,16 +1,16 @@
/* /*
RadioLib STM32WLx Channel Activity Detection Example RadioLib STM32WLx Channel Activity Detection Example
This example uses STM32WLx to scan the current LoRa This example uses STM32WLx to scan the current LoRa
channel and detect ongoing LoRa transmissions. channel and detect ongoing LoRa transmissions.
Unlike SX127x CAD, SX126x/STM32WLx can detect any part Unlike SX127x CAD, SX126x/STM32WLx can detect any part
of LoRa transmission, not just the preamble. of LoRa transmission, not just the preamble.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -33,18 +33,6 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
END_OF_MODE_TABLE, END_OF_MODE_TABLE,
}; };
// flag to indicate that a packet was detected or CAD timed out
volatile bool scanFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// something happened, set the flag
scanFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -60,7 +48,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -78,6 +66,18 @@ void setup() {
} }
} }
// flag to indicate that a packet was detected or CAD timed out
volatile bool scanFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// something happened, set the flag
scanFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(scanFlag) { if(scanFlag) {

View file

@ -64,7 +64,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set appropriate TCXO voltage for Nucleo WL55JC1 // set appropriate TCXO voltage for Nucleo WL55JC1
@ -74,7 +74,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -1,26 +1,26 @@
/* /*
RadioLib STM32WLx Receive with Interrupts Example RadioLib STM32WLx Receive with Interrupts Example
This example listens for LoRa transmissions and tries to This example listens for LoRa transmissions and tries to
receive them. Once a packet is received, an interrupt is receive them. Once a packet is received, an interrupt is
triggered. To successfully receive data, the following triggered. To successfully receive data, the following
settings have to be the same on both transmitter settings have to be the same on both transmitter
and receiver: and receiver:
- carrier frequency - carrier frequency
- bandwidth - bandwidth
- spreading factor - spreading factor
- coding rate - coding rate
- sync word - sync word
This example assumes Nucleo WL55JC1 is used. For other Nucleo boards This example assumes Nucleo WL55JC1 is used. For other Nucleo boards
or standalone STM32WL, some configuration such as TCXO voltage and or standalone STM32WL, some configuration such as TCXO voltage and
RF switch control may have to be adjusted. RF switch control may have to be adjusted.
For default module settings, see the wiki page For default module settings, see the wiki page
https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem https://github.com/jgromes/RadioLib/wiki/Default-configuration#sx126x---lora-modem
For full API reference, see the GitHub Pages For full API reference, see the GitHub Pages
https://jgromes.github.io/RadioLib/ https://jgromes.github.io/RadioLib/
*/ */
// include the library // include the library
@ -43,18 +43,6 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
END_OF_MODE_TABLE, END_OF_MODE_TABLE,
}; };
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -70,7 +58,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set appropriate TCXO voltage for Nucleo WL55JC1 // set appropriate TCXO voltage for Nucleo WL55JC1
@ -80,7 +68,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -95,7 +83,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// if needed, 'listen' mode can be disabled by calling // if needed, 'listen' mode can be disabled by calling
@ -109,6 +97,18 @@ void setup() {
// radio.scanChannel(); // radio.scanChannel();
} }
// flag to indicate that a packet was received
volatile bool receivedFlag = false;
// this function is called when a complete packet
// is received by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// we got a packet, set the flag
receivedFlag = true;
}
void loop() { void loop() {
// check if the flag is set // check if the flag is set
if(receivedFlag) { if(receivedFlag) {
@ -154,5 +154,8 @@ void loop() {
Serial.println(state); Serial.println(state);
} }
// put module back to listen mode
radio.startReceive();
} }
} }

View file

@ -59,7 +59,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set appropriate TCXO voltage for Nucleo WL55JC1 // set appropriate TCXO voltage for Nucleo WL55JC1
@ -69,7 +69,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -38,18 +38,6 @@ static const Module::RfSwitchMode_t rfswitch_table[] = {
// save transmission state between loops // save transmission state between loops
int transmissionState = RADIOLIB_ERR_NONE; int transmissionState = RADIOLIB_ERR_NONE;
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -65,7 +53,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set appropriate TCXO voltage for Nucleo WL55JC1 // set appropriate TCXO voltage for Nucleo WL55JC1
@ -75,7 +63,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
// set the function that will be called // set the function that will be called
@ -97,6 +85,18 @@ void setup() {
*/ */
} }
// flag to indicate that a packet was sent
volatile bool transmittedFlag = false;
// this function is called when a complete packet
// is transmitted by the module
// IMPORTANT: this function MUST be 'void' type
// and MUST NOT have any arguments!
void setFlag(void) {
// we sent a packet, set the flag
transmittedFlag = true;
}
// counter to keep track of transmitted packets // counter to keep track of transmitted packets
int count = 0; int count = 0;

View file

@ -29,13 +29,9 @@
// RESET pin: 3 // RESET pin: 3
SX1231 radio = new Module(10, 2, 3); SX1231 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1231 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -48,7 +44,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -28,13 +28,9 @@
// RESET pin: 3 // RESET pin: 3
SX1231 radio = new Module(10, 2, 3); SX1231 radio = new Module(10, 2, 3);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1231 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h>
Radio radio = new RadioModule();
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -47,7 +43,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

View file

@ -30,13 +30,12 @@
// BUSY pin: 9 // BUSY pin: 9
SX1262 radio = new Module(10, 2, 3, 9); SX1262 radio = new Module(10, 2, 3, 9);
// or detect the pinout automatically using RadioBoards // or using RadioShield
// https://github.com/radiolib-org/RadioBoards // https://github.com/jgromes/RadioShield
/* //SX1262 radio = RadioShield.ModuleA;
#define RADIO_BOARD_AUTO
#include <RadioBoards.h> // or using CubeCell
Radio radio = new RadioModule(); //SX1262 radio = new Module(RADIOLIB_BUILTIN_MODULE);
*/
void setup() { void setup() {
Serial.begin(9600); Serial.begin(9600);
@ -49,7 +48,7 @@ void setup() {
} else { } else {
Serial.print(F("failed, code ")); Serial.print(F("failed, code "));
Serial.println(state); Serial.println(state);
while (true) { delay(10); } while (true);
} }
} }

Some files were not shown because too many files have changed in this diff Show more