| Name | ecowater-softener-test JSON |
| Version |
2.2.2
JSON |
| download |
| home_page | https://github.com/figorr/ecowater-softener |
| Summary | This a forked version only for testing purposes. The original code is property of barleybobs, you can find it at ecowater-softener. A small package to pull data from Ecowater water softeners |
| upload_time | 2024-10-07 17:05:47 |
| maintainer | None |
| docs_url | None |
| author | figorr |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# **V2.0.0 BREAKING CHANGES**
**For version 2.0.0 the library has been rewritten and methods have changed.**
# Ecowater Softener
ecowater-softener-test is a Python library for collecting information from Ecowater water softeners.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install ecowater.
```bash
pip install ecowater-softener
```
## Usage
Liquids are measured in **US Gallons**, liquid speeds are measured in **US Gallons per Minute (gpm)**, and weights are measured in **Pounds (lbs)**
Importing the library
```python
import ecowater_softener
```
### Account
Initialize Ecowater account using username and password credentials
```python
ecowater_account = ecowater_softener.EcowaterAccount('username', 'password')
```
### Devices
Retrieve a list of all devices associated with the Ecowater account
```python
devices = ecowater_account.get_devices()
```
Access the first device from the list of devices
```python
device = devices[0]
```
Get / Update the devices values (Needs to be ran before accessing data or the data will return None)
```python
device.update()
```
### API Info
Get the date and time of the last successful API connection (datetime.datetime)
```python
last_api_call_successful = device.last_api_call_successful
```
Get the status from the API
```python
status = device.status
```
### Device Info
Get the device model (string)
```python
model = device.model
```
Get the device serial number (string)
```python
serial_number = device.serial_number
```
Get the device software version (string)
```python
software_version = device.software_version
```
Get the signal strength (rssi) (integer)
```python
rssi = device.rssi
```
Get the device ip address (string)
```python
ip_address = device.ip_address
```
### Water
Get the average daily water usage (integer)
```python
water_use_avg_daily = device.water_use_avg_daily
```
Get the amount of water used today (integer)
```python
water_use_today = device.water_use_today
```
Get the current amount of available water (integer)
```python
water_available = device.water_available
```
### Water Flow
Get the current water flow rate (float)
```python
current_water_flow = device.current_water_flow
```
### Salt
Get the current salt level as a percentage (float)
```python
salt_level_percentage = device.salt_level_percentage
```
Get the number of days until the device runs out of salt (integer)
```python
out_of_salt_days = device.out_of_salt_days
```
Get the estimated date when the device will run out of salt (datetime.date)
```python
out_of_salt_date = device.out_of_salt_date
```
Get the salt type, either "NaCl" or "KCl" (string)
```python
salt_type = device.salt_type
```
### Rock
Get the average amount of rock removed daily (float)
```python
rock_removed_avg_daily = device.rock_removed_avg_daily
```
Get the total amount of rock removed by the device over its lifetime (float)
```python
rock_removed = device.rock_removed
```
### Recharge
Get the recharge status, either "None", "Scheduled", or "Recharging" (string)
```python
recharge_status = device.recharge_status
```
Check if recharge is enabled (boolean)
```python
recharge_enabled = device.recharge_enabled
```
Check if a recharge is scheduled (boolean)
```python
recharge_scheduled = device.recharge_scheduled
```
Check if recharging currently (boolean)
```python
recharge_recharging = device.recharge_recharging
```
Get the number of days since the last recharge was performed (integer)
```python
last_recharge_days = device.last_recharge_days
```
Get the date of the last recharge (datetime.date)
```python
last_recharge_date = device.last_recharge_date
```
## Credits
- [Kyle Johnson](https://github.com/kylejohnson) for his work on using python to interface with Ecowater water softeners. Most of this libraries code was originally built upon code which he wrote. You can read his article regarding scraping data from Ecowater water softeners at https://gnulnx.net/2020/02/18/ecowater-api-scraping/
- [@rewardone](https://github.com/rewardone) for creating [ayla-iot-unofficial](https://github.com/rewardone/ayla-iot-unofficial) which is used to fetch the data
- [Jeff Rescignano](https://github.com/JeffResc) for creating [sharkiq](https://github.com/JeffResc/sharkiq) which [ayla-iot-unofficial](https://github.com/rewardone/ayla-iot-unofficial) is based on.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/figorr/ecowater-softener",
"name": "ecowater-softener-test",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "figorr",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3d/ce/e5a5e1890cb2f52595703a2dc793c3f449d107dc27206241d7d2fee5b1b0/ecowater_softener_test-2.2.2.tar.gz",
"platform": null,
"description": "# **V2.0.0 BREAKING CHANGES**\r\n**For version 2.0.0 the library has been rewritten and methods have changed.**\r\n\r\n# Ecowater Softener\r\n\r\necowater-softener-test is a Python library for collecting information from Ecowater water softeners.\r\n\r\n## Installation\r\n\r\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install ecowater.\r\n\r\n```bash\r\npip install ecowater-softener\r\n```\r\n\r\n## Usage\r\n\r\nLiquids are measured in **US Gallons**, liquid speeds are measured in **US Gallons per Minute (gpm)**, and weights are measured in **Pounds (lbs)**\r\n\r\nImporting the library\r\n\r\n```python\r\nimport ecowater_softener\r\n```\r\n\r\n### Account\r\n\r\nInitialize Ecowater account using username and password credentials\r\n\r\n```python\r\necowater_account = ecowater_softener.EcowaterAccount('username', 'password')\r\n```\r\n\r\n### Devices\r\n\r\nRetrieve a list of all devices associated with the Ecowater account\r\n\r\n```python\r\ndevices = ecowater_account.get_devices()\r\n```\r\n\r\nAccess the first device from the list of devices\r\n\r\n```python\r\ndevice = devices[0]\r\n```\r\n\r\nGet / Update the devices values (Needs to be ran before accessing data or the data will return None)\r\n\r\n```python\r\ndevice.update()\r\n```\r\n\r\n### API Info\r\n\r\nGet the date and time of the last successful API connection (datetime.datetime)\r\n\r\n```python\r\nlast_api_call_successful = device.last_api_call_successful\r\n```\r\n\r\nGet the status from the API\r\n\r\n```python\r\nstatus = device.status\r\n```\r\n\r\n### Device Info\r\n\r\nGet the device model (string)\r\n\r\n```python\r\nmodel = device.model\r\n```\r\n\r\nGet the device serial number (string)\r\n\r\n```python\r\nserial_number = device.serial_number\r\n```\r\n\r\nGet the device software version (string)\r\n\r\n```python\r\nsoftware_version = device.software_version\r\n```\r\n\r\nGet the signal strength (rssi) (integer)\r\n\r\n```python\r\nrssi = device.rssi\r\n```\r\n\r\nGet the device ip address (string)\r\n\r\n```python\r\nip_address = device.ip_address\r\n```\r\n\r\n### Water\r\n\r\nGet the average daily water usage (integer)\r\n\r\n```python\r\nwater_use_avg_daily = device.water_use_avg_daily\r\n```\r\n\r\nGet the amount of water used today (integer)\r\n\r\n```python\r\nwater_use_today = device.water_use_today\r\n```\r\n\r\nGet the current amount of available water (integer)\r\n\r\n```python\r\nwater_available = device.water_available\r\n```\r\n\r\n### Water Flow\r\n\r\nGet the current water flow rate (float)\r\n\r\n```python\r\ncurrent_water_flow = device.current_water_flow\r\n```\r\n\r\n### Salt\r\n\r\nGet the current salt level as a percentage (float)\r\n\r\n```python\r\nsalt_level_percentage = device.salt_level_percentage\r\n```\r\n\r\nGet the number of days until the device runs out of salt (integer)\r\n\r\n```python\r\nout_of_salt_days = device.out_of_salt_days\r\n```\r\n\r\nGet the estimated date when the device will run out of salt (datetime.date)\r\n\r\n```python\r\nout_of_salt_date = device.out_of_salt_date\r\n```\r\n\r\nGet the salt type, either \"NaCl\" or \"KCl\" (string)\r\n\r\n```python\r\nsalt_type = device.salt_type\r\n```\r\n\r\n### Rock\r\n\r\nGet the average amount of rock removed daily (float)\r\n\r\n```python\r\nrock_removed_avg_daily = device.rock_removed_avg_daily\r\n```\r\n\r\nGet the total amount of rock removed by the device over its lifetime (float)\r\n\r\n```python\r\nrock_removed = device.rock_removed\r\n```\r\n\r\n### Recharge\r\n\r\nGet the recharge status, either \"None\", \"Scheduled\", or \"Recharging\" (string)\r\n\r\n```python\r\nrecharge_status = device.recharge_status\r\n```\r\n\r\nCheck if recharge is enabled (boolean)\r\n\r\n```python\r\nrecharge_enabled = device.recharge_enabled\r\n```\r\n\r\nCheck if a recharge is scheduled (boolean)\r\n\r\n```python\r\nrecharge_scheduled = device.recharge_scheduled\r\n```\r\n\r\nCheck if recharging currently (boolean)\r\n\r\n```python\r\nrecharge_recharging = device.recharge_recharging\r\n```\r\n\r\nGet the number of days since the last recharge was performed (integer)\r\n\r\n```python\r\nlast_recharge_days = device.last_recharge_days\r\n```\r\n\r\nGet the date of the last recharge (datetime.date)\r\n\r\n```python\r\nlast_recharge_date = device.last_recharge_date\r\n```\r\n\r\n\r\n\r\n\r\n\r\n## Credits\r\n\r\n- [Kyle Johnson](https://github.com/kylejohnson) for his work on using python to interface with Ecowater water softeners. Most of this libraries code was originally built upon code which he wrote. You can read his article regarding scraping data from Ecowater water softeners at https://gnulnx.net/2020/02/18/ecowater-api-scraping/\r\n- [@rewardone](https://github.com/rewardone) for creating [ayla-iot-unofficial](https://github.com/rewardone/ayla-iot-unofficial) which is used to fetch the data\r\n- [Jeff Rescignano](https://github.com/JeffResc) for creating [sharkiq](https://github.com/JeffResc/sharkiq) which [ayla-iot-unofficial](https://github.com/rewardone/ayla-iot-unofficial) is based on.\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\n## License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "This a forked version only for testing purposes. The original code is property of barleybobs, you can find it at ecowater-softener. A small package to pull data from Ecowater water softeners",
"version": "2.2.2",
"project_urls": {
"Homepage": "https://github.com/figorr/ecowater-softener"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c97f737ad1d8a23270caa70a9c948800e587631395fa55a6d2f22e12ae94e195",
"md5": "6966f998e038b46e86178721222aa34f",
"sha256": "3e91ae998e3a25353eb8a34143f051c262f4b7a2d4c610524ff47eff54f51292"
},
"downloads": -1,
"filename": "ecowater_softener_test-2.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6966f998e038b46e86178721222aa34f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9443,
"upload_time": "2024-10-07T17:05:46",
"upload_time_iso_8601": "2024-10-07T17:05:46.290905Z",
"url": "https://files.pythonhosted.org/packages/c9/7f/737ad1d8a23270caa70a9c948800e587631395fa55a6d2f22e12ae94e195/ecowater_softener_test-2.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dcee5a5e1890cb2f52595703a2dc793c3f449d107dc27206241d7d2fee5b1b0",
"md5": "6209e7c43517fd9a2268c1fafef1c053",
"sha256": "5587ab0e522bddcebde64c9d0d6248efc7ff3c5784427ca97768caf9ac1af96d"
},
"downloads": -1,
"filename": "ecowater_softener_test-2.2.2.tar.gz",
"has_sig": false,
"md5_digest": "6209e7c43517fd9a2268c1fafef1c053",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10921,
"upload_time": "2024-10-07T17:05:47",
"upload_time_iso_8601": "2024-10-07T17:05:47.508331Z",
"url": "https://files.pythonhosted.org/packages/3d/ce/e5a5e1890cb2f52595703a2dc793c3f449d107dc27206241d7d2fee5b1b0/ecowater_softener_test-2.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 17:05:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "figorr",
"github_project": "ecowater-softener",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ecowater-softener-test"
}
