Lightweight Python module to discover and control WeMo devices
Project description
Lightweight Python 2 and Python 3 module to discover and control WeMo devices.
This is a stripped down version of the Python API for WeMo devices, ouimeaux, with simpler dependencies.
Dependencies
pyWeMo depends on Python packages: requests, ifaddr and six
How to use
>>> import pywemo
>>> devices = pywemo.discover_devices()
>>> print(devices)
[<WeMo Insight "AC Insight">]
>> devices[0].toggle()If discovery doesn’t work on your network
On some networks discovery doesn’t work reliably, in that case if you can find the ip address of your Wemo device you can use the following code.
>>> import pywemo
>>> url = pywemo.setup_url_for_address("192.168.1.192", None)
>>> print(url)
http://192.168.1.192:49153/setup.xml
>>> device = pywemo.discovery.device_from_description(url, None)
>>> print(device)
<WeMo Maker "Hi Fi Systemline Sensor">Please note that discovery.device_from_description call requires a url with an IP address, rather than a hostnames. This is needed for the subscription update logic to work properly. In addition recent versions of the WeMo firmware may not accept connections from hostnames, and will return a 500 error.
The setup_url_for_address function will lookup a hostname and provide a suitable url with an IP address.
Device Reset and Setup
pywemo includes the ability to reset and setup devices, without using the Belkin app or needing to create a Belkin account. This can be particularly useful if the intended use is fully local control, such as using Home Assistant.
Reset can be performed with the reset method, which has 2 boolean input arguments, data and wifi. Setting data=True will reset data (“Clear Personalized Info” in the Wemo app), which resets the device name and clears the icon and rules. Setting wifi=True will clear wifi information (“Change Wi-Fi” in the Wemo app), which does not clear the rules, name, etc. Setting both to true is equivalent to a “Factory Restore” from the app. It should also be noted that devices contain a hardware reset procedure as well, so using the software is for convenience or if physical access is not available.
Device setup is through the setup method. The user must first connect to the devices locally broadcast access point, then discover the device there. Once done, pass the desired SSID and password (AES encryption only) to the setup method to connect it to your wifi network.
Important Note for Device Setup - OpenSSL is Required!
OpenSSL is used to encrypt the password by the pywemo library. It must be installed and available on the path via calling openssl with a terminal (or command prompt, if on Windows). This is not required if connecting the device to an open network, since that requires no password, although an open network certainly isn’t recommended.
Firmware Warning
Starting in May of 2020, Belkin started requiring users to create an account and login to the app (Android app version 1.25). In addition to the account, most of the app functionality now requires a connection to the cloud (internet access), even for simple actions such as toggling a switch. All of the commands that go through the cloud are encrypted and cannot be easily inspected. This raises the possibility that Belkin could, in the future, update Wemo device firmware and make breaking API changes that can not longer be deciphered. If this happens, pywemo may no longer function on that device. It would be prudent to upgrade firmware cautiously and preferably only after confirming that breaking API changes have not been introduced.
Developing
Setup and builds are fully automated. You can run build pipeline locally by running.
# Setup, build, lint and test the code:
./scripts/build.shLicense
The code in pywemo/ouimeaux_device is written and copyright by Ian McCracken and released under the BSD license. The rest is released under the MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pywemo-0.5.4.tar.gz.
File metadata
- Download URL: pywemo-0.5.4.tar.gz
- Upload date:
- Size: 49.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a9783f61a1467b9a0b923e6f72474634174482ca1570b6fffa58d22f0c2e8eea |
|
| MD5 | e81c289de7ceb28d219bf9c2b51051f5 |
|
| BLAKE2b-256 | f6f6c3659c11005079060a670cdd46fa5fc941692b1a4b6699e2d070b1352046 |
Provenance
File details
Details for the file pywemo-0.5.4-py3-none-any.whl.
File metadata
- Download URL: pywemo-0.5.4-py3-none-any.whl
- Upload date:
- Size: 56.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.4 CPython/3.7.9 Linux/5.4.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bb661cd72b0ad6c634f53c1efb09244bd0feebd075e55febbd814221bda6f2db |
|
| MD5 | c8f40a2ec46d56c9bec42ec7028a6986 |
|
| BLAKE2b-256 | 01fdb4b495714eadd98cf76a90b56cf1c65a10d966822aba66620add679a4548 |
