Skip to content

Commit

Permalink
lr1110 tests: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanzhouyc authored and bradjc committed Jan 29, 2025
1 parent 51d2329 commit 850fbb6
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 197 deletions.
25 changes: 7 additions & 18 deletions examples/tests/lr1110/lorawan/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,10 @@
# LoRa Basics Modem LoRaWAN Class A/C example
LR1110 LoRaWAN Radio Example
============================

## Description
This is a test app for using the lr1110 library with the [WM1110 wireless
module](https://www.seeedstudio.com/Wio-WM1110-Dev-Kit-p-5677.html).

The application will automatically starts a procedure to join a LoRaWAN network (see [configuration](../../apps/common/lorawan_key_config.h)).
The library is a port of the [library from Seeed
Studio](https://github.com/Seeed-Studio/Seeed_Wio_WM1110_Dev_Board) to Tock.

Once a network is joined (i.e. when the corresponding event is triggered), uplinks are sent periodically. This periodic action is based on the LoRa Basics Modem alarm functionality. Each time the alarm-related event is triggered, the application requests an uplink.

The content of the uplink is the value read out from the charge counter by calling `smtc_modem_get_charge()`.

The application is also capable of displaying data and meta-data of a received downlink.

## Configuration

Several parameters can be updated in `main_lorawan.h` header file:

| Constant | Description |
| -------------------------- | ----------------------------------------------------------------------------- |
| `LORAWAN_APP_PORT` | LoRaWAN FPort used for the uplink messages |
| `LORAWAN_CONFIRMED_MSG_ON` | Request a confirmation from the LNS that the uplink message has been received |
| `APP_TX_DUTYCYCLE` | Delay in second between two uplinks |
This test is designed to connect to the Things Network in the US915 band.
4 changes: 4 additions & 0 deletions examples/tests/lr1110/lorawan/main_lorawan.c
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@
* POSSIBILITY OF SUCH DAMAGE.
*/


// link to README.md in seeed studio's repo where this exmaple is taken from:
// https://github.com/Seeed-Studio/Seeed_Wio_WM1110_Dev_Board/blob/master/apps/examples/lorawan/README.md

/*
* -----------------------------------------------------------------------------
* --- DEPENDENCIES ------------------------------------------------------------
Expand Down
179 changes: 0 additions & 179 deletions examples/tests/lr1110/wifi_scan/README.md

This file was deleted.

3 changes: 3 additions & 0 deletions examples/tests/lr1110/wifi_scan/main_geolocation_wifi.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
* POSSIBILITY OF SUCH DAMAGE.
* @endparblock
// link to README.md in seeed studio's repo where this exmaple is taken from:
// https://github.com/Seeed-Studio/Seeed_Wio_WM1110_Dev_Board/blob/master/apps/examples/geolocation_wifi/README.md
*/

/*!
Expand Down

0 comments on commit 850fbb6

Please sign in to comment.