IntelliDoor Keypad

Revision as of 17:38, 10 February 2015 by imported>NelsonJenkins
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Other than the security options in the door, the IntelliDoor Keypad allows for access by anyone with a custom-set password. It can be from 1-5 characters, and the Keypad has various customization options beyond just the password. It is also mesh, sporting high detail for only a prim.

Setup

  1. Set up the door according to its user manual..
  2. Rez the keypad near the door and position it.
  3. Open the _config notecard inside the keypad and make sure the DoorID is the same as the DoorID in the door's _config notecard. Also, change the password. Remember, anyone can unlock the door if they have the password, so make it difficult to guess.
  4. Save the _config notecard and test the keypad by entering the password. The green indicator light should turn on, and should turn off when you open the door. (As owner, you can open the door without unlocking it, so get someone not covered by the base access setting to test it as well.)

You can view the password by clicking the * button (only the owner can do this). To clear the entry, press the # button.

Textures

Two keypad textures are included; simply drag them onto the keypad buttons to change between them.

Config Values

  • DoorID: This is the door's identifier. Make sure this is the same as the DoorID value in the door's _config notecard.
  • Password: This is the keypad's password. It can be anywhere from 1-5 digits, each a number from 0-9.
  • Access: This is the base access setting. Can be "Everyone", "Group", or "Owner". These people can click the card swipe reader on the keypad to be immediately granted entry.
  • Whitelist: The list of people that will always be able to click the card swipe reader to gain entry. Separate with commas. NOTE: Whitelist names are usernames (nelson.jenkins, newbie), not legacy names (Nelson Jenkins, Newbie Resident). If you have more than 10 names, please read "Extended Whitelist" below.
  • GSS: If you are using a Global Security Server, enter its name in this field. The IntelliDoor GSS provides a "master" whitelist and blacklist for doors that subscribe to it (for example, if you have a group of doors that you want a list of people to control).
  • AKS: This is for a future product. Ignore this field.
  • Autoopen: Can be either Yes or No. Door(s) will automatically open when the keypad is unlocked if this is enabled.
  • DTMF: Can be either Yes or No. Changes default button sounds to DTMF tones (phone keypad sounds). This may weaken security if someone can "decipher" DTMF, but is generally harmless as anyone that wants to get in that badly can just sit-hack in.
  • HideNum: Can be either Yes or No. When disabled, this displays numbers instead of dashes when the password is entered. Not recommended unless you don't care if other people figure out the password.

Extended Whitelist

Because of LSL limitations, the whitelist line can only be read for 255 characters. However, the IntelliDoor system supports multiple whitelist lines. To be safe, separate your whitelist into 10-name increments, like so:
WHITELIST=User01, User02, User03, User04, User05, User06, User07, User08, User09, User10
WHITELIST=User11, User12, User13, User14

You can have as many whitelist lines as you need.

Compatibility

The Keypad is fully compatible with the IntelliDoor Home & Commercial, but only partially compatible with the IntelliDoor Garage, IntelliDoor Bollard, and IntelliDoor Gate. This is because the Garage & Bollards don't have a lock feature. However, you can set them to Owner only, and use the Keypad as a controller (enable auto-open, and use auto-close).

Builder Kit Instructions

Follow this guide before using your Builder Kit components, or they will break.

Make sure you review the Full Permissions Agreement to understand how you may distribute IntelliDoor products. Remember, objects in violation of this agreement will be remotely deleted. Therefore, make sure you follow the above instructions exactly.

API

As of v3.0, the IntelliDoor has an API for controlling individual doors and components. All API communication is done on channel -494827459.

For the following, [BBID] specifies the Buildbox ID. By default, this should be NONE. However, if your keypad was rezzed as part of a building through a Buildbox, it will have been set. You can get the Buildbox ID by selecting a keypad and checking its description - it should read BBID followed by the ID, which is usually formatted as a 36-character UUID or just "NONE". You can also set up your API-enabled item in the building such that it accepts and stores the Buildbox ID when it is rezzed. Note that Buildbox IDs do not change once the object is rezzed.

The IntelliDoor Keypad sends the following API commands:

  • [BBID][DoorID]&&open - Sent if the keypad's Autoopen setting is Yes after the unlock command is sent.
  • [BBID][DoorID]&&unlock - Sent when the keypad is unlocked.
  • [BBID][DoorID]&&lock - Sent when the keypad is relocked.

You should send the following API command to the keypad:

  • [BBID][DoorID]&&clear - Send this from the door when it is opened. This will clear the keypad's unlocked state, and will cause both the keypad and the door to relock.

Updates & Release Notes

You can update your IntelliDoor Keypad by rezzing the Update Box.

  • v3.1
    • Minor bugfixes to improve performance
  • v3.0
    • Implemented Buildbox integration
    • Usernames in whitelist are no longer case-sensitive
    • Blacklist removed
    • Communications now streamlined onto single channel for less lag
    • Two keypad textures now included
  • v2.1.3
    • Fixed integration bug with GSS.
  • v2.1
    • Primary public release.