TESRemoteProgrammer/README.md

Telephone Entry System Remote Programmer for Android

Program your Telephone Entry System remotely (off-site) using your phone.

Most Telephone Entry Systems can be programmed from the front keypad or remotely from an off-premise location using any touch-tone phone. TES Remote Programmer streamlines the often cumbersome remote programming process by providing data entry screens and automated dial-in options.

By default, TES Remote Programmer is configured to work with the DoorKing (DKS) 1802, 1802-EPD, 1803, 1808, 1810 and 1819 systems, additional configurations can be created for most systems supporting remote programming.

Please note that all default configurations are set for 3-digits directory code length. If your system is setup differently, you will need to modify the default configuration and re-import it. Look for all Directory Code fields and modify their size attributes accordingly.

Usage

In the main activity screen enter the entry system's phone number and master code, then select one the programming options.

In the programming activity screen fill out the fields and click the floating button (if available) to dial the programming in or the floating button to scroll through the manual (keypad) steps.

Configurations

To switch configuration, choose Configurations under the toolbar menu and select the desired configuration.

To import a new configuration, select Import in the Configurations dialog.

New Configurations

Custom configurations can be created using JSON.

View Examples

Parameters

Parameters define the configuration's global settings.

"params": {
  "name": "DKS 1802-EPD",
  "star": "*",
  "hash": "#",
  "end": "0 + #",
  "size": 4
}

Parameter	Description	Required
name	The name of the configuration.	Yes
star	The key used to start, acknowledge or terminate programming steps. Most systems use the * key.	Yes
hash	They key used to in place of numbers when applicable. Most system use the # key	No
end	The end programming manual sequence. For example DoorKing uses 0 and # pressed together.	No
size	The size (number of digits) of the master code. Most systems use 4 or 5.	Yes

Options

Opts define the data used to create programming activity screens in the app.

For example, the system's manual lists the steps to Programming 7-digit Phone Numbers as:

1. Press *01 and enter Master Code.
2. Enter a Directory Code then press *.
3. Enter a 7-digit Phone Number then press *. If the number is less than 7-digits, enter # in the empty spaces.
4. Press 0# TOGETHER when finished.

which would translate into:

"opts": [
  {
    "title": "Add 7-digit Phone Number",
    "fields": [
      {
        "hint": "Directory Code",
        "size": 3
      },
      {
        "hint": "Phone Number",
        "size": 7,
        "hash": true
      }
    ],
    "dtmf": "*01[MASTER],[FIELD:1]*,[FIELD:2]*"
  }
]

Step 4 is configured in the end parameter since it only applies to manual/keypad programming.

Elements	Description
title	The title of the option.
fields	See Fields
dtmf	See DTMF
nodial	Indicate that remote programming is not available. Steps must be executed manually at the keypad.
nosteps	Indicate that manual/keypad steps are not available. Programming must be executed remotely.

All are required, except nodial and nosteps which are mutually exclusive.

Fields

"fields": [
  {
    "hint": "Directory Code",
    "size": 3
  },
  {
    "hint": "Phone Number",
    "size": 7,
    "hash": true
  }
]

Fields represent the data entry text fields on option screens.

Element	Description	Required
hint	Set the hint/label of the field.	Yes
size	Set the size of the field.	Yes
min	Set the minimum value of a numeric field.	No
max	Set the maximum value of a numeric field.	No
alpha	Set to true if the field is alphanumeric.	No
hash	Set to true if the field accept the hash parameter value in place of a digit.	No

DTMF

"dtmf": "*01[MASTER],[FIELD:1]*,[FIELD:2]*"

DTMF represent the dialing sequence for the programming steps. A comma (,) should be used to specify a pause in the dialing sequence.

The following markers will be substituted by their actual values upon dialing.

Marker	Description
[MASTER]	Substituted with the Master Code
[FIELD:X]	Substituted with the field's value, where X is the field number in the array.

Validation

Imported configurations will be validated. While the validation is not perfect, it should be good enough to spot most syntax errors.

Please sure to use a JSON editor to make creating configurations a whole lot easier.

When in doubt be sure to look at the default configurations.