aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJan200101 <sentrycraft123@gmail.com>2020-03-09 11:54:37 +0100
committerJan200101 <sentrycraft123@gmail.com>2020-03-09 11:54:37 +0100
commitdc4790c0e945cb26f7f026fff6650595fad09eec (patch)
tree3a4b0da2ddd2d2735a5a500d2d0c3dc6a073ca55 /README.md
parent209a0b958f694bd5ad2f0f691bf52893584438bf (diff)
downloadShellyPy-dc4790c0e945cb26f7f026fff6650595fad09eec.tar.gz
ShellyPy-dc4790c0e945cb26f7f026fff6650595fad09eec.zip
Update Readme and change filename of example
The README has been updated to point to the filename of the one and only example as well as word some things correctly and remove the (UNTESTED) next to Shelly 2.5 The filename of the example is a bit misleading its not using any devices with a /light/{index} endpoint and instead talks about a personal setup where a Shelly relay is used on a light switch.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index b78c2d1..7e844d6 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,11 @@ 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
+other packages like [pyShelly](https://github.com/StyraHem/pyShelly) only support CoAP or MSQT, neither I am comfortable with using in personal projects
## example
-here is a simple working example for the Shelly 1 that turns on whatever is hooked up to it
+here is a simple working example for the Shelly 1 that turns a relay on
```python
import ShellyPy
@@ -16,14 +16,14 @@ 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)
+this example with comments can be found on [examples/toggle_relay.py](examples/toggle_relay.py)
## devices
#### supported
- Shelly1
- Shelly1PM
- Shelly2
-- Shelly2.5 (untested)
+- Shelly2.5
- Shelly4Pro (untested)
- Shelly Plug (untested)
- Shelly PlugS (untested)
@@ -44,4 +44,4 @@ 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
+feel free to do whatever you want with it