fixes and new site #205
fixes and new site #205
Conversation
* Fix function to flux counter ESPHome version 2024.6.x and Home assistant 2024.7.x
* New site * Cleanup html site * Fixed : #180 thanks for your feedback and help @schmm and @Hurr1c4n3 * Fixed : #203 thanks for your feedback and help @wes1993
huizebruin
added
documentation
WalkthroughThis update introduces enhancements across the S0tool project, including new firmware update functionality via HTTP requests, web page redesigns with Bootstrap for improved layout and styling, and the addition of a contact page. The updates enhance the user experience by restructuring installation, troubleshooting, and informational guides, as well as adding dynamic content loading through JavaScript. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (11)
static/contact.html (3)
7-7: Consider updating Bootstrap version.Bootstrap 4.5.2 is used. Consider updating to the latest version for improved features and security.
52-52: Consider using a mailto link for email.Using a mailto link can make it easier for users to contact via email.
- For information : info(at)s0tool(dot)nl + For information : <a href="mailto:info@s0tool.nl">info@s0tool.nl</a>
61-63: Consider updating jQuery and Bootstrap JS versions.jQuery 3.5.1 and Bootstrap 4.5.2 are used. Consider updating to the latest versions for improved features and security.
static/navbar.html (2)
8-8: Consider updating Bootstrap version.Bootstrap 4.5.2 is used. Consider updating to the latest version for improved features and security.
58-60: Consider updating jQuery and Bootstrap JS versions.jQuery 3.5.1 and Bootstrap 4.5.2 are used. Consider updating to the latest versions for improved features and security.
static/index.html (2)
7-7: Consider updating Bootstrap version.Bootstrap 4.5.2 is used. Consider updating to the latest version for improved features and security.
71-73: Consider updating jQuery and Bootstrap JS versions.jQuery 3.5.1 and Bootstrap 4.5.2 are used. Consider updating to the latest versions for improved features and security.
static/energydashboard.html (2)
8-8: Consider updating Bootstrap version.Bootstrap 4.5.2 is used. Consider updating to the latest version for improved features and security.
75-77: Consider updating jQuery and Bootstrap JS versions.jQuery 3.5.1 and Bootstrap 4.5.2 are used. Consider updating to the latest versions for improved features and security.
static/information.html (1)
124-124: Image Alt AttributeThe alt attribute for the image should be more descriptive to improve accessibility.
- <img src="./assets/npn-watermeter-wemosd1.png" class="img-fluid" alt="S0tool-diy"> + <img src="./assets/npn-watermeter-wemosd1.png" class="img-fluid" alt="Diagram of S0tool DIY setup">static/Installation.html (1)
231-233: Descriptive Alt TextThe alt attribute for the image should be more descriptive to improve accessibility.
- <img src="./assets/icon.ico" class="img-fluid" alt="s0tool-standard-flux"> + <img src="./assets/icon.ico" class="img-fluid" alt="Icon for S0tool Standard Flux">
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
static/s0tool-blank-esp8266/s0tool-blank-esp8266.binis excluded by!**/*.bin
Files selected for processing (18)
- .github/workflows/build.yml (1 hunks)
- esphome/components/s0tool-standard-flux-update.yml (1 hunks)
- esphome/pulscounter_flux.yaml (1 hunks)
- static/Installation.html (4 hunks)
- static/Troubleshooting.html (4 hunks)
- static/contact.html (1 hunks)
- static/contributing.html (2 hunks)
- static/diyorbuy.html (3 hunks)
- static/energydashboard.html (2 hunks)
- static/footer.html (1 hunks)
- static/index.html (3 hunks)
- static/information.html (4 hunks)
- static/js/script.js (1 hunks)
- static/licence.html (2 hunks)
- static/navbar.html (1 hunks)
- static/sidebar.html (1 hunks)
- static/sitemap.xml (1 hunks)
- static/styles.css (1 hunks)
Files skipped from review due to trivial changes (4)
- .github/workflows/build.yml
- static/footer.html
- static/js/script.js
- static/sidebar.html
Additional context used
yamllint
esphome/components/s0tool-standard-flux-update.yml
[error] 5-5: no new line character at the end of file
(new-line-at-end-of-file)
esphome/pulscounter_flux.yaml
[error] 31-31: trailing spaces
(trailing-spaces)
[error] 33-33: no new line character at the end of file
(new-line-at-end-of-file)
Additional comments not posted (42)
static/sitemap.xml (1)
1-14: LGTM!The sitemap file appears to be correctly formatted and includes the necessary URLs and last modification dates.
static/styles.css (1)
1-44: LGTM!The CSS file appears to be correctly formatted and includes the necessary styles for various HTML elements and classes. The styles are consistent and follow best practices.
static/contact.html (4)
35-35: Ensure navbar content is loaded correctly.The navbar is loaded dynamically. Ensure the script correctly loads and displays the content.
40-40: Ensure sidebar content is loaded correctly.The sidebar is loaded dynamically. Ensure the script correctly loads and displays the content.
59-59: Ensure footer content is loaded correctly.The footer is loaded dynamically. Ensure the script correctly loads and displays the content.
5-6: Remove duplicate charset meta tag.The charset meta tag is duplicated. Only one is necessary.
- <meta charset="UTF-8">Likely invalid or redundant comment.
static/navbar.html (3)
13-13: Ensure the navbar brand link is correct.Verify that the link to
index.htmlcorrectly navigates to the home page.
53-53: Ensure the GitHub version badge is up-to-date.Verify that the GitHub version badge correctly displays the latest release version.
5-6: Remove duplicate charset meta tag.The charset meta tag is duplicated. Only one is necessary.
- <meta charset="UTF-8">Likely invalid or redundant comment.
static/index.html (4)
26-26: Ensure navbar content is loaded correctly.The navbar is loaded dynamically. Ensure the script correctly loads and displays the content.
30-30: Ensure sidebar content is loaded correctly.The sidebar is loaded dynamically. Ensure the script correctly loads and displays the content.
69-69: Ensure footer content is loaded correctly.The footer is loaded dynamically. Ensure the script correctly loads and displays the content.
5-6: Remove duplicate charset meta tag.The charset meta tag is duplicated. Only one is necessary.
- <meta charset="UTF-8">Likely invalid or redundant comment.
static/energydashboard.html (3)
36-36: Ensure navbar content is loaded correctly.The navbar is loaded dynamically. Ensure the script correctly loads and displays the content.
40-40: Ensure sidebar content is loaded correctly.The sidebar is loaded dynamically. Ensure the script correctly loads and displays the content.
73-73: Ensure footer content is loaded correctly.The footer is loaded dynamically. Ensure the script correctly loads and displays the content.
static/licence.html (4)
13-14: Meta Keywords Tag Update ApprovedThe meta keywords tag has been updated correctly with relevant keywords.
15-15: Meta Author Tag Update ApprovedThe meta author tag has been updated correctly.
16-16: Meta Copyright Tag Update ApprovedThe meta copyright tag has been updated correctly.
17-17: Meta Cache-Control Tag Update ApprovedThe meta cache-control tag has been updated correctly.
static/contributing.html (4)
13-14: Meta Keywords Tag Update ApprovedThe meta keywords tag has been updated correctly with relevant keywords.
15-15: Meta Author Tag Update ApprovedThe meta author tag has been updated correctly.
16-16: Meta Copyright Tag Update ApprovedThe meta copyright tag has been updated correctly.
17-17: Meta Cache-Control Tag Update ApprovedThe meta cache-control tag has been updated correctly.
static/diyorbuy.html (4)
13-14: Meta Keywords Tag Update ApprovedThe meta keywords tag has been updated correctly with relevant keywords.
15-15: Meta Author Tag Update ApprovedThe meta author tag has been updated correctly.
16-16: Meta Copyright Tag Update ApprovedThe meta copyright tag has been updated correctly.
17-17: Meta Cache-Control Tag Update ApprovedThe meta cache-control tag has been updated correctly.
static/Troubleshooting.html (4)
13-14: Meta Keywords Tag Update ApprovedThe meta keywords tag has been updated correctly with relevant keywords.
15-15: Meta Author Tag Update ApprovedThe meta author tag has been updated correctly.
16-16: Meta Copyright Tag Update ApprovedThe meta copyright tag has been updated correctly.
17-17: Meta Cache-Control Tag Update ApprovedThe meta cache-control tag has been updated correctly.
static/information.html (5)
13-14: Meta Keywords UpdatedThe meta keywords have been updated to improve SEO. Ensure the keywords accurately reflect the content of the page.
35-37: Dynamic Content LoadingThe
#navbarand#sidebardivs are placeholders for dynamically loaded content. Ensure the JavaScript responsible for loading this content is functioning correctly.
49-52: Compatibility NoticeThe compatibility notice specifies the supported versions of ESPHome and Home Assistant. Ensure this information is accurate and up-to-date.
136-136: External ScriptEnsure the external script from the provided URL is trusted and secure.
172-175: JavaScript LibrariesThe inclusion of jQuery, Popper.js, and Bootstrap JavaScript libraries is noted. Ensure these libraries are necessary and do not introduce security vulnerabilities.
static/Installation.html (5)
13-14: Meta Keywords UpdatedThe meta keywords have been updated to improve SEO. Ensure the keywords accurately reflect the content of the page.
34-34: Script Source AddedA script source for
esp-web-toolshas been added. Ensure this script is necessary and does not introduce security vulnerabilities.
117-119: New Configuration OptionA new radio button option for
s0tool-standard-fluxhas been added. Ensure this new configuration is correctly implemented and tested.
Line range hint
255-276:
Dynamic Manifest LoadingThe script dynamically loads the manifest file based on the selected radio button option. Ensure this functionality works as expected and handles errors gracefully.
285-288: JavaScript LibrariesThe inclusion of jQuery, Popper.js, and Bootstrap JavaScript libraries is noted. Ensure these libraries are necessary and do not introduce security vulnerabilities.
| update: | ||
| - platform: http_request | ||
| name: Firmware Update | ||
| id: update_http_request | ||
| source: https://s0tool.nl/s0tool-standard-flux-manifest.json |
There was a problem hiding this comment.
Add a new line character at the end of the file.
The file is missing a new line character at the end, which is a common convention in YAML files.
- source: https://s0tool.nl/s0tool-standard-flux-manifest.json
+ source: https://s0tool.nl/s0tool-standard-flux-manifest.json
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| update: | |
| - platform: http_request | |
| name: Firmware Update | |
| id: update_http_request | |
| source: https://s0tool.nl/s0tool-standard-flux-manifest.json | |
| update: | |
| - platform: http_request | |
| name: Firmware Update | |
| id: update_http_request | |
| source: https://s0tool.nl/s0tool-standard-flux-manifest.json | |
Tools
yamllint
[error] 5-5: no new line character at the end of file
(new-line-at-end-of-file)
| @@ -28,4 +28,6 @@ packages: | |||
| - esphome/components/basis.yaml | |||
| - esphome/components/kwhpuls.yml | |||
| - esphome/components/watermeter_flux.yaml | |||
| - esphome/components/s0tool-standard-flux-update.yml | |||
|
|
|||
There was a problem hiding this comment.
Add a new line character at the end of the file.
The file is missing a new line character at the end, which is a common convention in YAML files.
- refresh: 0d
+ refresh: 0d
Committable suggestion was skipped due to low confidence.
| @@ -28,4 +28,6 @@ | |||
| - esphome/components/basis.yaml | |||
| - esphome/components/kwhpuls.yml | |||
| - esphome/components/watermeter_flux.yaml | |||
| - esphome/components/s0tool-standard-flux-update.yml | |||
There was a problem hiding this comment.
Remove trailing spaces.
Trailing spaces are present at the end of the line.
- - esphome/components/s0tool-standard-flux-update.yml
+ - esphome/components/s0tool-standard-flux-update.ymlCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - esphome/components/s0tool-standard-flux-update.yml | |
| - esphome/components/s0tool-standard-flux-update.yml |
Tools
yamllint
[error] 31-31: trailing spaces
(trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .github/workflows/build.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- .github/workflows/build.yml
What does this implement/fix? / Wat implementeert/repareert dit?
Proposed change / Voorgestelde verandering.
Types of changes / Soorten wijzigingen .
Test Environment / Test Omgeving
Additional information / Aanvullende info
Checklist / Checklijst:
If user-visible functionality or configuration variables are added/modified / Als door de gebruiker zichtbare functionaliteit of configuratievariabelen worden toegevoegd/gewijzigd :
Summary by CodeRabbit
New Features
Enhancements
Bug Fixes