SinricPro Python SDK
Official Python SDK for SinricPro - Control your IoT devices with Alexa and Google Home.
Features
- ✅ Easy to Use - Simple, pythonic API with async/await support
- ✅ Type Safe - Full type hints for better IDE support and error detection
- ✅ Voice Control - Works with Alexa and Google Home
- ✅ Real-time - WebSocket-based bidirectional communication
- ✅ Secure - HMAC-SHA256 message signatures
- ✅ Reliable - Auto-reconnection and heartbeat monitoring
- ✅ Flexible - Support for multiple device types and capabilities
- ✅ Cross-Platform - Works on Linux, Windows, macOS, and Raspberry Pi
Supported Devices
Lighting & Switches:
- Smart Switch - On/Off control
- Smart Light - RGB color, brightness, color temperature
- Dimmable Switch - On/Off with brightness control
Sensors:
- Motion Sensor - Detect movement
- Contact Sensor - Door/window open/closed detection
- Temperature Sensor - Temperature and humidity monitoring
- Air Quality Sensor - PM1.0, PM2.5, PM10 measurements
- Power Sensor - Voltage, current, power monitoring
Control Devices:
- Blinds - Position control (0-100%)
- Garage Door - Open/close control
- Smart Lock - Lock/unlock control
Climate Control:
- Thermostat - Temperature control with modes (AUTO, COOL, HEAT, ECO)
- Window AC - Air conditioning control
Other Devices:
- Fan - On/Off control
- Doorbell - Doorbell press events
Installation
pip install sinricpro
Requirements
- Python 3.10 or higher
websocketslibrary (automatically installed)
Platform Support
The SDK works on:
- Linux (Ubuntu, Debian, Raspberry Pi OS, etc.)
- Windows 10/11
- macOS 10.14+
- Raspberry Pi (All models with Python 3.10+)
Logging
Enable debug logging to see detailed information:
from sinricpro import SinricProLogger, LogLevel
# Set log level
SinricProLogger.set_level(LogLevel.DEBUG)
Available log levels: DEBUG, INFO, WARN, ERROR, NONE
Development
Setup Development Environment
# Clone the repository
git clone https://github.com/sinricpro/python-sdk.git
cd python-sdk
# Install development dependencies
pip install -e ".[dev]"
# Import sinricpro for development.
```python
import sys
from pathlib import Path
from typing import Any
sys.path.insert(0, str(Path(__file__).parent.parent.parent))
from sinricpro import SinricPro, SinricProAirQualitySensor, SinricProConfig
Run tests
pytest
Format code
black .
Type check
mypy sinricpro
Running Examples
# Set environment variables
export SINRICPRO_APP_KEY="your-app-key"
export SINRICPRO_APP_SECRET="your-app-secret"
# Run an example
python examples/switch/switch_example.py
API Reference
Full API documentation is available at Read the Docs (Coming soon!)
Troubleshooting
Connection Issues
- Check credentials - Ensure APP_KEY and APP_SECRET are correct
- Check device ID - Verify the device ID is exactly 24 hexadecimal characters
- Check network - Ensure you have internet connectivity
- Enable debug logging - Set
debug=Truein config to see detailed logs
Common Errors
"Invalid app_key format"
- App key must be a valid UUID (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
"Invalid app_secret: must be at least 32 characters"
- App secret must be at least 32 characters long
"Invalid device_id format"
- Device ID must be exactly 24 hexadecimal characters
Support
- Documentation: help.sinric.pro
- Community: Discord
- Issues: GitHub Issues
- Email: support@sinric.pro
License
Copyright (c) 2019-2025 Sinric. All rights reserved.
This project is licensed under the Creative Commons Attribution-Share Alike 4.0 International License (CC BY-SA 4.0) - see the LICENSE file for details.
You are free to share and adapt this work for any purpose (including commercially), as long as you give appropriate credit and distribute your contributions under the same license.
Acknowledgments
- Based on the official SinricPro C++ SDK
- Inspired by the SinricPro Node.js SDK
Related Projects
Vibe Coding
If you are to develop agent via vibe coding the llms.txt and the llms-full.txt can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.
Made with ❤️ by the SinricPro Team
Release files for sinricpro 5.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sinricpro-5.3.2.tar.gz | 43.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sinricpro-5.3.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:125.1 kB
Release files / sinricpro-5.3.2.tar.gz
| Download URL | sinricpro-5.3.2.tar.gz |
|---|---|
| Size | 43.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9be2422626147a20f3597ab24278e7a98e5b81960d2d1547992141a7c87b75ff
|
|
BLAKE2b-256 checksum How to use checksums |
6beb4e6428db6726e2deab195974a75963f3993baef015b29b3ea5c47f516db5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.2
|
Release files / sinricpro-5.3.2-py3-none-any.whl
| Download URL | sinricpro-5.3.2-py3-none-any.whl |
|---|---|
| Size | 81.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bf2461aad8bcb3a7e1fa558fd9063db6d2f15bd9b2e9ff23fab290994b48aaca
|
|
BLAKE2b-256 checksum How to use checksums |
9ccf8b7a230053b73e0163f2a29c45c4a7293a7ec791c26efa434d45514154dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.2
|
