Difference between revisions of "Nexus Burglar Alarm/Documentation"

From Nexus
Jump to: navigation, search
(Created page with "← Nexus Burglar Alarm System {|align=right |__TOC__ |} = '''<span style="color:#4D5A93">Nexus Burglar Alarm Documentation</span>''' = This document...")
 
Line 18: Line 18:
  
 
== To Setup ==
 
== To Setup ==
: Follow these steps to setup your Annunciator.
+
: Follow these steps to setup your Control Panel.
 
# Rez out the control panel.
 
# Rez out the control panel.
 
# Right Click and go into the object's contents.
 
# Right Click and go into the object's contents.
Line 35: Line 35:
 
# Set the location of your control panel.
 
# Set the location of your control panel.
 
# "PagerDebug" will send you pager's API error messages, if you're getting no messages on the pagers, this will help you and tell you why.
 
# "PagerDebug" will send you pager's API error messages, if you're getting no messages on the pagers, this will help you and tell you why.
 +
 +
= '''<span style="color:#4D5A93">Home Panel</span>''' =
 +
: The home panel allows for you to arm/disarm the burglary alarm.
 +
: It is also used to set the access list.
 +
:
 +
: If a user is set on the access list, they will not set off the alarm when it is armed.
 +
 +
== To Setup ==
 +
: Follow these steps to setup your Home Panel
 +
# Rez out the home panel.
 +
# Set your "AlarmID", make sure it matches the control panel.
 +
# Set your "Access". This will decide who can access the home panel. If it is set to group, anyone in the group matching the panel can access it.
 +
# Add names to the "WhiteList". Any names on this list will be ignored by the sensor and can access the home panel.
 +
 +
= '''<span style="color:#4D5A93">Straight / Angled Sensor</span>''' =
 +
: The sensor will detect people.
 +
 +
== To Setup ==
 +
: Follow these steps to setup your Sensor.
 +
# Rez out your Sensor, then position facing the area you want to detect.
 +
# Set the "AlarmID" to match your control panel.
 +
# Set the range of the sensor. This is how far the cone in front of the sensor will reach.
 +
 +
= '''<span style="color:#4D5A93">Alarm</span>''' =
 +
: The alarm is used to make sound for the alarm.
 +
: You can set your own sound, or use one provided for you.
 +
 +
== To Setup ==
 +
: Follow these steps to setup your Alarm.
 +
# Rez out the Alarm
 +
# Set the "AlarmID" to match your control panel.
 +
# Set the sound you would like to use. If you have your own sound, you will need to paste the sound UUID in the notecard.
 +
 +
= '''<span style="color:#4D5A93">Emergency Light</span>''' =
 +
: The Emergency Light can either be turned on with the Control Panel, or when an alarm is triggered.
 +
 +
== To Setup ==
 +
: Follow these steps to setup your Emergency Light
 +
# Rez out your Emergency Light.
 +
# Set the "AlarmID" to match your control panel.
 +
# Set whether you would like to have the lights turn on when the alarms are triggered.

Revision as of 22:48, 26 February 2017

← Nexus Burglar Alarm System

Nexus Burglar Alarm Documentation

This documentation is to better help you with the product to help you efficiently work with the product and make use of all of its features properly. Having trouble using a feature? Consult the documentation below.

Need help navigating this manual better? Please use the table of contents to the right of this page.

Before we get started on using the Burglar Alarm System, we would like to thank you for choosing us! If you have any questions please ask in our Second Life Group. If your questions are not answered, please file a ticket here on our Support Site.

Control Panel

Your control panel is used for controlling your Alarms, Lights, and Sensors.
Setting it up is extremely easy. All you need to do is follow the steps.

To Setup

Follow these steps to setup your Control Panel.
  1. Rez out the control panel.
  2. Right Click and go into the object's contents.
  3. Edit the notecard "_config".
  4. Enter an Alarm ID. (This is used to link alarms together).
  5. Choose who you want to access it. (Access)
If you don't want to use the pagers, then your control panel is all set up.
Since the pager API is pre-built into the control panel, you can set all the variables in "_config" notecard.

Setting Up Pagers

  1. Get Pager Network ID from Pager Computer Terminal.
  2. Put Pager Network Key in "PagerKey" in the _config notecard.
  3. Enter the channel you would like burglar alarm messages to be sent on.
  4. Set how you want the message to be sent. Setting "ToneOut" to "Pager" will send it to only pagers.
  5. Set the location of your control panel.
  6. "PagerDebug" will send you pager's API error messages, if you're getting no messages on the pagers, this will help you and tell you why.

Home Panel

The home panel allows for you to arm/disarm the burglary alarm.
It is also used to set the access list.
If a user is set on the access list, they will not set off the alarm when it is armed.

To Setup

Follow these steps to setup your Home Panel
  1. Rez out the home panel.
  2. Set your "AlarmID", make sure it matches the control panel.
  3. Set your "Access". This will decide who can access the home panel. If it is set to group, anyone in the group matching the panel can access it.
  4. Add names to the "WhiteList". Any names on this list will be ignored by the sensor and can access the home panel.

Straight / Angled Sensor

The sensor will detect people.

To Setup

Follow these steps to setup your Sensor.
  1. Rez out your Sensor, then position facing the area you want to detect.
  2. Set the "AlarmID" to match your control panel.
  3. Set the range of the sensor. This is how far the cone in front of the sensor will reach.

Alarm

The alarm is used to make sound for the alarm.
You can set your own sound, or use one provided for you.

To Setup

Follow these steps to setup your Alarm.
  1. Rez out the Alarm
  2. Set the "AlarmID" to match your control panel.
  3. Set the sound you would like to use. If you have your own sound, you will need to paste the sound UUID in the notecard.

Emergency Light

The Emergency Light can either be turned on with the Control Panel, or when an alarm is triggered.

To Setup

Follow these steps to setup your Emergency Light
  1. Rez out your Emergency Light.
  2. Set the "AlarmID" to match your control panel.
  3. Set whether you would like to have the lights turn on when the alarms are triggered.