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.16.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

pyvera-0.3.16-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyvera-0.3.16.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.18 Linux/6.8.0-1020-azure

File hashes

Hashes for pyvera-0.3.16.tar.gz
Algorithm Hash digest
SHA256 a59b829218500c72ef6330c5bb86b5cc02e912edadd4c4259a348b3f303c785a
MD5 7ab2bafca01e3681f8c14219649c9c33
BLAKE2b-256 782f9f08f3f56572acee73b4500b5969b824f5f8d09a5fbefb285a6ba00e5658

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyvera-0.3.16-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.8.18 Linux/6.8.0-1020-azure

File hashes

Hashes for pyvera-0.3.16-py3-none-any.whl
Algorithm Hash digest
SHA256 0145afafacab7f7962088045d721ec6a14ba80a9f9fa1b8e9ac36d1c722e67d1
MD5 eeef5a4f81d874f229e6481d19e9c171
BLAKE2b-256 0f561b4ef0376699061057dc0f520c7a60beffa25bad43c79aab5f9d49d2fea3

See more details on using hashes here.

Supported by

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