pyiskra


Namepyiskra JSON
Version 0.1.26 PyPI version JSON
download
home_pageNone
SummaryPython Iskra devices interface
upload_time2025-09-01 10:42:53
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT
keywords homeautomation iskra energy meter
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyIskra

PyIskra is a Python package designed to provide interface for Iskra devices using SG and it's RestAPI or ModbusTCP/RTU.

## Installation

You can install PyIskra using pip:

```bash
pip install pyiskra
```

## Features

- Object-oriented mapping for energy meters
- Access to measurements
- Access to Energy counters

## Supported devices

- Smart Gateway
- IE38
- IE14
- MCXXX
- iMCXXX
- MTXXX
- iMTXXX


## Usage

Here's a basic example of how to use PyIskra:

```
import asyncio
from pyiskra.devices import Device
from pyiskra.adapters import RestAPI


device_ip = "192.168.1.1"
device_auth = {"username": "admin", "password": "iskra"}

async def main():
    # Set device IP address

    # Create adapter
    adapter = RestAPI(ip_address=device_ip, authentication=device_auth)

    # Create device
    device = await Device.create_device(adapter)

    # Initalize device
    await device.init()

    devices = [device]


    if device.is_gateway:
        devices += device.get_child_devices()


    for device in devices:
        # Update device status
        print(f"Updating status for {device.model} {device.serial}")
        await device.update_status()

        if device.supports_measurements:
            for index, phase in enumerate(device.measurements.phases):
                print(f"Phase {index+1} - U: {phase.voltage.value} {phase.voltage.units}, I: {phase.current.value} {phase.current.units} P: {phase.active_power.value} {phase.active_power.units} Q: {phase.reactive_power.value} {phase.reactive_power.units} S: {phase.apparent_power.value} {phase.apparent_power.units} PF: {phase.power_factor.value} {phase.power_factor.units} PA: {phase.power_angle.value} {phase.power_angle.units} THD U: {phase.thd_voltage.value} {phase.thd_voltage.units} THD I: {phase.thd_current.value} {phase.thd_current.units}")

        if device.supports_counters:
            for counter in device.counters.non_resettable :
                print(f"Non-resettable counter - Name: {counter.name}, Value: {counter.value} {counter.units}, Direction: {counter.direction}")


            for counter in device.counters.resettable:
                print(f"Resettable counter - Name: {counter.name}, Value: {counter.value} {counter.units}, Direction: {counter.direction}")

asyncio.run(main())
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyiskra",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Iskra <razvoj.mis@iskra.eu>",
    "keywords": "homeautomation, iskra, energy meter",
    "author": null,
    "author_email": "\"Iskra d.o.o.\" <razvoj.mis@iskra.eu>",
    "download_url": "https://files.pythonhosted.org/packages/f0/d8/5d64a3b912e5314f8e287b2ed189253fc1b56ef44f835fbfef2390098284/pyiskra-0.1.26.tar.gz",
    "platform": null,
    "description": "# PyIskra\n\nPyIskra is a Python package designed to provide interface for Iskra devices using SG and it's RestAPI or ModbusTCP/RTU.\n\n## Installation\n\nYou can install PyIskra using pip:\n\n```bash\npip install pyiskra\n```\n\n## Features\n\n- Object-oriented mapping for energy meters\n- Access to measurements\n- Access to Energy counters\n\n## Supported devices\n\n- Smart Gateway\n- IE38\n- IE14\n- MCXXX\n- iMCXXX\n- MTXXX\n- iMTXXX\n\n\n## Usage\n\nHere's a basic example of how to use PyIskra:\n\n```\nimport asyncio\nfrom pyiskra.devices import Device\nfrom pyiskra.adapters import RestAPI\n\n\ndevice_ip = \"192.168.1.1\"\ndevice_auth = {\"username\": \"admin\", \"password\": \"iskra\"}\n\nasync def main():\n    # Set device IP address\n\n    # Create adapter\n    adapter = RestAPI(ip_address=device_ip, authentication=device_auth)\n\n    # Create device\n    device = await Device.create_device(adapter)\n\n    # Initalize device\n    await device.init()\n\n    devices = [device]\n\n\n    if device.is_gateway:\n        devices += device.get_child_devices()\n\n\n    for device in devices:\n        # Update device status\n        print(f\"Updating status for {device.model} {device.serial}\")\n        await device.update_status()\n\n        if device.supports_measurements:\n            for index, phase in enumerate(device.measurements.phases):\n                print(f\"Phase {index+1} - U: {phase.voltage.value} {phase.voltage.units}, I: {phase.current.value} {phase.current.units} P: {phase.active_power.value} {phase.active_power.units} Q: {phase.reactive_power.value} {phase.reactive_power.units} S: {phase.apparent_power.value} {phase.apparent_power.units} PF: {phase.power_factor.value} {phase.power_factor.units} PA: {phase.power_angle.value} {phase.power_angle.units} THD U: {phase.thd_voltage.value} {phase.thd_voltage.units} THD I: {phase.thd_current.value} {phase.thd_current.units}\")\n\n        if device.supports_counters:\n            for counter in device.counters.non_resettable :\n                print(f\"Non-resettable counter - Name: {counter.name}, Value: {counter.value} {counter.units}, Direction: {counter.direction}\")\n\n\n            for counter in device.counters.resettable:\n                print(f\"Resettable counter - Name: {counter.name}, Value: {counter.value} {counter.units}, Direction: {counter.direction}\")\n\nasyncio.run(main())\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python Iskra devices interface",
    "version": "0.1.26",
    "project_urls": {
        "Documentation": "https://github.com/Iskramis/pyiskra",
        "Homepage": "https://github.com/Iskramis/pyiskra",
        "Repository": "https://github.com/Iskramis/pyiskra"
    },
    "split_keywords": [
        "homeautomation",
        " iskra",
        " energy meter"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6f71d7640df13c14e9737bd06ae49a411d35be4df776dc9847cf6eadcf15e725",
                "md5": "55dfe01ca7b1183861803ae057668ed2",
                "sha256": "32c1d3e6070b2f057c139425993976fa26df737fb2d9e2a2ca15654e9073f57a"
            },
            "downloads": -1,
            "filename": "pyiskra-0.1.26-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "55dfe01ca7b1183861803ae057668ed2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 22266,
            "upload_time": "2025-09-01T10:42:52",
            "upload_time_iso_8601": "2025-09-01T10:42:52.283285Z",
            "url": "https://files.pythonhosted.org/packages/6f/71/d7640df13c14e9737bd06ae49a411d35be4df776dc9847cf6eadcf15e725/pyiskra-0.1.26-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f0d85d64a3b912e5314f8e287b2ed189253fc1b56ef44f835fbfef2390098284",
                "md5": "37e3ed2c3b29666743ffb8663b5d38c9",
                "sha256": "395073c1c626dd098d2ec73f8fa099c48707fc8b280cb91b580a6ddc66ed80f5"
            },
            "downloads": -1,
            "filename": "pyiskra-0.1.26.tar.gz",
            "has_sig": false,
            "md5_digest": "37e3ed2c3b29666743ffb8663b5d38c9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 15440,
            "upload_time": "2025-09-01T10:42:53",
            "upload_time_iso_8601": "2025-09-01T10:42:53.107459Z",
            "url": "https://files.pythonhosted.org/packages/f0/d8/5d64a3b912e5314f8e287b2ed189253fc1b56ef44f835fbfef2390098284/pyiskra-0.1.26.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-01 10:42:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Iskramis",
    "github_project": "pyiskra",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyiskra"
}
        
Elapsed time: 1.94581s