Skip to content

Latest commit

 

History

History
64 lines (39 loc) · 2.34 KB

README.md

File metadata and controls

64 lines (39 loc) · 2.34 KB

pyalmondplus

This is an API for the Home Assistant home automation. It is a wrapper for the Almond+ websocket interface. The Almond+ is a discontinued product from Securifi. It main goal was a wifi router, but they added zwave and zigbee radios and has some decent automation. But Home Assistant is better, so now with this API you can use the Almond+ as a zwave and zigbee hub.

See both https://www.home-assistant.io/ and https://forum.securifi.com/ for more information.

Getting Started

The project was developed on both Linux and OSX. So the virtual environment is not saved to the repository. So you must set it up first. After cloning ....

  1. python3 -m venv pyalmondplus/
  2. source pyalmondplus/bin/activate
  3. testapi --url ws://x.x.x.x:7681/root/password

In all examples of the URL x.x.x.x is the IP for and password is your password for the Almond+ When you run the testapi it will tell you the environment is correct and there is a connection to the Almond+. More details are in the "Installing" and "Testing" areas.

Prerequisites

The assumption is Home Assistant is up and running. The API uses python's websockets 5.0.

Installing

Not Sure what I need here either?

Running the tests

There is a testapi entry point console script for testing. It takes a --url parameter and it is the URL that connects to the Almond+. For example testapi --url ws://192.168.1.20:8671/root/password

Deployment

Need to: Add additional notes about how to deploy this on a live system

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Paul Enright - Started project

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to @kvldr for his jump start.
  • Also @rytilahti for helping me to learn how to setup the dev environment.
  • Hat tip to anyone whose code was used