Skip to content
This repository was archived by the owner on Feb 2, 2023. It is now read-only.

Commit c4b7781

Browse files
authored
Add configuration section // Resolve #19
1 parent 95f5ccd commit c4b7781

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,36 @@ board = ...
3232

3333
# Configuration
3434

35-
Please navigate to [documentation](https://docs.platformio.org/page/platforms/asrmicro650x.html).
35+
## LoRaWAN
36+
37+
LoRaWAN protocol can be configured in :ref:`projectconf` using the following syntax
38+
``board_build.arduino.lorawan.*`` where ``*`` is an option from the following list:
39+
40+
| Option | Description | Possible values | Default |
41+
| ----------- | ----------- | --------------- | ------- |
42+
| ``region`` | Region definition | ``AS923_AS1``, ``AS923_AS2``, ``AU915``, ``CN470``, ``CN779``, ``EU433``, ``EU868``, ``KR920``, ``IN865``, ``US915``, ``US915_HYBRID`` | ``US915`` |
43+
| ``class`` | Device class | ``CLASS_A``, ``CLASS_C`` | ``CLASS_A`` |
44+
| ``netmode`` | Activation method | ``OTAA``, ``ABP`` | ``OTAA`` |
45+
| ``adr`` | Adaptive Data Rate | ``ON``, ``OFF`` | ``ON`` |
46+
| ``uplinkmode`` | Uplink confirmed/unconfirmed messages | ``CONFIRMED``, ``UNCONFIRMED`` | ``CONFIRMED`` |
47+
| ``net_reserve`` | Don't rejoin after reset | ``ON``, ``OFF`` | ``OFF`` |
48+
| ``at_support`` | AT commands support | ``ON``, ``OFF`` | ``ON`` |
49+
| ``rgb`` | RGB light for LoRaWAN status | ``ACTIVE``, ``DEACTIVE`` | ``ACTIVE`` |
50+
| ``preamble_length`` | Preamble length | ``8``, ``16`` (For M00 and M00L) | ``8`` |
51+
| ``debug_level`` | Print LoRaWAN relevant messages print to serial port | ``NONE``, ``FREQ`` (Sending/receiving frequency), ``FREQ_AND_DIO`` (Sending/receiving frequency and DIO pin interrupt information) | ``NONE`` |
52+
53+
54+
**Example**
55+
56+
```ini
57+
[env:cubecell_board]
58+
platform = asrmicro650x
59+
framework = arduino
60+
board = cubecell_board
61+
board_build.arduino.lorawan.region = EU433
62+
board_build.arduino.lorawan.adr = OFF
63+
board_build.arduino.lorawan.debug_level = FREQ_AND_DIO
64+
```
65+
66+
More information about LoRaWAN configuration can be found in
67+
[the official CubeCell documentation](https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/index.html).

0 commit comments

Comments
 (0)