solax

🌞 Solax Inverter API Wrapper

https://github.com/squishykid/solax

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 30 committers (3.3%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.6%) to scientific vocabulary

Keywords

home-automation iot photovoltaic raspberry-pi solar solax

Last synced: 5 months ago · JSON representation

Repository

🌞 Solax Inverter API Wrapper

Basic Info

Host: GitHub
Owner: squishykid
License: mit
Language: Python
Default Branch: master
Homepage:
Size: 238 KB

Statistics

Stars: 114
Watchers: 14
Forks: 67
Open Issues: 22
Releases: 14

Topics

home-automation iot photovoltaic raspberry-pi solar solax

Created almost 7 years ago · Last pushed 7 months ago

Metadata Files

Readme License

Solax

Read energy usage data from the real-time API on Solax solar inverters.

Real time power, current and voltage
Grid power information
Battery level
Temperature and inverter health
Daily/Total energy summaries

Usage

pip install solax

Then from within your project:

``` import solax import asyncio

async def work(): r = await solax.realtimeapi('10.0.0.1') return await r.get_data()

loop = asyncio.neweventloop() asyncio.seteventloop(loop) data = loop.rununtilcomplete(work()) print(data) ```

This will try all the inverter classes in turn until it finds the first one that works with your installation. You can see the list of inverter implementation classes in the entry points configured in setup.py.

If you want to bypass the inverter discovery code and use a specific inverter class, you can invoke discover specifying directly the class. In this example, the X1 Hybrid Gen4 implementation is used:

``` from importlib.metadata import entry_points import solax import asyncio

INVERTERSENTRYPOINTS = { ep.name: ep.load() for ep in entry_points(group="solax.inverter") }

async def work(): inverter = await solax.discover("10.0.0.1", 80, "xxxxx", inverters=[INVERTERSENTRYPOINTS.get("x1hybridgen4")], returnwhen=asyncio.FIRSTCOMPLETED) return await inverter.get_data()

loop = asyncio.neweventloop() asyncio.seteventloop(loop) data = loop.rununtilcomplete(work()) print(data) ```

Confirmed Supported Inverters

These inverters have been tested and confirmed to be working. If your inverter is not listed below, this library may still work- please create an issue so we can add your inverter to the list 😊.

SK-TL5000E
X1 Hybrid Gen4

You can get the list of supported inverters by looking up the solax.inverter entry points:

for ep in entry_points(group="solax.inverter"): print(ep)

Owner

Name: Robin Wohlers-Reichel
Login: squishykid
Kind: user
Location: Sydney, Australia

Repositories: 42
Profile: https://github.com/squishykid

GitHub Events

Total

Create event: 6
Issues event: 33
Release event: 1
Watch event: 18
Delete event: 1
Issue comment event: 134
Push event: 11
Pull request review comment event: 5
Pull request review event: 6
Pull request event: 24
Fork event: 7

Last Year

Create event: 6
Issues event: 33
Release event: 1
Watch event: 18
Delete event: 1
Issue comment event: 134
Push event: 11
Pull request review comment event: 5
Pull request review event: 6
Pull request event: 24
Fork event: 7

Committers

Last synced: 7 months ago

All Time

Total Commits: 86
Total Committers: 30
Avg Commits per committer: 2.867
Development Distribution Score (DDS): 0.523

Past Year

Commits: 13
Committers: 9
Avg Commits per committer: 1.444
Development Distribution Score (DDS): 0.769

Top Committers

Name	Email	Commits
Robin Wohlers-Reichel	r**l@g**m	41
Vadim Kraus	3****s	5
Dos Moonen	d**r@g**m	4
Petru Paler	p**u@p**t	4
Jakub Darmach	j**b@s**m	3
Khalid Eldehairy	k**d@k**m	2
rnauber	7****r	2
Th3Link	m**r@g**m	2
Niclas Kühnapfel	n****u	2
Robin Wohlers-Reichel	me@r****m	1
Adam Bogocz	5****z	1
Arne Mauer	a**r@g**m	1
Bo Biene	2****e	1
Daniel Weeber	m**l@d**e	1
DarkerCz	j**f@g**m	1
Derek Kaye	g**b@d**k	1
Fabian Affolter	m**l@f**h	1
dickinsonrob	r**n@c**t	1
Szilárd Kálosi	k****z	1
Sergiy Andrusenko	a****e	1
Sebastian Stäubert	s**t@u**e	1
Rupert Nash	r**t@n**k	1
Renaud Bruyeron	b**n@g**m	1
Pedro Simoes	p**s@g**m	1
Nazar Mokrynskyi	n**r@m**m	1
Martin Richtarsky	s@m****e	1
Martin Beran	m**n@m**z	1
Joel Ekström	j**l@e**v	1
Jesse Hills	3****z	1
JJ Macalinao	j**o@g**m	1

Committer Domains (Top 20 + Academic)

ekstrom.dev: 1 mber.cz: 1 martinien.de: 1 mokrynskyi.com: 1 nash.me.uk: 1 uni-leipzig.de: 1 cantab.net: 1 fabian-affolter.ch: 1 dezzanet.co.uk: 1 daniel-weeber.de: 1 robinwohlers.com: 1 kdehairy.com: 1 stackhpc.com: 1 paler.net: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 85
Total pull requests: 129
Average time to close issues: 10 months
Average time to close pull requests: 3 months
Total issue authors: 59
Total pull request authors: 44
Average comments per issue: 6.08
Average comments per pull request: 2.19
Merged pull requests: 81
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 10
Pull requests: 21
Average time to close issues: 13 days
Average time to close pull requests: 11 days
Issue authors: 10
Pull request authors: 8
Average comments per issue: 5.5
Average comments per pull request: 2.14
Merged pull requests: 15
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

squishykid (11)
matthewjporter (4)
nazar-pc (3)
rupertnash (3)
sommo (3)
rwg0 (2)
petgriffin (2)
VadimKraus (2)
sp0ok3r (2)
adambogocz (2)
emichel11 (2)
DanielWeeber (2)
KuzonCode (1)
riffy99 (1)
jurahudak (1)

Pull Request Authors

squishykid (26)
Darsstar (8)
VadimKraus (7)
darmach (6)
brew-your-own (6)
ppetru (4)
rnauber (4)
rowinho (4)
DarkerCz (4)
nazar-pc (4)
Th3Link (3)
Safi105 (3)
BoBiene (3)
niclasku (3)
joelekstrom (2)

Top Labels

Issue Labels

inverter:x3 (1) inverter:xhybrid (1) inverter:x1 (1)

Pull Request Labels

inverter:xhybrid (2) inverter:x3 (1)

Packages

Total packages: 1
Total downloads:
- pypi 39,504 last-month
Total docker downloads: 757,208,562

Total dependent packages: 0
Total dependent repositories: 631
Total versions: 30
Total maintainers: 1

pypi.org: solax

Solax inverter API client

Homepage: https://github.com/squishykid/solax
Documentation: https://solax.readthedocs.io/
License: MIT
Latest release: 3.2.3
published about 1 year ago

Versions: 30
Dependent Packages: 0
Dependent Repositories: 631
Downloads: 39,504 Last month
Docker Downloads: 757,208,562

Rankings

Docker downloads count: 0.2%

Dependent repos count: 0.6%

Downloads: 4.4%

Average: 4.4%

Forks count: 6.2%

Dependent packages count: 7.3%

Stargazers count: 8.0%

Maintainers (1)

squishykid

Last synced: 6 months ago

Dependencies

.github/workflows/publish.yml actions

actions/checkout master composite
actions/checkout v1 composite
actions/setup-python v1 composite

.github/workflows/tests.yaml actions

actions/checkout v2 composite
actions/setup-python v2 composite

setup.py pypi

aiohttp >=3.5.4,
async_timeout >=4.0.2
voluptuous >=0.11.5

solax

Science Score: 36.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Solax

Usage

Confirmed Supported Inverters

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: solax

Rankings

Maintainers (1)

Dependencies