PyShellyControl 0.1.0

A python library for controlling shelly devices

ShellyControl

ShellyControl is a Python library for controlling and managing Shelly smart devices via HTTP and MQTT protocols. It provides an easy-to-use interface to interact with Shelly devices, retrieve their status, configure settings, and perform actions such as OTA updates and reboots.

Features

• Supports communication with Shelly devices via HTTP and MQTT
• Retrieve device status, settings, and actions
• Perform OTA updates and reboots
• Factory reset Shelly devices
• MQTT authentication support
• Easily extensible for different Shelly models

Installation

To install ShellyControl, you need Python 3.7 or later. Install the required dependencies using pip:

pip install requests paho-mqtt

Alternatively, if you have a requirements.txt file, install the dependencies with:

pip install -r requirements.txt

Usage

Importing the Library

from shellycontrol import ShellyDevice

Creating a Shelly Device Instance

You can initialize a Shelly device using either HTTP or MQTT:

Using HTTP:

device = ShellyDevice(deviceID="shelly1", ip="192.168.1.100")

Using MQTT:

device = ShellyDevice(deviceID="shelly1", mqttBroker="mqtt.example.com", mqttPort=1883, username="user", password="pass")

Retrieve Device Status

status = device.getStatus()
print(status)

Retrieve Device Settings

settings = device.getSettings()
print(settings)

Retrieve Device Actions

actions = device.getActions()
print(actions)

Perform OTA Update

device.OTAUpdate()

Reboot Device

device.reboot()

Factory Reset

device.factoryReset()

Available Classes and Methods

ShellyDevice Class

Constructor

ShellyDevice(deviceID, ip=None, mqttBroker=None, mqttPort=1883, username=None, password=None)

• deviceID (str): Unique identifier of the Shelly device.
• ip (str, optional): IP address of the device (if using HTTP).
• mqttBroker (str, optional): MQTT broker address (if using MQTT).
• mqttPort (int, optional): MQTT broker port (default is 1883).
• username (str, optional): Username for authentication.
• password (str, optional): Password for authentication.

Methods

def sendHTTPRequest(endpoint, params=None)

• Sends an HTTP request to the Shelly device.
• endpoint (str): API endpoint (e.g., "status").
• params (dict, optional): Request parameters.
• Returns: JSON response if successful, else None.

def sendMQTTCommand(topic, payload)

• Sends an MQTT message.
• topic (str): MQTT topic.
• payload (str): Message payload.

def getStatus()

• Retrieves device status.
• Returns: JSON response with device status.

def getSettings()

• Retrieves device settings.
• Returns: JSON response with device settings.

def getActions()

• Retrieves available device actions.
• Returns: JSON response with device actions.

def OTAUpdate()

• Performs an over-the-air (OTA) update.

def reboot()

• Reboots the device.

def factoryReset()

• Resets the device to factory settings.

Supported Shelly Devices

ShellyControl is designed to work with multiple Shelly devices, including:

• Shelly 3EM
• Shelly Dimmer 2
• Shelly Duo E27/GU10
• Shelly Plug
• Shelly Plus 1/1PM/2PM
• Shelly Pro 1/1PM/2/2PM/3/4PM
• Shelly RGBW2
• Shelly TRV
• Shelly Uni
• Shelly Vintage

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

License

This project is licensed under the MIT License.