Introduction
What is the Push Notification Series?
The push notification series was designed for customers requiring contact closure input monitoring via push notification rather than a query based method. This means your application is free to process other tasks while listening for input status change. This opens the door to many new and exciting applications such as email/text message notification, data logging, security monitoring, and much more. These controllers can be configured to send information to a specific server via internet connection when their input status changes, or alternatively they can broadcast their input status change across all devices a local area network so many applications can be informed of the recent closure.
What can this device be used for?
The possibilities are endless. Just think, a closure generated by someone walking through a door could trigger a notification on 5 managers’ Android devices informing them a customer has entered the building. A notification could be sent to a small local server such as the WiNet which can in turn send an email notification when the float switch on a reservoir has been tripped by excess water.
Several types of devices can be connected to the Push Notification Series product’s inputs such as motion detectors, push buttons, switches, relay outputs, float switches, virtually any device that generates a dry contact closure. The Push Notification series offers controllers with 1, 2, 4, and 8 contact closure inputs.
We believe this product is the missing link in so many applications. When combined with our current products such as the WiNet and Fusion series your imagination really is the limit to what can be done.
How do Push Notification series products work?
PN series products send a packet via TCP or UDP sockets when the status of their inputs change. They can be configured to send this packet when the input is open/closed, opened, or closed. Setup of the socket and a breakdown of the packet will be covered later in this guide.
Getting Started
WiFi Module Configuration
Setup of the WiFi module configures it for connection to your wireless network. It also specifies where the notification packet it sent. This configuration is very simple using our NCD Base Station Software.
Things you will need
- Push Notification series controller with included WiFi module
- WiFi configuration kit (Zigmo configuration board and USB cable)
- A windows based computer (XP, 7, or 8)
WiFi Network Setup
Step 1:
Install the Wi-Fi module into the WiFi Module Configuration board (Zigmo)
Step 2:
Connect USB cable from Zigmo board to your computer using the USB port.
Step 3:
Install NCD Base Station Software for configuration/testing purposes
Step 4:
Launch NCD Base Station Software. On the Select Connection window that appears click the drop down menu under com port, select the USB Serial port which was created when the Zigmo board was connected to the computer. Make sure Baudrate is set to 115200. Click the More button in the upper right corner of the window to expand it. Click the MirCC WiFi Module Setup button.
Step 5:
The MirCC WiFi Module configuration window will read the stored settings in your module at launch. These settings need to be changed for your particular network.
- Making sure the WiFi module is within wireless range of the network you wish to attach it to click the Scan for Networks Button. A window will pop up displaying all wireless networks within range, select the network you wish the module to connect to, then click the Select button.
- Type the passphrase for your WLAN network in the Enter Network Passphrase box.
- Enter a device name in the Enter Device Name box if you wish.
- Enter the TCP port you wish the module to listen on in the Device Local TCP Port box (this will be used for connecting to the module and reading its input’s status if needed).
- We recommend that you leave the Join Network On Power Up box checked, this means as soon as the module powers up it will associate with the network stored. Alternatively if you do not check this box it will only connect to the network when it needs to transmit data.
- You can enable a socket connection timeout on the module which is recommended by checking the Enable TCP Socket Timeout, then type a timeout duration in the box that appears in seconds. When enabled the module will forcibly close any TCP socket connections after no data is transmitted or received for the specified period of time.
- Select DHCP or Static IP. DHCP is recommended whenever possible but you may store a static IP address into the controller if desired. If you do not know what a Static IP address is leave DHCP enabled.
This concludes configuration of the module for your WLAN. Don’t press the Save to WiFly button yet though.
Step 6:
Now we will configure where the controller is to transmit its input status on change. There are two main methods for this (TCP or UDP). IF the module will be transmitting its data to a remote server or if security is a concern TCP should be used. UDP is a good solution if multiple devices on the network need to receive information (UDP Broadcast).
TCP Notification Setup
Select the Send Notification via TCP radio button. A window will appear allowing you to enter the destination IP address and Port Number. A listener application will need to be present at that location listening on the specified port number.
UDP Notification Setup
Select the Send Notification via UDP radio button. A window will appear with three variables: a checkbox for Use UDP broadcast, a Server IP, and a Port. When Use UDP broadcast is checked and device on the network can receive the broadcast since the IP is set to 255.255.255.255. When not checked you must specify a specific Server IP address. A port number must be specified in the Port text box, your listener application(s) will need to listen for USP broadcasts on this port number.
Step 7:
Click the Save to WiFly button. You will see several commands exchanged between Base Station and the WiFi module in the Log window. At the end you should see Associated, and then farther down a line that says IP = the address next to this line will be the IP address of your module. If a Static IP address was assigned it will say using specified static IP. You should also now see the Green LED on you WiFi module flashing slowly which means it is associated with your network.
Step 8:
Close Base Station. Disconnect the Zigmo from your computer. Remove the WiFi module from the Zigmo configuration board. With no power applied install the WiFi module into your Push Notification series controller, then to apply power using a regulated 12VDC power supply (see Power Supply specifications section under Hardware Reference for more info on Power supply requirements). You should see the busy and ready LEDs on the PM controller turn on solid initially, after a moment you will see them flash as well as the amber LED on the WiFi module, once this flashing stops and the Ready LED on the controller turns on solid you are ready.
Initial Testing
Step 9:
(This will only work if the module was configured for UDP broadcast or if this is done on the computer specified as the server IP). For testing purposes open Base Station once more on a windows computer connected to the same network as the PN controller. Click the More button in the upper right corner of the select connection window. Click the Com Operator button which appears below. When asked to register you can specify register later. Click the Chain icon button in the upper left corner of Com operator to open a new connection. If you set the module up for UDP broadcast click the UDP tab, enter the port number specified as the notification port in the WiFi module in the Listen Port box, then click OK. If you setup the module for a TCP socket connection click the TCP Server tab and enter the port number specified during setup as the server port number is the Listen port box and click ok. You will now see a send/receive window. Trip and input on the controller using a dry contact and you should see data received in Com operator. This concludes the setup of your controller.