# pysma library
[![Workflow Status](https://github.com/kellerza/pysma/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/kellerza/pysma/actions)
[![Codecov](https://codecov.io/gh/kellerza/pysma/branch/master/graph/badge.svg)](https://codecov.io/gh/kellerza/pysma)
[![Documentation Status](https://readthedocs.org/projects/pysma/badge/?version=latest)](https://pysma.readthedocs.io/en/latest/?badge=latest)
SMA Webconnect library for Python 3. The library was created
to integrate SMA inverters with HomeAssistant
See <http://www.sma-solar.com> for more information on the SMA solar
inverters
Other SMA interfaces include [SBFspot](https://github.com/SBFspot/SBFspot/) and a
Python [adaptation](https://github.com/TD22057/T-Home/)
## Example usage
See [example.py](./example.py) for a basic usage and tests
# Home Assistant
The Home Assistant sma sensor documentation can be found
[here](https://www.home-assistant.io/components/sma)
> ---
>
> **This library uses Webconnect.** ~Modbus~ is not supported
>
> **If you can access your SMA via your browser, this might work for you.**
>
> ---
If you access your SMA WebConnect via `https://` you should set both
`ssl: true` and `verify_ssl: false`.
Daily usage is not always available from the SMA WebConnect interface.
It is possible to get around this by using a
[utility meter](https://www.home-assistant.io/components/utility_meter)
or more recently from the Energy management feature in Home Assistant
### How to debug this addon
1. Ensure you can access your SMA from your browser
To enable detailed logging in Home Assistant, you can add the following to your configuration
```yaml
logger:
default: info
logs:
homeassistant.components.sma: debug
pysma: debug
```
## Energy Meter
This library can read the second version of the emnergy meter, there is a seperate Home Assistant OS Addon that could also read older Energy Meters directly. See [Energy Meter](https://github.com/kellerza/hassio-sma-em)
Raw data
{
"_id": null,
"home_page": "https://github.com/kellerza/pysma",
"name": "pysma",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Johann Kellerman",
"author_email": "kellerza@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a8/de/9a43df4bc3350f5ef7db80030e2d2c394f5f7dd58d44ee9bb9ab57e78dd6/pysma-0.7.5.tar.gz",
"platform": null,
"description": "# pysma library\n\n[![Workflow Status](https://github.com/kellerza/pysma/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/kellerza/pysma/actions)\n[![Codecov](https://codecov.io/gh/kellerza/pysma/branch/master/graph/badge.svg)](https://codecov.io/gh/kellerza/pysma)\n[![Documentation Status](https://readthedocs.org/projects/pysma/badge/?version=latest)](https://pysma.readthedocs.io/en/latest/?badge=latest)\n\nSMA Webconnect library for Python 3. The library was created\nto integrate SMA inverters with HomeAssistant\n\nSee <http://www.sma-solar.com> for more information on the SMA solar\ninverters\n\nOther SMA interfaces include [SBFspot](https://github.com/SBFspot/SBFspot/) and a\nPython [adaptation](https://github.com/TD22057/T-Home/)\n\n## Example usage\n\nSee [example.py](./example.py) for a basic usage and tests\n\n# Home Assistant\n\nThe Home Assistant sma sensor documentation can be found\n[here](https://www.home-assistant.io/components/sma)\n\n> ---\n>\n> **This library uses Webconnect.** ~Modbus~ is not supported\n> \n> **If you can access your SMA via your browser, this might work for you.**\n>\n> ---\n\nIf you access your SMA WebConnect via `https://` you should set both\n`ssl: true` and `verify_ssl: false`.\n\nDaily usage is not always available from the SMA WebConnect interface.\nIt is possible to get around this by using a\n[utility meter](https://www.home-assistant.io/components/utility_meter)\nor more recently from the Energy management feature in Home Assistant\n\n### How to debug this addon\n\n1. Ensure you can access your SMA from your browser\n\nTo enable detailed logging in Home Assistant, you can add the following to your configuration\n\n```yaml\nlogger:\n default: info\n logs:\n homeassistant.components.sma: debug\n pysma: debug\n```\n\n## Energy Meter\n\nThis library can read the second version of the emnergy meter, there is a seperate Home Assistant OS Addon that could also read older Energy Meters directly. See [Energy Meter](https://github.com/kellerza/hassio-sma-em)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library to interface an SMA Solar WebConnect module",
"version": "0.7.5",
"project_urls": {
"Download": "https://github.com/kellerza/pysma/tarball/0.7.5",
"Homepage": "https://github.com/kellerza/pysma"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78baf362e53856ed025eaa4f5353a96e4c6088a7df36d376d23c105d9acbf50d",
"md5": "f4aa1bf29f4c324f6d6e6bc8275af5ef",
"sha256": "ddfa1f6d6aa629e27d7282065c55fbcc633a1af5ecf6ded7c935385816bd463c"
},
"downloads": -1,
"filename": "pysma-0.7.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4aa1bf29f4c324f6d6e6bc8275af5ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14805,
"upload_time": "2023-08-19T19:37:00",
"upload_time_iso_8601": "2023-08-19T19:37:00.357976Z",
"url": "https://files.pythonhosted.org/packages/78/ba/f362e53856ed025eaa4f5353a96e4c6088a7df36d376d23c105d9acbf50d/pysma-0.7.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8de9a43df4bc3350f5ef7db80030e2d2c394f5f7dd58d44ee9bb9ab57e78dd6",
"md5": "bf8356a98fed4b2a656efbf19a40de24",
"sha256": "ce508611c1b9b668045e148c0cb2a3d3f8a64f588706a969d4ed508663eb25c0"
},
"downloads": -1,
"filename": "pysma-0.7.5.tar.gz",
"has_sig": false,
"md5_digest": "bf8356a98fed4b2a656efbf19a40de24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36251,
"upload_time": "2023-08-19T19:37:01",
"upload_time_iso_8601": "2023-08-19T19:37:01.466350Z",
"url": "https://files.pythonhosted.org/packages/a8/de/9a43df4bc3350f5ef7db80030e2d2c394f5f7dd58d44ee9bb9ab57e78dd6/pysma-0.7.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-19 19:37:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kellerza",
"github_project": "pysma",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pysma"
}