# SmartCocoon Python API
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)
[![pre-commit][pre-commit-shield]][pre-commit]
[![Black][black-shield]][black]
[![Project Maintenance][maintenance-shield]][user_profile]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
This Python library allows you to control [SmartCocoon fans](https://mysmartcocoon.com/).
## Status
This is not an official API from SmartCocoon and is in the the very early stages of developement.
This API is built for the main purpose of integrating into Home Assistant but can be used independently.
### Supported devices
- SmartCocoon Smart Vents
## Features
The following feature are supported:
- Connect to the SmartCocoon cloud service
- Obtain configuration data as it has been set up through the SmartCocoon mobile app
- Ability to control fans
- Turn on/off
- Set speed
- Set Auto mode
- Set Eco mode
## Examples
You can refer to the tests/test_integration.py to see an example of integration with the
SmartCocoon API
Copy the tests/template.env* to \_tests/.env* file and update the account information with your your SmartCocoon account information:
```python
USERNAME="user@domain.com"
PASSWORD="mypassword"
FAN_ID="abc123"
```
## Work to do
- The fans are using MQTT but this is not being leveraged yet
- Discovery has not been implemented, not sure if this is possible
- Fan status will currently require polling if the fan is changed directly in the app
[black]: https://github.com/psf/black
[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge
[buymecoffee]: https://www.buymeacoffee.com/davepearce
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/davecpearce/pysmartcocoon.svg?style=for-the-badge
[commits]: https://github.com/davecpearce/pymywatertoronto/commits/main
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/davecpearce/pysmartcocoon.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40davecpearce-blue.svg?style=for-the-badge
[pre-commit]: https://github.com/pre-commit/pre-commit
[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/davecpearce/pysmartcocoon.svg?style=for-the-badge
[releases]: https://github.com/davecpearce/pysmartcocoon/releases
[user_profile]: https://github.com/davecpearce
Raw data
{
"_id": null,
"home_page": null,
"name": "pysmartcocoon",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "smartcocoon, fan",
"author": null,
"author_email": "Dave Pearce <davepearce@live.com>",
"download_url": "https://files.pythonhosted.org/packages/66/b8/40d5bdcc8e994a625a6be8d1281b9403ff4491b7d469105ab26847f1db8c/pysmartcocoon-1.2.4.tar.gz",
"platform": null,
"description": "# SmartCocoon Python API\n\n[![GitHub Release][releases-shield]][releases]\n[![GitHub Activity][commits-shield]][commits]\n[![License][license-shield]](LICENSE)\n\n[![pre-commit][pre-commit-shield]][pre-commit]\n[![Black][black-shield]][black]\n\n[![Project Maintenance][maintenance-shield]][user_profile]\n[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]\n\n\n\nThis Python library allows you to control [SmartCocoon fans](https://mysmartcocoon.com/).\n\n## Status\n\nThis is not an official API from SmartCocoon and is in the the very early stages of developement.\n\nThis API is built for the main purpose of integrating into Home Assistant but can be used independently.\n\n### Supported devices\n\n- SmartCocoon Smart Vents\n\n## Features\n\nThe following feature are supported:\n\n- Connect to the SmartCocoon cloud service\n- Obtain configuration data as it has been set up through the SmartCocoon mobile app\n- Ability to control fans\n - Turn on/off\n - Set speed\n - Set Auto mode\n - Set Eco mode\n\n## Examples\n\nYou can refer to the tests/test_integration.py to see an example of integration with the\nSmartCocoon API\n\nCopy the tests/template.env* to \\_tests/.env* file and update the account information with your your SmartCocoon account information:\n\n```python\nUSERNAME=\"user@domain.com\"\nPASSWORD=\"mypassword\"\nFAN_ID=\"abc123\"\n```\n\n## Work to do\n\n- The fans are using MQTT but this is not being leveraged yet\n- Discovery has not been implemented, not sure if this is possible\n- Fan status will currently require polling if the fan is changed directly in the app\n\n[black]: https://github.com/psf/black\n[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge\n[buymecoffee]: https://www.buymeacoffee.com/davepearce\n[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge\n[commits-shield]: https://img.shields.io/github/commit-activity/y/davecpearce/pysmartcocoon.svg?style=for-the-badge\n[commits]: https://github.com/davecpearce/pymywatertoronto/commits/main\n[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge\n[forum]: https://community.home-assistant.io/\n[license-shield]: https://img.shields.io/github/license/davecpearce/pysmartcocoon.svg?style=for-the-badge\n[maintenance-shield]: https://img.shields.io/badge/maintainer-%40davecpearce-blue.svg?style=for-the-badge\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge\n[releases-shield]: https://img.shields.io/github/release/davecpearce/pysmartcocoon.svg?style=for-the-badge\n[releases]: https://github.com/davecpearce/pysmartcocoon/releases\n[user_profile]: https://github.com/davecpearce\n",
"bugtrack_url": null,
"license": null,
"summary": "Library built for Home Assistant to integrate with the SmartCocoon",
"version": "1.2.4",
"project_urls": {
"Homepage": "https://github.com/davecpearce/pysmartcocoon"
},
"split_keywords": [
"smartcocoon",
" fan"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "891ecc66e5faf4d751e06200fa96eba85208dab135d5764729b8aaba69bbbb37",
"md5": "29b97f2df2c8e53022eb8720deee0e50",
"sha256": "26e00041cdf9d0dc1c9f0793ff6a1c5eb5ce67330467b318d5d48d966c07797f"
},
"downloads": -1,
"filename": "pysmartcocoon-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29b97f2df2c8e53022eb8720deee0e50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 12342,
"upload_time": "2024-11-23T19:34:49",
"upload_time_iso_8601": "2024-11-23T19:34:49.821066Z",
"url": "https://files.pythonhosted.org/packages/89/1e/cc66e5faf4d751e06200fa96eba85208dab135d5764729b8aaba69bbbb37/pysmartcocoon-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66b840d5bdcc8e994a625a6be8d1281b9403ff4491b7d469105ab26847f1db8c",
"md5": "a2a13f83d46644eb38e83beceb5e78bc",
"sha256": "51bc3724ee23c9bb1c875e7f4279d86362aa8a1a71f2b280bd20742e28979b0e"
},
"downloads": -1,
"filename": "pysmartcocoon-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "a2a13f83d46644eb38e83beceb5e78bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 11220,
"upload_time": "2024-11-23T19:34:50",
"upload_time_iso_8601": "2024-11-23T19:34:50.681744Z",
"url": "https://files.pythonhosted.org/packages/66/b8/40d5bdcc8e994a625a6be8d1281b9403ff4491b7d469105ab26847f1db8c/pysmartcocoon-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-23 19:34:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davecpearce",
"github_project": "pysmartcocoon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": [
[
"==",
"3.10.4"
]
]
},
{
"name": "async-timeout",
"specs": [
[
"==",
"4.0.3"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
}
],
"lcname": "pysmartcocoon"
}
JSON
