Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added SofarSolar FAQ #614

Merged
merged 8 commits into from
Nov 12, 2023
Merged

Added SofarSolar FAQ #614

merged 8 commits into from
Nov 12, 2023

Conversation

cschlipf
Copy link
Contributor

Wrote a FAQ for SofarSolar

Carsten Schlipf and others added 5 commits September 8, 2023 10:57
@cschlipf cschlipf marked this pull request as draft November 12, 2023 17:20
@wills106
Copy link
Owner

Just let me know when you are happy with it.

@wills106
Copy link
Owner

Is it worth adding in the examples in #612 into the FAQ or even sofar-automations.md ?
Assuming we can keep the formatting?

@cschlipf
Copy link
Contributor Author

Is it worth adding in the examples in #612 into the FAQ or even sofar-automations.md ? Assuming we can keep the formatting?

Already did that before your comment :). Had the same idea

@cleveHEX
Copy link
Contributor

I stick to a guideline that FAQ has only two level headers - questions (Just like I did in SolaX). Your page looks to me more like an article than FAQ (complex header structure). Your way there are only two items in the side menu and they need to be clicked to display their content and so it's not visible at first sight.

"How to connect xyz?" should have a separate page imho, as it's a standard thing and not something that might happen.

Just my opinion. It's up to Will if he sets any common criteria.

@cschlipf
Copy link
Contributor Author

Good points. Let me know the decision and I will change it accordingly.

@wills106
Copy link
Owner

I think for now the main thing is to get the documentation.

We can look at formatting and where certain items best fit later.
I think sections like modbus-adaptor-setup.md needs a complete rewrite, it's aimed at SolaX with random bit's of Sofar and Solis thrown in there.

@cleveHEX
Copy link
Contributor

Yes, it's nice to see that after my work people join. I didn't make any major changes to existing pages, just made fixups and added stubs.

@cschlipf
Copy link
Contributor Author

OK, I have removed one level as @cewbdex suggested. Ready for review/merge now. Thank you very much for your inputs.

@cschlipf cschlipf marked this pull request as ready for review November 12, 2023 17:52
Copy link
Contributor

@cleveHEX cleveHEX left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Format looks user friendly to me.

@cschlipf
Copy link
Contributor Author

cschlipf commented Nov 12, 2023

I think sections like modbus-adaptor-setup.md needs a complete rewrite, it's aimed at SolaX with random bit's of Sofar and Solis thrown in there.

Agree. Maybe moving Solax specific information into the Solax section and give each section a similar structure? Also with regards to Compatible adaptors: Not every adaptor works or is tested with every inverter. But that is really a bigger revamp of the doc, where I am not feeling comfortable enough yet.

Structure for each inverter type section could be:

  • <Vendor>
    • Tested Hardware (Inverters and RS485 Adaptors)
    • Modbus Setup
    • Modes of Operation
    • Examples
    • FAQ

@cleveHEX
Copy link
Contributor

cleveHEX commented Nov 12, 2023

I would explicitly state which inverter does and does not each adaptor support. The same for setup/install instruction, I would add a substep for every step that needs something extra for specific inverter. Having specific page for everything would be a huge amount of work without any major benefit.

Edit: also some generations of e.g. SolaX have things differently, so that would need a separated page too, so unified is the best IMHO.

@cschlipf
Copy link
Contributor Author

cschlipf commented Nov 12, 2023

I would explicitly state which inverter does and does not each adaptor support. The same for setup/install instruction, I would add a substep for every step that needs something extra for specific inverter. Having specific page for everything would be a huge amount of work without any major benefit.

Depends on how much duplicate information we have for each inverter. Maybe a general section for the generic parts? Right now however the generic part on the top is mainly focused on Solax and does not work for other inverters.

Not so sure on the a unified page approach. It would make it hard to read with many 'if you have this, then this applies'. This can't be avoided, but should be reduced.

@wills106
Copy link
Owner

But that is really a bigger revamp of the doc, where I am not feeling comfortable enough yet.

Don't worry I wasn't asking you to rewrite it.

Not every adaptor works or is tested with every inverter.

Yes that's something I need to workout based on Feedback. There is even a Modbus adaptor listed as unsupported that actually works now thanks to #413 but I haven't got round to updating the "Supported Adaptors list"

Yes, it's nice to see that after my work people join.

I appreciate the work you have done. I have been in contact with @cschlipf for a while about adding more specifics for Sofar, but with the limitations of the Wiki I wasn't sure the best way to get contributions into the Wiki.

@cleveHEX
Copy link
Contributor

I think tested adaptors page is a bit too much and also modbus setup, it has a lot of common stuff, so one page would be the best. What differs is entities, as every vendor has a different set.

I don't believe that there would be much IFTTT, as differences are exception rather than rule. Look at Waveshare B, only like one section has subsection.

@wills106 wills106 merged commit 5683b66 into wills106:main Nov 12, 2023
2 checks passed
@cschlipf
Copy link
Contributor Author

I think tested adaptors page is a bit too much and also modbus setup, it has a lot of common stuff, so one page would be the best. What differs is entities, as every vendor has a different set.

OK, depends on what you see as ModBus setup. What I wrote in the FAQ is about the wiring and that is totally specific, right?

@cschlipf
Copy link
Contributor Author

cschlipf commented Nov 12, 2023

In any way: Please suggest a structure and I can start working on that. I agree that the current structure is a bit chaotic for non-Solax inverters as you constantly need to figure out, what does not apply to my inverter.

@wills106
Copy link
Owner

What I wrote in the FAQ is about the wiring

That's probably something that does need to go into "Sofar Installation"

Like I say I'm not too bothered about structure at the moment. Once I have enough content for each Inverter I can understand the differences and how they work and rearrange accordingly.

@cleveHEX
Copy link
Contributor

I think tested adaptors page is a bit too much and also modbus setup, it has a lot of common stuff, so one page would be the best. What differs is entities, as every vendor has a different set.

OK, depends on what you see as ModBus setup. What I wrote in the FAQ is about the wiring and that is totally specific, right?

Yes, looks fine to me. Maybe if we have a dedicated page for wiring connection at one day, one answer could get merged there.

@wills106
Copy link
Owner

That's probably something that does need to go into "Sofar Installation"

Or a page dedicated to wiring like @cewbdex mentions:

a dedicated page for wiring connection

@cleveHEX
Copy link
Contributor

In any way: Please suggest a structure and I can start working on that. I agree that the current structure is a bit chaotic for non-Solax inverters as you constantly need to figure out, what does not apply to my inverter.

Test every common page and if anything differs, publish it and if not, you can just state it works for xyz too. If you have any ideas, I am open, I am not an authority here. If you propose anything, I will tell you my opinion and it's up to Will to decide.

@cschlipf
Copy link
Contributor Author

That's probably something that does need to go into "Sofar Installation"

See #616

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants