Skip to main content

A python package for Shelly Cloud API. Shelly is devoted to the development of innovative IoT solutions and products.

Project description

Shelly Easy Smart Home Automation

SHELLY: The go-to access control for smart homes.

This Python library provides convenient access to the Shelly cloud API, allowing you to manage your relays, rollers and lights.

Shelly Shop
Request Feature/Suggestion: https://forms.gle/efGD5DuTpWsX96GG7

Download stats

Downloads

Installation

pip install shelly_control

Shelly supports Python 3+.

Usage

Default

import shelly_control

Authentication

Before making requests, you need to authenticate using your Shelly API key. Initialize the Connect class with your API key:

from shelly_control import Connect

base_url = "Your Cloud Server Address"
api_key = "Your Authorization cloud key"
sh = Connect(base_url,api_key)

OR

import shelly_control 

base_url = "Your Cloud Server Address"
api_key = "Your Authorization cloud key"
sh = shelly_control.Connect(base_url,api_key)

Get Key & Server address from here Shelly Control Cloud Dashboard

Relay

Fetch Devices

# Fetch device status
sh.get_device('device_id')

Control Devices

# Control device
sh.control_device(channel , 'on'/'off' , device_id)

Bulk Control Devices

# Bulk Control device
sh.bulk_control_relays('devices')

# Parameters:
#        - devices (list of dict): List of devices to control, each device should be a dictionary with keys:
#            - "id" (int): ID of the device.
#            - "channel" (int): Index of the relay or switch component.

Rollers

Control Roller Direction

# Control Roller
sh.control_roller_direction(direction , device_id)

Control Roller Position

# Control Roller
sh.control_roller_position(position , device_id)

Bulk Control Roller

# Bulk Control Roller
sh.bulk_control_rollers(device_id)

Lights

Control Lights

# Bulk Control Roller
sh.control_light(turn=None , white=None , red=None , green=None , blue=None , gain=None , device_id=None)

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

shelly_control-0.3.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shelly_control-0.3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file shelly_control-0.3.tar.gz.

File metadata

  • Download URL: shelly_control-0.3.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.8

File hashes

Hashes for shelly_control-0.3.tar.gz
Algorithm Hash digest
SHA256 1baf1193c9dea00233745f8fd0dc354db5289a18f9c0504440dbbec762332d5e
MD5 2e41daf7d99e15f1826c54eca4021cae
BLAKE2b-256 cae7b14d6ecf11d0ee1aa019506fa106eae171e71cbe904d5dc6f0a02ade1653

See more details on using hashes here.

File details

Details for the file shelly_control-0.3-py3-none-any.whl.

File metadata

  • Download URL: shelly_control-0.3-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.8

File hashes

Hashes for shelly_control-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b767cabf3d79351808512858493a3a77df892c81a759c6a240fda8979d86f3a3
MD5 dd5a877f1b46312405e1df337844a4eb
BLAKE2b-256 e6948569c0d90bca2d49b40c6f466fe86bfb3405ae8b05cb7d765031126f60a7

See more details on using hashes here.

Supported by

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