@@ -20,47 +20,36 @@ A list of supported protocols can be found in the pilight manual:
20
20
https://manual.pilight.org/protocols/433.92/index.html
21
21
22
22
23
- ## Software/Requirements
24
-
25
- The software is using the [ PlatformIO] ( http://platformio.org/ ) ecosystem. See their
26
- [ install instructions] ( http://docs.platformio.org/en/latest/installation.html ) or get
27
- their [ IDE] ( http://docs.platformio.org/en/latest/ide/pioide.html ) to get the
28
- software. More information can be found in their [ documentation] ( http://docs.platformio.org/en/latest/ ) .
29
-
30
- 1 . Open a terminal and go to the MQTT433Gateway project folder.
31
-
32
- 2 . After that, decide for which board to create the firmware and give
33
- this as ` --environment ` to the platformio ` run ` command:
34
- ``` console
35
- $ platformio run --environment <board>
36
- ```
37
- The available boards are defined in ` platformio.ini ` . Currently, this are
38
- + ` esp12e ` for ESP8266-12e/f models,
39
- + ` esp12e_160 ` for ESP8266-12e/f models with cpu clock set to 160MHz,
40
- + ` nodemcu ` for NodeMCU 0.9 boards,
41
- + ` nodemcuv2 ` for NodeMCU 1.0 boards,
42
- + ` d1_mini ` for D1 Mini boards,
43
- + ` huzzah ` for the Huzzah boards.
44
-
45
- 3 . To flash the firmware to the board, connect the board to the PC via
46
- USB or a serial adapter. Make sure, it is the only device currently
47
- connected, as otherwise you might flash the wrong unit
48
- accidentally. Some boards need to be set manually into a programming
49
- mode, please check the manual of the board to get more details about
50
- how to do that. The ` platformio run ` has the upload target to
51
- initialize flashing:
52
- ``` console
53
- $ platformio run --environment <board> --target upload
54
- ```
55
- this will try to autodetect the serial port. If this is not
56
- successful, try
57
- ``` console
58
- $ platformio run --environment <board> --target upload --upload-port <path-to-serial-port>
59
- ```
60
-
61
- Older versions of MQTT433gateway were developed with the Arduino
62
- IDE. You can find the old sources in the departed
63
- [ ` arduino ` ] ( ../../tree/arduino ) branch.
23
+ ## Installation
24
+
25
+ Firmware binary are provided under
26
+ [ releases] ( https://github.com/puuu/MQTT433gateway/releases ) . If you
27
+ want to build from source please have a look at
28
+ [ Development] ( #development ) . For the first flash you have multiple
29
+ possibilities, some of them are:
30
+
31
+ - Build and flash with PlatformIO (see [ Development] ( #development ) )
32
+ - Flash with [ esptool.py] ( https://github.com/espressif/esptool )
33
+ ``` console
34
+ $ esptool.py --port <serialport> write_flash 0 mqtt433gateway_<env>-<version>.bin
35
+ ```
36
+ - Flashing the ` WebUpdater ` example from
37
+ [ Arduino] ( https://github.com/esp8266/Arduino#installing-with-boards-manager )
38
+ (File -> Examples -> ESP8266HTTPUpdateServer) and uploading the
39
+ MQTT433gateway binary via browser.
40
+
41
+ At the moment two binaries are provided:
42
+ - ` mqtt433gateway_esp12e-*.bin ` generic ESP8266 module with cpu clock
43
+ = 80 MHz (recommend)
44
+ - ` mqtt433gateway_esp12e_160-*.bin ` generic ESP8266 module with cpu
45
+ clock = 160 MHz
46
+
47
+ The ` platformio.ini ` provides more environments, but the main
48
+ different between these are the way how they are flashed via serial
49
+ connector and how additional components (like LEDs) are
50
+ connected. Since MQTT433gateway can be fully configured by the web
51
+ frontend and provided [ over-the-air programming] ( #ota-update ) , these
52
+ binaries should be sufficient.
64
53
65
54
66
55
## Hardware
@@ -273,9 +262,12 @@ switch:
273
262
274
263
# # OTA Update
275
264
276
- Updates of the MQTT433gateway can be preformed by OTA (Over-the-air programming)
277
- via the web frontend. To do this, you need the binary file that can be found at
278
- ` <BUILD_DIR>/firmware.bin` , e.g. `.pioenvs/huzzah/firmware.bin`.
265
+ Updates of the MQTT433gateway can be preformed by OTA (Over-the-air
266
+ programming) via the web frontend. To do this, you need the binary
267
+ file that can be found under
268
+ [releases](https://github.com/puuu/MQTT433gateway/releases) or, if you
269
+ build with PlatformIO, at `<BUILD_DIR>/firmware.bin`,
270
+ e.g. `.pioenvs/huzzah/firmware.bin`.
279
271
280
272
281
273
# # Debugging/RF-protocol analyzing
@@ -295,6 +287,49 @@ and/or your device matches multiple protocols, you can limit the
295
287
available protocols. This is easily possible with via the web frontend.
296
288
297
289
290
+ # # Development
291
+
292
+ The software is using the [PlatformIO](http://platformio.org/) ecosystem. See their
293
+ [install instructions](http://docs.platformio.org/en/latest/installation.html) or get
294
+ their [IDE](http://docs.platformio.org/en/latest/ide/pioide.html) to get the
295
+ software. More information can be found in their [documentation](http://docs.platformio.org/en/latest/).
296
+
297
+ 1. Open a terminal and go to the MQTT433Gateway project folder.
298
+
299
+ 2. After that, decide for which board to create the firmware and give
300
+ this as `--environment` to the platformio `run` command :
301
+ ` ` ` console
302
+ $ platformio run --environment <board>
303
+ ` ` `
304
+ The available boards are defined in `platformio.ini`. Currently, this are
305
+ + `esp12e` for ESP8266-12e/f models,
306
+ + `esp12e_160` for ESP8266-12e/f models with cpu clock set to 160MHz,
307
+ + `nodemcu` for NodeMCU 0.9 boards,
308
+ + `nodemcuv2` for NodeMCU 1.0 boards,
309
+ + `d1_mini`for D1 Mini boards,
310
+ + `huzzah` for the Huzzah boards.
311
+
312
+ 3. To flash the firmware to the board, connect the board to the PC via
313
+ USB or a serial adapter. Make sure, it is the only device currently
314
+ connected, as otherwise you might flash the wrong unit
315
+ accidentally. Some boards need to be set manually into a programming
316
+ mode, please check the manual of the board to get more details about
317
+ how to do that. The `platformio run` has the upload target to
318
+ initialize flashing :
319
+ ` ` ` console
320
+ $ platformio run --environment <board> --target upload
321
+ ` ` `
322
+ this will try to autodetect the serial port. If this is not
323
+ successful, try
324
+ ` ` ` console
325
+ $ platformio run --environment <board> --target upload --upload-port <path-to-serial-port>
326
+ ` ` `
327
+
328
+ Older versions of MQTT433gateway were developed with the Arduino
329
+ IDE. You can find the old sources in the departed
330
+ [`arduino`](../../tree/arduino) branch.
331
+
332
+
298
333
# # Contributions
299
334
300
335
If you find any bug, please feel free to fill an issue. Also, pull request are
0 commit comments