From 5ac1ead5b9822a47f6d3814c34c756a6744597f2 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Fri, 4 Nov 2022 10:17:31 +0100 Subject: [PATCH] Update readme --- .github/workflows/doc-build.yaml | 4 +-- README.md | 36 ++++--------------------- html/about.htm | 2 +- src_docs/source/images/buymecoffee.png | Bin 0 -> 23888 bytes 4 files changed, 8 insertions(+), 34 deletions(-) create mode 100644 src_docs/source/images/buymecoffee.png diff --git a/.github/workflows/doc-build.yaml b/.github/workflows/doc-build.yaml index 300731b..e7cefed 100644 --- a/.github/workflows/doc-build.yaml +++ b/.github/workflows/doc-build.yaml @@ -3,8 +3,8 @@ name: Sphinx Build on: push: branches: - - dev -# - master + - master + #- dev jobs: build: diff --git a/README.md b/README.md index 2ba3fc0..5bd74ca 100644 --- a/README.md +++ b/README.md @@ -12,40 +12,14 @@ GravityMon is a replacement firmware for the iSpindle firmware. It's 100% compatible with the iSpindle hardware design so it does not require any hardware changes. -Now also works with ESP32, either an ESP32 d1 mini or ESP32 c3 mini which both are compatible with ESP8266. +Now also works with ESP32, either an ESP32 d1 mini or ESP32 c3 mini which both are pin compatible with ESP8266. Installation can be made using https://www.brewflasher.com or the web version at https://web.brewflasher.com -The documenation can be found here: https://mp-se.github.io/gravitymon/index.html +The documentation can be found here: https://www.gravitymon.com/docs/index.html -## The main differences: +Visit the gravitymon homepage here for more information about the project: https://www.gravitymon.com -* Support either an ESP8266-d1-mini, ESP32-mini, ESP32S2-mini or ESP32C3-mini board -* Operates in two modes gravity monitoring and configuration mode -* Gravity mode is comparable to how the iSpindle works when collectintg data -* Configuration mode has a modern HTML5 based web UI. No need to start the access point to change settings -* Offloading some of the functionallity to run in the web browser, this allows for more advanced features. -* REST API to enable scripted configuration -* Send data to multiple endpoints and services at once (2xHTTP POST, HTTP GET, MQTT, INFLUXDB2) -* Directly test all endpoints from user interface with feedback to simplify troubleshooting -* Complete format customization for all endpoints using templates (dont really need to change the software to support new services) -* Setup guides for how to send data to many popular services. Currently 10+ are documented -* Automatic temperature adjustment of gravity (just tick a checkbox) -* OTA support from webserver -* Firmware update via web interface -* Built in function to create gravity formulas, no need for additional software, just enter tilt/gravity and let GravityMon creates a formula -* Visual graph showing how formula will be interpreted based on entered values -* Using the temperature sensor in gyro instead of DS18B20 (faster) -* SSL support in all endpoints (no certificate validation due to limitations on esp8266). -* Built in performance measurements (used to optimise code) -* Storage mode when placed on cap (indefinite sleep) -* Customize various hardware parameters to opimize device functionallity. -* No code has been reused from the iSpindle project. +If you want to support my work you can do that through these options -## Supported boards - -| | | | -| ----------- | ----------- |----------- | -| ![ESP8266](/d1_mini_v4.0.0.png) | ![ESP32C3](/c3_mini_v2.1.0.jpg) | ![ESP32S2](/s2_mini_v1.0.0.jpg) | -| HW: Any version | HW: v1.0+ | HW: v1.0+ | -| SW: GravityMon v0.1+ | SW: GravityMon v1.2.0+ | SW: GravityMon v1.2.0+ | +[](https://www.buymeacoffee.com/mpse/) [](https://github.com/sponsors/mp-se) diff --git a/html/about.htm b/html/about.htm index e8de109..8aa54c4 100644 --- a/html/about.htm +++ b/html/about.htm @@ -39,7 +39,7 @@
  • Upload firmware
  • -