SABnzbd is a versatile tool written in Python specifically designed to take an NZB-File as input and then retrieve all of the content defined inside of it for you automatically. Recently there have been new improvements with SABnzbd in the past few releases. So I thought I’d share a working out of the box solution using RPMs. In addition to this, I’ve packaged up my notification script I wrote which can further enhance this great product.
SABnzbd and Usenet
First off; lets summarize Usenet for those who don’t use it or aren’t already familiar with it. In the simplest terms: Usenet is a great big fucking mess; a total disaster. It’s basically a location where literally anyone with access to it can post/upload all they want at their free will anonymously. Don’t get me wrong; this is cool too because it’s basically one very large hard drive without anyone telling you what you can and can’t place onto it. Seriously though, just consider for a second what your computer would look like if you allowed absolutely anyone who has access to the internet to upload content freely and without rules to it. You’d probably run out of hard disk space quickly; and you’ll be left with a lot of content everywhere. Well; that’s exactly what Usenet is (greatly simplified); it’s one large centralized location filled with petabytes of data. The thing with Usenet though is… it isn’t, and won’t be running out of disk space anytime soon.
The good news is, (thankfully) people sift through the heaps of information constantly being posted (onto Usenet) using automated tools regularly. These tools that do the sifting are generally known as Indexers. I talk more about this in another blog I wrote here a while back. But basically whenever an Indexer finds some useful data, it records the location as to where it was found. Indexers record this information in a special file call an NZB-File. NZB-Files are effectively treasure maps containing the coordinates on Usenet to which a specific piece of data can be located at. NZB-Files are like Treasure Maps
It should be known that if you’re planning on posting/uploading stuff to Usenet yourself (for backup purposes or what have you), most (good) software will generate you an NZB-File afterwards allowing you to retrieve your data back again later on.
Now lets throw SABnzbd into the picture because it specifically is designed to retrieve content based on an NZB-File it’s provided. The process looks a little like this: SABnzbd Download Process
Acquire NZB-File: Presumably you already have it because you’re just trying to retrieve data you posted in the past. But alternatively, the NZB-File could have also been acquired from and Indexer too.
Give SABnzbd Access to NZB-File: You simply hand off your treasure map to the application who’s actually going to go out there and get the content for you.
This is truly the bread and butter of SABnzbd. The next set of steps identified below are all fully automated (and done behind the scenes) for you. They require nothing from you, but it’s worth explaining it for those who are interested.
SABnzbd Establishes a Connection to Usenet: The catch with SABnzbd is it’s merely a vessel for fetching the data. You need to have provided it access to Usenet to which it will fetch this data from. Thus SABnzbd must (obviously) connect to a Usenet provider in order to retrieve data from Usenet itself. This step is put in place to make sure you’ve got yourself an account with a provider!
SABnzbd Downloads Content: Segment by segment, each portion of your data is downloaded and re-assembled. There are lots of additional things that go on too such as making sure the data isn’t damaged and attempting to correct it (all automatic) if it is.
SABnzbd Saves Data:If all goes well; and in most circumstances it will. You will have all of the content successfully retrieved at this point!
SABnzbd has tons of automation built into it; I’m really just focusing on the basics here to get you going.
I Want To Try It
Of course you do! So here’s the thing; if you’ve already connected to my repository here, you can get it by simply typing the following:
# Download and install SABnzbd plus the Notification Addon
# on CentOS 7.x using the nuxref repositories located
# here: https://nuxref.com/repo/
yum install -y --enablerepo=nuxref \
--enablerepo=nuxref-shared \
sabnzbd sabnzbd-script-notify
You can also just visit the location I host these packages directly (via my repository) here and download the RPMs for yourself:
Note: I provided the source rpms optionally; they are not required unless you want to build this for yourself from scratch.
SABnzbd Environment
It’s worth giving you a quick rundown of how the RPM installs itself upon your computer: First off, it creates a general user/group called sabnzbd. By default this is the user/group it will run as. To grant a user access to all of the content retrieved by SABnzbd, you can just add yourself to the sabnzbd group:
# as root; we can add ourselves to the sabnzbd group
usermod -a -G sabnzbd myuserid
# Note: if this user is logged in, they will have to log out and log
# back in to have these new security credentials noticed.
You can start it up with the command:
# as root; start up SABnzbd:
systemctl start sabnzbd.service
You’ll be able to access the web page through your browser by punching in https://localhost:9080.
You can set it up to survive reboots with the following command:
# as root; start up SABnzbd when the machine is first
# powered on:
systemctl enable sabnzbd.service
All of your log files will show up in /var/log/sabnzbd/sabnzbd.log
All of configuration will get written to /etc/sabnzbd/sabnzbd.conf
All of the variable data (file processing, etc) will be located in /var/lib/sabnzbd/*. In fact this is a very important directory because unless you configure things differently, all downloaded content will appear in /var/lib/sabnzbd/complete.
Firewall Configuration
The package will provide you the files needed to set up the firewall and make SABnzbd available to you from other stations by simply doing the following:
# as root; start up SABnzbd when the machine is first
# powered on (assuming your network is set up to the `home` zone
firewall-cmd --zone=home --add-service sabnzbd --permanent
# Now reload your firewall to take on the new change:
firewall-cmd --reload
SABnzbd Notifications
SABnzbd can keep you posted on what it’s doing by sending you emails when a download completes (or fails). It can send you an notification on Pushbullet, and a few others too.
If you want to use the Notify script I wrote, you’re already almost set up and ready to go because it’s in the sabnzbd-script-notify rpm you already installed.
To enable it, you simply need to need to access the Notifications tab from within the SABnzbd Configuration section. SABnzbd Notification Setup
Select the Enable notification script checkbox
Select the Notify.py script from the dropdown list next to the Script category
Next to the Parameter category, you must specify the URL(s) identifying which service(s) you want to notify.
Depending on what you want plan on alerting, the URL(s) you specify in the Parameter field will vary. You can get a better understanding of the URL options supported here.
Credit
This blog took me a very long time to put together and test! The repository hosting alone accommodates all my blog entries up to this date. If you like what you see and wish to copy and paste this HOWTO, please reference back to this blog post at the very least. It’s really all I ask.
Special thanks to Safihrefor reaching out to me and allowing me to contribute to their product with the notification add-on.
NZB-Notify: My Notification tool with extended SABnzbd support.
Another blog I wrote on Usenet a while back which focuses on NZBGet and other tools. The blog is still useful for even a CentOS 7 setup as I’ve ported over most of these packages too.
Recently NZBGet v17 was released which involved a massive re-factoring and over-haul of most of it’s back-end. Here is a quote taken from the ticket (#88) that makes up the bulk of this release:
Due to a wide variety of platforms we could not control which version of compiler is used. To make it compatible even with old compilers NZBGet was targeting old C++ versions.
In last years C++ has been evolved dramatically. New versions were standardized by ISO as C++11 and lately C++14. These new standards bring many interesting features to the language making it much more pleasure to work with.
The new (C++) standards are amazing, there is no doubt about that. But the problem is that not all (Stable) Linux distributions support these new standards. To put it in perspective, here is a chart of some Linux Distributions and the GCC standards they support (without any extra hacking/effort):
Compatibility
C++98
C++03
C++11
C++14
C++17
Red Hat 5 / CentOS 5
Yes
Yes
No
No
No
Red Hat 6 / CentOS 6
Yes
Yes
No
No
No
Red Hat 7 / CentOS 7
Yes
Yes
Yes
No
No
Ubuntu 12.x
Yes
Yes
No
No
No
Ubuntu 14.x
Yes
Yes
Yes
No
No
Ubuntu 16.x
Yes
Yes
Yes
Yes
No
Fedora 22
Yes
Yes
Yes
Yes
no
Fedora 23
Yes
Yes
Yes
Yes
Yes
Fedora 24
Yes
Yes
Yes
Yes
Yes
The point is: By making NZBGet require the C++14 standard, the list of supported (Linux) distributions drops significantly.
Just use the NZBGet Binaries Already Provided
Yes, NZBGet allows you to install an already pre-compiled version of it, and if this satisfies your needs, then I’m not here to tell you to change.
In my personal opinion, there are several problems with going with this approach:
Your program is statically linked to everything it uses. What does this mean? It means that any vulnerabilities discovered and patched on your system (via distributed system updates) will NOT patch NZBGet. These patches that are released don’t just resolve vulnerabilities, but they also add stability too.
This isn’t to say NZBGet isn’t stable, it’s to point out that it can’t reap benefits of added stability when it becomes available.
There is no package management using the binary provided on NZBGet’s website and therefore no version control (unless you’re using Microsoft). Thus, you can’t automate it’s deployment through tools like yum, dnf or apt-get (depending on your distribution).
Just to give you an idea of how many libraries NZBGet (v17) links to; here they are. I also identify the likelihood of a patch to be released between now and the next 3 months (purely speculation based on recent releases):
Package
Risk
Description
glibc, libgcc & libstdc++
MED
The systems standard libraries (what this whole blog is about really). Ideally you don’t want to use programs that aren’t linked to a different system core then the one your system depends on. This core is managed by your distribution and is key to it’s stability. It only makes sense to use it for everything else too!
gmp
LOW
Just a really powerful library for doing mathematical calculations. There are rarely exploits found here; but it’s worth noting that this is a dependency of NZBGet.
keyutils-libs
MED
A wrapper library for the key management facility system
calls
krb5-libs
MED
A network authentication system.
libselinux
LOW
An API for SELinux applications to get and set process and file security contexts and to obtain security policy decisions. This is very customized for each distribution. Ideally you’ll always want to link to you’re managed library.
libxml2
LOW
XML Parser which is used for reading through your NZB Files and RSS feeds.
nettle, trousers & openssl-libs
HIGH
The encryption between you an your Usenet provider is here. This is also the encryption between you and your indexer. There are constant exploits an vulnerabilities detected in these encryption libraries. These libraries alone are the main reason you should not use the NZBGet binaries and link to the ones you can keep current instead.
xz-libs, & zlib
LOW
Compression libraries for handling zip files (like those zipped NZB files for example when bundled).
Some important libraries, but nothing with a high risk level associated with them. They’re still worth noting as they’re part of its requirements.
The point is that there are a lot of moving parts that make up NZBGet and you should make sure that it links to shared actively maintained libraries that you have control over.
You Talk To Much, Just Hand Over Whatever It Is You’re Selling!
Sure, here they are:
CentOS 7: rpm / src Note: This is the true bread and butter of this blog because this rpm contains the NZBGet v17 installable package completely modified to work with the C++11 standard. Thus you can take advantage of this beautiful piece of software while still using your shared libraries.
The Fedora packages were all compiled using C++14 standard; there was no patch required for them.
You can also feel free to connect to my repository by following the information provided here and then download them using yum or dnf.
A worthy note about these packages:
It’ll automatically create a nzbget user (an group) for you so that you can control access to your downloads better.
Adding users to it’s access is as simple as just adding them to the nzbget group:
# Add a user to the nzbget group
usermod -a -G nzbget myuser
Provides a SystemD service ready to go for those who want to tie it to their systems startup and shutdown.
# Add NZBGet to the startup of your system
systemctl enable nzbget.service
# Start it up now if you like too!
systemctl start nzbget.service
# Now you can go ahead and access http://localhost:6789 with your browser
# The default login/password is nzbget/tegbzn6789
A small separate patch in these RPMs change:
All of the ~/downloads references to ~/Downloads.
All references to /usr/local/bin to /usr/bin.
Added ~/.config/nzbget/ to the default paths list (for those who just want to run nzbget -d as they’re user). I personally prefer to tuck all my configuration files in .config/ instead of the root folder of my home directory (which still works too if you want).
A default configuration (/etc/nzbget.conf) is pre-prepared for you which
configures most of the basic settings out of the box such as unrar and 7za paths.
sets up the logging directory to be /var/log/nzbget/nzbget.log (with log rotation on).
sets up the $MainDir directory to /var/lib/nzbget which is pre-created already for you and protected by the nzbget user and group.
What About Everybody Else?
For those using other Linux Distributions like Ubuntu, you can download my patch file which back-ports all of the C++14 code to C++11 here.
Alternatively, you can follow these instructions which should get it working for you (using share libraries instead):
# Note: The below is only applicable to v17.0.
# Download the NZBGet v17 Source
wget https://github.com/nzbget/nzbget/releases/download/v17.0/nzbget-17.0-src.tar.gz
# Download the patch:
wget https://repo.nuxref.com/pub/patches/nzbget/nzbget-use.c++11.patch
# Extract the tarball
tar xfz nzbget-17.0-src.tar.gz
# Change into the directory it extracts to
pushd nzbget-17.0
# Apply the patch
patch -p1 < ../nzbget-use.c++11.patch
You can now build NZBGet (assuming you have all the right libraries):
# first rebuild the configure script (part of what the patch prepares)
autoreconf -i
automake
# You may need to install the following packages
# Red Hat / CentOS 7:
# sudo yum install libxml2-devel libpar2-devel \
# ncurses-devel dos2unix \
# openssl-devel autoconf, libtool, automake
#
# Ubuntu:
# sudo apt-get install libxml2-dev libpar2-dev \
# ncurses-dev dos2unix \
# libssl-dev autoconf, libtool, automake
# Now you can run the rest of the setup:
./configure
# correct any problems you have here. The configure
# script will look after telling you if you're missing
# any libraries or not. If there are no problems then
# go ahead and type:
make
# Now you can install it into your system
make install
Now the last commands don’t provide you any kind of package management like RPMs or DEB packages do. But there is enough information in this blog create your own installable package here if you wanted. The main thing you accomplish is that you link a working copy of NZBGet to your stable (upgradable) system libraries.
Credit
Please note that this information took me several days to put together and test thoroughly. The C++11 patch alone took me several hours to test an create. I may not blog often; but I want to re-assure the stability and testing I put into everything I intend share.
If you like what you see and wish to copy and paste this HOWTO, please reference back to this blog post at the very least. It’s really all I ask.
Aug 5th, 2016 – Update
Since writing this blog, the amazing developer (hugbug) of NZBGet reached out to me to incorporate my patch (a much simplified version of it) into the next release of NZBGet (v17.1)! Here is a link to the pull request. So this pretty much renders this blog entry useless but accomplishing (at the end) none the less! 🙂 I still intend to package NZBGet (and all of it’s future releases) on my repository for those still interested.
Sept 10th, 2016 – Update
NZBGet v17.1 came out and the packages in this blog and the repository have been updated to reflect this. Those that still wish to build it manually can do so as follows:
# Download the latest version of NZBGet
wget https://github.com/nzbget/nzbget/releases/download/v17.1/nzbget-17.1-src.tar.gz
# You may need to install the following packages
# Red Hat / CentOS 7:
# sudo yum install libxml2-devel libpar2-devel \
# ncurses-devel dos2unix \
# openssl-devel autoconf, libtool, automake
#
# Ubuntu:
# sudo apt-get install libxml2-dev libpar2-dev \
# ncurses-dev dos2unix \
# libssl-dev autoconf, libtool, automake
# Now you can run the rest of the setup:
CXXFLAGS="-std=c++11 -O2 -s" ./configure --disable-cpp-check
# correct any problems you have here. The configure
# script will look after telling you if you're missing
# any libraries or not. If there are no problems then
# go ahead and type:
make
# Now you can install it into your system
make install
NZBGet Ticket #88: This is the ticket that made it so NZBGet became incompatible with so many systems.
Just another blog on a good Usenet solution. It touches more on CentOS 6, but there are still other packages within it that are useful an compatible with the packages shared in this blog post.
A great post that was invaluable in creating the C++11 patch on Stack Overflow.
Home security is important to all of us but why should we pay someone to monitor our home when we can do it ourselves (for free)? I mean, imagine if it were possible to just receive a text message on your phone when your alarm has been set off. Imagine if you could check to see if you armed the alarm this morning before you left for work. If you had forgotten, wouldn’t it offer you a peace of mind to be able to arm it from wherever you are?
Some great reasons why one would choose to monitor their home themselves:
Hundreds of Dollars in Yearly Savings: Think of how much money you invest in a 3rd party company that does nothing unless your alarm goes off. Even if you’re just paying $25 (before tax) a month for home security, we’re talking about a $300+ in yearly savings that you can pocket!
Faster Emergency Response Time: Consider the scenario where a thief has broken into your home and has begun loading up his van with all of your valuables.
Regardless of whether you’re paying for home monitoring or doing it yourself, the first thing that will happen is: Your alarm will sound within a 30+ seconds of the perpetrator’s entry; a very loud ear piercing siren I might add.
If you’re paying for a monitoring station service: They will call your home line to see if the threat is real or not (meanwhile your home is still being robbed). If they don’t receive an answer or get a busy signal, only then will they call the police. We’re easily a few minutes into the robbery before the authorities are even notified. The police will eventually arrive, they’ll file a report and you’re left to deal with insurance because the crime is long over and the criminals are long gone.
If you’re monitoring the home yourself: Well then your cell phone has already alerted you the second the alarm was set off. It’s a no brainer at this point, you can take action right then and there and call the police or 911 depending on if you’re home or not. You just immediately reduced the time the thief has to accomplish his crime in.
Remote Control: Ensure the alarm is armed at any time. Change the alarm keycode remotely or disarm it from a distance to let a construction worker in. You can even arm/disarm your alarm from the comfort of your bed via your tablet, laptop or cell phone.
This blog focuses on the amazing hard work of Alarm Decoder and their team. It specifically focuses on their AD2USB device which allows you to connect a virtual keypad to your existing alarm system.
It’s also worth noting that I specifically focus on the Honeywell Vista 15p/20p models because that’s what I have. But I’m sure you could use the content of this blog and the other supported alarm systems Alarm Decoders AD2USB supports and follow along.
The Goal
The goal of this blog is to share with you my success, but more importantly:
To show you how easy it is to tap into an existing (pre-wired) alarm system without paying for a monitoring service.
Receive SMS (text) messages, emails or other notification services when your alarm is ever set off.
To be able to control the (security) keypad in your house from anywhere and at anytime.
To provide you all of this in a cookie cutter solution that works out of the box. I spent several hours packaging everything into self installing RPMs residing on my repository.
This blog will assume you’re both familiar with and have access to either CentOS (or Red Hat) 6.x or 7.x.
I’ll also assume you don’t have much experience with alarm systems (as I certainly didn’t at the start). I’ll try to save you as much research as I can and provide everything to you here. As a result, this blog is probably a bit longer then it needs to be since I get wordy trying to explain it.
Prerequisites
There are a few things you’ll need to be able to pull this feat off:
An Ademco/Honeywell Vista 15p or 20p alarm system, but it doesn’t mean you can’t keep reading (just as long as your alarm panel is listed here as being supported).
If you don’t have an alarm system pre-wired in your home already, it might be worth spending the money to have one installed (sensors and keypad included). It will be the last cost you make since the monitoring will be free from that point forward. If you don’t intend do this, then the this blog won’t be of much use to you.
This blog assumes that the zones (sensors/alarms) are already pre-configured too. Thus, your sensors are all hooked up to the alarm system already.
Note: If you’re currently paying a 3rd party company to monitor your home, then you MUST cancel your contract with them before you proceed any further!
You’ll need full access to your Honeywell alarm system (usually in the basement) and at least one keypad (usually near the front entrance). Most alarm systems are (and should be) locked up in a small box accessible with a key. You will want this key because you’ll want to lock everything up when we’re done too!
You’ll need one NuTech AD2USB device which is what will bridge/connect your security system to your Linux Server. The AD2USB device effectively just becomes a second keypad attached to your alarm system.
At the time this blog was written, the NuTech AD2USB devices cost about $88USD ($119.99 CAN) ; a one time fee. The cost is well worth it since it’ll pay itself off in 2-4 months (if you compare it to the costs of a 3rd party home monitoring solution).
A Mini USB to USB CableYou’ll need one Linux server pre-configured with CentOS or Red Hat 6.x (or 7.x).
Enough wiring to get from the locked up alarm system to your Linux server. In my case, I am hooked up just below the panel, so I just needed about 4 feet. You can order this cable with your purchase;it’s only about .50 cents a foot (very inexpensive).
Wire strippers.
A small (1/4″) Philips screw driver.
A Mini-USB to USB cable (no longer then 10ft).
Alarm Installer Code
Before we can even look or use the NuTech AD2USB device, we need to first alert our current alarm system of it’s presence. To do this, you need to be able to re-program a tiny portion of the alarm system. Don’t worry, it’s not as complicated as it sounds! This step is done through the keypad already installed in your house (usually at one of your front entrance ways).
The installer code grants us unrestricted access to our entire alarm system (through it’s programming mode). The installer code is a 4 digit (numeric code) and won’t be the same one you’re used to keying in when activating/deactivate your alarm.
If you already know your installer code you can access the programming mode by keying in the following and skipping to the next section (substitute [ABCD] with the installer code): [ABCD] + [8] + [00]
If you don’t know what your installer code is then don’t worry, just keep reading…
Again, I can’t stress enough that you make sure you are ‘NOT’ still hooked up with an external monitoring service at this point because these next steps will disconnect them from your home (and could cause them to treat the situation as a crime in progress):
Unplug your alarm system’s main power by simply unplugging the transformer nearby from the wall.
Disconnect the battery backup from our alarm system. No need to unplug both terminals, just unplug one for the time being. We’ll be restoring the power back soon enough.
Note: At this point you’ve effectively powered off your alarm system completely.
To gain access to the programming mode and ‘take back’ the alarm system for your own, you need to just plug the transformer back in (leave the battery unplugged now).You now have 30 seconds to locate your alarm keypad and press and hold both the asterisks [*] and the hash button [#] down at the same time (for about ~1 to 2 seconds).
If the above step worked correctly for you, then you should see the value of 20 written on your keypad’s display. If not, then you’ll need to repeat all of the steps above again.
Note: If your battery backup for your alarm system is still unplugged, now would be a good time to just plug it back in (so we don’t forget about it later).
Keypad Configuration
This step requires you to be in-front of the same keypad described in the last section. More importantly, you must be in it’s programming mode. This means you either used your known installer key code or you booted the alarm up in such a away that granted you access to the programming mode (without a code). If you’re unsure what I’m talking about here, make sure to re-read the last section before proceeding!
Your alarm system is effectively organized as a series of registers (think of them as mailboxes organized by 2-3 digit addresses). Registers are basically a spot you can store and retrieve information from. You’ll always press the [*] followed by the register you want to modify (using it’s address), followed by the new value you want to store in it. Alternatively you can always press the hash [#] key followed by the register just to display it’s contents instead.
So with respect to the Mailbox analogy, programming our alarm system through our keypad works like so:
[*] + [mailbox] + [new value] Save content into a specific mailbox (by address) and then print it to the display.
[#] + [mailbox] Just print the content of the mailbox (by address) to the display.
Simple enough right?
Just to avoid any confusion, when I group numbers below as [20] and [1234], they can still be interpreted as pressing (sequentially / one after the other) [2] + [0] + [1] + [2] + [3] + [4]. It’s easier to group the actions separately for readability; this way you can think of it with respect to the mailbox/content analogy.
While in programming mode, execute the following commands:
Command
Details
[*]+ [20] + [ABCD]
Substitute ABCD with a 4 digit code you want to become the new programmer code. This is what you can use in the future to get into programming mode (without having to power off the entire system again).
[*]+ [41] + [*]
Remove the primary phone #’s of any external monitoring station that may or may not be hooked up. Even if this register is already empty; it doesn’t hurt to run this again just to ensure it really is empty. We don’t want our alarm system calling out to anyone.
[*]+ [42] + [*]
Remove the secondary phone #’s of any external monitoring station (if any is set). Again…even if this register is already empty; it doesn’t hurt to run this command again just to ensure it really is empty.. We don’t want our alarm system calling out to anyone.
[*] + [191] + [10]
Enabled keypad slot at Address 18; this is what the AD2USB device defaults to using. This default address should work for everyone.
[*] + [99]
Exit the installer mode returning the keypad to it’s regular state
We’re not done yet though, if this is you first time using your alarm system, it might be wise to set a new Master Code and clear all existing User Codes. In case you didn’t already know, there are actually 3 types of users that are associated with our alarm system:
The Installer: A key code that allows us to add/remove new keypads, acknowledge new sensors, configure zones, etc. In our case, our alarm system will only allows for 1 designated Installer Code.
The Master: A key code that allows us to to create/delete Users of the system. In our case, our alarm system only allows us to have 1 designated Master Code.
The User: Our alarm system allows us to program up to 31 of them (32 if you count the master). Residential owners will probably only need to set one user while a commercial business owner might set several for each of their employees. It will be our User Code that we’ll be using when interfacing with our alarm system 99% of the time. This blog will focus on just dealing with 1 main user.
So if you inherited this alarm, you may not know what was previously configured into it. You ideally should set a new Master Code (different then the Installer Code) and make sure there are no lingering User Codes active that we don’t know about. Note: The commands identified above are called outside of programming mode. They can be issued at any time as long as your alarm is not armed. If you’re still in programming mode, just type [*] + [99] to exit it.
Command
Details
[Installer Code] + [8] + [02] + [DEFG]
Substitute [DEFG] with your new 4 digit Master Code using the Installer Code we setup above.
[Master Code] + [8] + [03] + [WXYZ]
Substitute [WXYZ] with your new 4 digit User Code using the Master Code. This will become our main User account; the [03] identifies us as user #1. This is a code you’ll want to keep secret but can safely tell those whom you trust with access to and from your home.
[Master Code] + [8] + [04] + [#] + [0]
[Master Code] + [8] + [05] + [#] + [0]
[Master Code] + [8] + [06] + [#] + [0]
…
[Master Code] + [8] + [33] + [#] + [0]
Delete User #2 ([04]), #3 ([05]) and , #4 ([06]) in our alarm system (in case they exists). This step is entirely optional, but worth doing since you really don’t know how many users are actually set up from whomever had it before you.
If you’re really paranoid, you’ll iterate through all of the combinations identified here to cover of all 31 possible users where the last user (#31) is identified by [33]. In most cases your system will probably have just a few users (worst case) in it. Thus it’s probably safe to stop at [06] (user #4). I’ll let you use your own paranoia and discretion here as to how far you go.
You now have a security system and 3 Codes. The Installer and Master codes are useful to keep documented (but hidden) somewhere. The User Code will be the main code we use from now on; this code is safe to share with those you share your home with; obviously keep it safe from others.
Hook Up our NuTech AD2USB Device
First of all; let me point out to you that the Alarm Decoder’s Installation videos are a much better reference then anything I’ll identify in this section. I strongly encourage you to check the videos out (they’re only a few minutes) and get properly set up.
But in short, it really just boils down to connecting the AD2USB Device to our Home Alarm System and getting the wires correctly matched up and fastened tightly. From there you just connect the AD2USB device to your Linux Server via the mini-usb cable. NuTech AD2USB Wiring In a Nutshell
Your goal is to see the little green light blink; this is the devices internal heartbeat. It’s a good thing when this starts to flash on and off; if it isn’t, you’ll want to revisit your wiring!
Here is what my AD2USB device looked like after it was all hooked up. Obviously I can’t capture a pulsating green light in a single photo, so you’ll just to have to take my word for it that the light was blinking on and off. 🙂 NuTech AD2USB Device
At the end of the day, the AD2USB device is nothing but ‘another’ alarm keypad in your house. As far as the Alarm System is concerned, there is no distinguishable difference at all. What makes the device so powerful is the fact that now we can interface with it using software from anywhere!
However, I’ve spent hours (sadly) making it possible for these tools to just work in both CentOS 6.x and 7.x via installable RPMs. I strongly encourage you to go this route for several reasons:
You won’t be required to compile anything.
I handle SELinux for you so you won’t have to to disable it!
I handle all of the initial (and complicated configuration) out of the box for you.
I handled all of the system dependencies for you.
It’s easier to provide safe upgrades and version control through RPMs. Relying on pypi (pip) instead will make it difficult to reproduce your working setup since the packages there change constantly (for better of for worse).
If you want the RPM approach, then keep reading…
Install Core Components
You must be connected to my repository for this to work:
# Assuming you're correctly hooked up to the nuxref repositories:
yum --enablerepo=nuxref --enablerepo=nuxref-shared \
alarmdecoder ser2sock \
alarmdecoder-webapp alarmdecoder-webapp-selinux
Note: the SElinux package has to interact with the kernel to enable 4 web ports Alarm Decoder (WebApp) uses. During this time, it will appear as though your installation froze and/or hung. Do not abort this task, it’s completely normal to take up to a minute or more to do this. If you’re not using SELinux then you don’t need this package.
Enable ser2sock; this will convert your AD2USB device (in /dev/) into a TCP/IP stream. This is much easier to work with (and debug)
# Enable ser2sock and start it
chkconfig ser2sock on
service ser2sock start
If your ser2sock doesn’t start, then you have a problem with your AD2USB configuration and/or hookup. Feel free to have a look at /etc/ser2sock/ser2sock.conf to see the configuration it’s using. Alternatively, the next section discusses some troubleshooting steps you can do.
Start up our Alarm Decoder Webapp
Even if you’re using systemd, these commands will work (it’ll call the proper command for you).
# Enable gunicorn (back-end webserver)
chkconfig ad2web on
service ad2web start
# Enable NginX (front-end web hosting and static file control)
chkconfig nginx on
service nginx start
# If it was already running, then:
service nginx reload
You’ll need to open ports 5080 and 5443 on your firewall. CentOS/Red Hat 6.x users should be able to apply something like this in their /etc/sysconfig/iptables file:
# add (something like) this to your /etc/sysconfig/iptables
#---------------------------------------------------------------
# Home Security Monitoring
#---------------------------------------------------------------
# 192.168.1.0/24 is the subnet of my local home network and eth0
# is the device it access.
-A INPUT -i eth0 -s 192.168.1.0/24 -p tcp --dport 5080 -j ACCEPT
-A INPUT -i eth0 -s 192.168.1.0/24 -p tcp --dport 5443 -j ACCEPT
If you’re using CentOS 7.x, then you’ll need to use firewalld to accomplish the same task:
# Open the port in your home network
firewall-cmd --zone=home --add-port=5080/tcp --permanent
firewall-cmd --zone=home --add-port=5443/tcp --permanent
firewall-cmd --reload
I do not recommend opening the ports to the public (zone) network unless you strap on a bit of extra security such as fail2ban. This blog is already long enough, so I won’t discuss that here. Although, you can check out a blog I did on security that can get you started with fail2ban (6.x users).
It’s worth confirming at this point that everything is up and running too:
# This command just checks that we're properly listening on the
# ports we care about (with respect to Alarm Decoder):
netstat -nat | egrep LISTEN | egrep ':(10000|5(00[01]|080|443))'
5080: NginX non-encrypted hosting of the Alarm Decoder WeAapp.
5443: NginX secure hosting of the Alarm Decoder WeAapp.
10000: Ser2Sock (this is converting you’re AD2USB to a TCP/IP stream that the Alarm Decoder WebApp can read and display to you).
5000: This is forked from the gunicorn instance to handle all incoming requests from NginX
5001: This is the gunicorn application which helps with handling some of the backend tasks such as the detection of your AD2USB device.
You should be able to access the keypad website now; simply visit http://localhost:5080/ or it’s secure version https://localhost:5443/. If you’re configuring this on another server, we’ll then you’ll need to access the host/ip accordingly. Alarm Decoder WebApp Installation
You can accept the defaults for everything, just keep pressing next. Next 3 Setup Screens
When you’re all done with the setup and have created your administrative account, you’ll be able to sign in an access your new virtual keypad. Alarm Decoder Keypad
You can explore the software and take advantage of all of it’s features. You can setup a twilio account and have the Alarm Decoder WebApp send you a text message whenever an even occurs. You can have it email you, and/or use a variety of other messaging services too!
If the page still isn’t coming up, it might be because you have SELinux enabled. Unlike other bloggers, I will NOT tell you to disable it (although that’s an option). Instead I’d advise that you install the SELinux package I put together:
/etc/nginx/conf.d/alarmdecoder-webapp.conf: Here is your NginX configuration file. This is the front end of your keypad.
/etc/alarmdecoder-webapp/alembic.ini: This is another configuration file used by the website. It defines information such as the database type and location. By default, it’s just a simple sqlite database. But feel free to point it to a PostgreSQL or MySQL database too (see the sqlalchemy.url directive).
/etc/ser2sock/ser2sock.conf: This is ser2sock configuration file.
/etc/alarmdecoder-webapp/ad2web.conf.py: This is where your gunicorn configuration is defined.
/var/lib/alarmdecoder-webapp/instance/db.sqlite: Here is the database the website uses and interfaces with.
/var/lib/alarmdecoder-webapp/instance/logs/: Here are where you’re logs will appear from the webapp.
Troubleshooting
First make sure CentOS (or Red Hat) can see your NuTech AD2USB device properly.
# This ideally should return something like /dev/ttyUSB0
find /dev -mindepth 1 -maxdepth 1 -type c -name 'ttyUSB*'
# If you're using my RPM files, you'll also have another
# entry you can look for. The following should output
# something like /dev/alarm-XXXXXXXX where the X's represent
# the Serial # of your NuTech AD2USB
find /dev -mindepth 1 -maxdepth 1 -type l -name 'alarm-*'
If you can’t find your device, then:
Double check that the USB connections are firmly plugged in to both your PC and the AD2USB device.
You’ll want to see a pulsating green light on the AD2USB device signifying it’s getting power and running.
NuTech also make mention that the USB cable you use can not be longer then 10ft. Ideally the shorter the cable the better though (less noise/interference).
If your device does exist, then read on to the next step…
Ensure that the Honeywell Alarm System setup has been correctly configured to support a second keypad. This was discussed above in the Keypad Configuration section of the blog. Specifically you need to be in Programming Mode and enable keypad address 18 (done via the command: [*] + [191] + [10]).
You can verify that you’ve configured this correctly by accessing the Programming mode of your alarm keypad and typing: [#] + [191]. The device should output either a 10 or 0A (both are valid responses).
Make sure your NuTech AD2USB can properly communicate with your Alarm system.
I took extra care and time packaging everything, so I actually have another RPM you can install that may help you out:
# Assuming you're correctly hooked up to the nuxref repositories:
yum --enablerepo=nuxref alarmdecoder-cli
# These commands require you to be the superuser (root)
# or a user that is as a member of the 'alarm' group.
# Test your data feed (through ser2sock):
ad2-disp-sock
# Or test your block device directly:
ad2-disp-dev
Note: If ser2sock is running properly, you will not be able to test the block device (using ad2-disp-dev) until you stop it first. So don’t panic if the ad2-disp-sock works and ad2-disp-dev doesn’t!
You can adjust these test tools by editing /etc/ad2cli.conf (if the defaults
aren’t working for you).
If you can’t communicate properly, then you may need to recheck your wiring. Review the NuTech YouTube videos again if you need to.
If you still can’t communicate with your alarm system after confirming all of the suggestions above, then you may have a faulty device.
Don’t give up if you’re having problems. It’s worth searching the Alarm Decoder Forums for an answer. Post a question there too if you like. The Alarm Decoder team are a great bunch of people always willing to help.
What If
What if the thief cuts the power? In my case, my alarm system (yours should too) has a battery backup locked up tight with it. So it’ll keep monitoring in this situation no matter what. It wouldn’t hurt to connect both your server internet modem into a Uninterruptible Power Supply (UPS). These things are relatively cheap for what they offer. A UPS would certainly handle this situation.
What if the thief powers off the computer within the 30 second deactivation window?
Well, if they are this clever then yes, they cut you off from remote monitoring. But that’s all they do. Keep in mind that the 30 second deactivation timer is still counting down. It will reach zero… and when it does…
A properly installed alarm system will come with a siren (I know mine does) and they are quite loud and irritating! The siren will sound regardless of the NuTech Alarm Decoder, Internet or PC get shut off or unplugged. It might be a good idea to make sure your siren is installed in the attic where it is difficult to get to (and disable). Most people and installations place these devices in the basement. This is silly because a thief can just smash it or yank the wire from it to kill the sound. Either way, unless the thief knows your setup, he’s certainly playing with fire if he thinks silencing the siren will keep him safe.
Consider a backup plan; I mean what would the alarm company do if they could no longer suddenly monitor you’re home. They’d probably immediately attempt to contact you and then call the police. You could do the same. Call a neighbor, call a friend. The fact you even just have a heads up on the situation is more then the guy who doesn’t have any monitoring solution at all.
Another great tool you can use is Nagios; I wrote a blog on it a while ago. Pair that up with aNag (for Google Devices) or iNag (for Apple Devices), and you’ll be monitoring your ability to monitor. You can be notified immediately if your monitoring capabilities diminish.
On a side note, consider notifying your (trustworthy) neighbor(s) too of weeks you intend to be out of town, I’m sure they can alert authorities for you if they hear your house alarm going off.
Home Security Tips
Remember, since you’re doing the monitoring yourself, you need to be prepared for when or if a situation ever arises. There is no longer a remote monitoring station looking out for you. But remember that even they can fail to pull through, so the following information is useful regardless of what your monitoring situation is.
I am not a trained professional when it comes the safety and responsibilities (nor will I claim to be). But there are clear cut obvious things worth stating up front that you must always consider:
If you’re at home at night and the alarm goes off:
It’s our human nature to panic, but just don’t let the panic take over the situation.
Don’t ever second guess the potential danger of the situation!
Do not ever decide to be brave and investigate the situation unless you’re absolutely sure!!
Call 911 immediately. If the phone line is dead, then use a cell phone if you have one.
If you’re at work or on vacation and the alarm goes off:
Ask Yourself? Could it be your spouse? A Child? A Pet? Does the timing of this alarm jive with a notable time of day such as after school (maybe the kids got home)? Perhaps it’s around the time your spouse returns from work or other family member?
Can you contact a specific person in mind directly based on the time of day (with respect to the alarm going off)?
Remember though: if this truly is a robbery, then time is not on your side! The longer you wait, the more your home is exposed.
If you can’t be sure, then call the local police immediately!. If you fear someone else could be home during this time and at risk then call 911! Don’t think twice!
Make sure you have your local police contact information programmed in your cell phone. Alternatively, keep it on a sheet of paper in your wallet or purse.
If you have children, make sure they know what to do if they hear the alarm go off. If they have access to a phone, they should know how to call 911 during these kind of emergencies. Obviously their safety becomes your number one concern, so be sure to educate them to hide someplace close by. Having them leaving the room their in when the alarm is going off could put them in serious jeopardy depending on the situation.
Credit
This blog took me a very (,very) long time to put together and test! The repository hosting alone accommodates all my blog entries up to this date. If you like what you see and wish to copy and paste this HOWTO, please reference back to this blog post at the very least. It’s really all I ask.
Special thanks to the Alarm Decoder team; their support made it possible for me to write this blog. In return I was able to make it easier for everyone else!
An Ademco/Honeywell Vista 15p or 20p alarm system, but it doesn’t mean you can’t keep reading (just as long as your 
You’ll need full access to your Honeywell alarm system (usually in the basement) and at least one keypad (usually near the front entrance). Most alarm systems are (and should be) locked up in a small box accessible with a key. You will want this key because you’ll want to lock everything up when we’re done too!
You’ll need one NuTech AD2USB device which is what will bridge/connect your security system to your Linux Server. The AD2USB device effectively just becomes a second keypad attached to your alarm system.
