Skip to content

Commit 82e648a

Browse files
committed
docs: document nrf52833-nosd snippet
1 parent 24419ac commit 82e648a

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/docs/config/system.md

+40
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,43 @@ Following [split keyboard](../features/split-keyboards.md) settings are defined
135135
| `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_STACK_SIZE` | int | Stack size of the BLE split peripheral notify thread | 650 |
136136
| `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_PRIORITY` | int | Priority of the BLE split peripheral notify thread | 5 |
137137
| `CONFIG_ZMK_SPLIT_BLE_PERIPHERAL_POSITION_QUEUE_SIZE` | int | Max number of key state events to queue to send to the central | 10 |
138+
139+
## Snippets
140+
141+
Snippets are a way to save common configuration separately when it applies to multiple different applications.
142+
143+
More documentation is available from [Zephyr](https://docs.zephyrproject.org/3.5.0/build/snippets/index.html).
144+
145+
Enable snippets with `-S <snippet>` for local builds, for example:
146+
147+
```sh
148+
west build -b nrfmicro_13_52833 -S nrf52833-nosd -- -DSHIELD=corne_left
149+
```
150+
151+
Or by adding `snippet: <snippet>` to your `build.yaml` for the appropriate board:
152+
153+
```yaml
154+
- board: nrfmicro_13_52833
155+
snippet: nrf52833-nosd
156+
shield: corne_left
157+
```
158+
159+
ZMK implements the following system configuration snippets:
160+
161+
### nrf52833-nosd
162+
163+
Definition: [zmk/app/snippets/nrf52833-nosd](https://github.com/zmkfirmware/zmk/blob/main/app/snippets/nrf52833-nosd)
164+
165+
On memory-constrained nRF52833 boards this snippet will extend the code partition to overwrite the Nordic SoftDevice.
166+
This gives 428KB for the code partition as opposed to 280KB with the Nordic SoftDevice.
167+
168+
The added memory allows the nRF52833 to fit displays and other memory-intensive features.
169+
170+
:::danger
171+
Erasing the SoftDevice will prevent the board from using firmware built without the snippet.
172+
173+
Flashing such firmware **will** totally brick the board, disabling the USB flashing functionality.
174+
The only way to restore functionality after that is to re-flash the bootloader.
175+
176+
Re-flashing a bootloader built without the SoftDevice will require firmware built with this snippet.
177+
:::

0 commit comments

Comments
 (0)