Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LoSk-p committed Sep 18, 2024
1 parent b667344 commit 1f9a356
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 24 deletions.
38 changes: 14 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# Sensor.Community flashing tool


## Modified flasher to burn the Wifi credentials at once.

spiffsgen.py added and kindly modified by @DeeKey

![Modified GUI](images/modified_GUI2.png)

config.json example:

`{"SOFTWARE_VERSION":"NRZ-2020-133","current_lang":"FR","wlanssid":"Livebox-7E78","wlanpwd":"i0c_YSNS","www_username":"admin","www_password":"","fs_ssid":"airRohr-2509507","fs_pwd":"","www_basicauth_enabled":false,"dht_read":false,"htu21d_read":false,"ppd_read":false,"sds_read":false,"pms_read":true,"hpm_read":false,"npm_read":false,"sps30_read":false,"bmp_read":false,"bmx280_read":true,"sht3x_read":false,"ds18b20_read":false,"dnms_read":false,"dnms_correction":"0.0","temp_correction":"0.0","gps_read":false,"send2dusti":true,"ssl_dusti":false,"send2madavi":true,"ssl_madavi":false,"send2sensemap":false,"send2fsapp":false,"send2aircms":false,"send2csv":false,"auto_update":true,"use_beta":false,"has_display":false,"has_sh1106":false,"has_flipped_display":false,"has_lcd1602":false,"has_lcd1602_27":true,"has_lcd2004":false,"has_lcd2004_27":false,"display_wifi_info":true,"display_device_info":true,"debug":3,"sending_intervall_ms":145000,"time_for_wifi_config":600000,"senseboxid":"","send2custom":false,"host_custom":"192.168.234.1","url_custom":"/data.php","port_custom":80,"user_custom":"","pwd_custom":"","ssl_custom":false,"send2influx":false,"host_influx":"influx.server","url_influx":"/write?db=sensorcommunity","port_influx":8086,"user_influx":"","pwd_influx":"","measurement_name_influx":"feinstaub","ssl_influx":false}`

## Binary builds and downloads

Our main target is having working prebuilt binaries for users to simply download and run, to avoid all the setup below.
Expand All @@ -37,25 +26,26 @@ On Linux you should not need drivers, as they are usually already there, but you

Linux users: Please check that the downloaded file is executable. Otherwise set the executable bit with `chmod u+x <filename of download>`

To flash a device:
### To flash a device:

1. connect the ESP8266 with a USB cable to your computer (micro-USB)
2. launch the downloaded software
3. check/select the serial device
4. select the firmware (`latest_<COUNTRYCODE>.bin` should be fine for any setup)
5. press button *Upload*
6. wait for a few seconds to finish the flashing procedure
7. take a note of the **Sensor ID** written in the Window status bar at the bottom - you will need it to register the sensor
1. Connect the ESP8266 with a USB cable to your computer (micro-USB)
2. Launch the downloaded software
3. Check/select the serial device
4. Select the firmware (`latest_<COUNTRYCODE>.bin` should be fine for any setup)
5. Press button *Upload*
6. Wait for a few seconds to finish the flashing procedure

If you want to delete/reset all settings on the device (e.g. the Wifi credentials) you can use the `Erase Flash` button (exists in software version 0.2.2 and above).
### To configure the device

### Screenshots
1. Reconnect the device to your computer
2. Choose the sensors
3. Press `Save Configuration` and wait for a few seconds to finish the flashing procedure

![Select the firmware](images/airrohr-flasher_select_firmware.png)
If you want to delete/reset all settings on the device (e.g. the Wifi credentials) you can use the `Erase Flash` button (exists in software version 0.2.2 and above).

![The upload button starts the flashing procedure](images/airrohr-flasher_flash_progress.png "The upload button starts the flashing procedure")
### Screenshots

![Flashing is finished, take a note of the sensor ID (here: 1596171)](images/airrohr-flasher_flash_finished.png "Flashing is finished, take a note of the sensor ID (here: 1596171)")
![Select the firmware](images/flasher_main.png)


### Further steps
Expand Down
Binary file added images/flasher_main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1f9a356

Please sign in to comment.