You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-15Lines changed: 28 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,34 @@ This firmware is in no way associated with The Button Corporation Ltd.
6
6
7
7
Installing this firmware will most likely void your warranty.
8
8
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
+
9
21
## Gettings started
10
22
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
+
11
37
### Building
12
38
13
39
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
43
69
* It should now show up in the DFU list (`dfu-util --list`)
44
70
4.`cd openbttn/src && make download`
45
71
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.
0 commit comments