Git Product home page Git Product logo

aficustree / nx584adplugin Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 7 KB

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.

License: Apache License 2.0

Python 100.00%

nx584adplugin's Introduction

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.

nx584adplugin's People

Contributors

aficustree avatar

Stargazers

Charles M Dellinger avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.