napco gemini plugin for homesee · napco gemini plugin for homeseer arm button: controls whether or...

Napco Gemini Plugin for HomeSeer

Napco Gemini Plugin for HomeSeer Requirements

HomeSeer Version 2.0.0.0 or higher must be installed.

Installation

To install the Napco Gemini plug-in for HomeSeer version 2.x, select the “Updater” button on the web interface, or select “Updates” from the “Help” menu. Follow the on-screen instructions for the Updater. Select the Napco Gemini plug-in on the package selection screen, then follow the on-screen instructions to finish the update process, and restart HomeSeer. After restarting HomeSeer, click the “Setup” tab and then the “Interfaces” tab on the web site. Click “Disabled” to enable the plugin, and then click “Save” at the bottom of the screen.

Overview

This plug-in adds support for the Napco Gemini security panel that contains the GEM-AUTO upgrade. By connecting your panel to the RS232 port on your PC, HomeSeer can control your security system. The plug-in adds new event triggers that allow you to trigger on changes in zone status as well as trigger on alarms. New actions include the ability to arm/disarm your system as well as bypass zones. An image of your keypad is available on a web page and shows the current system status.

Napco Devices

The plug-in will poll your Napco Gemini panel on startup and retrieve a list of zone descriptions, the status of each zone, and the area number to which that zone belongs. The panel will send keypad display messages for each defined area, and as those updates arrive (within 1 minute of starting HomeSeer), the area devices will be discovered and the web page links will be created (this means there could be up to 1 minute where no area devices exist and no links are present on the web page).

The following devices will be created to represent and control your alarm panel:

Last Alarm Event

This device exists to display information regarding any actual alarms recorded by the panel. When the device is created, it is in the “Off” state with a description of “No New Alarms.” If an alarm occurs, the device will be changed to “On”, and have information regarding the time and zone of the alarm. Until reset, the device will continue to have alarm events added to the list.

The device has a control option (accessed by right-clicking the device and choosing “Control” in the GUI, or through the button on the web page) of “Clear Last Alarm”, which will reset the text to “No New Alarms” and turn the device “Off”.

One example use for this device is to check the On/Off status in a HomeSeer Phone script when logging into your voice mail or to added it to your “Welcome Home” event to announce any alarms that occurred while you

3.

2.

1.


were away.

Area Devices

One area device will be created for each defined area upon receiving a keypad status update. Area devices are numbered sequentially, and have control options of “Arm Area” and “Disarm Area”. Their status will change from “On” (Armed) to “Off” (Disarmed). They can also be used with Condition statements in Event definitions.

Zone Devices

One zone device will be created for each zone returned when the panel is polled at startup. Zone devices are numbered sequentially, but have a description that is provided by the panel. To edit this description, you must use either the keypad programming technique outlined in the installation instructions or panel programming software such as PCD3000 or QuickLoader for Windows.

Zone devices have two control options, “Bypass Zone” and "Set Device Type for Zone". Their device string will indicate whether the area they are in is armed or disarmed, or if the zone is currently bypassed. When you set a device type for the zone, your new choice is saved in the ini file and will be used whenever the zone number device is recreated. Status changes from “On” (Open) to “Off” (Closed).

Web Page Options


Arm Button: Controls whether or not the area’s Arm button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Disarm Button: Controls whether or not the area’s Disarm button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Bypass Button: Controls whether or not each zone’s Bypass button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Keypad Refresh: The number of seconds to wait while viewing the Napco Area web pages of the HomeSeer Web Interface site before automatically refreshing the page.

Scripting Interface

The scripting interface for the Napco plug-in is limited due to concerns about the sensitive nature of alarm systems. Status and control functions are only available via the HomeSeer GUI and Web Interface.

The plugin, which can be accessed in scripts using the ‘hs.plugin(“Napco Gemini”)” object, does provide a


“LastSecurityEvent”, which will allow scripts to react to panel event notifications with specific information available depending on the event.

The following attributes may be available for any given event:

General Options

Event Name The name of the event that just occurred.

Event Number The number of the event that just occurred.

Parameter1 The first parameter provided (this will often be the AreaNumber)

, but because each event could have different interpretations of this parameter, it is provided here as well.

Parameter2 The second parameter provided (this will often be the

ZoneNumber), but because each event could have different interpretations of this parameter, it is provided here as well.

AreaNumber The area associated with the event. Typically Parameter1.

ZoneNumber The zone number associated with the event. Typically

Parameter2.

ZoneName The zone description associated with the event. Typically

Parameter2.

UserNumber The user associated with the event. Only populated with Arm

and Disarm events as Parameter2.


Panel options

Master Code: This is the master code to your alarm panel. It is typically found inside your panel’s housing on a sticker over the main chip area. Contact your installer if you don’t know this code.

(Note: The master code is stored in the hspi_napco_gemini.ini file in an encrypted manner. It is still advisable to avoid sharing this file with anyone as an added precaution.)

Port: This is the COM port that your panel’s PC-MINI is connected to.

Timing options

Command Timeout: The amount of time to wait for a response from the panel when sending commands.

Poll Delay on Disarm: This is a small delay used to adjust how long the plug-in waits to poll the panel for device status after a disarm event occurs. Setting this to 0 will cause the polling to be immediate, which can occasionally result in a delay in the keypad receiving it’s notification of the disarm event. Usually 1 or 2 seconds is sufficient.

Appearance options


Use Built-In Icons in Device String: The plug-in ships with icons that can be automatically added to the device string for display on the HomeSeer status web page. These icons are installed in the “HomeSeer\html\images\napco” directory, and can be changed or replaced at any time. They will not be overwritten by future updates.

Logging Options

Incoming Status Messages: Creates log entries for any events sent from the panel to the plug-in (if the event relates to a zone, the event will NOT be logged unless the zone is selected below).

Outgoing Commands: Logs all commands sent from the plug-in to the panel.

Debug Information: This is a very verbose level and should only be used for a short time while troubleshooting. It includes keypad update messages and program location information for support purposes.

Log changes for these zones: De-select any zones for which you do not want Incoming Status Messages logged. Particularly useful for motion sensors and other high-traffic areas.

Web Page Options


Arm Button: Controls whether or not the area’s Arm button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Disarm Button: Controls whether or not the area’s Disarm button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Bypass Button: Controls whether or not each zone’s Bypass button will be displayed on the Napco Area web pages of the HomeSeer Web Interface site.

Keypad Refresh: The number of seconds to wait while viewing the Napco Area web pages of the HomeSeer Web Interface site before automatically refreshing the page.

Bypass Zones Options


Always Bypass Zones: This allows multiple zones to be selected that should be bypassed every time the alarm is armed using the plug-in.

Event Triggers

The following events are support by the plug-in, and can be used as triggers to execute events in HomeSeer. Some events include options for triggering based on specific zones and/or areas.

About to Set Clock AC Power Fail AC Power Reset Alarm Alarm Supervisory Alarm Supervisory Restore Area Armed Area Disarmed Auto-arm Delayed 1 Hour Auto-arm Delayed 2 Hours Auto-arm Delayed 3 Hours Auto-arm Delayed 4 Hours Auto-arm Disabled Auto-Bypass Zone Re-Entry Burg Bell Silence Burg Bell Timeout


Bus 2 Fail Bus 2 Restore Communications Restored Date Day Zone Alarm Day Zone Reset Day Zone Trouble Day Zone Trouble Reset Dealer Memory Fail Dealer Program Mode Activity Digital Dialer Test Door Access EZM Fail EZM Restore EZM Tamper EZM Tamper Reset Fail to Close Fail to Close Delayed 1 Hour Fail to Close Delayed 2 Hours Fail to Close Delayed 3 Hours Fail to Close Delayed 4 Hours Fail to Close Disabled Fail to Open Failure to Communicate FEZM Tamper FEZM Tamper Reset Fire Fire Bell Silence Fire Bell Timeout Fire Bypass Fire Drill Fire Reset Fire Supervisory Fire Supervisory Reset Fire Supervisory Trouble Fire Supervisory Trouble Reset Fire Trouble Fire Trouble Reset Fire Unbypass FKP:Tamper FKP:Tamper Reset Guard Tour Fail Guard Tour Pass Guard Tour Start Guard Tour Station History Log Auto Dump History Log Auto Dump Fail KeyFob LB KeyFob LB Reset


Keypad Ambush Keypad Bus Fail Keypad Bus Reset Keypad Fail Keypad Fire Keypad Medical Keypad Panic Keypad Restore Keypad Tamper Keypad Tamper Reset Low Battery Low Battery Reset Low RF Signal Level NT Log Cleared One Man Test Alarm One Man Test Reset Panel Ground Fault Panel Ground Fault Reset Panel Reset Normal Panel Reset Watchdog Panel Signal ckt Fault Panel Signal ckt Reset PCD Callback Failure PCD Forced WatchDog PCPreset Log Upload Printer Fail Printer Restore Program Change Pulsed Burg Bell Silenced QL Bypass QL Connection Dealer QL Connection Technical QL Connection Terminated QL Device Control QL Download QL Histroy Log Activity QL Keypad Reset QL Log Cleared QL Remote Relay Control QL Service Code QL System Shutdown QL Trouble Bypass QL Upload QL Verify QL Verify Fail RBM Fail RBM Reset RBM Sig Circuit Fault RBM Sig Circuit Fault Reset


Event Actions

Relay Off Relay On Reset Sensor Watch Restore RF Transmitter Low Bat RF Transmitter Low Bat Reset RF Transmitter Supervisory Fail RF Transmitter Supervisory Reset RF Transmitter Tamper RF Transmitter Tamper Reset RFEZM Fail RFEZM Receiver Jam RFEZM Receiver Jam Reset RFEZM Reset RFEZM Tamper RFEZM Tamper Reset Self Test Failure Sensor Fail Service Message Activated Silence Pulse Burg Time Out Telemetry Failure Telemetry Failure Restore Telemetry Restore Telemetry Trouble Telephone Line 1 Fail Telephone Line 1 Reset Telephone Line 2 Fail Telephone Line 2 Reset Test Timer Time Trouble Trouble Reset User Memory Fail User Program Mode Activity V61:FEZM Ground Fault V61:FEZM Ground Fault Reset Water Alarm Water Reset Water Trouble Water Trouble Reset Zone Bypassed Zone Closed Zone Opened Zone Shorted Zone Unbypassed


The plug-in also adds a new tab to the event properties dialog that allows you to control the panel through the execution of a HomeSeer event.

Area/Zone Actions:

Arm Area

Disarm Area

Bypass Zone

Area: For Arm and Disarm actions, an Area must be specified. Area is not allowed for the Bypass Zone action.

Zone: For the Bypass Zone action, a Zone must be specified. Zone is not allowed for Arm and Disarm actions.

The following commands can also be sent to the panel using an event:


Burg On Burg Off Burg Toggle Aux On Aux Off Fire On Fire Off Reset On Reset Off Ext Relay On (followed by Relay Number 1-96) Ext Relay Off (followed by Relay Number 1-96)

Support

For Support:

Help Desk: www.homeseer.com (select HelpDesk from the Suppot menu)

Support is also available on our message board at:

http://board.homeseer.com

Look for the forum dedicated to the Napco Gemini plugin.

napco gemini plugin for homesee · napco gemini plugin for homeseer arm button: controls whether or...

Documents