erik/TESRemoteProgrammer
erik/TESRemoteProgrammer
1
0
Fork 0
Code Issues Pull requests Releases Activity

Added type parameter.

Browse source
This commit is contained in:
Erik C. Thauvin 2016-08-31 16:57:58 -07:00
parent c1e6b1167f
commit fa40890202
13 changed files with 63 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -47,6 +47,7 @@ Parameters define the configuration's global settings.
```json
"params": {
"name": "DKS 1802-EPD",
"type": "dks"
"ack": "*",
"alt": "#",
"end": "0 + #",
@ -54,14 +55,15 @@ Parameters define the configuration's global settings.
}
```
| Property | Description | Required |
|:---------|:-------------------------------------------------------------------------------------------------|:---------|
|`name` | The name of the configuration. | Yes |
|`ack` | The key used to acknowledge or terminate programming steps. Most systems use the `*` or `#` key. | Yes |
|`alt` | They key used to in place of numbers when applicable. DKS systems use the `#` key | No |
|`begin` | The begin programming manual sequence. For example Linear uses `0` and `2` pressed together. | No |
|`end` | The end programming manual sequence. For example DSK uses `0` and `#` pressed together. | No |
|`size` | The size (number of digits) of the master code. Most systems use 4 or 6. | Yes |
| Property | Description | Required |
|:---------|:--------------------------------------------------------------------------------------------------|:---------|
|`name` | The name of the configuration. | Yes |
|`type` | The system's type, either `dks` or `linear`. | Yes |
|`ack` | The key used to acknowledge or terminate programming steps. Most systems use the `*` or `#` keys. | Yes |
|`alt` | They key used to in place of numbers when applicable. DKS systems use the `#` key | No |
|`begin` | The begin programming manual sequence. (e.g. Linear uses `0` and `2` pressed together) | No |
|`end` | The end programming manual sequence. (e.g. DSK uses `0` and `#` pressed together.) | No |
|`size` | The size (number of digits) of the master code. Most systems use 4 or 6. | Yes |
### Options
@ -133,10 +135,10 @@ Fields represent the data entry text fields on option screens.
|`minSize` | Set the minimum size of the field. If set, `size` is the maximum size of the field. | No |
|`min` | Set the minimum value of a numeric field. | No |
|`max` | Set the maximum value of a numeric field. | No |
|`alpha` | Set to `dks` or `linear` for alphanumeric fields. | No |
|`digits` | Set digits that are allowed. For example DKS uses `1234567` for days of the week: Sun=1... Sat=7. | No |
|`alpha` | Set to `true` for alphanumeric fields. | No |
|`digits` | Set digits that are allowed. (e.g. DKS uses `1234567` for days of the week: Sun=1... Sat=7) | No |
|`alt` | Set to `true` if the field accepts the `alt` [parameter](#parameters) value in place of a digit. | No |
|`zeros` | Set to `true` by default. Allows numeric values with leading zeros (i.e. `001`), based on the `size`. | No |
|`zeros` | Set to `true` by default. Allows numeric values with leading zeros (e.g. `001`), based on the `size`. | No |
#### DTMF