Skip to main content

Library built for Home Assistant to integrate with the SmartCocoon

Project description

SmartCocoon Python API

GitHub Release GitHub Activity License

pre-commit Black

Project Maintenance BuyMeCoffee

logo

This Python library allows you to control SmartCocoon fans.

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:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysmartcocoon-1.0.0.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

pysmartcocoon-1.0.0-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

Details for the file pysmartcocoon-1.0.0.tar.gz.

File metadata

  • Download URL: pysmartcocoon-1.0.0.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.4

File hashes

Hashes for pysmartcocoon-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8605f5ac9cb07ae3d6554a00d65f24462a4cf55c3b5010031a911baf95e9b184
MD5 e8a628371d99809276bcfe04c000ca48
BLAKE2b-256 fe97e7d16b81d80089f10f47f9f454b8224ad40604a7bef0171f04fd09d491fd

See more details on using hashes here.

File details

Details for the file pysmartcocoon-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pysmartcocoon-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 82689376df8016fef35a0906de63e9011f1b6540913e0200c990a3d357ad2fd0
MD5 4b0ea5c12d954938202c0a8c97b4eec1
BLAKE2b-256 26d973b5e6e52e1815b2510c2a55ec006e7325028abe33f5e3c2c602e296c887

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page