Closed Pre10der closed 6 years ago
This is great, thanks! I wonder if it might be best integrated under the wiki tab? That way you (and others) can easily add and update it. Also, it will allow it to be split up a bit, as I think the HA-specific bits should probably be somewhat separate from the regular setup and use.
What do you think? I think by default anyone should be able to use the wiki, if you want to give it a try. I think you can probably just copy/paste what you have into a new wiki page. If that works, then I can commit a change to the main readme file with a link directing people there for more info.
Yep, I'm good with that approach. I'll put it in as is, and when time allows, break it up a bit.
I'm a bit new to GitHub, but I'll figure it out. Is the wiki disabled on this repo? When I hit wiki, it just takes me back to the main repo page....
I might've had to create a page first before it would advertise it or something. I just did that and put your stuff, with a few tweaks, into a few different pages. See if this works and verify that you can edit it:
Just tried updating the RPi Example page via github desktop and received this:
Got the invite. All fixed, and updates working correctly now.
Thanks!
Documentation content now moved to Wiki. Closing this issue.
Apparently I can't control it any more granularly than granting you full push access to the entire repository. So, please use care and probably limit any sort of push activity to the wiki :)
Thanks!
Understood and no problem at all. I'll stick to the wiki and use the issues section for any items relating to code changes.
Here is some additional documentation that I have put together that may be useful to users of the pynx584 library. It has some Raspberry Pi and Home Assistant specific components as they are fairly common use case for this library. It also contains some information on the NX-584E and its compatibility with related panels (namely the Networx NX and Hills Reliance series panels). This is a collection of information I have obtained that has not been easy to find else where, so hopefully it will help some others.
@kk7ds - I am not overly familiar with how to add this to the repo, so adding it here for you to merge into the README.rst as you see fit. I also feel some other nx584_client examples may be warranted. Once @lumavp has provided his info on the SMTP integration nx584_client panic functions, these can also be added into the mix. Hope you find it useful.
Merry Christmas!
Configuring the NX-584E Module for use with pynx584 The NX-584E module is an additional serial (RS232) module for the Networx NX (NX-4,NX-6,NX-8) series alarm panels and is designed for home automation tasks. This is built into the NX-8E boards by default. These alarm panels are also known as the Hills Reliance panels (R8/R12/R128) in some countries (e.g. Australia). Nb. The base models of these alarm panels only allows a single additional module to be installed. If you are using the NX-4/R8 panel and have another module already installed (such as an NX-595E/ComNav board), you will run into trouble with having both the NX-584E and the NX-595E/ComNav modules co-exist (the NX-595E/ComNav will appear to go offline). In this case, consider upgrading your alarm panel to a higher model such as the NX-8/R128. If the NX-584E is the only additional module installed on the base model panel, then you are good to go and the NX-584E should work as per the below.
The NX-584E module should be installed as per the installation instructions of the module and configured to allow only the required features. This is more of a security best practice than it is a compatibility issue. Best practice is to enable the baseline set of features, and then enable additional items on an as needs basis.
Depending on your deployment model, it would also be wise to ensure that the host running the pynx584 library and in turn the serial connection is secured so that other hosts on the network are unable to impact the security system. Remember, communications to pynx584 by default are unencrypted, and the NX-584E should be considered as a trusted and privileged device as it has direct access to the security systems data bus.
The below features can be used as a baseline set to allow interfacing with the pynx584 library.
Installing pynx584 on a Raspberry Pi w/USB to Serial Adapter
Install latest version of Minibian (or your favourite flavour of Raspbian)
Change locale, timezone etc:
sudo raspi-config
Undertake some mandatory configuration changes including password resets: Change root PW
passwd root
Add new user account (not root). Nb. Minibian does not have 'pi' user by default. This is not necessary for Raspbian distro's.adduser pi
Add user to sudo fileadduser pi sudo
Change hostname:nano /etc/hostname
Reset passwords for pi and root:
Install pynx584 for interfacing with alarm:
sudo pip3 install pynx584
Nb. You can upgrade pynx584 by running: sudo pip3 install pynx584 --upgradeInsert your USB to serial device and give permission to the USB device for the pi user account:
sudo usermod -a -G dialout pi
Nb. If the usb-to-serial device is not detected, you may need to run:apt-get install firmware-linux-free
Run pynx584_server at startup by modifying /etc/rc.local
sudo /etc/rc.local
Add the following line (or similar):sudo su - pi -c '/usr/local/bin/nx584_server --config /home/pi/config.ini --serial /dev/ttyUSB0 --baudrate 9600 --listen 192.168.1.100 --port 5007 --log /home/pi/nx584.log'
Nb. This will log output to /home/pi/nx584.log. Make sure log file exists, and that pi user has access to it (sudo chown pi /home/pi/nx584.log).By default, pynx584 should create a config.ini file. Some users have reported that this does not happen. You can work around this by creating the file manually in /home/pi/config.ini and adding/modifying the following config.ini contents:
[email] fromaddr = security@foo.com smtphost = imap.foo.com
[zones] 1 = Study 2 = Kitchen 3 = Hallway 1 4 = Hallway 2 5 = Pool Room 6 = Front Door 7 = Rear Door 8 = Garage Door
nx584_client -h nx584_server -h
alarm_control_panel:
binary_sensor: