diff --git a/bin/firmware.bin b/bin/firmware.bin index d7c6a34c..4907a1a4 100644 Binary files a/bin/firmware.bin and b/bin/firmware.bin differ diff --git a/bin/firmware32.bin b/bin/firmware32.bin index 346354a5..66d71e58 100644 Binary files a/bin/firmware32.bin and b/bin/firmware32.bin differ diff --git a/bin/firmware32c3.bin b/bin/firmware32c3.bin index f9299398..da349a5a 100644 Binary files a/bin/firmware32c3.bin and b/bin/firmware32c3.bin differ diff --git a/bin/firmware32lite.bin b/bin/firmware32lite.bin index 057ddc1d..6f3b7807 100644 Binary files a/bin/firmware32lite.bin and b/bin/firmware32lite.bin differ diff --git a/bin/firmware32s2.bin b/bin/firmware32s2.bin index ff788f60..e9d0a2f2 100644 Binary files a/bin/firmware32s2.bin and b/bin/firmware32s2.bin differ diff --git a/bin/firmware32s3.bin b/bin/firmware32s3.bin index 7398b859..340cbd55 100644 Binary files a/bin/firmware32s3.bin and b/bin/firmware32s3.bin differ diff --git a/html/app.js.gz b/html/app.js.gz index ff047e4f..a926615a 100644 Binary files a/html/app.js.gz and b/html/app.js.gz differ diff --git a/html/favicon.ico.gz b/html/favicon.ico.gz new file mode 100644 index 00000000..2447467e Binary files /dev/null and b/html/favicon.ico.gz differ diff --git a/platformio.ini b/platformio.ini index bbdbbee7..fed27346 100644 --- a/platformio.ini +++ b/platformio.ini @@ -15,8 +15,8 @@ include_dir = lib [common_env_data] upload_speed = 921600 monitor_speed = 115200 -platform = espressif8266 @ 4.2.1 -platform32 = espressif32 @6.6.0 +platform = espressif8266@4.2.1 +platform32 = espressif32@6.6.0 build_unflags = build_flags = -Wl,-Map,output.map @@ -26,7 +26,7 @@ build_flags = #-D COLLECT_PERFDATA -D USE_LITTLEFS=true -D CFG_APPVER="\"2.0.0\"" - -D CFG_GITREV=\""beta-1\"" + -D CFG_GITREV=\""beta-2\"" #-D ENABLE_REMOTE_UI_DEVELOPMENT #!python script/git_rev.py lib_deps = @@ -41,7 +41,7 @@ lib_deps = https://github.com/mp-se/arduino-mqtt#v2.5.2 https://github.com/mp-se/ESPAsyncWebServer#0.1.1 https://github.com/mp-se/ESPAsyncTCP#0.1.0 - https://github.com/mp-se/espframework/#1.0.0 + https://github.com/mp-se/espframework/#1.0.1 lib_deps32 = https://github.com/mp-se/NimBLE-Arduino#1.4.1 extra_scripts = @@ -51,6 +51,7 @@ html_files = html/index.html html/app.js.gz html/app.css.gz + html/favicon.ico.gz [env:gravity-release] upload_speed = ${common_env_data.upload_speed} diff --git a/src_docs/source/conf.py b/src_docs/source/conf.py index fa095cfd..3b987b9a 100644 --- a/src_docs/source/conf.py +++ b/src_docs/source/conf.py @@ -22,7 +22,7 @@ author = 'Magnus Persson' # The full version, including alpha/beta/rc tags -release = '2.0.0-beta1' +release = '2.0.0-beta2' # -- General configuration --------------------------------------------------- @@ -48,7 +48,7 @@ # html_theme = 'furo' html_logo = "images/gravitymon_logo.png" -html_title = "GravityMon v2.0.0-beta1" +html_title = "GravityMon v2.0.0" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/src_docs/source/configuration.rst b/src_docs/source/configuration.rst index d07bd9c3..4b3de0ff 100644 --- a/src_docs/source/configuration.rst +++ b/src_docs/source/configuration.rst @@ -526,7 +526,6 @@ Push - Bluetooth - **TILT iBeacon**: Standard tilt data transmission. Data: Gravity and Temperature - **TILT PRO iBeacon**: Higher accuracy tilt data transmission. Data: Gravity and Temperature - **GM iBeacon**: Higher accuracy. Data: Gravity, Temperature, ID, Angle - - **GM SERVICE**: Client can read standard iSpindle JSON payload, require connection with device. - **GM EDDYSTONE**: Beacon format that requires active scanning by the client. Data: Gravity, ID, Temperature and Angle Other diff --git a/src_docs/source/gateway.rst b/src_docs/source/gateway.rst new file mode 100644 index 00000000..90d0767f --- /dev/null +++ b/src_docs/source/gateway.rst @@ -0,0 +1,209 @@ +.. _gateway: + +Gateway +####### + +.. note:: + + This documentation reflects **v0.4.0 beta 1**. Last updated 2024-08-02 + +GravityMon Gateway is an separate project that can act as a proxy between your GravityMon devices and services. It can: + +* Receive the new GravityMon 2.0 BLE formats and transform these to HTTP Post/Get, InfluxDB or MQTT requests +* Receive data via direct WiFi connection (Direct connection between the device and the gateway) and relay this data to defined endpoints. + +Hardware +======== + +The main supported hardware is ESP32s3 PRO with a TFT + +* `Lolin ESP32s3 PRO `_ +* `Lolin TFT `_ +* Cable to connect the display with the ESP + +There is also a build for the ESP32 PRO (Tiltbridge Hardware setup) but that does not support the new BLE formats since that board does not have BLE 5 support. + +* `Releases for GravityMon Gateway `_ + +Most of the UI is copied from GravityMon with a few alterations so the documentation here will only point out the differences. + +.. note:: + + GravityMon Gateway does not support the TILT options, if you want to use these I recommend Tiltbridge that has a lot of good + features for that. The main reason is that these formats have very little data and would require a lot of work to make the gateway + add the missing information. Tiltbridge already has this support built in so it makes little sense to replicate that work. + + +Home page +========= + +URL: (http://gravmon-gw.local) + +.. image:: images/gw/ui-home.png + :width: 800 + :alt: Home page + +The main page shows the device settings as well as the latest readings from connected devices. + + +Device +====== + +Device - Settings ++++++++++++++++++ + +.. image:: images/gw/ui-device-settings.png + :width: 800 + :alt: Device Settings + +* **MDNS:** + + This is unique name for the device. It will be used in pushing data as well as mDNS name on the network (.local). + The limitation is 63 chars but using long names might break endpoints that data is sent to if they have other limitations. + +* **Temperature format:** + + Choose between Celsius and Fahrenheit when displaying temperature. + +* **Gravity format:** + + Gravity format can be either `SG` or `Plato`. The device will use SG Internally and convert to Plato when displaying or sending data. + +* **Dark Mode:** + + Switches the UI between light and dark mode. You can also use the toggle on the menubar for that. + +* **Factory default** + + This function will reset all settings to factory default. Use with caution! + +* **Restart** + + Restarts the device, similar to pressing the reset button + + +Device - Hardware ++++++++++++++++++ + +.. image:: images/gw/ui-device-hardware.png + :width: 800 + :alt: Device Hardware + +* **Scan mode:** + + Determine if the BLE scan will be done in active or passive mode. + +* **Scan time:** + + Time the BLE scan cycle. Don't use too long time since this will impact the updates on readings and display. + +* **Time zone:** + + Select the timezone so that date / time will be correcly displayed. This is not an extensive list of all timezones so let me know if you are missing one. + + +Device - WIFI ++++++++++++++ + +.. image:: images/gw/ui-device-wifi.png + :width: 800 + :alt: Device WIFI + +Most of these settings are the same as for GravityMon with the following expections. + +* **Direct SSID:** + + Name of the SSID that GravityMon devices will use in Wifi Direct mode. + +* **Direct Password:** + + Enter the SSID password. + +* **Generate:** + + Will create an SSID and Password + + +Push targets +============ + +Push - Settings ++++++++++++++++ + +.. image:: images/gw/ui-push-settings.png + :width: 800 + :alt: Push Settings + +* **Token:** + + If the incoming payload does not contain the token this value will be added to the outgoing payload. + +* **Push timeout:** + + How long the device will wait for a connection accept from the remote service. + +* **Push minium resend time:** + + This the minimum time before an update can be sent. Some remote services do not want to have updates too often. + +Push - HTTP Post +++++++++++++++++ + +See GravityMon configuration. + + +Push - HTTP Get ++++++++++++++++ + +See GravityMon configuration. + + +Push - InfluxDB v2 +++++++++++++++++++ + +See GravityMon configuration. + + +Push - MQTT ++++++++++++ + +See GravityMon configuration. + + +Other +===== + +Other - Serial +++++++++++++++ + +See GravityMon configuration. + + +Other - Backup +++++++++++++++ + +See GravityMon configuration. + + +Other - Firmware +++++++++++++++++ + +See GravityMon configuration. + + +Other - Support ++++++++++++++++ + +See GravityMon configuration. + + +Other - Tools ++++++++++++++ + +See GravityMon configuration. + + +Other - About ++++++++++++++ + +Shows information about the software diff --git a/src_docs/source/images/config-popup1.png b/src_docs/source/images/config-popup1.png deleted file mode 100644 index 704261d2..00000000 Binary files a/src_docs/source/images/config-popup1.png and /dev/null differ diff --git a/src_docs/source/images/firmware.png b/src_docs/source/images/firmware.png deleted file mode 100644 index e298ec80..00000000 Binary files a/src_docs/source/images/firmware.png and /dev/null differ diff --git a/src_docs/source/images/format.png b/src_docs/source/images/format.png deleted file mode 100644 index 964a5a5e..00000000 Binary files a/src_docs/source/images/format.png and /dev/null differ diff --git a/src_docs/source/images/formula1.png b/src_docs/source/images/formula1.png deleted file mode 100644 index b67b1618..00000000 Binary files a/src_docs/source/images/formula1.png and /dev/null differ diff --git a/src_docs/source/images/formula2.png b/src_docs/source/images/formula2.png deleted file mode 100644 index 33c5445e..00000000 Binary files a/src_docs/source/images/formula2.png and /dev/null differ diff --git a/src_docs/source/images/gw/ui-device-hardware.png b/src_docs/source/images/gw/ui-device-hardware.png new file mode 100644 index 00000000..14fc0440 Binary files /dev/null and b/src_docs/source/images/gw/ui-device-hardware.png differ diff --git a/src_docs/source/images/gw/ui-device-settings.png b/src_docs/source/images/gw/ui-device-settings.png new file mode 100644 index 00000000..c7777356 Binary files /dev/null and b/src_docs/source/images/gw/ui-device-settings.png differ diff --git a/src_docs/source/images/gw/ui-device-wifi.png b/src_docs/source/images/gw/ui-device-wifi.png new file mode 100644 index 00000000..14d9d819 Binary files /dev/null and b/src_docs/source/images/gw/ui-device-wifi.png differ diff --git a/src_docs/source/images/gw/ui-home.png b/src_docs/source/images/gw/ui-home.png new file mode 100644 index 00000000..f3f133d4 Binary files /dev/null and b/src_docs/source/images/gw/ui-home.png differ diff --git a/src_docs/source/images/gw/ui-push-settings.png b/src_docs/source/images/gw/ui-push-settings.png new file mode 100644 index 00000000..83e675d1 Binary files /dev/null and b/src_docs/source/images/gw/ui-push-settings.png differ diff --git a/src_docs/source/images/ui-device-hardware.png b/src_docs/source/images/ui-device-hardware.png index e9a1580b..319b9f52 100644 Binary files a/src_docs/source/images/ui-device-hardware.png and b/src_docs/source/images/ui-device-hardware.png differ diff --git a/src_docs/source/images/ui-device-settings.png b/src_docs/source/images/ui-device-settings.png index 3f573c80..d3850531 100644 Binary files a/src_docs/source/images/ui-device-settings.png and b/src_docs/source/images/ui-device-settings.png differ diff --git a/src_docs/source/images/ui-device-wifi.png b/src_docs/source/images/ui-device-wifi.png index 18049535..1041b00b 100644 Binary files a/src_docs/source/images/ui-device-wifi.png and b/src_docs/source/images/ui-device-wifi.png differ diff --git a/src_docs/source/images/ui-gravity-analysis.png b/src_docs/source/images/ui-gravity-analysis.png index bc877541..2e8b733a 100644 Binary files a/src_docs/source/images/ui-gravity-analysis.png and b/src_docs/source/images/ui-gravity-analysis.png differ diff --git a/src_docs/source/images/ui-gravity-formula.png b/src_docs/source/images/ui-gravity-formula.png index 0af254eb..6ef71637 100644 Binary files a/src_docs/source/images/ui-gravity-formula.png and b/src_docs/source/images/ui-gravity-formula.png differ diff --git a/src_docs/source/images/ui-gravity-settings.png b/src_docs/source/images/ui-gravity-settings.png index dcfeac63..95f06cc2 100644 Binary files a/src_docs/source/images/ui-gravity-settings.png and b/src_docs/source/images/ui-gravity-settings.png differ diff --git a/src_docs/source/images/ui-home.png b/src_docs/source/images/ui-home.png index bf694971..d2576862 100644 Binary files a/src_docs/source/images/ui-home.png and b/src_docs/source/images/ui-home.png differ diff --git a/src_docs/source/images/ui-other-about.png b/src_docs/source/images/ui-other-about.png index 9bdb2a06..2a6120a7 100644 Binary files a/src_docs/source/images/ui-other-about.png and b/src_docs/source/images/ui-other-about.png differ diff --git a/src_docs/source/images/ui-other-backup.png b/src_docs/source/images/ui-other-backup.png index bb231041..20ecce03 100644 Binary files a/src_docs/source/images/ui-other-backup.png and b/src_docs/source/images/ui-other-backup.png differ diff --git a/src_docs/source/images/ui-other-firmware.png b/src_docs/source/images/ui-other-firmware.png index dc7f27f5..46e1d201 100644 Binary files a/src_docs/source/images/ui-other-firmware.png and b/src_docs/source/images/ui-other-firmware.png differ diff --git a/src_docs/source/images/ui-other-logs.png b/src_docs/source/images/ui-other-logs.png index c2c1f646..089abc90 100644 Binary files a/src_docs/source/images/ui-other-logs.png and b/src_docs/source/images/ui-other-logs.png differ diff --git a/src_docs/source/images/ui-other-serial.png b/src_docs/source/images/ui-other-serial.png index a23ddbaa..d29d954d 100644 Binary files a/src_docs/source/images/ui-other-serial.png and b/src_docs/source/images/ui-other-serial.png differ diff --git a/src_docs/source/images/ui-other-tools.png b/src_docs/source/images/ui-other-tools.png index fb41c26c..8cf22d4f 100644 Binary files a/src_docs/source/images/ui-other-tools.png and b/src_docs/source/images/ui-other-tools.png differ diff --git a/src_docs/source/images/ui-push-ble.png b/src_docs/source/images/ui-push-ble.png index e5d91af0..15ee03fc 100644 Binary files a/src_docs/source/images/ui-push-ble.png and b/src_docs/source/images/ui-push-ble.png differ diff --git a/src_docs/source/images/ui-push-get.png b/src_docs/source/images/ui-push-get.png index d5bc6f6a..0f003e34 100644 Binary files a/src_docs/source/images/ui-push-get.png and b/src_docs/source/images/ui-push-get.png differ diff --git a/src_docs/source/images/ui-push-influx.png b/src_docs/source/images/ui-push-influx.png index 9240726a..3d3f8784 100644 Binary files a/src_docs/source/images/ui-push-influx.png and b/src_docs/source/images/ui-push-influx.png differ diff --git a/src_docs/source/images/ui-push-mqtt.png b/src_docs/source/images/ui-push-mqtt.png index 0038e824..30bf2c0a 100644 Binary files a/src_docs/source/images/ui-push-mqtt.png and b/src_docs/source/images/ui-push-mqtt.png differ diff --git a/src_docs/source/images/ui-push-post.png b/src_docs/source/images/ui-push-post.png index cdff9234..5df419ea 100644 Binary files a/src_docs/source/images/ui-push-post.png and b/src_docs/source/images/ui-push-post.png differ diff --git a/src_docs/source/images/ui-push-settings.png b/src_docs/source/images/ui-push-settings.png index e987deda..4e85b4fb 100644 Binary files a/src_docs/source/images/ui-push-settings.png and b/src_docs/source/images/ui-push-settings.png differ diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 348e7c26..10f05d96 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon ##################### .. note:: - This documentation reflects **v2.0.0 beta 1**. Last updated 2024-07-13 + This documentation reflects **v2.0.0 beta 2**. Last updated 2024-07-13 Link to `previous documentation here `_ @@ -138,6 +138,7 @@ the following libraries and without these this would have been much more difficu hardware services data + gateway compiling contributing license diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index b6154c31..cf62f352 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -3,6 +3,19 @@ Releases ######## +v2.0.0-beta2 +============ + +Issues adressed ++++++++++++++++ +* Force gravity mode toggle on main page does not reflect the real state of the flag when other views have been used. +* Updated user interface with project name and device name for easier identification. +* Removed BLE GravityMon Service option since this is not really performing well. + +Known Issues +++++++++++++ +* RGB led on ESP32S3 does not work due to bug in Arduino for ESP32 (Manually edit the pins_arduino.h for esp32s3 will fix the issue, #define RGB_BUILTIN LED_BUILTIN+SOC_GPIO_PIN_COUNT) + v2.0.0-beta1 ============ @@ -13,12 +26,6 @@ Issues adressed * Added WIFI Direct Connect option with GravityMon Gateway, I hope this will help with wifi connection issues in my steel fermenter and force a connect to the designated AP. Wifi Direct will send the data via http to the Gateway and then forward this to the correct endpoint. -Known Issues -++++++++++++ -* Wire (Gyro communication), does not work properly on ESP32C3 boards, timeout error. Problem resides in esp-idf framework. - https://github.com/espressif/arduino-esp32/issues/8056 -* RGB led on ESP32S3 does not work due to bug in Arduino for ESP32 (Manually edit the pins_arduino.h for esp32s3 will fix the issue, #define RGB_BUILTIN LED_BUILTIN+SOC_GPIO_PIN_COUNT) - New Features ++++++++++++ * Added option for wifi direct when in gravity mode, wifi direct allows direct access to device without going through AP. This feature is inteded to be used with the gravitymon gateway.