Skip to content

Commit 586d39f

Browse files
committed
Update README
1 parent 4eb763a commit 586d39f

File tree

1 file changed

+28
-15
lines changed

1 file changed

+28
-15
lines changed

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,34 @@ This firmware is in no way associated with The Button Corporation Ltd.
66

77
Installing this firmware will most likely void your warranty.
88

9+
10+
## Features
11+
12+
* Allow spaces in Wi-Fi SSIDs (the original firmware doesn't).
13+
* Probably other special characters as well.
14+
* Single and long press
15+
* Super fast response times in a local setting
16+
* Live configuration (from Web-UI hosted on bt.tn)
17+
* OTA update of the SPWF01SA Wi-Fi module
18+
* Custom led flashing by [POST request](https://github.com/mafredri/openbttn/commit/d2a22cb6291fbe04f809ac2fbe771ca0c1953c66)
19+
* Password authentication for bt.tn configuration
20+
921
## Gettings started
1022

23+
### First steps
24+
25+
1. Download the latest [release](https://github.com/mafredri/openbttn/releases) or build the project yourself
26+
2. Install the firmware
27+
* Optionally, backup the original firmware
28+
3. Configure bttn in recovery mode
29+
1. Boot bttn while holding the button for 4 seconds to enter recovery mode
30+
2. Connect to the 'OpenBttn' Wi-Fi network
31+
3. Navigate to `http://192.168.1.1/`
32+
4. Configure your Wi-Fi settings
33+
4. Configure the button press URLs
34+
1. Navigate to `http://[bttn_IP_on_your_network]/`
35+
5. Enjoy your OpenBttn!
36+
1137
### Building
1238

1339
Install the [GNU ARM Embedded Toolchain](https://launchpad.net/gcc-arm-embedded/+download):
@@ -43,26 +69,13 @@ This firmware can be installed in two ways, either via DFU mode or via the JTAG
4369
* It should now show up in the DFU list (`dfu-util --list`)
4470
4. `cd openbttn/src && make download`
4571

46-
`make download` is the same as manually issuing `dfu-util -d 0483:df11 -s 0x08000000 -a 0 -D main.bin` which requires the `main.bin` to be built first. This downloads the firmware to the bt.tn and overwrites the original firmware.
47-
48-
## Features
49-
50-
* Allow spaces in Wi-Fi SSIDs (the original firmware doesn't).
51-
* Probably other special characters as well.
52-
* Single and long press
53-
* Super fast response times in a local setting
54-
* Live configuration (from Web-UI hosted on bt.tn)
55-
* OTA update of the SPWF01SA Wi-Fi module
56-
* Custom led flashing by POST request
57-
* This is a WIP and part of the `socket-refactor` branch (d2a22cb)
58-
* Password authentication for bt.tn configuration
72+
`make download` is the same as manually issuing `dfu-util --device 0483:df11 --dfuse-address 0x08000000 --alt 0 --download main.bin` which requires the `main.bin` to be built first. This downloads the firmware to the bt.tn and overwrites the original firmware.
5973

6074
## Current status
6175

6276
### TODO
6377

64-
* Complete the `socket-refactor` branch
65-
* Improve Web-UI
78+
* Improve documentation
6679

6780
### Nice to have
6881

0 commit comments

Comments
 (0)