{"id":14985347,"url":"https://github.com/algorithmicentropy/solarwattenergymanagerapi","last_synced_at":"2025-04-11T15:32:24.881Z","repository":{"id":47176041,"uuid":"326070202","full_name":"AlgorithmicEntropy/SolarWattEnergyManagerAPI","owner":"AlgorithmicEntropy","description":"Python library to acces solar watt energy manager data","archived":false,"fork":false,"pushed_at":"2024-08-24T10:44:59.000Z","size":44,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-07T07:02:46.344Z","etag":null,"topics":["homeassistant","iot","python"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/LocalSolarWatt/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlgorithmicEntropy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-01T22:58:44.000Z","updated_at":"2024-08-24T10:42:21.000Z","dependencies_parsed_at":"2022-09-19T09:30:28.116Z","dependency_job_id":null,"html_url":"https://github.com/AlgorithmicEntropy/SolarWattEnergyManagerAPI","commit_stats":null,"previous_names":["sebastianwallat/solarwattenergymanagerapi"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgorithmicEntropy%2FSolarWattEnergyManagerAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgorithmicEntropy%2FSolarWattEnergyManagerAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgorithmicEntropy%2FSolarWattEnergyManagerAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlgorithmicEntropy%2FSolarWattEnergyManagerAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlgorithmicEntropy","download_url":"https://codeload.github.com/AlgorithmicEntropy/SolarWattEnergyManagerAPI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223472813,"owners_count":17150745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["homeassistant","iot","python"],"created_at":"2024-09-24T14:10:44.511Z","updated_at":"2024-11-07T07:04:21.329Z","avatar_url":"https://github.com/AlgorithmicEntropy.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LocalSolarWatt\nA python3 library to access the data of solar watt devices via local api  \nDisclaimer: This library uses an unofficial local api and could therefore break at any point\n\n# Overview\nThe package uses the kiwigrid api provided by your solar watt energy manager device.  \nData available:\n  - Real time power values from inverter, AC sensor and battery (if exists)\n  - Long term energy statistics\n\nThis library does some preprocessing by extracting relevant fields and grouping them by device class.  \nFor now this mostly includes data I deem usefully for the integration with home assistant.\n\nNote: Polling the energy manager with a very high interval often could lead to reliability issues (untested).\n\n# Supported devices\nAs I only have access to one installation and the api is as far as I'm aware not documented by SolarWatt, I can not guarantee that this library works with your setup.  \nIf you encounter issues with your concrete setup, feel free to open a new issue.  \nThe raw json data is available via `http://YOUR_DEVICE_IP/rest/kiwigrid/wizard/devices`  \nIf you can provide the raw json dump, I can try to add support for your device.  \n**Important Note**: This data does contain some sensitive information (especially for the \"Location\" device), so make sure to remove any sensitive data before sharing.\n\n## Installation\n\n```\npip install LocalSolarWatt\n```\n\n## Usage\n```\nfrom local_solar_watt import Api, WorkUnits, DeviceClass\n\n# create a new api objects\nenergy_api = Api('hostname or ip')\n\n# optional, change work units to Wh instead of kWh\napi = Api('hostname or ip', work_unit=WorkUnits.Wh)\n\n# optional, change log level\napi.set_log_level('WARNING')\n\n# test the connection (returns bool based on success)\nstatus, data = api.test_connection()\n\n# pull data from the device (returns only selected power values, grouped by device class)\nprint(api.pull_data())\n\n# You can also pull the raw json data for your own parsing needs\nprint(api.pull_raw())\n```\n\n# Tests:\nIf you want to run the tests locally make sure to set the following environment variables to correct IPs / hostnames\n```\nENERGY_MANAGER_HOST\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorithmicentropy%2Fsolarwattenergymanagerapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorithmicentropy%2Fsolarwattenergymanagerapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorithmicentropy%2Fsolarwattenergymanagerapi/lists"}