From 22fcff66823ba3f7c2c7558ce380b2e7b2a9f899 Mon Sep 17 00:00:00 2001 From: proddy Date: Sun, 20 Sep 2020 12:30:19 +0200 Subject: [PATCH] doc updates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .../questions---troubleshooting.md | 2 +- CHANGELOG.md | 16 ++++++++-------- CONTRIBUTING.md | 2 +- FIRMWARE.md | 2 +- README.md | 6 +++--- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d5518b692..34dbc9340 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,7 +10,7 @@ assignees: '' *Before creating a new issue please check that you have:* * *searched the existing [issues](https://github.com/proddy/EMS-ESP/issues) (both open and closed)* -* *searched the [wiki help pages](https://emsesp.github.io/docs)* +* *searched the [Documentation help section](https://emsesp.github.io/docs)* *Completing this template will help developers and contributors to address the issue. Try to be as specific and extensive as possible. If the information provided is not enough the issue will likely be closed.* diff --git a/.github/ISSUE_TEMPLATE/questions---troubleshooting.md b/.github/ISSUE_TEMPLATE/questions---troubleshooting.md index c04109b85..69151112e 100644 --- a/.github/ISSUE_TEMPLATE/questions---troubleshooting.md +++ b/.github/ISSUE_TEMPLATE/questions---troubleshooting.md @@ -10,7 +10,7 @@ assignees: '' *Before creating a new issue please check that you have:* * *searched the existing [issues](https://github.com/proddy/EMS-ESP/issues) (both open and closed)* -* *searched the [wiki help pages](https://emsesp.github.io/docs)* +* *searched the [documentation help section](https://emsesp.github.io/docs)* *Completing this template will help developers and contributors help you. Try to be as specific and extensive as possible. If the information provided is not enough the issue will likely be closed.* diff --git a/CHANGELOG.md b/CHANGELOG.md index 990236540..880a62b81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - support for uploading compressed firmware binaries - add wWType to MQTT publish - option to set the MQTT retain flag -- HTTP REST API, e.g. http://ems-esp/api?device=boiler&cmd=wwtemp&data=20&id=1 +- HTTP REST API, e.g. http://ems-esp/api?device=boiler&cmd=wwtemp&data=20&id=1. See https://emsesp.github.io/docs/#/API - `show commands` command ### Fixed @@ -22,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - renamed wWCircPumpType to wWChargeType -- Installation doc moved to wiki +- Installation and Configuration notes moved to the official EMS-ESP documentation site - Removed the _cmd from the MQTT topic names ### Removed @@ -129,7 +129,7 @@ There are breaking changes in this release. See `publish_time` below and make su - Added `kick` command to reset core services like NTP, Web, Web Sockets - Added WiFi static IP (setting done in WebUI only) - `log w ` for watching a specific telegram type ID -- initial support for EMS+ GB125s and MC110's (https://github.com/proddy/EMS-ESP/wiki/MC110-controller) +- initial support for EMS+ GB125s and MC110's - Buderus RFM200 receiver ### Fixed @@ -173,7 +173,7 @@ There are breaking changes in this release. See `publish_time` below and make su ## [1.9.2] 2019-10-19 #### Important! This build has breaking changes: - - MQTT topics have changed. Use the `mqttlog` command to see the names of the subscriptions and the format of the payload data. Also reference the [Wiki page](https://github.com/proddy/EMS-ESP/wiki/MQTT). + - MQTT topics have changed. Use the `mqttlog` command to see the names of the subscriptions and the format of the payload data. - Home Assistant `.yaml` files need updating to reflect the recent MQTT changes - The web builder has been upgraded to use Gulp 4. Remove `tools/webfilesbuilder/node_modules` and re-install the libraries using `npm ci` from within the `tools/webfilesbuilder` folder @@ -223,7 +223,7 @@ There are breaking changes in this release. See `publish_time` below and make su - Web login password is now mandatory - Faster detection of EMS devices on bus by using the 0x07 telegram instead of the brute-force scan - Fixes to the default HA climate component .yaml file to support latest Home Assistance ('heat' added) -- Update documentation in Wiki on MQTT and troubleshooting +- Update documentation on MQTT and troubleshooting - Slowed down firmware upload via the Web to prevent users rebooting too early - Change way WiFi is initialized to prevent dual AP and Client @@ -236,7 +236,7 @@ There are breaking changes in this release. See `publish_time` below and make su ### Changed -- New web interface with more features showing Boiler, Thermostat, Solar Module and Heat Pump. See https://github.com/proddy/EMS-ESP/wiki/Running-and-Monitoring +- New web interface with more features showing Boiler, Thermostat, Solar Module and Heat Pump. - Merged with @susisstrolch's TxMode2 branch for improved support for sending EMS packages. This is the default tx mode. - Upgraded MyESP library optimizations for WiFi, AP and error handling - `reboot` command renamed to `restart` to keep consistent with web interface @@ -252,12 +252,12 @@ There are breaking changes in this release. See `publish_time` below and make su ### Added - Added back -DCRASH in Debug build target for capturing any ESP8266 stack dumps during crashes -- Web Interface, for checking stats and setting wifi credentials. See wiki for more details. +- Web Interface, for checking stats and setting wifi credentials. See documentation for more details. - reset firmware option. If the reset button on the ESP is pressed during boot up sequence (the LED is flashing very fast) all settings are erased and goes into AP mode. - Added tx_mode back with options 0,1 and 2 until we've fixed option 2 that works for everyone and doesn't reset ESP - More solar module data captured, thanks to @Vuego123 - Detect thermostat mode for EMS+ RC300/Moduline 3000 -- MQTT message to set boiler flowtemp (`boiler_cmd_flowtemp`). See [wiki](https://github.com/proddy/EMS-ESP/wiki/MQTT). +- MQTT message to set boiler flowtemp (`boiler_cmd_flowtemp`). ### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb88bdbee..8cf6e4d6f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,7 +28,7 @@ This document describes rules that are in effect for this repository, meant for 2. An issue that needs to be closed, either due to not complying with this policy, or for other reasons, should be closed by a contributor. 3. Issues that are accepted should be marked with appropriate labels. 4. Issues that could impact functionality for many users should be considered severe. -5. Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the Wiki, for reference by users. +5. Issues caused by the SDK or chip should not be marked severe, as there usually isn’t much to be done. Common sense should be applied when deciding. Such issues should be documented in the documentation, for reference by users. 6. Issues with feature requests should be discussed for viability/desirability. 7. Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified. 8. Feature requests that are not accompanied by a PR: diff --git a/FIRMWARE.md b/FIRMWARE.md index c2a260acc..3a0550bf5 100644 --- a/FIRMWARE.md +++ b/FIRMWARE.md @@ -21,6 +21,6 @@ If you like **EMS-ESP**, please give it a star, or fork it and contribute! # Installation -Development builds can be found in https://github.com/proddy/EMS-ESP/tree/firmware/firmware. Follow the instructions in the [Wiki](https://emsesp.github.io/docs) on how to install. +Development builds can be found in https://github.com/proddy/EMS-ESP/tree/firmware/firmware. Follow the instructions in the [Documentation](https://emsesp.github.io/docs) on how to install. See [CHANGELOG.md](https://github.com/proddy/blob/development/tasmota/CHANGELOG.md) for changes since the last release. diff --git a/README.md b/README.md index 7654ade2c..a747db85a 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Note, EMS-ESP requires a small hardware circuit that can convert the EMS bus dat ## **Installing** -Refer to the [Wiki](https://emsesp.github.io/docs) articles to install the firmware. +Refer to the [Official documentation](https://emsesp.github.io/docs) to install the firmware and configure it. * [Uploading a pre-built binary](https://emsesp.github.io/docs/#/Uploading-firmware) * [Building the firmware and flashing manually](https://emsesp.github.io/docs/#/Building-firmware) @@ -56,8 +56,8 @@ If you're looking for support on **EMS-ESP** there are some options available: ### Documentation -* [Documentation Site](https://emsesp.github.io/docs): For information on how to build and upload the firmware -* [FAQ and Troubleshooting](https://emsesp.github.io/docs/#/Troubleshooting): For information on common problems and solutions. See also [BBQKees's site](https://bbqkees-electronics.nl/wiki/gateway/troubleshooting.html) +* [Official Documentation](https://emsesp.github.io/docs): For information on how to build and upload the firmware +* [FAQ and Troubleshooting](https://emsesp.github.io/docs/#/Troubleshooting): For information on common problems and solutions. See also [BBQKees's wiki](https://bbqkees-electronics.nl/wiki/gateway/troubleshooting.html) ### Support's Community