Skip to content

Commit e84d437

Browse files
author
Irit Arkin
committed
Merge branch 'new_engine' of https://github.com/ARMmbed/Handbook into new_engine
2 parents 91f71ba + d2a97e6 commit e84d437

File tree

8 files changed

+181
-153
lines changed

8 files changed

+181
-153
lines changed

docs/reference/api/rtos/Event.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ The Event class is thread safe. The `post` and `cancel` APIs are IRQ safe.
1313
The code below demonstrates how you can instantiate, configure and post events.
1414

1515
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-events/)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-events/file/86c4bf2d90fa/main.cpp)
16+
17+
### Related content
18+
19+
- [RTOS configuration](https://os-doc-builder.test.mbed.com/docs/development/reference/configuration-rtos.html).

docs/reference/api/storage/FileSystem.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ The file system API provides a common interface for implementing a file system o
99
### File system example
1010

1111
[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-fat-filesystem)](https://github.com/ARMmbed/mbed-os-example-fat-filesystem/blob/master/main.cpp)
12+
13+
### Related content
14+
15+
- [Storage configuration](configuration-storage.html).

docs/reference/api/storage/LittleFileSystem.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,7 @@ The API that this presents is the standard Mbed OS file system API. Once declare
4242
### LittleFileSystem example
4343

4444
[![View code](https://www.mbed.com/embed/?url=https://github.com/armmbed/mbed-os-example-filesystem)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-filesystem/file/8e251d9511b8/main.cpp)
45+
46+
### Related content
47+
48+
- [Storage configuration](configuration-storage.html).

docs/reference/api/storage/NVStore.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@ NVStore uses two Flash areas, active and nonactive. Each area must consist of at
1515
### NVStore example
1616

1717
[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-nvstore/)](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-nvstore/file/0a3e19b12855/main.cpp)
18+
19+
### Related content
20+
21+
- [Storage configuration](configuration-storage.html).

docs/reference/configuration/Connectivity.md

Lines changed: 90 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ You can configure various parameters using either C++ APIs or the Arm Mbed confi
77
Configuration parameters
88
------------------------
99
10-
Name: use-apn-lookup
10+
Name: cellular.random_max_start_delay
11+
Description: Maximum random delay value used in start-up sequence in milliseconds
12+
Defined by: library:cellular
13+
No value set
14+
Name: cellular.use-apn-lookup
1115
Description: Use APN database lookup
1216
Defined by: library:cellular
1317
Macro name: MBED_CONF_CELLULAR_USE_APN_LOOKUP
1418
Value: 1 (set by library:cellular)
15-
Name: random_max_start_delay
16-
Description: Maximum random delay value used in start-up sequence in milliseconds
17-
Defined by: library:cellular
18-
Macro name: MBED_CONF_CELLULAR_RANDOM_MAX_START_DELAY
19-
Value: 0 (set by library:cellular)
19+
2020
Name: ppp-cell-iface.apn-lookup
2121
Defined by: library:ppp-cell-iface
22-
No value set
22+
Macro name: MBED_CONF_PPP_CELL_IFACE_APN_LOOKUP
23+
Value: 1 (set by library:ppp-cell-iface)
2324
Name: ppp-cell-iface.at-parser-buffer-size
2425
Defined by: library:ppp-cell-iface
2526
Macro name: MBED_CONF_PPP_CELL_IFACE_AT_PARSER_BUFFER_SIZE
@@ -32,6 +33,7 @@ Name: ppp-cell-iface.baud-rate
3233
Defined by: library:ppp-cell-iface
3334
Macro name: MBED_CONF_PPP_CELL_IFACE_BAUD_RATE
3435
Value: 115200 (set by library:ppp-cell-iface)
36+
3537
Name: lwip.addr-timeout
3638
Description: On dual-stack system how long to additionally wait for other stack's address in seconds
3739
Defined by: library:lwip
@@ -138,55 +140,91 @@ Name: lwip.use-mbed-trace
138140
Description: Use mbed trace for debug, rather than printf
139141
Defined by: library:lwip
140142
No value set
143+
141144
Name: nsapi.present
142145
Defined by: library:nsapi
143146
Macro name: MBED_CONF_NSAPI_PRESENT
144147
Value: 1 (set by library:nsapi)
145-
146-
Name: lora.adr-on
147-
Defined by: library:lora
148-
Value: 1 (set by library:lora)
149-
Name: lora.app-port
150-
Defined by: library:lora
151-
Value: 15 (set by library:lora)
152-
Name: lora.application-eui
153-
Defined by: library:lora
154-
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
155-
Name: lora.application-key
156-
Defined by: library:lora
157-
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
158-
Name: lora.appskey
159-
Defined by: library:lora
160-
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
161-
Name: lora.device-address
162-
Defined by: library:lora
163-
Value: 0x00000000 (set by library:lora)
164-
Name: lora.device-eui
165-
Defined by: library:lora
166-
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
167-
Name: lora.duty-cycle-on
168-
Defined by: library:lora
169-
Value: 1 (set by library:lora)
170-
Name: lora.lbt-on
171-
Defined by: library:lora
172-
Name: lora.nb-trials
173-
Defined by: library:lora
174-
Value: 12 (set by library:lora)
175-
Name: lora.nwkskey
176-
Defined by: library:lora
177-
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
178-
Name: lora.over-the-air-activation
179-
Defined by: library:lora
180-
Value: 1 (set by library:lora)
181-
Name: lora.phy
182-
Defined by: library:lora
183-
Value: 0 (set by library:lora)
184-
Name: lora.public-network
185-
Defined by: library:lora
186-
Value: 1 (set by library:lora)
187-
Name: lora.tx-max-size
188-
Defined by: library:lora
189-
Value: 64 (set by library:lora)
148+
149+
Name: lora.adr-on
150+
Description: LoRaWAN Adaptive Data Rate, default: 1
151+
Defined by: library:lora
152+
Macro name: MBED_CONF_LORA_ADR_ON
153+
Value: 1 (set by library:lora)
154+
Name: lora.app-port
155+
Description: LoRaWAN application port, default: 15
156+
Defined by: library:lora
157+
Macro name: MBED_CONF_LORA_APP_PORT
158+
Value: 15 (set by library:lora)
159+
Name: lora.application-eui
160+
Description: Application IEEE EUI
161+
Defined by: library:lora
162+
Macro name: MBED_CONF_LORA_APPLICATION_EUI
163+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
164+
Name: lora.application-key
165+
Description: AES encryption/decryption cipher application key
166+
Defined by: library:lora
167+
Macro name: MBED_CONF_LORA_APPLICATION_KEY
168+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
169+
Name: lora.appskey
170+
Description: AES encryption/decryption cipher application session key
171+
Defined by: library:lora
172+
Macro name: MBED_CONF_LORA_APPSKEY
173+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
174+
Name: lora.automatic-uplink-message
175+
Description: Stack will automatically send an uplink message when lora server requires immediate response
176+
Defined by: library:lora
177+
Macro name: MBED_CONF_LORA_AUTOMATIC_UPLINK_MESSAGE
178+
Value: 1 (set by library:lora)
179+
Name: lora.device-address
180+
Description: Device address on the network
181+
Defined by: library:lora
182+
Macro name: MBED_CONF_LORA_DEVICE_ADDRESS
183+
Value: 0x00000000 (set by library:lora)
184+
Name: lora.device-eui
185+
Description: Mote device IEEE EUI
186+
Defined by: library:lora
187+
Macro name: MBED_CONF_LORA_DEVICE_EUI
188+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
189+
Name: lora.duty-cycle-on
190+
Description: Enables/disables duty cycling. NOTE: Disable only for testing. Mandatory in many regions.
191+
Defined by: library:lora
192+
Macro name: MBED_CONF_LORA_DUTY_CYCLE_ON
193+
Value: 1 (set by library:lora)
194+
Name: lora.lbt-on
195+
Description: Enables/disables LBT. NOTE: [This feature is not yet integrated].
196+
Defined by: library:lora
197+
No value set
198+
Name: lora.nb-trials
199+
Description: Indicates how many times join can be tried, default: 12
200+
Defined by: library:lora
201+
Macro name: MBED_CONF_LORA_NB_TRIALS
202+
Value: 12 (set by library:lora)
203+
Name: lora.nwkskey
204+
Description: AES encryption/decryption cipher network session key
205+
Defined by: library:lora
206+
Macro name: MBED_CONF_LORA_NWKSKEY
207+
Value: {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} (set by library:lora)
208+
Name: lora.over-the-air-activation
209+
Description: When set to 1 the application uses the Over-the-Air activation procedure, default: true
210+
Defined by: library:lora
211+
Macro name: MBED_CONF_LORA_OVER_THE_AIR_ACTIVATION
212+
Value: 1 (set by library:lora)
213+
Name: lora.phy
214+
Description: LoRa PHY region: EU868, AS923, AU915, CN470, CN779, EU433, IN865, KR920, US915, US915_HYBRID
215+
Defined by: library:lora
216+
Macro name: MBED_CONF_LORA_PHY
217+
Value: EU868 (set by library:lora)
218+
Name: lora.public-network
219+
Description: LoRaWAN will connect to a public network or private network, true = public network
220+
Defined by: library:lora
221+
Macro name: MBED_CONF_LORA_PUBLIC_NETWORK
222+
Value: 1 (set by library:lora)
223+
Name: lora.tx-max-size
224+
Description: User application data buffer maximum size, default: 64, MAX: 255
225+
Defined by: library:lora
226+
Macro name: MBED_CONF_LORA_TX_MAX_SIZE
227+
Value: 64 (set by library:lora)
190228
```
191229

192230
To change any of these parameters, edit the `mbed_app.json` file in the root of your application. Prefix the parameter name, for example, `lora.my-parameter: value`.

docs/reference/configuration/Platform.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,34 @@ Name: platform.default-serial-baud-rate
1111
Defined by: library:platform
1212
Macro name: MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE
1313
Value: 9600 (set by library:platform)
14+
Name: platform.force-non-copyable-error
15+
Description: Force compile time error when a NonCopyable object is copied
16+
Defined by: library:platform
17+
No value set
18+
Name: platform.poll-use-lowpower-timer
19+
Description: Enable use of low power timer class for poll(). May cause missing events.
20+
Defined by: library:platform
21+
No value set
1422
Name: platform.stdio-baud-rate
1523
Description: Baud rate for stdio
1624
Defined by: library:platform
1725
Macro name: MBED_CONF_PLATFORM_STDIO_BAUD_RATE
1826
Value: 9600 (set by library:platform)
27+
Name: platform.stdio-buffered-serial
28+
Description: Use UARTSerial driver to obtain buffered serial I/O on stdin/stdout/stderr. If false, unbuffered serial_getc and serial_putc are used directly.
29+
Defined by: library:platform
30+
No value set
1931
Name: platform.stdio-convert-newlines
20-
Description: Enable conversion to standard newlines on stdin/stdout
32+
Description: Enable conversion to standard newlines on stdin/stdout/stderr
33+
Defined by: library:platform
34+
No value set
35+
Name: platform.stdio-convert-tty-newlines
36+
Description: Enable conversion to standard newlines on any tty FILE stream
2137
Defined by: library:platform
2238
No value set
2339
Name: platform.stdio-flush-at-exit
2440
Description: Enable or disable the flush of standard I/O's at exit.
2541
Defined by: library:platform
2642
Macro name: MBED_CONF_PLATFORM_STDIO_FLUSH_AT_EXIT
2743
Value: 1 (set by library:platform)
28-
```
44+
```

docs/reference/configuration/RTOS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,8 @@ Name: events.shared-stacksize
4848
Defined by: library:events
4949
Macro name: MBED_CONF_EVENTS_SHARED_STACKSIZE
5050
Value: 1024 (set by library:events)
51+
Name: events.use-lowpower-timer-ticker
52+
Description: Enable use of low power timer and ticker classes in non-RTOS builds. May reduce the accuracy of the event queue. In RTOS builds, the RTOS tick count is used, and this configuration option has no effect.
53+
Defined by: library:events
54+
No value set
5155
```

0 commit comments

Comments
 (0)