diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 46 |
1 files changed, 45 insertions, 1 deletions
@@ -1,3 +1,47 @@ # ShellyPy not to be confused with [pyShelly](https://github.com/StyraHem/pyShelly) -Wrapper around the Shelly HTTP api +Python 2 and 3 Wrapper around the Shelly HTTP api + + +## why +other packages like [pyShelly](https://github.com/StyraHem/pyShelly) only support CoAP or MSQT, neither I am comfortable with using in something + + +## example +here is a simple working example for the Shelly 1 that turns on whatever is hooked up to it +```python +import ShellyPy + +device = ShellyPy.Shelly("192.168.0.5") + +device.relay(0, turn=True) +``` +this example with comments can be found on [examples/toggle_lights.py](examples/toggle_lights.py) + +## devices +#### supported +- Shelly1 +- Shelly1PM +- Shelly2 +- Shelly2.5 (untested) +- Shelly4Pro (untested) +- Shelly Plug (untested) +- Shelly PlugS (untested) +- Shelly Bulb (untested) +- Shelly H&T (untested) +- Shelly Smoke (untested) +- Shelly EM (untested) +- Shelly flood (untested) + +#### unsupported +- Shelly Sense (documentation is inaccurate, incomplete) +- Shelly RGBW (documentation is incomplete) + +## applicability +this wrapper is best used in closed networks where other solutions are either not an option or not desired +give your shelly devices static IP adresses for best results + + +## license +this project is licensed under the [MIT License](LICENSE) +feel free to do whatever you want with it
\ No newline at end of file |