aficustree / nx584ADPlugin

This is a plugin to the pynx584 module to enable connectivity to Apple's Homekit via Homebridge using the AlarmDecoder Platform Homebridge Plugin. This plugin is installed via pip and dynamically loaded into the pynx584 module at runtime via the stevedore plugin system.

Plugin for the NX584 Python Module to connect to Homebridge Alarm System Platform

This is a plugin to the pynx584 module to enable connectivity to Apple's Homekit via Homebridge using the AlarmDecoder Platform Homebridge Plugin. This plugin is installed via pip and dynamically loaded into the pynx584 module at runtime via the stevedore plugin system.

Installation

Normal Approach:

1. Clone repo git clone https://github.com/aficustree/nx584ADPlugIn
2. Change to directory where cloned cd ./nx584ADPlugIn/nx584ADPlugIn
3. Install via pip3 install .
4. Edit configuration file and place in home directory
5. Run pynx584 server module nx584_server --serial /dev/ttyS0 --baud 38400 (or equiv)
6. Enjoy

If integrating into Dockerized nx584:

The pynx584 module includes plugin support by mapping a directory on your host machine to the nx584 docker container. This allows the container to load multiple plugins by copying each plugin to the /plugins folder and updating the requirements.txt file with the appropriate path.

Configuration

System will search for a configuration file (.nx584ADPlugIn.cfg) in the pip installation folder, the working directory and your home directory (in that order). It will use the LAST FILE FOUND.

See the sample configuration file for details

License

Copyright 2018, aficustree

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.