From fd71a2d428253c28bf6a4aa49b3be78dbf9d2787 Mon Sep 17 00:00:00 2001 From: Magnus <51722613+mp-se@users.noreply.github.com> Date: Sat, 4 Jun 2022 14:40:20 +0200 Subject: [PATCH 1/5] Create stale.yaml --- .github/stale.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .github/stale.yaml diff --git a/.github/stale.yaml b/.github/stale.yaml new file mode 100644 index 0000000..fde18fa --- /dev/null +++ b/.github/stale.yaml @@ -0,0 +1,17 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 60 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 14 +# Issues with these labels will never be considered stale +exemptLabels: + - on-hold + - security +# Label to use when marking an issue as stale +staleLabel: wontfix +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: false From bf3a3de2077b4fcd3165a6c5859e65741855019b Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Fri, 1 Jul 2022 09:22:16 +0200 Subject: [PATCH 2/5] Added brewblox --- src_docs/source/index.rst | 2 +- src_docs/source/releases.rst | 1 + src_docs/source/services.rst | 29 +++++++++++++++++++++++++++++ 3 files changed, 31 insertions(+), 1 deletion(-) diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index be98643..a909290 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon's documentation! ###################################### .. note:: - This documentation reflects **v1.0**. Last updated 2022-05-16 + This documentation reflects **v1.0**. Last updated 2022-07-01 * Docs for: `v0.8 `_ * Docs for: `v0.9 `_ diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index ccdd98a..3e9c8c3 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -10,6 +10,7 @@ Documentation +++++++++++++ * Added documentation for Brewpiless as target * Added q&a on formula creation and value deviation +* Added brewblox as new service v1.0.0 ====== diff --git a/src_docs/source/services.rst b/src_docs/source/services.rst index b15a3ce..b0595d9 100644 --- a/src_docs/source/services.rst +++ b/src_docs/source/services.rst @@ -272,3 +272,32 @@ Brewpiless If you connect the device to the brewpiless access point there is not way to access the user interface for configuration so it's recommended to connect the device to your normal network. The device need to have a name starting with iSpindle, for example `iSpindel000`. Set the URL for one of the http POST targets to `http://ip/gravity` where ip is the ip adress of Brewpiless. + + +BrewBlox +++++++++++ + +To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template +for this target. + +This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic name and after the first `:` this is the json playload. + +.. code-block:: + + brewcast/history:{"key":"${mdns}","data":{"Temperature": ${temp-c},"Battery":${battery},"Tilt":${angle},"Rssi":${rssi},"Gravity":${gravity-sg}}}| + + +The json message on the mqtt topic would look like this: + +.. code-block:: json + + { + "key": "gravitymon", + "data": { + "Temperature": 27, + "Battery": 4.99, + "Tilt": 88.86, + "Rssi": -51, + "Gravity": 1.1173 + } + } From 637392350688a9834e07a71526e538cff72a0a94 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Fri, 1 Jul 2022 09:30:16 +0200 Subject: [PATCH 3/5] Doc build pip upgrade --- .github/workflows/doc-build.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/doc-build.yaml b/.github/workflows/doc-build.yaml index 74a28ff..ea40060 100644 --- a/.github/workflows/doc-build.yaml +++ b/.github/workflows/doc-build.yaml @@ -16,6 +16,7 @@ jobs: with: docs-folder: "src_docs/" pre-build-command: | + pip install --upgrade pip pip install sphinx_rtd_theme pip install furo build-command: "sphinx-build -b html ./source ../docs" From 67f60b817e31d885768da283d16f24658539bc35 Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Fri, 1 Jul 2022 09:42:25 +0200 Subject: [PATCH 4/5] Attempting to fix broken docs build --- .github/workflows/doc-build.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/doc-build.yaml b/.github/workflows/doc-build.yaml index ea40060..f70973d 100644 --- a/.github/workflows/doc-build.yaml +++ b/.github/workflows/doc-build.yaml @@ -17,8 +17,11 @@ jobs: docs-folder: "src_docs/" pre-build-command: | pip install --upgrade pip - pip install sphinx_rtd_theme - pip install furo + pip install sphinx==4.3.2 + pip install docutils==0.16 + pip install pygments==2.11.1 + pip install furo==2022.1.2 + pip list build-command: "sphinx-build -b html ./source ../docs" - name: Commit documentation changes From 361d287a22c7c929b67c75202ba7e7837027454c Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Sat, 2 Jul 2022 09:52:14 +0200 Subject: [PATCH 5/5] Updated brewblox integration --- src_docs/source/index.rst | 2 +- src_docs/source/services.rst | 22 +++++++++++++--------- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index a909290..dc5b8dd 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon's documentation! ###################################### .. note:: - This documentation reflects **v1.0**. Last updated 2022-07-01 + This documentation reflects **v1.0**. Last updated 2022-07-02 * Docs for: `v0.8 `_ * Docs for: `v0.9 `_ diff --git a/src_docs/source/services.rst b/src_docs/source/services.rst index b0595d9..0208104 100644 --- a/src_docs/source/services.rst +++ b/src_docs/source/services.rst @@ -280,11 +280,13 @@ BrewBlox To send iSpindel data to brewblox over mqtt you need to modify the format template to match the expected format. Once you have configured the mqtt information you also need to update the format template for this target. -This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic name and after the first `:` this is the json playload. +This format template will post the expected json document on the topic, dont forget the `|` character at the end of the line which is needed to parse the payload. The first to words are the topic +name and after the first `:` this is the json playload. Text within the brackets will be used as the unit for the value and degC is displayed as °C. You can add other parameters under the data section +in the json document if you need other values as well. .. code-block:: - brewcast/history:{"key":"${mdns}","data":{"Temperature": ${temp-c},"Battery":${battery},"Tilt":${angle},"Rssi":${rssi},"Gravity":${gravity-sg}}}| + brewcast/history:{"key":"${mdns}","data":{"Temperature[degC]": ${temp-c},"Temperature[degF]": ${temp-f},"Battery[V]":${battery},"Tilt[deg]":${angle},"Rssi[dBm]":${rssi},"SG":${gravity-sg},"Plato":${gravity-plato}}}| The json message on the mqtt topic would look like this: @@ -292,12 +294,14 @@ The json message on the mqtt topic would look like this: .. code-block:: json { - "key": "gravitymon", - "data": { - "Temperature": 27, - "Battery": 4.99, - "Tilt": 88.86, - "Rssi": -51, - "Gravity": 1.1173 + "key": "gravitymon", + "data": { + "Temperature[degC]": 27, + "Temperature[degF]": 80, + "Battery[V]": 4.1, + "Tilt[deg]": 25, + "Rssi[dBm]": -78, + "SG": 1, + "Plato": 0 } }