Skip to content

Commit ad59cde

Browse files
kegilbertkegilbert
authored
Change config parameters to proper format
Matchs Connectivity.md
1 parent 32ae68f commit ad59cde

File tree

1 file changed

+49
-67
lines changed

1 file changed

+49
-67
lines changed

‎docs/reference/api/connectivity/lorawan/lorawanconfig.md

Lines changed: 49 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -6,72 +6,54 @@ Various parameters for Mbed LoRaWAN stack can be configured via either C++ APIs
66

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

9-
```json
10-
{
11-
"name": "lora",
12-
"config": {
13-
"phy": {
14-
"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",
15-
"value": "0"
16-
},
17-
"over-the-air-activation": {
18-
"help": "When set to 1 the application uses the Over-the-Air activation procedure, default: true",
19-
"value": true
20-
},
21-
"nb-trials": {
22-
"help": "Indicates how many times join can be tried, default: 12",
23-
"value": 12
24-
},
25-
"device-eui": {
26-
"help": "Mote device IEEE EUI",
27-
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
28-
},
29-
"application-eui": {
30-
"help": "Application IEEE EUI",
31-
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
32-
},
33-
"application-key": {
34-
"help": "AES encryption/decryption cipher application key",
35-
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
36-
},
37-
"device-address": {
38-
"help": "Device address on the network",
39-
"value": "0x00000000"
40-
},
41-
"nwkskey": {
42-
"help": "AES encryption/decryption cipher network session key",
43-
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
44-
},
45-
"appskey": {
46-
"help": "AES encryption/decryption cipher application session key",
47-
"value": "{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}"
48-
},
49-
"app-port": {
50-
"help": "LoRaWAN application port, default: 15",
51-
"value": 15
52-
},
53-
"tx-max-size": {
54-
"help": "User application data buffer maximum size, default: 64, MAX: 255",
55-
"value": 64
56-
},
57-
"adr-on": {
58-
"help": "LoRaWAN Adaptive Data Rate, default: 1",
59-
"value": 1
60-
},
61-
"public-network": {
62-
"help": "LoRaWAN will connect to a public network or private network, true = public network",
63-
"value": true
64-
},
65-
"duty-cycle-on": {
66-
"help": "Enables/disables duty cycling. NOTE: Disable only for testing. Mandatory in many regions.",
67-
"value": true
68-
},
69-
"lbt-on": {
70-
"help": "Enables/disables LBT. NOTE: [This feature is not yet integrated].",
71-
"value": false
72-
}
73-
}
74-
}
9+
```
10+
Configuration parameters
11+
------------------------
12+
13+
Name: lora.adr-on
14+
Defined by: library:lora
15+
Value: 1 (set by library:lora)
16+
Name: lora.app-port
17+
Defined by: library:lora
18+
Value: 15 (set by library:lora)
19+
Name: lora.application-eui
20+
Defined by: library:lora
21+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
22+
Name: lora.application-key
23+
Defined by: library:lora
24+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
25+
Name: lora.appskey
26+
Defined by: library:lora
27+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
28+
Name: lora.device-address
29+
Defined by: library:lora
30+
Value: 0x00000000 (set by library:lora)
31+
Name: lora.device-eui
32+
Defined by: library:lora
33+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
34+
Name: lora.duty-cycle-on
35+
Defined by: library:lora
36+
Value: 1 (set by library:lora)
37+
Name: lora.lbt-on
38+
Defined by: library:lora
39+
Name: lora.nb-trials
40+
Defined by: library:lora
41+
Value: 12 (set by library:lora)
42+
Name: lora.nwkskey
43+
Defined by: library:lora
44+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
45+
Name: lora.over-the-air-activation
46+
Defined by: library:lora
47+
Value: 1 (set by library:lora)
48+
Name: lora.phy
49+
Defined by: library:lora
50+
Value: 0 (set by library:lora)
51+
Name: lora.public-network
52+
Defined by: library:lora
53+
Value: 1 (set by library:lora)
54+
Name: lora.tx-max-size
55+
Defined by: library:lora
56+
Value: 64 (set by library:lora)
7557
```
7658

7759
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`.
@@ -88,4 +70,4 @@ For changing any of these parameters, edit the `mbed_app.json` file in the root
8870

8971
### Using APIs from LoRaWANInterface
9072

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

0 commit comments

Comments
 (0)