pysma


Namepysma JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryLibrary to interface an SMA Solar devices
upload_time2025-10-22 07:17:27
maintainerNone
docs_urlNone
authorJohann Kellerman, René Klomp
requires_python>=3.12
licenseThe MIT License (MIT) Copyright (c) 2016-2025 kellerza Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # pysma library

[![Workflow Status](https://github.com/kellerza/pysma/actions/workflows/ci.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 separate 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": null,
    "name": "pysma",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": null,
    "author": "Johann Kellerman, Ren\u00e9 Klomp",
    "author_email": "Johann Kellerman <kellerza@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/35/f8/b453d9ae432cf17cab6ddc3618d0dd81afe926fe268e68c0e238fab61094/pysma-1.0.1.tar.gz",
    "platform": null,
    "description": "# pysma library\n\n[![Workflow Status](https://github.com/kellerza/pysma/actions/workflows/ci.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 separate 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": "The MIT License (MIT)  Copyright (c) 2016-2025 kellerza  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Library to interface an SMA Solar devices",
    "version": "1.0.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "28037e444cc201ebd45ba20b7884cd8e92ed99167949e4cbfa2d0d00bec609bb",
                "md5": "d9ae3f06f5ec8fd9ed3680227225def3",
                "sha256": "50a7de25cd573537fb5ae54351d5c30e670f046944efa983ef17889b6ec41cf7"
            },
            "downloads": -1,
            "filename": "pysma-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d9ae3f06f5ec8fd9ed3680227225def3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 15265,
            "upload_time": "2025-10-22T07:17:26",
            "upload_time_iso_8601": "2025-10-22T07:17:26.651236Z",
            "url": "https://files.pythonhosted.org/packages/28/03/7e444cc201ebd45ba20b7884cd8e92ed99167949e4cbfa2d0d00bec609bb/pysma-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "35f8b453d9ae432cf17cab6ddc3618d0dd81afe926fe268e68c0e238fab61094",
                "md5": "55057c28f945dfc1b9c3dc1328a0f77f",
                "sha256": "b49481a1bc96ee4d93681d331ffa9ec313a162087c8435b7b3b96180f247c629"
            },
            "downloads": -1,
            "filename": "pysma-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "55057c28f945dfc1b9c3dc1328a0f77f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 13643,
            "upload_time": "2025-10-22T07:17:27",
            "upload_time_iso_8601": "2025-10-22T07:17:27.844880Z",
            "url": "https://files.pythonhosted.org/packages/35/f8/b453d9ae432cf17cab6ddc3618d0dd81afe926fe268e68c0e238fab61094/pysma-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-22 07:17:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pysma"
}
        
Elapsed time: 2.71444s