Skip to content

Commit 2127358

Browse files
committed
documentation improvements
1 parent 0ed1031 commit 2127358

8 files changed

Lines changed: 96 additions & 89 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ Learn about my other projects [here](https://daniel.nullco.de).
4444

4545
## Table of contents
4646

47-
1. [Configuration](docs/CONFIGURATION.md)
48-
2. [Feature configuration](docs/FEATURES.md)
49-
3. [Pin inputs/outputs (Automation IO)](docs/AUTOMATION_IO_SERVICE.md)
50-
4. [Pin inputs (Binary Sensor Service)](docs/BINARY_SENSOR_SERVICE.md)
51-
5. [gpioASM](docs/GPIO_ASM_SERVICE.md)
52-
6. [Compilation](docs/COMPILATION.md)
53-
7. [Programming the chip](docs/FLASHING.md)
54-
8. [First steps](docs/FIRST_STEPS.md)
47+
1. [First steps](docs/FIRST_STEPS.md)
48+
2. [Configuration](docs/CONFIGURATION.md)
49+
3. [gpioASM](docs/GPIO_ASM_SERVICE.md)
50+
4. [Compilation](docs/COMPILATION.md)
51+
5. [Programming the chip](docs/FLASHING.md)
52+
6. [Feature configuration](docs/FEATURES.md)
53+
7. [Pin inputs/outputs (Automation IO)](docs/AUTOMATION_IO_SERVICE.md)
54+
8. [Pin inputs (Binary Sensor Service)](docs/BINARY_SENSOR_SERVICE.md)
5555

5656
## Roadmap
5757

docs/FIRST_STEPS.md

Lines changed: 8 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -6,84 +6,11 @@ Just check the pictures if anything looks like your board and click on it.
66
After flashing your file feel free to re-configure BLEnky using the section at the bottom of the page.
77

88
If you don't find your board here, try looking through the [latest release](https://github.com/dakhnod/BLEnky/releases/latest) for a package that sounds like your board.
9-
If your board shows up as a drive and says something about UF2, follow [these instructions](#uf2-based-boards).
10-
If it just shows up as a Serial port, it likely has the nordic bootloader installed, go with [this](#nordic-dfu-based-boards).
11-
If it doesn't show up at all, follow [this](#generic-board--without-bootloader).
12-
13-
[<img height="100" src="https://files.seeedstudio.com/wiki/XIAO-BLE/nrf52840_front.jpg">](#xiao-ble)
14-
[<img height="100" src="https://docs-be.nordicsemi.com/bundle/ncs-latest/page/zephyr/_images/others_promicro_nrf52840.webp?_LANG=enus">](#pro-micro--nice-nano)
15-
[<img height="100" src="https://camo.githubusercontent.com/b0ed7718a2938ed9660fe2611832c7d0cc850ea262c49a9e873610f651241ffe/68747470733a2f2f6769746875622d70726f64756374696f6e2d757365722d61737365742d3632313064662e73332e616d617a6f6e6177732e636f6d2f3835323534372f3239353031303232332d66363464356466372d633465642d343862382d613961382d6162663534653031343739312e6a7067">](#pro-micro)
16-
[<img height="100" src="https://www.nordicsemi.com/-/media/Images/Products/DevKits/nRF52-Series/nRF52840-Dongle/nRF52840-Dongle-rev2-prod-page.png?h=750&iar=0&mw=350&w=350&hash=994DC726E9F3DBB12056C07F5DC0A802">](#nrf52840-dongle)
17-
18-
## XIAO BLE
19-
20-
On these boards, you need to update the bootloader first.
21-
Thus install `adafruit-nrfutil` using pip.
22-
Then, get [this file](https://github.com/user-attachments/files/19794746/xiao_nrf52840_ble_bootloader-0.9.2-10-g4329614-dirty_s140_6.1.1.zip) and run `adafruit-nrfutil dfu serial -p BOARD_PORT -pkg xiao_nrf52840_ble_bootloader-0.9.2-10-g4329614-dirty_s140_6.1.1.zip`.
23-
After, make sure that the .txt on the board shows Softdevice version 6.1.1.
24-
After, you just need to copy the right file onto the board, which appears as a flash drive.
25-
The firmware file to search for contains `xiao_ble.uf2`.
26-
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
27-
28-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
29-
30-
To get back into the bootloader, a quick doble reset should suffice.
31-
32-
## Pro micro / Nice nano
33-
34-
These boards come pre-flashed with a uf2 bootloader, so you just need to copy the right file onto the board, which appears as a flash drive.
35-
The firmware file to search for contains `others_promicro_nrf52840.uf2`.
36-
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
37-
38-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
39-
40-
To get back into the bootloader, a quick doble reset should suffice.
41-
42-
## nRF52840 Dongle
43-
44-
These boards come pre-flashed with the nordic bootloader.
45-
To flash these, you need to plugin the dongle and install nrfutil.
46-
47-
Then get this file and run
48-
```
49-
nrfutil dfu serial -p DONGLE_PORT -pkg FIRMWARE_FILE.zip
50-
```
51-
The file to look for contains `nordic_nrf52840dongle.zip`.
52-
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
53-
54-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
55-
56-
To get back into the bootloader, a quick doble reset should suffice.
57-
58-
## UF2 based boards
59-
60-
For these boards, find the right `.uf2` firmware in [in the latest release](https://github.com/dakhnod/BLEnky/releases/latest) and copy it onto the drive that should appear once you connect the board.
61-
If you can't find anything suiting, get the generic build and configure it through the website.
62-
63-
Just make sure, using the text file on the drive, that the Softdevice version is 6.1.1.
64-
65-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
66-
67-
To get back into the bootloader, a quick doble reset should suffice.
68-
69-
## Nordic DFU based boards
70-
71-
For these boards, find the right firmware in [in the latest release](https://github.com/dakhnod/BLEnky/releases/latest).
72-
To flash these, you need to plugin the dongle and install nrfutil.
73-
If you can't find anything suiting, get the generic build and configure it through the website.
74-
75-
Then get this file and run
76-
```
77-
nrfutil dfu serial -p DONGLE_PORT -pkg FIRMWARE_FILE.zip
78-
```
79-
80-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
81-
82-
To get back into the bootloader, a quick doble reset should suffice.
83-
84-
## Generic board / without bootloader
85-
86-
If your board does not appear to have a bootloader at all, get the hex file for your board, or the generic hex file.
87-
Then follow [these instruction](FLASHING.md).
88-
89-
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
9+
If your board shows up as a drive and says something about UF2, follow [these instructions](boards/GENERIC_UF2.md).
10+
If it just shows up as a Serial port, it likely has the nordic bootloader installed, go with [this](boards/NORDIC_DFU.md).
11+
If it doesn't show up at all, follow [this](boards/GENERIC.md).
12+
13+
[<img height="100" src="https://files.seeedstudio.com/wiki/XIAO-BLE/nrf52840_front.jpg">](boards/XIAO_BLE.md)
14+
[<img height="100" src="https://docs-be.nordicsemi.com/bundle/ncs-latest/page/zephyr/_images/others_promicro_nrf52840.webp?_LANG=enus">](boards/PRO_MICRO.md)
15+
[<img height="100" src="https://camo.githubusercontent.com/b0ed7718a2938ed9660fe2611832c7d0cc850ea262c49a9e873610f651241ffe/68747470733a2f2f6769746875622d70726f64756374696f6e2d757365722d61737365742d3632313064662e73332e616d617a6f6e6177732e636f6d2f3835323534372f3239353031303232332d66363464356466372d633465642d343862382d613961382d6162663534653031343739312e6a7067">](boards/PRO_MICRO.md)
16+
[<img height="100" src="https://www.nordicsemi.com/-/media/Images/Products/DevKits/nRF52-Series/nRF52840-Dongle/nRF52840-Dongle-rev2-prod-page.png?h=750&iar=0&mw=350&w=350&hash=994DC726E9F3DBB12056C07F5DC0A802">](boards/NRF52840_DONGLE.md)

docs/boards/GENERIC.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Generic board / without bootloader
2+
3+
If your board does not appear to have a bootloader at all, get the hex file for your board, or the generic hex file.
4+
Then follow [these instruction](FLASHING.md).
5+
6+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!

docs/boards/GENERIC_UF2.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# UF2 based boards
2+
3+
For these boards, find the right `.uf2` firmware in [in the latest release](https://github.com/dakhnod/BLEnky/releases/latest) and copy it onto the drive that should appear once you connect the board.
4+
If you can't find anything suiting, get the generic build and configure it through the website.
5+
6+
Just make sure, using the text file on the drive, that the Softdevice version is 6.1.1.
7+
8+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
9+
10+
To get back into the bootloader, a quick doble reset should suffice.

docs/boards/NORDIC_DFU.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Nordic DFU based boards
2+
3+
For these boards, find the right firmware in [in the latest release](https://github.com/dakhnod/BLEnky/releases/latest).
4+
To flash these, you need to plugin the dongle and install nrfutil.
5+
If you can't find anything suiting, get the generic build and configure it through the website.
6+
7+
Then get this file and run
8+
```
9+
nrfutil dfu serial -p DONGLE_PORT -pkg FIRMWARE_FILE.zip
10+
```
11+
12+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
13+
14+
To get back into the bootloader, a quick doble reset should suffice.

docs/boards/NRF52840_DONGLE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# nRF52840 Dongle
2+
3+
These boards come pre-flashed with the nordic bootloader.
4+
To flash these, you need to plugin the dongle and install nrfutil.
5+
6+
Then get this file and run
7+
```
8+
nrfutil dfu serial -p DONGLE_PORT -pkg FIRMWARE_FILE.zip
9+
```
10+
The file to look for contains `nordic_nrf52840dongle.zip`.
11+
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
12+
13+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
14+
15+
To get back into the bootloader, a quick doble reset should suffice.

docs/boards/PRO_MICRO.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Pro micro / Nice nano
2+
3+
## Flashing
4+
5+
These boards come pre-flashed with a uf2 bootloader, so you just need to copy the right file onto the board, which appears as a flash drive.
6+
The firmware file to search for contains `others_promicro_nrf52840.uf2`.
7+
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
8+
9+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
10+
11+
To get back into the bootloader, a quick doble reset should suffice.
12+
13+
## Low power
14+
15+
In order to get the lowest power ingest (microamperes), supply around 3V to the pin marked in this picture:
16+
17+
![Image](https://github.com/user-attachments/assets/85d85e85-a2dd-4b9f-a323-fdbf0cab0c24)
18+
19+
As far as I have discovered so far, no other pin is connected to the 3V input of the nRF.
20+
As such, all other power pins consume more power.
21+
22+
Please open an Issue if I am wrong.

docs/boards/XIAO_BLE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# XIAO BLE
2+
3+
On these boards, you need to update the bootloader first.
4+
Thus install `adafruit-nrfutil` using pip.
5+
Then, get [this file](https://github.com/user-attachments/files/19794746/xiao_nrf52840_ble_bootloader-0.9.2-10-g4329614-dirty_s140_6.1.1.zip) and run `adafruit-nrfutil dfu serial -p BOARD_PORT -pkg xiao_nrf52840_ble_bootloader-0.9.2-10-g4329614-dirty_s140_6.1.1.zip`.
6+
After, make sure that the .txt on the board shows Softdevice version 6.1.1.
7+
After, you just need to copy the right file onto the board, which appears as a flash drive.
8+
The firmware file to search for contains `xiao_ble.uf2`.
9+
Firmware files can be found [in the releases](https://github.com/dakhnod/BLEnky/releases/latest).
10+
11+
Once the firmware is copied/flashed, the flash drive will disappear and you should be able to head to https://ble.nullco.de and connect to your board. You just saved yourself years of development!
12+
13+
To get back into the bootloader, a quick doble reset should suffice.

0 commit comments

Comments
 (0)