Difference between revisions of "FAS"

From JacobDNS
Jump to navigation Jump to search
(Added API)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
Welcome and thank you for purchasing my Fire Alarm System! It has several components and I've attempted to make it as user friendly as possible. If you have any questions, feel free to ask in our discord server for the fastest support. https://discord.gg/KDTQXBQm6K
 
Welcome and thank you for purchasing my Fire Alarm System! It has several components and I've attempted to make it as user friendly as possible. If you have any questions, feel free to ask in our discord server for the fastest support. https://discord.gg/KDTQXBQm6K
  
=== Definitions ===
+
=== Feature List ===
{| class="wikitable"
+
 
|+
+
* Detects and Suppresses HD Fires
!Terms
+
* Able to send Alarm Messages to Discord and the Nexus Pager System.
!Definition/Purposes
+
* Able to automatically unlock Certain Gentek IntelliDoor Models.
|-
+
* Fully Functional Emergency Lighting System
|FACU
+
* Bell and Buzzer Models for the Notification System.
|FACU, or Fire Alarm Control Unit, is also known as the Annunciator or Control Panel. This is the brains of your fire alarm system, and it will not work without it.  
+
* Includes US, UK, and EU Fire Pull Station Versions.  
|-
+
 
|Buzzer, Alarm, Notification Appliance
+
=== Credits ===
|These are the things that Beep, Buzz, Ring, Flash or whatever you need to get the building occupants attention. There are several models and versions described later in this manual.  
+
 
|-
+
* Scripting - Jacob Fear (dark.nebula)
|Pull Station
+
* Models - Vesper Beretta (dardickerish); Libby Static(European and UK Pull Station Models); Niki Halkia (thessalie.vespucciano)(Alarm Bell & US Pull Station)
|This is the thing you pull to manually set off the fire alarm system.  
+
* Textures - Jacob Fear, Niki Halkia
|}
+
* Includes Integrations for 3rd party systems by:
 +
** Gentek IntelliDoors by [https://marketplace.secondlife.com/stores/18844 Nelson Jenkins & Gentek].  
 +
** [https://marketplace.secondlife.com/p/Nexus-Pager-System-V3/4593342 Nexus Pager System] by [https://marketplace.secondlife.com/stores/58639 Shymus Roffo & Nexus Roleplay Systems.]
 +
** [https://discord.com/company Discord by uh...Discord :) It's a Chat Platform.]
 +
 
 
= '''<span style="color:#4D5A93">FACU - Fire Alarm Control Unit</span>''' =
 
= '''<span style="color:#4D5A93">FACU - Fire Alarm Control Unit</span>''' =
 
:The first steps on setting everything up is to have your FACU set up.  
 
:The first steps on setting everything up is to have your FACU set up.  
Line 22: Line 27:
 
== To Setup ==
 
== To Setup ==
 
:Follow these steps to setup your FACU.
 
:Follow these steps to setup your FACU.
# Rez out the "[JAC] Fire Alarm Control Unit".
+
# Rez out the "[RR] FAS FACU".
 
# Right Click and go into the object's contents.
 
# Right Click and go into the object's contents.
 
# Edit the notecard "Application.Config".
 
# Edit the notecard "Application.Config".
Line 32: Line 37:
  
 
=== Suppression ===
 
=== Suppression ===
Not Yet Implemented
+
If Suppression is on, and a Detector has a fire signal sent, Suppression will activate. It will not activate for a Pull Station Activation.
 
=== Reset ===
 
=== Reset ===
 
:Resetting your FACU will turn everything off in the system and rearm it.
 
:Resetting your FACU will turn everything off in the system and rearm it.
Line 40: Line 45:
 
:Don't you love when your employees see you heading towards that alarm panel? DRILL TIME
 
:Don't you love when your employees see you heading towards that alarm panel? DRILL TIME
  
:When you do a drill on the Annunciator, it will not send a tone out on Discord
+
:When you do a drill on the Annunciator, it will not send a tone out on Discord/Pagers
 +
:
 +
 
 +
=== Lighting ===
 +
You can manually turn on the lights via this button on the panel. They will auto turn on when a alarm goes off.
 +
 
 +
=== Doors/Egress ===
 +
If you have a Relay setup for the Gentek IntelliDoors, this will toggle weather or not a door unlock signal is sent upon a alarm.
 +
 
 +
These only work with Gentek IntelliDoors Home, Commercial, Industrial, Glass and Alarmed that are versions 3.0.0 and later.
  
 
= Pull Station =
 
= Pull Station =
 
: The pull station is used to set off the alarms in case of an emergency.
 
: The pull station is used to set off the alarms in case of an emergency.
: Make sure this is out in the opening or people might burn.
+
: Make sure this is out in the open or people might burn.
  
 
== To Setup ==
 
== To Setup ==
Line 59: Line 73:
 
== To Setup ==
 
== To Setup ==
 
:Follow these steps to setup your Bell
 
:Follow these steps to setup your Bell
# Rez out the "[JAC] FAS Fire Alarm Notification Appliance(Bell)".
+
# Rez out the "[RR] FAS Alarm Bell".
 
# Right Click and go into the object's contents.
 
# Right Click and go into the object's contents.
 
# Edit the notecard "Application.Config".
 
# Edit the notecard "Application.Config".
 
# Put the Alarm ID from your Fire Alarm Control Unit. Then Save.
 
# Put the Alarm ID from your Fire Alarm Control Unit. Then Save.
 +
# Changing the sounds can be accomplished by replacing the sounds inside the Bell/Buzzer with your own named "DRILL" and "FIRE".
  
 
= Smoke Detector =
 
= Smoke Detector =
  
 +
# Rez out your [RR] FAS Smoke Detector.
 +
# Configure your AlarmID as appropriate, there are no other configurable variables at this time.
 +
# It will detect HD Fires and anything else named "SMOKE". <br />
 +
= Fire Sprinklers =
 +
 +
# Rez out your sprinklers and configure the AlarmID to your system. There is no other configurable variables at this time.
 +
 +
= Auxilary Relays =
 +
 +
=== Discord Relay ===
 +
 +
# Rez Out your "[RR] FAS Relay(Discord)"
 +
# Configure your Relay as described in your Notecard, detailed instructions are above each variable.
 +
 +
=== Nexus Pager Relay ===
 +
 +
# Rez out your "[RR] FAS Relay(Nexus Pagers)"
 +
# Go to your Nexus Pager Computer Terminal and Copy the Object Description. Paste this into the Description of your Relay.
 +
# Configure the Relay Variables as you wish in the Notecard Configuration.
 +
# The Messages will show up on the pagers and speakers you have set to that channel. 
 +
 +
=== Gentek IntelliDoor Relay ===
  
= Fire Sprinklers =
+
# Rez our your "[RR] FAS Relay(IntelliDoor)"
Not Yet Implemented
+
# Copy the BBID Of your doors(It must be the same for all the doors you are controlling.) You will find this in the Object Description of one of your doors. Place this BBID in your Config Notecard where appropriate unless the BBID of your Doors is None, then leave it as is.
= Discord Relay =
+
# Place the List of Doors you wish to unlock when a alarm goes off in the notecard as well, separating them with commands. DoorID1,DoorID2,MyFrontDoor,WeirdRoom
Setup Instructions will be put here for the discord relay
+
 
 +
 
 +
== API ==
 +
For any techies out there, I've included a very basic API for you. It doesn't give all the specifics and stuff like the system gives components made by Red Robot(It's simply to allow us to create proprietary components that have more features), but nevertheless, I feel any decent system in SL should have a API nowadays as should any software in General.
 +
 
 +
You can listen on channel 69421 for the following commands prefixed by your Alarm ID and a |
 +
 
 +
-  ALARM    =   Means the system is in an Alarm State from a Pull Station or a Smoke Detector. When a 3rd party modification receives this, a internal boolean should be set to TRUE and the device should not accept any more fire commands until a RESET command is received.  This will not be triggered with a drill.
 +
 
 +
- RESET = The System has been reset, any third party modifications should reset as well.
 +
 
 +
- SILENCE = The System has been silenced, but is still in Alarm Mode.

Latest revision as of 08:29, 17 November 2021

Welcome and thank you for purchasing my Fire Alarm System! It has several components and I've attempted to make it as user friendly as possible. If you have any questions, feel free to ask in our discord server for the fastest support. https://discord.gg/KDTQXBQm6K

Feature List

  • Detects and Suppresses HD Fires
  • Able to send Alarm Messages to Discord and the Nexus Pager System.
  • Able to automatically unlock Certain Gentek IntelliDoor Models.
  • Fully Functional Emergency Lighting System
  • Bell and Buzzer Models for the Notification System.
  • Includes US, UK, and EU Fire Pull Station Versions.

Credits

FACU - Fire Alarm Control Unit

The first steps on setting everything up is to have your FACU set up.
The FACU is used to control your network of fire alarms that are configured to it.

To Setup

Follow these steps to setup your FACU.
  1. Rez out the "[RR] FAS FACU".
  2. Right Click and go into the object's contents.
  3. Edit the notecard "Application.Config".
  4. Enter an Alarm ID. (This is used to link alarms together).
  5. Enter a group setting.


Operation

Suppression

If Suppression is on, and a Detector has a fire signal sent, Suppression will activate. It will not activate for a Pull Station Activation.

Reset

Resetting your FACU will turn everything off in the system and rearm it.
When you're done with the alarms and don't need them on anymore, this is what you should press to reset them back to Normal Status

Drill

Don't you love when your employees see you heading towards that alarm panel? DRILL TIME
When you do a drill on the Annunciator, it will not send a tone out on Discord/Pagers

Lighting

You can manually turn on the lights via this button on the panel. They will auto turn on when a alarm goes off.

Doors/Egress

If you have a Relay setup for the Gentek IntelliDoors, this will toggle weather or not a door unlock signal is sent upon a alarm.

These only work with Gentek IntelliDoors Home, Commercial, Industrial, Glass and Alarmed that are versions 3.0.0 and later.

Pull Station

The pull station is used to set off the alarms in case of an emergency.
Make sure this is out in the open or people might burn.

To Setup

Follow these steps to setup your Fire Alarm Notification Station.
  1. Rez out the "[JAC] FAS Manual Notification Station".
  2. Right Click and go into the object's contents.
  3. Edit the notecard "Application.Config".
  4. Enter an Alarm ID (This is used to link alarms to the FACU).

Bell

The Bell is used to make your nearby people upset
Of course, you can use it to inform people they need to get out of the oven.

To Setup

Follow these steps to setup your Bell
  1. Rez out the "[RR] FAS Alarm Bell".
  2. Right Click and go into the object's contents.
  3. Edit the notecard "Application.Config".
  4. Put the Alarm ID from your Fire Alarm Control Unit. Then Save.
  5. Changing the sounds can be accomplished by replacing the sounds inside the Bell/Buzzer with your own named "DRILL" and "FIRE".

Smoke Detector

  1. Rez out your [RR] FAS Smoke Detector.
  2. Configure your AlarmID as appropriate, there are no other configurable variables at this time.
  3. It will detect HD Fires and anything else named "SMOKE".

Fire Sprinklers

  1. Rez out your sprinklers and configure the AlarmID to your system. There is no other configurable variables at this time.

Auxilary Relays

Discord Relay

  1. Rez Out your "[RR] FAS Relay(Discord)"
  2. Configure your Relay as described in your Notecard, detailed instructions are above each variable.

Nexus Pager Relay

  1. Rez out your "[RR] FAS Relay(Nexus Pagers)"
  2. Go to your Nexus Pager Computer Terminal and Copy the Object Description. Paste this into the Description of your Relay.
  3. Configure the Relay Variables as you wish in the Notecard Configuration.
  4. The Messages will show up on the pagers and speakers you have set to that channel.

Gentek IntelliDoor Relay

  1. Rez our your "[RR] FAS Relay(IntelliDoor)"
  2. Copy the BBID Of your doors(It must be the same for all the doors you are controlling.) You will find this in the Object Description of one of your doors. Place this BBID in your Config Notecard where appropriate unless the BBID of your Doors is None, then leave it as is.
  3. Place the List of Doors you wish to unlock when a alarm goes off in the notecard as well, separating them with commands. DoorID1,DoorID2,MyFrontDoor,WeirdRoom


API

For any techies out there, I've included a very basic API for you. It doesn't give all the specifics and stuff like the system gives components made by Red Robot(It's simply to allow us to create proprietary components that have more features), but nevertheless, I feel any decent system in SL should have a API nowadays as should any software in General.

You can listen on channel 69421 for the following commands prefixed by your Alarm ID and a |

- ALARM = Means the system is in an Alarm State from a Pull Station or a Smoke Detector. When a 3rd party modification receives this, a internal boolean should be set to TRUE and the device should not accept any more fire commands until a RESET command is received. This will not be triggered with a drill.

- RESET = The System has been reset, any third party modifications should reset as well.

- SILENCE = The System has been silenced, but is still in Alarm Mode.