## alphaess
This Python library uses the Alpha ESS Open API to retrieve data on your Alpha ESS inverter, photovoltaic panels, and battery if you have one. This library is principally intended for use by my Home Assistant integration [https://github.com/CharlesGillanders/homeassistant-alphaESS]
## How to use
### 1. Sign up for an open API account
Register at https://open.alphaess.com/ for a (free) account to get your Developer ID (AppID) and Developer Secret (AppSecret).
Once registered, add your battery/inverter to the developer account via the web UI.
### Note
To be good internet citizens, it is advised that your polling frequency for any AlphaCloud endpoints are 10 seconds at a minimum.
# Methods
There are public methods in this module that duplicate the AlphaESS OpenAPI and provide wrappers for
+ https://openapi.alphaess.com/api/getEssList
+ https://openapi.alphaess.com/api/getLastPowerData
+ https://openapi.alphaess.com/api/getOneDayPowerBySn
+ https://openapi.alphaess.com/api/getOneDateEnergyBySn
+ https://openapi.alphaess.com/api/getChargeConfigInfo
+ https://openapi.alphaess.com/api/updateChargeConfigInfo
+ https://openapi.alphaess.com/api/getDisChargeConfigInfo
+ https://openapi.alphaess.com/api/updateDisChargeConfigInfo
All of the above are documented at https://open.alphaess.com/developmentManagement/apiList (Registration required)
+ getdata() - Attempts to get statistical energy data for use in Home Assistant for all registered Alpha ESS systems - will return None if there are issues retrieving data from the Alpha ESS API.
+ authenticate - Attempts to use https://openapi.alphaess.com/api/getEssList to validate authentication to the ALpha ESS API - will return True or False.
+ setbatterycharge (serial, enabled, dp1start, dp1end, dp2start, dp2end, chargecutoffsoc)
**Parameters:**
- `chargecutoffsoc` (float) % to stop charging from the grid at
- `enabled` (bool) True to charge from the grid, False do not
- `dp1start` (`datetime.time`) The start time of charging period 1 (the minutes must be one of :00, :15, :30, :45)
- `dp1end` (`datetime.time`) The end time of charging period 1 (the minutes must be one of :00, :15, :30, :45)
- `dp2start` (`datetime.time`) The start time of charging period 2 (the minutes must be one of :00, :15, :30, :45)
- `dp2end` (`datetime.time`) The end time of charging period 2 (the minutes must be one of :00, :15, :30, :45)
- `serial` (str) The serial number of the battery/inverter.
+ setbatterydischarge (serial, enabled, dp1start, dp1end, dp2start, dp2end, dischargecutoffsoc)
**Parameters:**
- `dischargecutoffsoc` (float) % to stop discharging from the battery at
- `enabled` (bool) True to discharge from the battery, False do not
- `dp1start` (`datetime.time`) The start time of charging period 1 (the minutes must be one of :00, :15, :30, :45)
- `dp1end` (`datetime.time`) The end time of charging period 1 (the minutes must be one of :00, :15, :30, :45)
- `dp2start` (`datetime.time`) The start time of charging period 2 (the minutes must be one of :00, :15, :30, :45)
- `dp2end` (`datetime.time`) The end time of charging period 2 (the minutes must be one of :00, :15, :30, :45)
- `serial` (str) The serial number of the battery/inverter.
Raw data
{
"_id": null,
"home_page": "https://github.com/CharlesGillanders/alphaess-openAPI",
"name": "alphaessopenapi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Charles Gillanders",
"author_email": "charles@charlesgillanders.com",
"download_url": "https://files.pythonhosted.org/packages/ee/9c/1c8d811e6e0cc2e29888608770517a4b801904fafcc3e7d62c8098704651/alphaessopenapi-0.0.11.tar.gz",
"platform": null,
"description": "## alphaess\nThis Python library uses the Alpha ESS Open API to retrieve data on your Alpha ESS inverter, photovoltaic panels, and battery if you have one. This library is principally intended for use by my Home Assistant integration [https://github.com/CharlesGillanders/homeassistant-alphaESS]\n\n## How to use\n\n### 1. Sign up for an open API account\nRegister at https://open.alphaess.com/ for a (free) account to get your Developer ID (AppID) and Developer Secret (AppSecret).\n\nOnce registered, add your battery/inverter to the developer account via the web UI.\n\n### Note\n\nTo be good internet citizens, it is advised that your polling frequency for any AlphaCloud endpoints are 10 seconds at a minimum.\n\n# Methods\n\nThere are public methods in this module that duplicate the AlphaESS OpenAPI and provide wrappers for\n\n+ https://openapi.alphaess.com/api/getEssList\n+ https://openapi.alphaess.com/api/getLastPowerData\n+ https://openapi.alphaess.com/api/getOneDayPowerBySn\n+ https://openapi.alphaess.com/api/getOneDateEnergyBySn \n+ https://openapi.alphaess.com/api/getChargeConfigInfo\n+ https://openapi.alphaess.com/api/updateChargeConfigInfo\n+ https://openapi.alphaess.com/api/getDisChargeConfigInfo\n+ https://openapi.alphaess.com/api/updateDisChargeConfigInfo\n\nAll of the above are documented at https://open.alphaess.com/developmentManagement/apiList (Registration required)\n\n+ getdata() - Attempts to get statistical energy data for use in Home Assistant for all registered Alpha ESS systems - will return None if there are issues retrieving data from the Alpha ESS API.\n+ authenticate - Attempts to use https://openapi.alphaess.com/api/getEssList to validate authentication to the ALpha ESS API - will return True or False.\n+ setbatterycharge (serial, enabled, dp1start, dp1end, dp2start, dp2end, chargecutoffsoc)\n**Parameters:**\n- `chargecutoffsoc` (float) % to stop charging from the grid at \n- `enabled` (bool) True to charge from the grid, False do not\n- `dp1start` (`datetime.time`) The start time of charging period 1 (the minutes must be one of :00, :15, :30, :45)\n- `dp1end` (`datetime.time`) The end time of charging period 1 (the minutes must be one of :00, :15, :30, :45)\n- `dp2start` (`datetime.time`) The start time of charging period 2 (the minutes must be one of :00, :15, :30, :45)\n- `dp2end` (`datetime.time`) The end time of charging period 2 (the minutes must be one of :00, :15, :30, :45)\n- `serial` (str) The serial number of the battery/inverter.\n\n+ setbatterydischarge (serial, enabled, dp1start, dp1end, dp2start, dp2end, dischargecutoffsoc)\n**Parameters:**\n- `dischargecutoffsoc` (float) % to stop discharging from the battery at \n- `enabled` (bool) True to discharge from the battery, False do not\n- `dp1start` (`datetime.time`) The start time of charging period 1 (the minutes must be one of :00, :15, :30, :45)\n- `dp1end` (`datetime.time`) The end time of charging period 1 (the minutes must be one of :00, :15, :30, :45)\n- `dp2start` (`datetime.time`) The start time of charging period 2 (the minutes must be one of :00, :15, :30, :45)\n- `dp2end` (`datetime.time`) The end time of charging period 2 (the minutes must be one of :00, :15, :30, :45)\n- `serial` (str) The serial number of the battery/inverter.\n",
"bugtrack_url": null,
"license": null,
"summary": "A python library to retrieve energy statistics from your Alpha ESS inverter by polling the Official Alpha ESS Open API.",
"version": "0.0.11",
"project_urls": {
"Homepage": "https://github.com/CharlesGillanders/alphaess-openAPI"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3f9a47a298248a471c5abd15eb09b2deffc87692bc3204b43e1b0f9a2aeae0ee",
"md5": "cb3ab33fa45b0bca4f72d4be053e5a89",
"sha256": "4d379edd1f1039a59d9628fefd235019b463802a307e1846036d3a4c150445e5"
},
"downloads": -1,
"filename": "alphaessopenapi-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb3ab33fa45b0bca4f72d4be053e5a89",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5616,
"upload_time": "2024-08-20T13:25:24",
"upload_time_iso_8601": "2024-08-20T13:25:24.609266Z",
"url": "https://files.pythonhosted.org/packages/3f/9a/47a298248a471c5abd15eb09b2deffc87692bc3204b43e1b0f9a2aeae0ee/alphaessopenapi-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee9c1c8d811e6e0cc2e29888608770517a4b801904fafcc3e7d62c8098704651",
"md5": "f5ed86cd430b134b3a99e15de295c40e",
"sha256": "ad78cc8c1dfe6495606c09a4d7a04a040f058ac0f68b1cc00267773c4b4f51aa"
},
"downloads": -1,
"filename": "alphaessopenapi-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "f5ed86cd430b134b3a99e15de295c40e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5136,
"upload_time": "2024-08-20T13:25:26",
"upload_time_iso_8601": "2024-08-20T13:25:26.165920Z",
"url": "https://files.pythonhosted.org/packages/ee/9c/1c8d811e6e0cc2e29888608770517a4b801904fafcc3e7d62c8098704651/alphaessopenapi-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 13:25:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CharlesGillanders",
"github_project": "alphaess-openAPI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "alphaessopenapi"
}
JSON
