Skip to content

Change config parameters to proper format #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 13, 2018
Merged

Change config parameters to proper format #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 49 additions & 67 deletions docs/reference/api/connectivity/lorawan/lorawanconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,54 @@ Various parameters for Mbed LoRaWAN stack can be configured via either C++ APIs

Here are the parameters that can be configured using Mbed configuration system:

```json
{
"name": "lora",
"config": {
"phy": {
"help": "LoRa PHY region. 0 = EU868 (default), 1 = AS923, 2 = AU915, 3 = CN470, 4 = CN779, 5 = EU433, 6 = IN865, 7 = KR920, 8 = US915, 9 = US915_HYBRID",
"value": "0"
},
"over-the-air-activation": {
"help": "When set to 1 the application uses the Over-the-Air activation procedure, default: true",
"value": true
},
"nb-trials": {
"help": "Indicates how many times join can be tried, default: 12",
"value": 12
},
"device-eui": {
"help": "Mote device IEEE EUI",
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
},
"application-eui": {
"help": "Application IEEE EUI",
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
},
"application-key": {
"help": "AES encryption/decryption cipher application key",
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
},
"device-address": {
"help": "Device address on the network",
"value": "0x00000000"
},
"nwkskey": {
"help": "AES encryption/decryption cipher network session key",
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
},
"appskey": {
"help": "AES encryption/decryption cipher application session key",
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
},
"app-port": {
"help": "LoRaWAN application port, default: 15",
"value": 15
},
"tx-max-size": {
"help": "User application data buffer maximum size, default: 64, MAX: 255",
"value": 64
},
"adr-on": {
"help": "LoRaWAN Adaptive Data Rate, default: 1",
"value": 1
},
"public-network": {
"help": "LoRaWAN will connect to a public network or private network, true = public network",
"value": true
},
"duty-cycle-on": {
"help": "Enables/disables duty cycling. NOTE: Disable only for testing. Mandatory in many regions.",
"value": true
},
"lbt-on": {
"help": "Enables/disables LBT. NOTE: [This feature is not yet integrated].",
"value": false
}
}
}
```
Configuration parameters
------------------------

Name: lora.adr-on
Defined by: library:lora
Value: 1 (set by library:lora)
Name: lora.app-port
Defined by: library:lora
Value: 15 (set by library:lora)
Name: lora.application-eui
Defined by: library:lora
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
Name: lora.application-key
Defined by: library:lora
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
Name: lora.appskey
Defined by: library:lora
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
Name: lora.device-address
Defined by: library:lora
Value: 0x00000000 (set by library:lora)
Name: lora.device-eui
Defined by: library:lora
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
Name: lora.duty-cycle-on
Defined by: library:lora
Value: 1 (set by library:lora)
Name: lora.lbt-on
Defined by: library:lora
Name: lora.nb-trials
Defined by: library:lora
Value: 12 (set by library:lora)
Name: lora.nwkskey
Defined by: library:lora
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
Name: lora.over-the-air-activation
Defined by: library:lora
Value: 1 (set by library:lora)
Name: lora.phy
Defined by: library:lora
Value: 0 (set by library:lora)
Name: lora.public-network
Defined by: library:lora
Value: 1 (set by library:lora)
Name: lora.tx-max-size
Defined by: library:lora
Value: 64 (set by library:lora)
```

For changing any of these parameters, edit the `mbed_app.json` file in the root of your application. Prefix the parameter name with `lora.`, e.g., `lora.my-parameter: value`.
Expand All @@ -88,4 +70,4 @@ For changing any of these parameters, edit the `mbed_app.json` file in the root

### Using APIs from LoRaWANInterface

See API reference [here](https://os.mbed.com/docs/v5.8/reference/lorawan.html).
See API reference [here](https://os.mbed.com/docs/v5.8/reference/lorawan.html).