From dc4790c0e945cb26f7f026fff6650595fad09eec Mon Sep 17 00:00:00 2001 From: Jan200101 Date: Mon, 9 Mar 2020 11:54:37 +0100 Subject: 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. --- README.md | 10 +++++----- examples/toggle_lights.py | 10 ---------- examples/toggle_relay.py | 10 ++++++++++ 3 files changed, 15 insertions(+), 15 deletions(-) delete mode 100644 examples/toggle_lights.py create mode 100644 examples/toggle_relay.py 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 diff --git a/examples/toggle_lights.py b/examples/toggle_lights.py deleted file mode 100644 index a2e10a5..0000000 --- a/examples/toggle_lights.py +++ /dev/null @@ -1,10 +0,0 @@ -import ShellyPy - -# try connecting to the Shelly device under that ip -device = ShellyPy.Shelly("192.168.0.5") -# WILL throw an exception if the device is not reachable, gives a bad response or requires a login - -device.relay(0, turn=True) # turn the relay at index 0 on -device.relay(0, turn=False) # same as bove but turn it off -device.relay(0, turn=True, delay=3) # turn the relay 0 on for 3 seconds then off -# most shelly devices only have 1 or 2 relays diff --git a/examples/toggle_relay.py b/examples/toggle_relay.py new file mode 100644 index 0000000..a2e10a5 --- /dev/null +++ b/examples/toggle_relay.py @@ -0,0 +1,10 @@ +import ShellyPy + +# try connecting to the Shelly device under that ip +device = ShellyPy.Shelly("192.168.0.5") +# WILL throw an exception if the device is not reachable, gives a bad response or requires a login + +device.relay(0, turn=True) # turn the relay at index 0 on +device.relay(0, turn=False) # same as bove but turn it off +device.relay(0, turn=True, delay=3) # turn the relay 0 on for 3 seconds then off +# most shelly devices only have 1 or 2 relays -- cgit v1.2.3