Skip to main content

Python API for talking to Veracontrollers

Project description

pyVera Build status PyPi version PyPi downloads

A simple Python library to control devices via the Vera controller (http://getvera.com/).

Based on https://github.com/jamespcole/home-assistant-vera-api

Additions to support subscriptions and some additional devices

How to use

>>> import pyvera

>>> controller = pyvera.VeraController("http://192.168.1.161:3480/")
>>> devices = controller.get_devices('On/Off Switch')
>>> devices
[VeraSwitch (id=15 category=On/Off Switch name=Bookcase Uplighters), VeraSwitch (id=16 category=On/Off Switch name=Bookcase device)]

>>> devices[1]
VeraSwitch (id=15 category=On/Off Switch name=Bookcase Uplighters)

>>> devices[1].is_switched_on()
False

>>> devices[1].switch_on()
>>> devices[1].is_switched_on()
True

>>> devices[1].switch_off()

Examples

There is some example code (that can also help with tracing and debugging) in the examples directory.

This will list your vera devices

$ ./examples/list_devices.py -u http://192.168.1.161:3480

This will show you events on a particular device (get the id from the example above)

$ ./examples/device_listener.py -u http://192.168.1.161:3480/  -i 26

If you have locks - this will show you information about them.

$ ./examples/show_lock_info.py -u http://192.168.1.161:3480/

View existing locks and PINs:

$ ./examples/show_lock_info.py -u http://192.168.1.161:3480/

Set a new door lock code on device 335:

$ ./examples/set_door_code.py -u http://192.168.1.161:3480/ -i 335 -n "John Doe" -p "5678"

Clear a existing door lock code from device 335:

$ ./examples/delete_door_code.py -u http://192.168.1.161:3480/ -i 335 -n "John Doe"

Debugging

You may use the PYVERA_LOGLEVEL environment variable to output more verbose messages to the console. For instance, to show all debug level messages using the list-devices implementation in the example directory, run something similar to:

$ PYVERA_LOGLEVEL=DEBUG ./examples/list-devices.py -u http://192.168.1.161:3480

Debugging inside home assistant

If you're running pyvera inside home assistant and need the debugging log traces, add the following to your configuration.yaml

logger:
    logs:
        pyvera: debug

Developing

Setup and builds are fully automated. You can run build pipeline locally by running.

# Setup, build, lint and test the code.
./scripts/build.sh

License

The initial code was initially was written by James Cole and released under the BSD license. The rest is released under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvera-0.3.15.tar.gz (24.9 kB view details)

Uploaded Source

Built Distribution

pyvera-0.3.15-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file pyvera-0.3.15.tar.gz.

File metadata

  • Download URL: pyvera-0.3.15.tar.gz
  • Upload date:
  • Size: 24.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure

File hashes

Hashes for pyvera-0.3.15.tar.gz
Algorithm Hash digest
SHA256 f65c0cc3785f398ca5baf6a0ae65906536bb0eadffe0d74b937e084c3d92d710
MD5 5262d7951456cf6fada5f0c2aecc3663
BLAKE2b-256 2d91a1e7a818a9ea84f3c0159c7173afc40485509aa7cf790ca61119356ab76d

See more details on using hashes here.

File details

Details for the file pyvera-0.3.15-py3-none-any.whl.

File metadata

  • Download URL: pyvera-0.3.15-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.7.12 Linux/5.11.0-1028-azure

File hashes

Hashes for pyvera-0.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 fbefe666324c1c8d74d239e43f8f96e66283e7ed11dcf30d161d3fcf075e91a6
MD5 c92ab83cec07b59eeb9828ec733da25d
BLAKE2b-256 4180935db840d2b9143e2e934a45926d62126a600cc0a26c61423952a498b557

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page