Initial documentation for Solis inverters #308
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge Main
Reformat to 180 line length (#304)
iainfogg
reviewed
Nov 11, 2023
docs/config-yml-settings.md
Outdated
| @@ -186,13 +184,14 @@ Connect to your cars sensors for accurate data: | |||
| Control how your battery behaves during car charging: | |||
|
|
|||
| - **car_charging_from_battery** - When True the car can drain the home battery, Predbat will manage the correct level of battery accordingly. When False home battery discharge will be prevented when your car charges, all load from the car and home will be from the grid. This is achieved by setting the discharge rate to 0 during car charging and to the maximum otherwise, hence if you turn this switch Off you won't be able to change your discharge rate outside Predbat. The home battery can still charge from the grid/solar in either case. Only use this if Predbat knows your car charging plan, e.g. you are using Intelligent Octopus or you use the car slots in Predbat to control your car charging. | |||
| - CAUTION: If you turn this switch back on during a car charging session you will need to set your battery discharge rate back to maximum manually. | |||
|
|
|||
| - CAUTION: If you turn this switch back on during a car charging session you will need to set your battery discharge rate back to maximum manually. | |||
There was a problem hiding this comment.
The proper Markdown spec is to have 4 spaces (or a tab) for an indented list, I think you've changed this plus some others to 2.
I went through them all when I redid the docs and set them all to 4 (GitHub was fairly forgiving, and would work with 2).
And if it did with with mkdocs, that'll be because fairly late on I added the sane lists extension, as one of the original lists wasn't working with the strict implementation of Markdown spec.
| @@ -19,6 +19,7 @@ nav: | |||
| - creating-charts.md | |||
| - predbat-plan-card.md | |||
| - 'Predbat development': | |||
| - other-inverters.md | |||
There was a problem hiding this comment.
Personally I'd add this in another section, rather than in the section on developing on Predbat, as it's not really developer content.
docs/config-yml-settings.md
Outdated
| @@ -230,21 +229,21 @@ The triggers count export energy until the next active charge slot only. | |||
|
|
|||
| For each trigger give a name, the minutes of export needed and the energy required in that time | |||
| Multiple triggers can be set at once so in total you could use too much energy if all run | |||
| Each trigger create an entity called 'binary_sensor.predbat_export_trigger_<name>' which will be turned On when the condition is valid | |||
| Each trigger create an entity called 'binary*sensor.predbat_export_trigger*<name>' which will be turned On when the condition is valid | |||
There was a problem hiding this comment.
Typo, the star should be before binary?
docs/install.md
Outdated
| @@ -45,7 +51,7 @@ | |||
|
|
|||
| Predbat needs a solar forecast in order to predict battery levels. | |||
|
|
|||
| If you don't have solar then comment out the Solar forecast part of the apps.yml: **pv_forecast_* ** | |||
| If you don't have solar then comment out the Solar forecast part of the apps.yml: **pv*forecast*\* ** | |||
There was a problem hiding this comment.
Why star's in place of underscore?
|
I don’t remember editing this at all. May have been som auto-formatting nonsense!
…On 11 Nov 2023 at 14:22 +0000, iainfogg ***@***.***>, wrote:
@iainfogg commented on this pull request.
Added a couple of comments
In docs/config-yml-settings.md:
> @@ -186,13 +184,14 @@ Connect to your cars sensors for accurate data:
Control how your battery behaves during car charging:
- **car_charging_from_battery** - When True the car can drain the home battery, Predbat will manage the correct level of battery accordingly. When False home battery discharge will be prevented when your car charges, all load from the car and home will be from the grid. This is achieved by setting the discharge rate to 0 during car charging and to the maximum otherwise, hence if you turn this switch Off you won't be able to change your discharge rate outside Predbat. The home battery can still charge from the grid/solar in either case. Only use this if Predbat knows your car charging plan, e.g. you are using Intelligent Octopus or you use the car slots in Predbat to control your car charging.
- - CAUTION: If you turn this switch back on during a car charging session you will need to set your battery discharge rate back to maximum manually.
+
+ - CAUTION: If you turn this switch back on during a car charging session you will need to set your battery discharge rate back to maximum manually.
The proper Markdown spec is to have 4 spaces (or a tab) for an indented list, I think you've changed this plus some others to 2.
I went through them all when I redid the docs and set them all to 4 (GitHub was fairly forgiving, and would work with 2).
And if it did with with mkdocs, that'll be because fairly late on I added the sane lists extension, as one of the original lists wasn't working with the strict implementation of Markdown spec.
In mkdocs.yml:
> @@ -19,6 +19,7 @@ nav:
- creating-charts.md
- predbat-plan-card.md
- 'Predbat development':
+ - other-inverters.md
Personally I'd add this in another section, rather than in the section on developing on Predbat, as it's not really developer content.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Hmm - something odd going on here. Again not a change I remember making…
…On 11 Nov 2023 at 14:30 +0000, Trefor Southwell ***@***.***>, wrote:
@springfall2008 commented on this pull request.
In docs/install.md:
> @@ -45,7 +51,7 @@
Predbat needs a solar forecast in order to predict battery levels.
-If you don't have solar then comment out the Solar forecast part of the apps.yml: **pv_forecast_* **
+If you don't have solar then comment out the Solar forecast part of the apps.yml: **pv*forecast*\* **
Why star's in place of underscore?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Could it be that you'd already written the code in the original README then you copied it in here after I reworked the documentation? The original README used 2 characters for indents, so that would explain it. |
|
I don’t think so. I think it may be VScode doing some autoformatting. I’ve noticed that it changes some markdown - sorting out tables and the like but maybe it’s not following the same standards?
Will have a look tomorrow once the rain has set in
…On 11 Nov 2023 at 19:53 +0000, iainfogg ***@***.***>, wrote:
Could it be that you'd already written the code in the original README then you copied it in here after I reworked the documentation?
The original README used 2 characters for indents, so that would explain it.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Ok, that's strange as I used VS Code to do the work in the first place. It griped about some indents but never auto changed them for me. I think it leans towards the GitHub more relaxed standards, rather than the strict standards. |
|
@fboundy were you going to fix the issues with the * before merging? |
|
Yes. Leave this for now
…On 14 Nov 2023 at 11:42 +0000, Trefor Southwell ***@***.***>, wrote:
@fboundy were you going to fix the issues with the * before merging?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
|
@fboundy any updates on this one? |
springfall2008
approved these changes
Dec 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.