sma-manager


Namesma-manager JSON
Version 2.1.0 PyPI version JSON
download
home_pagehttps://github.com/DEADSEC-SECURITY/sma-manager
SummaryPackage for collecting information from the SMA Manager device of solar panels.
upload_time2024-02-03 02:17:36
maintainer
docs_urlNone
authorDeadSec-Security
requires_python>=3.8
licenseMIT
keywords sma sma-manager manager sunny-portal sunny
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # SMA Manager ![Release](https://img.shields.io/github/v/release/DEADSEC-SECURITY/sma-manager?label=Release&style=flat-square) ![Python_Version](https://img.shields.io/badge/Python-3.9%2B-blue?style=flat-square) ![License](https://img.shields.io/github/license/DEADSEC-SECURITY/sma-manager?label=License&style=flat-square) 

[![CodeQL](https://github.com/DEADSEC-SECURITY/sma-manager/actions/workflows/codeql.yml/badge.svg)](https://github.com/DEADSEC-SECURITY/sma-manager/actions/workflows/codeql.yml) 

![PyPI - Downloads](https://img.shields.io/pypi/dd/sma-manager?label=Daily%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dw/sma-manager?label=Weekly%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dm/sma-manager?label=Monthly%20Downloads&style=flat-square)

## 📝 CONTRIBUTIONS

Before doing any contribution read <a href="https://github.com/DEADSEC-SECURITY/sma-manager/blob/main/CONTRIBUTING.md">CONTRIBUTING</a>.

## 📧 CONTACT

Email: amng835@gmail.com

General Discord: https://discord.gg/dFD5HHa

Developer Discord: https://discord.gg/rxNNHYN9EQ

## 📥 INSTALLING
<a href="https://pypi.org/project/sma-manager">Latest PyPI stable release</a>
```bash
pip install sma-manager
```

## ⚙ HOW TO USE
```python
import sma_manager_api
sma_manager_api.SMA(<PARAMS>)
```
OR
```python
from sma_manager_api import SMA
SMA(<PARAMS>)
```

## 🤝 PARAMETERS
- name : str, required
  - Sensor name. 
  - Used only for Home Assistant Integration, a random value can be used if not implementing as a Home Assistant Component
- ip : str, required
  - IP of SMA Manager
- port : str, required 
  - Port of SMA Manager
- refresh_time : int, optional
  - Option to disable/enable the default progress bar (Default: 1)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DEADSEC-SECURITY/sma-manager",
    "name": "sma-manager",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "sma,sma-manager,manager,sunny-portal,sunny",
    "author": "DeadSec-Security",
    "author_email": "amng835@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6b/74/5200600ad5c7877a89bbc10324702817c97f0c385f6903f76740dafd2655/sma-manager-2.1.0.tar.gz",
    "platform": null,
    "description": "# SMA Manager ![Release](https://img.shields.io/github/v/release/DEADSEC-SECURITY/sma-manager?label=Release&style=flat-square) ![Python_Version](https://img.shields.io/badge/Python-3.9%2B-blue?style=flat-square) ![License](https://img.shields.io/github/license/DEADSEC-SECURITY/sma-manager?label=License&style=flat-square) \n\n[![CodeQL](https://github.com/DEADSEC-SECURITY/sma-manager/actions/workflows/codeql.yml/badge.svg)](https://github.com/DEADSEC-SECURITY/sma-manager/actions/workflows/codeql.yml) \n\n![PyPI - Downloads](https://img.shields.io/pypi/dd/sma-manager?label=Daily%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dw/sma-manager?label=Weekly%20Downloads&style=flat-square) ![PyPI - Downloads](https://img.shields.io/pypi/dm/sma-manager?label=Monthly%20Downloads&style=flat-square)\n\n## \ud83d\udcdd CONTRIBUTIONS\n\nBefore doing any contribution read <a href=\"https://github.com/DEADSEC-SECURITY/sma-manager/blob/main/CONTRIBUTING.md\">CONTRIBUTING</a>.\n\n## \ud83d\udce7 CONTACT\n\nEmail: amng835@gmail.com\n\nGeneral Discord: https://discord.gg/dFD5HHa\n\nDeveloper Discord: https://discord.gg/rxNNHYN9EQ\n\n## \ud83d\udce5 INSTALLING\n<a href=\"https://pypi.org/project/sma-manager\">Latest PyPI stable release</a>\n```bash\npip install sma-manager\n```\n\n## \u2699 HOW TO USE\n```python\nimport sma_manager_api\nsma_manager_api.SMA(<PARAMS>)\n```\nOR\n```python\nfrom sma_manager_api import SMA\nSMA(<PARAMS>)\n```\n\n## \ud83e\udd1d PARAMETERS\n- name : str, required\n  - Sensor name. \n  - Used only for Home Assistant Integration, a random value can be used if not implementing as a Home Assistant Component\n- ip : str, required\n  - IP of SMA Manager\n- port : str, required \n  - Port of SMA Manager\n- refresh_time : int, optional\n  - Option to disable/enable the default progress bar (Default: 1)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Package for collecting information from the SMA Manager device of solar panels.",
    "version": "2.1.0",
    "project_urls": {
        "Homepage": "https://github.com/DEADSEC-SECURITY/sma-manager"
    },
    "split_keywords": [
        "sma",
        "sma-manager",
        "manager",
        "sunny-portal",
        "sunny"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0b3a2b6cdc89c74d91a21e8733df20f4c06b33f6aea5cc01b2f0b73f48e9f87a",
                "md5": "c238993fb8d96893b392442a1c3df8c1",
                "sha256": "2a9844e9dabc5069b537170bc6a92ad00fc2ead944ab004e6918cd6b061aff3a"
            },
            "downloads": -1,
            "filename": "sma_manager-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c238993fb8d96893b392442a1c3df8c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8182,
            "upload_time": "2024-02-03T02:17:35",
            "upload_time_iso_8601": "2024-02-03T02:17:35.029786Z",
            "url": "https://files.pythonhosted.org/packages/0b/3a/2b6cdc89c74d91a21e8733df20f4c06b33f6aea5cc01b2f0b73f48e9f87a/sma_manager-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b745200600ad5c7877a89bbc10324702817c97f0c385f6903f76740dafd2655",
                "md5": "50046866f2f096d6ceb1c0cbc1122bb8",
                "sha256": "db2ab0a84ca00ac3038070096ba3db1e4aabd5385759ca00fece46cb5dfb0d76"
            },
            "downloads": -1,
            "filename": "sma-manager-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "50046866f2f096d6ceb1c0cbc1122bb8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7545,
            "upload_time": "2024-02-03T02:17:36",
            "upload_time_iso_8601": "2024-02-03T02:17:36.566419Z",
            "url": "https://files.pythonhosted.org/packages/6b/74/5200600ad5c7877a89bbc10324702817c97f0c385f6903f76740dafd2655/sma-manager-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-03 02:17:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DEADSEC-SECURITY",
    "github_project": "sma-manager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "sma-manager"
}
        
Elapsed time: 3.46839s