{
    "info": {
        "author": "David Roberts",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# SolarEdge Local\n\nThe goal if this respository is to provide information about using the local API available on some solar edge inverters.  This is a WIP based on my observations and may contain inaccuracies.  Pull Requests or Issues are encouraged to correct any mistakes or add additonal informatoin.\n\n### Relevant Models\n\nThe local API is available on the [SExxxxH-US models with SetApp](https://www.solaredge.com/sites/default/files/se-hd-wave-single-phase-inverter-with-setapp-datasheet-na.pdf) as well as European three phase inverters SEXXK-XXXTXBXX4 models with SetApp like [SE3K-E10K](https://www.solaredge.com/sites/default/files/se-three-phase-inverter-setapp-ds.pdf), [SE12.5K-SE27.6K](https://www.solaredge.com/sites/default/files/se-three-phase-inverter-setapp-datasheet.pdf) and [SE33.3K](https://www.solaredge.com/sites/default/files/se-three-phase-inverter-for-277-480-grid-setapp-datasheet.pdf).\nPlease check carefully the datasheets if in the section \"Additional Features\", sub-section \"Inverter Commissioning\" is present the following line \"With the SetApp mobile application using built-in Wi-Fi access point for local connection\".\n\nMore inforation on SeeApp could be found [here](https://www.solaredge.com/us/products/installer-tools/setapp). These models have no LED screen and are provisioned ONLY via a phone app during commissioning.\nCheck also the [SetApp FAQ](https://www.solaredge.com/sites/default/files/solaredge-setapp-faqs-eng.pdf) for more info.\nFor convenience it is reported here one Q&A:\n\n> Q: Can the new app be used for already installed inverters?\n>\n> A: Only SolarEdge inverters with a new communication board (no display) can be activated or configured via SetApp.\n\nReportedly, these new inverters have a CPU number starting with 04.\n\nYou can check by finding the IP address of your inverter and visiting it in a browser.  If it supports the local API, you'll see the SolarEdge logo and a \"Commissioning\" menu.\n\nIf you do not have the local API available, see [this repository](https://github.com/jbuehl/solaredge) as an alternative.\n\n### Using the Python wrapper\n\nFor convinience, a python API wrapper, [solaredge_local](https://pypi.org/project/solaredge-local/) is available.  **Only python 3 is supported**\n\nTo install: `pip install solaredge-local`\n\nTo use:\n\n```\nfrom solaredge_local import SolarEdge\nclient = SolarEdge(\"http://<inverter ip address>\")\nclient.get_status()  # Provides general energy and other overview information\nclient.get_maintenance() # Provides optimizer level information and other details\nclient.get_information() # Provides software versions and error log list.\nclient.get_power_control() # Provides power control information and other details.\n```\n\n### API Endpoints\n\n* AppConfigs: \"web/v1/app_configs\"\n* Region: \"web/v1/region\"\n* Region_Country: \"web/v1/region/country\"\n* Region_Language: \"web/v1/region/language\"\n* Pairing: \"web/v1/pairing\"\n* Pairing_Request: \"web/v1/pairing/request\"\n* Communication: \"web/v1/communication\"\n* Communication_Server: \"web/v1/communication/server\"\n* Communication_Lan: \"web/v1/communication/lan\"\n* Communication_Rs485_SlaveDetect: \"web/v1/communication/rs485/<id>/slave_detect\"\n* Communication_Rs485_Protocol: \"web/v1/communication/rs485/<id>/protocol\"\n* Communication_Rs485_DeviceId: \"web/v1/communication/rs485/<id>/deviceid\"\n* Communication_Rs485_Modbus: \"web/v1/communication/rs485/<id>/modbus\"\n* Communication_Rs485_Modbus_AddDevice: \"web/v1/communication/rs485/<id>/modbus/add_device\"\n* Communication_Rs485_Modbus_RemoveDevice: \"web/v1/communication/rs485/<id>/modbus/remove_device\"\n* Communication_Wifi: \"web/v1/communication/wifi\"\n* Communication_Wifi_Wps: \"web/v1/communication/wifi/wps\"\n* Communication_Wifi_Connect: \"web/v1/communication/wifi/connect\"\n* Communication_Cellular: \"web/v1/communication/cellular\"\n* Communication_Zigbee_Defaults: \"web/v1/communication/zigbee/defaults\"\n* Communication_Zigbee_ModuleConfigs: \"web/v1/communication/zigbee/module_configs\"\n* Communication_Zigbee_OpMode: \"web/v1/communication/zigbee/op_mode\"\n* Communication_Gpio_Pri: \"web/v1/communication/gpio/pri\"\n* Communication_ModbusTcp: \"web/v1/communication/modbus_tcp\"\n* PowerControl: \"web/v1/power_control\"\n* PowerControl_GridControl: \"web/v1/power_control/grid_control\"\n* PowerControl_EnergyManager_LimitControl: \"web/v1/power_control/energy_manager/limit_control\"\n* PowerControl_EnergyManager_EnergyControl: \"web/v1/power_control/energy_manager/energy_control\"\n* PowerControl_EnergyManager_StorageControl: \"web/v1/power_control/energy_manager/storage_control\"\n* PowerControl_ReactivePower: \"web/v1/power_control/reactive_power\"\n* PowerControl_ActivePower: \"web/v1/power_control/active_power\"\n* PowerControl_Wakeup: \"web/v1/power_control/wakeup\"\n* PowerControl_Advanced: \"web/v1/power_control/advanced\"\n* PowerControl_Reset: \"web/v1/power_control/reset\"\n* PowerControl_Rrcr: \"web/v1/power_control/rrcr\"\n* Maintenance: \"web/v1/maintenance\"\n* Maintenance_DateTime: \"web/v1/maintenance/date_and_time\"\n* Maintenance_ResetCounters: \"web/v1/maintenance/reset_counters\"\n* Maintenance_ResetFactory: \"web/v1/maintenance/reset_factory\"\n* Maintenance_Afci: \"web/v1/maintenance/afci\"\n* Maintenance_AfciTest: \"web/v1/maintenance/afci/test\"\n* Maintenance_Inverters_SelfTest: \"web/v1/maintenance/inverters/<position>/self_test\"\n* Maintenance_Standby: \"web/v1/maintenance/standby\"\n* Maintenance_GridProtectionLogin: \"web/v1/maintenance/grid_protection/login\"\n* Maintenance_GridProtection: \"web/v1/maintenance/grid_protection\"\n* Maintenance_UpgradeUsb: \"web/v1/maintenance/fw_upgrade/usb\"\n* Information: \"web/v1/information\"\n* Status: \"web/v1/status\"\n* Status_ServerCommTest: \"web/v1/status/server_comm_test\"\n\nThe Status endpoint appears to the most useful for realtime production data.\nOptimizer level data is available from the maintenance API endpoint.\n\n\n## Using the API\n\nAll endpoints I have explored so far appear to be a GET, and responses use [Protocol Buffers](https://developers.google.com/protocol-buffers/).  There is no authentication\n\n### View Raw Response\n\nYou can see the raw data by doing the following (assuming you have the protoocal buffers CLI tool installed)\n\n```\ncurl -s http://<inverter ip>/web/v1/status | protoc --decode_raw\n```\n\nMany numbers appear to be 32 bit floating point.\n\nThe proto definitions required to fully parse the responses are available in  javascript if you choose \"view source\" in the developer tools of your browser.\n\n### View Parsed response\n\nIf there is a corresponding `.proto` file in [message_types](/message_types), you can view the parsed response from the API.  Each proto file correspond to the name of an API endpoint. These are very much a WIP and may be incomplete.  These can be created by choosing \"view source\" in the developer tools of your browser, and searching for text like `proto.web_status.<apiNameInCamelCase>.toObject`\n\nHere is an example for the status API:\n\n```\ncurl -s http://<inverter ip>/web/v1/status | protoc --decode Status message_types/status.proto\n```\n\n### Updating Protocol Buffer response\n\nTo add or change the Protocol Buffer defintions, please do the following\n\n1. Manually change the `message_types/*.proto` files as required\n2. Test the file using `curl` as described in [View Parsed Response](#view-parsed-response)\n3. Update the generated `*_pb2.py` files for each file changed by running a command like:\n\n    ```\n    protoc -I=message_types --python_out=solaredge_local message_types/<filename_changed>.proto\n    ```\n4. Commit the generated updates\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/drobtravels/solaredge-local",
        "keywords": "",
        "license": "MIT License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "solaredge-local",
        "package_url": "https://pypi.org/project/solaredge-local/",
        "platform": "any",
        "project_url": "https://pypi.org/project/solaredge-local/",
        "project_urls": {
            "Homepage": "https://github.com/drobtravels/solaredge-local"
        },
        "release_url": "https://pypi.org/project/solaredge-local/0.2.0/",
        "requires_dist": [
            "uplink",
            "uplink-protobuf"
        ],
        "requires_python": ">=3.0",
        "summary": "API wrapper to communicate locally with SolarEdge Inverters",
        "version": "0.2.0"
    },
    "last_serial": 5312751,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "58b54140cd16a86af053f99000171597",
                    "sha256": "3131a2cf061e53eddd11a8e45ee5044afab77c82dd8830095059a584d392868d"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "58b54140cd16a86af053f99000171597",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10691,
                "upload_time": "2019-03-31T20:09:13",
                "url": "https://files.pythonhosted.org/packages/43/80/8ed99770cafd36468247d0e9a50cd3ae7f142f1e180d708fc7b5398d3bc3/solaredge_local-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "dc5839a9235a8df667456f8ed91d7b6f",
                    "sha256": "330e45ba94c36d70c6f494e4874089c9f01330fb700c5e2c3c6afda91cdd6beb"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "dc5839a9235a8df667456f8ed91d7b6f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12015,
                "upload_time": "2019-03-31T20:09:15",
                "url": "https://files.pythonhosted.org/packages/30/00/5a368bb0158759b8ce4ef0c839c18f41c9624bb8dd99bd26b7b28536241d/solaredge_local-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ea146e539226d9ce30093ffc0876161e",
                    "sha256": "ca78f23ef2403d8aaa931543c01b7636b24019e9aa7efce160ca8bd855e48353"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ea146e539226d9ce30093ffc0876161e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 10700,
                "upload_time": "2019-03-31T20:35:10",
                "url": "https://files.pythonhosted.org/packages/4a/30/ae4a40825ebb6968cf9ac87f867877347f69d46d1bc7bba3e40503a26f11/solaredge_local-0.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2105cd75c3611e14c12b60fe6b4868d5",
                    "sha256": "e26e94636554bdd5eb60e89577ece459b93fcc3bc13226626d21bc6071b1bd11"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "2105cd75c3611e14c12b60fe6b4868d5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12022,
                "upload_time": "2019-03-31T20:35:12",
                "url": "https://files.pythonhosted.org/packages/ff/f1/e467c9c90d5d25cc2e4ce3c5ef27297f13bda623edab1fd2fef7748f4644/solaredge_local-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3d6d7383496fb817b818368a812a50fc",
                    "sha256": "70430aa6eeb9fe6aa5745ab907a0914a0db83e2ebcff66adfce848194a2a7592"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3d6d7383496fb817b818368a812a50fc",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 10904,
                "upload_time": "2019-04-01T00:19:29",
                "url": "https://files.pythonhosted.org/packages/b4/0d/f48836e05b7ced0655de04f8d934afc9f439e4e61726741b6f570299604f/solaredge_local-0.1.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "be970d0cbe8f699adcd7cbcff0c6e7ee",
                    "sha256": "915bcf7f6b9037b28569ca9d2b315bbf9a44e044ea3439f9e75dc1a3806e42fa"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "be970d0cbe8f699adcd7cbcff0c6e7ee",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 12437,
                "upload_time": "2019-04-01T00:19:31",
                "url": "https://files.pythonhosted.org/packages/a9/a6/0ec476eda6f32af2f99d01ba71bc2d132d2104a4d5458920b84aca32fa8e/solaredge_local-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "74a2accb938462a778248aeaf92fc2d6",
                    "sha256": "79cdaefc7c4f8fb07bd391b35706921348d561c3a6ac0979837d0826d2e017cf"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "74a2accb938462a778248aeaf92fc2d6",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 10906,
                "upload_time": "2019-05-08T00:53:51",
                "url": "https://files.pythonhosted.org/packages/c0/cf/1beceb7cb1b24d9c954557fee77d5880d56f7c47f8b12795f87ffa5df131/solaredge_local-0.1.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e8caddf5b7fe67094e426ef0888cc7de",
                    "sha256": "0d2b911f5b0ebd252cd1fc74dcc19bb6a93e4ea8a81cc30ff8a7fe7fdbc01b42"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "e8caddf5b7fe67094e426ef0888cc7de",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 12461,
                "upload_time": "2019-05-08T00:53:52",
                "url": "https://files.pythonhosted.org/packages/87/b1/eb9137dd239d20e5970575f6dc2a0dcc577239575812485bffcd4570805a/solaredge_local-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3673e0021bc6971ce53985cd0df4f16b",
                    "sha256": "3160fa3926727c9e25ec678551c7a80651edb930b901cb14348648b2f82a20fc"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3673e0021bc6971ce53985cd0df4f16b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 10907,
                "upload_time": "2019-05-09T00:28:23",
                "url": "https://files.pythonhosted.org/packages/1b/0e/015b7130881809fd20ed75805bc9acf045150cf0cb7e49a6761ad2141ed3/solaredge_local-0.1.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fd84047055d32d3f8d7a1f7b757e69fa",
                    "sha256": "a5de76178155c8cd28ed4417305132a5aa9890abe64e351de90fb8a705458831"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "fd84047055d32d3f8d7a1f7b757e69fa",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 12457,
                "upload_time": "2019-05-09T00:28:25",
                "url": "https://files.pythonhosted.org/packages/95/6f/133f93cf0dbe1593ac318068fbd4fc00e3a602a7ffd43ae9a68c054776b9/solaredge_local-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "43f859d8142d6ea7501c92435df827fa",
                    "sha256": "7c096f0518951801cc1ea5de85b843b06f60726c2977b041d7eb4c67ee7e6c4d"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.5-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "43f859d8142d6ea7501c92435df827fa",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 12266,
                "upload_time": "2019-05-20T10:45:38",
                "url": "https://files.pythonhosted.org/packages/27/96/5ad9dff13748ef03abf6256d5576c3f4ad5d8b5d095c0d6ddd20edaff61d/solaredge_local-0.1.5-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "1f551b54d3d183535473fef385ca89ec",
                    "sha256": "64a1ca899880cd596889ca68a30fefc1749f030bbcd1023e73b0f80041a1310b"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "1f551b54d3d183535473fef385ca89ec",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 14571,
                "upload_time": "2019-05-20T10:45:40",
                "url": "https://files.pythonhosted.org/packages/34/ab/69cdc3079f869aa7031da41f0fa72aefeb1cb35f8aee5e8ca05f8a002485/solaredge_local-0.1.5.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0c4e5844ed834670d26c14f3dc8fab40",
                    "sha256": "c70e8a6bff988c3dc302ef34e692abd48533a7134ec86407081928c22de4829c"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0c4e5844ed834670d26c14f3dc8fab40",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.0",
                "size": 20227,
                "upload_time": "2019-05-24T13:17:05",
                "url": "https://files.pythonhosted.org/packages/f3/3c/a5a15caa26e03c87247b94f3a7356a1a8bded55275e2af17880182cb48fe/solaredge_local-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "09ad3ae29ece72a8db56a3a63b0b392a",
                    "sha256": "5e0675f64303c9ba49e6f845f9ae8a38be106017b36544f2ff1a6121bfc708d7"
                },
                "downloads": -1,
                "filename": "solaredge_local-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "09ad3ae29ece72a8db56a3a63b0b392a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.0",
                "size": 21602,
                "upload_time": "2019-05-24T13:17:07",
                "url": "https://files.pythonhosted.org/packages/8d/f9/53910a21930fef60a588cd27776b62fcc1b538eb9daf93884668bb7c7af0/solaredge_local-0.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0c4e5844ed834670d26c14f3dc8fab40",
                "sha256": "c70e8a6bff988c3dc302ef34e692abd48533a7134ec86407081928c22de4829c"
            },
            "downloads": -1,
            "filename": "solaredge_local-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c4e5844ed834670d26c14f3dc8fab40",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 20227,
            "upload_time": "2019-05-24T13:17:05",
            "url": "https://files.pythonhosted.org/packages/f3/3c/a5a15caa26e03c87247b94f3a7356a1a8bded55275e2af17880182cb48fe/solaredge_local-0.2.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "09ad3ae29ece72a8db56a3a63b0b392a",
                "sha256": "5e0675f64303c9ba49e6f845f9ae8a38be106017b36544f2ff1a6121bfc708d7"
            },
            "downloads": -1,
            "filename": "solaredge_local-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "09ad3ae29ece72a8db56a3a63b0b392a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 21602,
            "upload_time": "2019-05-24T13:17:07",
            "url": "https://files.pythonhosted.org/packages/8d/f9/53910a21930fef60a588cd27776b62fcc1b538eb9daf93884668bb7c7af0/solaredge_local-0.2.0.tar.gz"
        }
    ]
}