https://github.com/sinricpro/micropython-sinricpro-sdk
Micropython SinricPro SDK
https://github.com/sinricpro/micropython-sinricpro-sdk
Last synced: 8 months ago
JSON representation
Micropython SinricPro SDK
- Host: GitHub
- URL: https://github.com/sinricpro/micropython-sinricpro-sdk
- Owner: sinricpro
- Created: 2023-12-18T17:36:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T16:32:10.000Z (over 2 years ago)
- Last Synced: 2025-04-13T15:13:48.855Z (about 1 year ago)
- Language: Python
- Size: 139 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Micropython-SinricPro SDK
[](https://discord.gg/rq9vcRcSqA)
The simple way to control your MicroPython board with Amazon Alexa, Google Home, SmartThings, Homebridge and Node-RED.
Tutorials:
- ##### [How to turn on and off a Relay (ESP32)](https://help.sinric.pro/pages/tutorials/switch/micropython/how-to-turn-on-and-off-a-relay-using-micropython.html)
### Which device types are working as of now?
|Device Type |Supported ? | Example
|--- |--- |---
| `Switch` |
- - [x] Completed
| `Blinds` |
- - [x] Completed
| `Dimmable Switch` |
- - [x] Completed
| `Fan` |
- - [x] Completed
| `Garage Door` |
- - [x] Completed
| `Light` |
- - [x] Completed
| `Lock` |
- - [x] Completed
| `Thermostat` |
- - [x] Completed
| `TV` |
- - [x] Completed
| `AC Unit` |
- - [x] Completed
| `Temperature Sensor` |
- - [x] Completed
| `Motion Sensor` |
- - [x] Completed
| `Contact Sensor` |
- - [x] Completed
| `Speaker` |
- - [x] Completed
| `Custom Device Types` | Pending | -
### How do I install it?
Using mpremote: (pip install --user mpremote)
**make sure device is not connected to IDE**
```
mpremote mip install github:sinricpro/micropython-sinricpro-sdk
```
or
```
py -m mpremote connect mip install github:sinricpro/micropython-sinricpro-sdk
```
Using mip (in REPL):
```
import mip
mip.install("github:sinricpro/micropython-sinricpro-sdk")
```
SinrciPro library will be installed in the /lib folder. You can manually copy the `sinricpro` folder to /lib as well
## How can I use it?
Checkout the examples directory.
### Will it run on Microcontroller X?
Tested on
1. MicroPython v1.21.0 on 2023-10-05; Generic ESP32 module with ESP32
2. MicroPython v1.21.0 on 2023-10-06; Raspberry Pi Pico W with RP2040
### For development using PyMakr:
1. Install Micropython (https://docs.micropython.org/en/latest/esp32/tutorial/intro.html)
2. Install PyMakr in VSCode
3. VSCode -> Open Workspace from File -> micropython-sinricpro-sdk.code-workspace
4. Create a new file called main.py to code.
5. Connect to ESP32 in PyMakr -> Upload -> Hardreset device.
6. Please use Pylint for formatting (https://marketplace.visualstudio.com/items?itemName=ms-python.pylint)
### To remove the library manually:
```
import mip
mip.install("shutil")
import shutil
shutil.rmtree("/lib/sinricpro")
```
### To list files in ESP32 or PICOW
```
import os
def listdir(dir):
for i in os.listdir(dir):
print('{}/{}'.format(dir,i))
listdir("/")
```
## Join the community!
Join us on our [Official Discord Server](https://discord.gg/rq9vcRcSqA)!