Overview
This guide provides step-by-step instructions for configuring the Shooter Detection System (SDS) integration with Genea. The integration connects your Guardian Gateway sensors to the Genea platform, enabling real-time monitoring, automatic alerting, and comprehensive event logging.
Prerequisites
Before beginning setup, ensure you have:
• Guardian Gateway application installed and running (default port 31000)
• Access to the Guardian Gateway configuration files (gateway.csv)
• Administrator access to your Genea account
• On-premises server with network access to both Guardian Gateway and Genea cloud services
• Valid SDS license code from Guardian Engineering
• Network connectivity between the on-premises server and the Guardian Gateway
Integration Architecture
The SDS integration consists of three main components:
• Guardian Gateway - Manages all sensor communications and runs on port 31000 by default
• Genea SDS On-Premises Application - TCP server that receives sensor data and forwards events to Genea Cloud
• Genea Cloud Services - Processes events, manages alerts, and provides the user interface
Setup Steps
Step 1: Enable SDS Integration in Genea
a) Log in to your Genea account as an administrator
b) Navigate to Settings > Integrations
c) Locate Shooter Detection System in the integrations list
d) Click Enable to activate the integration
e) Copy the generated API token (you will need this for the on-premises server)
f) Copy the webhook URL provided (format: wss://genea-sds.example.com/webhook)
Important: Store the API token securely. It will only be displayed once. If you lose it, you will need to regenerate a new token.
Step 2: Verify License Configuration
The SDS integration requires a valid license code. Contact Guardian Engineering to obtain your license code, then:
g) Add the license code to the Guardian Gateway system
h) Restart the Guardian Gateway to apply the license
When connecting to the Guardian FSAMon channel, the system transmits license information in this format:
LICENSE_INFO LACMEV:1;LC9000A:1;LSEALEV:1;...
The integration specifically checks for the LACMEV license:
• LACMEV:1 - Licensed, integration will operate normally
• LACMEV:0 - Not licensed, integration will not operate
• LACMEV not present - Integration will proceed as if licensed (legacy support)
Step 3: Configure the On-Premises TCP Server
Set up the Genea SDS on-premises application on a server that can communicate with both the Guardian Gateway and Genea Cloud:
i) Download the Genea SDS application from the Genea support portal
j) Install the application on your on-premises server
k) Configure the application with the API token and webhook URL from Step 1
l) Set the TCP listener port (default: 31002, or choose an available port)
m) Start the application and verify it is listening on the configured port
The on-premises application will establish a socket connection to Genea Cloud for real-time event forwarding.
Step 4: Configure Guardian Gateway to Forward Data
Modify the Guardian Gateway configuration to send sensor data to the Genea on-premises application:
n) Locate the gateway.csv configuration file on your Guardian Gateway server
o) Add a new entry for the Genea TCP server with the following parameters:
Parameter | Value |
Network Interface | IP address of your on-premises server (e.g., 192.168.1.100) |
Port | Port configured in Step 3 (e.g., 31002) |
PortType | FSAMonClient |
MaxClients | 1 |
SSLEnabled | false |
SSLKey | "" (empty string) |
p) Save the gateway.csv file
q) Restart the Guardian Gateway application to apply the changes
Note: The Guardian Gateway only accepts numeric IPv4 addresses. DNS names are not supported.
Step 5: Verify Connection and Data Flow
r) Check the on-premises application logs to confirm connection from Guardian Gateway
s) Verify the application is receiving heartbeat messages (sent every 15-20 seconds)
t) Log in to Genea and navigate to Security > Shooter Detection System
u) Confirm sensors are appearing in the Genea dashboard (may take 10-15 minutes for initial sync)
Understanding Message Types
The Guardian Gateway sends several types of messages that the on-premises application processes:
Heartbeat Messages (MT:HB)
Sent every 15-20 seconds for each sensor. Heartbeats provide current sensor status:
• No WC field or WC:0 - Sensor is fully functional
• WC:1 to WC:189 - Sensor is degraded (specific code indicates issue type)
• WC:190 - Sensor is offline
^SI:S6474F600F7D3;MT:HB;ST:GRDN_2;MSC:2;DD:20241220173655;SV:R2.7.3;UT:28;TMP:21;NIP:127.0.0.1;WC:0$
Description Messages (MT:DESC)
Contains complete sensor configuration information including facility, floor, location, and network details. Sent approximately every 10 minutes. The on-premises application uses these to populate sensor details in Genea.
^SI:S1234567;MT:DESC;ST:GRDN_2;MSC:2;DD:20171027012233;NIP:192.168.1.33;NFC:300 Newbury Turnpike;NFL:Floor 2;NLC:Executive Office Suite;NDS:S33$
Gunshot Detection Messages (MT:DET)
Generated when a sensor detects gunfire. These messages are forwarded immediately to Genea Cloud to trigger critical alarms.
Live Shot Detection:
^SI:S1234567;MT:DET;ST:GRDN_2;MSC:2;DD:20180912110109;DT:EV_FLASHBANG;CL:HIGH;NIP:10.10.0.99;NFC:SDS HQ;NFL:Floor 2;NLC:Conference Room$
Simulated Shot (Training):
^SI:S1234567;MT:DET;ST:GRDN_2;MSC:2;DD:20171027012233;DT:EV_FLASHBANG;CL:HIGH;DSC:TRAINER;NIP:10.10.0.99$
The presence of DSC:FSASIM or DSC:TRAINER indicates a test/training scenario.
Maintenance Warning Messages (MT:WARN)
Indicate sensor health issues. The warning code (WC) determines severity:
• WC:190 - Sensor offline (critical)
• WC:1-189 - Sensor degraded (warning level varies by code)
• WC:200+ - Singular events like tamper or tester mode (always report)
^SI:S1234567;MT:WARN;ST:GRDN_2;MSC:2;DD:20171027012233;WT:TESTSIG;WC:50;WDS:IR SENSOR BIT;WDL:IR SENSOR - DEGRADED;NIP:10.10.0.99$
Maintenance Event Aggregation
To prevent alert fatigue from large-scale maintenance events (such as network outages affecting many sensors), the on-premises application implements aggregation logic:
1. System starts in a healthy state (100% operational)
2. On first maintenance warning (WC < 200), send immediate notification
3. Wait 3 minutes, then send a summary notification if any sensors remain degraded or offline
4. Continue sending hourly summary notifications until all sensors are healthy
5. Send an ALL-CLEAR notification when all sensors return to healthy status
This approach provides immediate notification of issues while preventing hundreds of redundant alerts during infrastructure problems.
Sensor Mapping and Initial Sync
The integration supports two approaches for initial sensor discovery:
Approach 1: Description Message Parsing (Recommended)
The on-premises application passively listens for description messages (MT:DESC) sent every 10 minutes:
• Advantages: Simple implementation, no additional connections required
• Disadvantages: Initial sync takes 10-15 minutes as description messages arrive
• Use case: Standard deployment where immediate sensor visibility is not critical
Approach 2: Command Port Query
The application can connect to the Guardian Gateway command port (31001) to request sensor configuration:
• Send command: GGW:export_node_config
• Parse the returned CSV data to populate sensor details immediately
• Advantages: Immediate sensor visibility upon integration activation
• Disadvantages: Requires additional connection management and CSV parsing logic
• Use case: Deployments requiring immediate sensor visibility
Hybrid Approach (Optimal)
For optimal user experience:
6. On initial setup, use command port query for immediate sensor discovery
7. Close command port connection after initial sync
8. Use description messages for ongoing updates to sensor configuration
Floor Plan Integration
To map sensors to floor plans in Genea:
9. Ensure floor plans are uploaded to Genea (Settings > Floor Plans)
10. Navigate to Security > Shooter Detection System > Floor Plan Mapping
11. Select a sensor from the list
12. Click on the floor plan at the sensor's physical location
13. Save the mapping
Sensor locations from description messages (latitude/longitude if provided) can be used for automatic mapping if floor plans have geospatial coordinates configured.
Troubleshooting
On-Premises Application Not Receiving Data
• Verify the application is listening on the correct port
• Check firewall rules allow traffic from Guardian Gateway IP
• Confirm gateway.csv entry uses the correct IP address and port
• Verify Guardian Gateway was restarted after gateway.csv modification
Sensors Not Appearing in Genea Dashboard
• Wait 10-15 minutes for initial description messages to arrive
• Check on-premises application logs for description message parsing
• Verify socket connection to Genea Cloud is established
• Confirm API token is valid and correctly configured
Events Not Triggering Alarms
• Check event logs in Genea to verify events are being received
• Verify your user role has permissions for SDS alarms
• Confirm notification settings are enabled for SDS events
• Review on-premises application logs for event processing errors
License Validation Failing
• Verify license code was added to Guardian Gateway
• Restart Guardian Gateway after adding license
• Check on-premises application logs for LICENSE_INFO header parsing
• Contact Guardian Engineering if LACMEV license is not present in header
Advanced Configuration
Customizing Maintenance Alert Intervals
The default maintenance alert intervals can be adjusted in the on-premises application configuration:
• Initial alert delay: 3 minutes (time before first summary)
• Repeat interval: 1 hour (time between summary notifications)
Modify these values in the application configuration file to match your operational requirements.
Heartbeat Monitoring Threshold
If no heartbeat is received from a sensor within a configurable threshold (default: 60 seconds), the sensor is marked inactive. Adjust this threshold based on network conditions and acceptable detection latency.
Support and Additional Resources
For additional assistance:
• Genea Support Portal: support.genea.com
• Email: support@genea.com
• Phone: 1-866-935-1557
