Contact Closure Email Generator User Guide

Introduction

In this guide we will cover the functionality and use of the Contact Closure Email Generator.

We will cover basic requirements, hardware functionality, configuration, and troubleshooting of the device.

Basic Requirements

Email Broker

This device communicates directly with your Email Broker via the SMTP protocol.  Most Email Brokers such as Gmail and Outlook support SMTP connectivity so this device is compatible with most Email brokers.  You should check with your specific email broker to ensure it supports SMTP.

Note for Gmail Users

Google by default will not allow this device to access your Email account as it does not recognize it.  You will need to enable less secure apps on your google account.  Simply google ‘gmail allow less secure apps’ for official Google documentation.  If you are uncomfortable consider creating a Gmail account solely for this device to use.  They are Free after all.

WiFi Connectivity

This device communicates with your email broker over an internet connection.  This is a WiFi connected device so you will need a WiFi network which provides internet connectivity.  This device supports most WiFi Network security protocols, however it does not support captive portal networks.

This device is also a 2.4ghz device and does not support 5ghz networks so ensure your WiFi network supports 2.4ghz.

One other possible issue is WiFi network passwords which contain special characters such as # $ % * etc.  It is recommended to connect this device to a network with a password containing only alpha numeric characters and other basic characters such as , _ – etc.

Hardware

Power

This device will operate on a power supply source of 6-32VDC, however 12VDC is the nominal and recommended power supply voltage level.  Power may be connected via the center pin positive 2.1mm barrel connector or via the dual screw terminals on the device.

USB Port

The USB port is for diagnostic and firmware updates only.  The device should never be powered solely from the USB port.  The USB port is a USB Micro size port.

Contact Closure Input Signals

This device has 4 contact closure input ports via the 8 screw terminal connector on the end of the device.  These contact closure inputs are isolated which provides additional protection to the device against possible static discharge on long wire runs.  However it is recommended that contact closure signals are supplied over wire as short as possible.  If long wire runs cannot be avoided Cat5 or Cat6 shielded wire is recommended to help prevent static buildup on the wire.

RGB LED

An RGB color changing LED visible from the top of the device provides information about the current status of the device.  Here is a break down of the Status LED states:

  • Flashing Green: Device is properly connected to WiFi and is ready for operation.
  • Yellow: Device is currently booting.
  • Flashing Blue: Device is in Configuration Mode and should appear as a WiFi AP on your computer, phone or tablet.
  • Random Color flash: Device is restoring factory default settings.
  • Repeated Single Red Flash: Email sending failed.  It is normal for this mode to return to Flashing Green after 5 seconds.  See Troubleshooting Section.
  • Repeated 2 Red flashes: There is an issue with Device Settings.  It is normal for this mode to return to Flashing Green after 5 seconds.  See Troubleshooting Section.
  • Repeated 3 Red flashes:  Connection to the configured WiFi network cannot be established. 

Mode Button

The device has a button located on the side.  This button is used to enter and exit configuration mode.  Simple press and release the button to toggle between configuration and run mode.

Configuration

Entering Configuration Mode and Initial Connection

Configuration of the device is done via a Soft AP interface hosted by the device.  Essentially this is a web page the device serves over a WiFi connection provided by the device.

The device has 2 modes of operation.  Configuration and Run.  To toggle between these two modes simply press the Mode button on the side of the device.

In configuration mode the device will flash the LED blue indicating it is in configuration mode.  

Once the device is in configuration mode scan for WiFi networks on your computer phone or tablet.  By default the device will broadcast a network SSID of NCD_Email.  The default password to join this network is NCDBeast.

Accessing the Configuration Web Interface

Once your computer, smartphone, or tablet is connected to the Device via WiFi you can access the device’s web interface for configuration.  On many devices your web browser will open automatically and display the device’s configuration web interface.  If a browser does not automatically open then simply open your web browser and enter 172.217.28.1.  If your browser gives you an error that internet connection is not available try opening an incognito or private browser window and try again.

WiFi Configuration

Network/Hidden Network fields

Upon entering configuration mode the device will scan for Wireless networks.  The discovered networks will be displayed in the Network Drop down menu.  If the network you wish to connect to is listed in this drop down then select it.  If your network is not displayed there then manually enter the SSID of your WiFi network in the Hidden Network field.  If you have selected your network from the Network drop down menu then ensure the Hidden Network field is left blank.

Password

If your WiFi network is password protected then enter the password for connecting to the network in this field.  Leave this field blank if your WiFi network is open and does not require a password.

DHCP Enabled

If your network supports DHCP and you do not require a static IP address then check this box.  If you need to assign the device a Static IP address then uncheck this setting.  The following fields are only enabled if this box is unchecked.  If you are using DHCP then please ignore the remaining fields in this configuration section.

Default Gateway

This field is only enabled if DHCP Enabled is unchecked.  Enter the Default Gateway IP for your network here.

Subnet Mask

This field is only enabled if DHCP enabled is unchecked.  Enter the Subnet Mask IP for your network here.

DNS Primary

This field is only enabled if DHCP enabled is unchecked.  Enter a valid DNS primary server IP in this field.  This can match your network settings or can be set to a common DNS server.  8.8.8.8 is Google’s primary DNS lookup server IP.

DNS Secondary

This field is only enabled if DHCP enabled is unchecked.  Enter a valid DNS secondary server IP in this field.  This can match your network settings or can be set to a common DNS server.  8.8.4.4 is Google’s primary DNS lookup server IP.

Static IP

This field is only enabled if DHCP enabled is unchecked.  Enter the Static IP address you would like the device to use on your network in this field.

Soft AP Configuration

Soft AP SSID

When in configuration mode the device broadcasts an SSID and acts as a WiFi Access Point.  This field allows you to customize the SSID which is broadcast by the device.

Soft AP Password

When in configuration mode the device broadcasts an SSID and acts as a WiFi Access Point.  This field allows you to customize the password required to connect to the device’s WiFi Access Point.

Email Client Configuration

Host

Enter the SMTP host address of your Email broker in this field.  Common email brokers are smtp.gmail.com and smtp-mail.outlook.com

Host Port

Enter the SMTP port for your Email Broker in this field.  Most Email Brokers which support SMTP connections allow those connections on port 587.

Login Email

Enter the login username or email in this field.  Most common Email Brokers utilize the account email address as the Username so enter the email address of the account you would like to use to generate emails in this field.  For example john_doe@gmail.com

Password

Your email Broker will more than likely require a password for connecting to it over SMTP.  For Gmail or Outlook this is just your account password(used to sign in to check mail).

Device Name

When this device generate’s emails it will sign the email with it’s Device Name.  Customize this Device Name to what you want the email’s signed with.

Calibration Configuration

Debounce Cycles

It is not generally recommended to alter this setting unless advised to do so by NCD Staff.  This setting determines the number of CPU cycles are required to determine a change to an input has actually been made.  Most contact closures bounce a bit when they make contact, this setting ensures multiple email events do not occur when an input is closed.

If your contact closure is extremely brief and is missed by the device it may be necessary to decrease this amount.  If on the other hand you are seeing multiple email messages when your contact is made it may be advised to increase this setting.

Power On Email

It is possible to configure the device to generate an email message when it initially powers on.  For some applications this may be very important as it will inform the user that the device lost power and then powered on again so some contact closure signals may have been missed during the power down period.  This could also be useful to monitor power availability in some applications.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 1 Close Email

It is possible to configure the device to generate an email message when Input 1 Closes.  When input one’s state changes from Open to Closed this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 1 Open Email

It is possible to configure the device to generate an email message when Input 1 Opens.  When input one’s state changes from Closed to Open this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 2 Close Email

It is possible to configure the device to generate an email message when Input 2 Closes.  When input two’s state changes from Open to Closed this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 2 Open Email

It is possible to configure the device to generate an email message when Input 2 Opens.  When input two’s state changes from Closed to Open this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 3 Close Email

It is possible to configure the device to generate an email message when Input 3 Closes.  When input three’s state changes from Open to Closed this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 3 Open Email

It is possible to configure the device to generate an email message when Input 3 Opens.  When input three’s state changes from Closed to Open this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 4 Close Email

It is possible to configure the device to generate an email message when Input 4 Closes.  When input four’s state changes from Open to Closed this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Input 4 Open Email

It is possible to configure the device to generate an email message when Input 4 Opens.  When input four’s state changes from Closed to Open this event will execute.  And the email will be sent to all recipients listed in the recipients field.

If it is not desired to generate an email when this event occurs leave the Subject and Body fields empty, if both the subject and body fields are empty this event will be ignored.

Subject

This will be the subject of the email generated when this event occurs.

Message Body

This will be the body of the email generated when this event occurs.

Recipients

This is a comma delimited list of email recipients who should receive this email.  For example: john_doe@gmail.com,john_doe@outlook.com It is important not to insert spaces in this list, only commas to separate email recipient addresses.

Troubleshooting

Unable to access configuration web interface

Ensure the Device LED is flashing Blue.  This ensures it is in configuration mode.  Scan for networks on your Computer Phone or Tablet and it should appear.  If the device does not appear in the WiFi scan try using another Computer Phone or Tablet.

If you are able to connect but are unable to load the configuration page manually open a web browser once connected to the Device’s WiFi and enter 172.217.28.1. If the page still will not load ensure you are using Google Chrome, Firefox, or Safari browser and try again.  You may also try opening a private/incognito browser.

Repeated 3 Red Flash on LED(Won’t connect to WiFi Network)

Ensure the network the device is attempting to connect to supports 2.4ghz.  This device cannot connect to 5ghz WiFi networks.

Ensure the network password does not contain special characters such as $ # % * etc.  _ – + ! characters are acceptable.

For diagnostic purposes move the device within approximately 10 ft or so of the WiFi Router/Access Point and try again.

Emails not going through(Two red LED flashes in sequence)

This will most generally be due to inability to authenticate with the email server.  If you are using Gmail you will need to change the Google Setting to allow insecure apps.  This device is not insecure but it is not recognized by Google so it will be blocked until you enable this on your Google account.  Simply Google ‘Google allow less secure apps’, this will take you to google documentation to enable this feature.

Check to make sure the Email Client Host, Port, Login Email, and Password settings are correct.  You may also check these settings using a 3rd party email client to ensure the settings are correct.  It is difficult for NCD Staff to provide in depth support for this topic as we are not the developers of the Email Broker you are using.