![](\"https://github.com/homebridge/branding/blob/latest/logos/homebridge-color-round-stylized.png\")
\n ![](\"https://github.com/haywirecoder/homebridge-envisalink-ademco/blob/master/img/link.png?raw=true\")
\n ![](\"https://github.com/haywirecoder/homebridge-envisalink-ademco/blob/master/img/EyezOn_logo_signature_size.png?raw=true\"){kind=logo}
\n\n \n \n \n \n\n
**Note:** Panel reporting must be enabled, for plug-in to properly monitor zone bypasses. Refer to Envisalink Installation Guide.| \n| batteryRunTime | *(optional)* User-supplied runtime of the main system backup battery in hours. This value allows the plug-in to estimate the remaining time when the system switches to backup battery power. | \n| ignoreFireTrouble | *(optional)* When the virtual keypad sends a fire trouble signal, treat it as a warning and allow the system to arm the alarm. The default is false. |\n| ignoreSystemTrouble | *(optional)* When the virtual keypad sends a system trouble signal, treat it as a warning and allow the system to arm the alarm. The default is false. |\n| proxyEnabled | *(optional)* Create a proxy server that allows two additional Envisalink TPI clients to share the existing Envisalink TPI connection. These clients can connect to the TPI default port 4026 and HTTP (web console) default port 4080 of the Homebridge server running this plug-in. The default setting is false.
**Note:** Because the connection to the Envisalink server is being shared, a secondary TPI client may cause this plug-in to malfunction.
**Support Notice:** Support is limited to the proxy server itself. Issues related to third-party clients are not covered and will not be addressed.|\n| maintenanceMode | *(optional)* Disable communication with the Envisalink module. The default is false.
**Note:** This will disable all updates. |\n| **zones** | *(optional)* List of zones to display and monitor in HomeKit. |\n| **bypass** | *(optional)* Creates a bypass control (a switch) to bypass zones that are open (faulted). |\n| | If \"quickbypass\" is not enabled, the bypass switch can only bypass zones that are being monitored in HomeKit and have the zone entry \"bypassenable\" attribute set to true. |\n| | \"quickbypass\" can be used to bypass all faulted zones. This feature must be enabled in the Ademco panel *(refer to panel guide)*. |\n| **speedkeys** | *(optional)* Create controls (switches) to replicate the special function keys on the Ademco keypad. |\n\n**partitions**\n\n> - name: Partition name - *If not present, defaults to \"house.\"*\n> - partitionNumber: Partition number - *If not present, a consecutive number is used, which is not ideal. Not needed in a single partition configuration.*\n> - partitionPIN: Partition PIN/code - *If not present, the master configured PIN is used. Not needed in a single partition configuration.*\n\n**zones** *(Optional section -- At least one zone must be defined if used)*\n\n> - name: Zone name - *This is a required value for each entry.*\n> - sensorType: co | door | glass | leak | motion | smoke | tilt | window - *This is a required value for each entry.*\n> - partition: Sensor partition number - *This is a required value for each entry.*\n> - zoneNumber: Panel zone number for the sensor. The presence of this attribute triggers consecutive or non-consecutive zone numbering (see example). *This attribute is required if your system has unused zones, uses non-consecutive zone numbering, or if you want to selectively display zones within HomeKit.*\n> - bypassEnabled: true | false - A true value allows zones to be bypassed. This setting works in conjunction with the bypass control option (below). *This is an optional element and defaults to false. The alarm system will not allow fire or emergency zones to be bypassed.*\n\n**bypass** *(Optional section)*\n\n> - enabledbyPass: true | false - A true value creates a global bypass switch in HomeKit to bypass faulted zones with bypassEnabled set to true. A false value (default) allows for the creation of a zone-specific switch associated with each zone with bypassEnabled. The direct zone bypass switch can bypass zones that are faulted and/or normal. Unbypassing one zone will unbypass all zones; this is a limitation of the alarm panel. *Note: Once your system is disarmed, bypassed zones will need to be bypassed again to arm your system again. An optional feature is aviable to allow Plug-in to remember zone status. Please refer to bypassedZonesMemory attribute.* \n> - quickbypass: true | false - Must be pre-configured on the alarm panel (please refer to your alarm panel programming guide). If programmed, \"Quick Bypass\" allows you to easily bypass all open (faulted) zones without having to configure zones individually and performs operations quickly. *This is a required value for this section.*\n\n**speedkeys** *(Optional section)*\n> - name: Name of the special function key to display in HomeKit - *This is a required value for this section, and each name must be unique.*\n> - speedcommand: A | B | C | D | Custom - Indicates which special function key (e.g., A, B, C, and D keys) will be associated with this switch. The special keys are located to the left of the numeric keys and can be programmed with special functions at the alarm panel. \"Custom\" allows the use of a command field to input a custom automated input sequence that imitates keypad inputs. *This is a required value for this section.* \n> - command: Input a custom automated input sequence that imitates keypad inputs. The special '@pin' notation will be replaced with the configured master PIN/code. *This is required if \"custom\" is selected as speedcommand.*\n\nAn example configuration is below:\n\n```javascript\n...\n\n\"platforms\": [\n\n{\n\n \"platform\": \"Envisalink-Ademco\",\n \"host\": \"192.168.YYY.XXX\",\n \"deviceType\": \"20P\",\n \"password\": \"---envisalink password (default is user)---\",\n \"pin\": \"---panel pin for arming/disarming---\",\n \"partitions\": [\n {\n \"name\": \"House\"\n }\n\n ],\n \"zones\": [\n {\n \"name\": \"Front Door\",\n \"sensorType\": \"door\", \n \"partition\": 1\n },\n {\n \"name\": \"Master Bedroom Window\",\n \"sensorType\": \"window\",\n \"partition\": 1,\n \"bypassEnabled\": true\n }\n ],\n \"bypass\": [\n {\n \"enabledbyPass\": true,\n \"quickbypass\": false\n }\n ],\n \"speedkeys\" : [\n {\n \"name\": \"Panic\",\n \"speedcommand\": \"A\"\n },\n {\n \"name\": \"Special key\",\n \"speedcommand\": \"custom\",\n \"command\": \"@pin03\"\n }\n ]\n}\n...\n\n```\n\n## Non-Consecutive Zones\n\nIf your system has unused zones, simply include a *zoneNumber* integer property on ***each*** zone you have in the config. Make sure you add the property to each zone. This is the recommended configuration if you don't wish to monitor (display) all zones within HomeKit or don't know the ordering of your system zones.\n\nExample:\n\n```javascript\n\n...\n\n\"zones\": [\n {\n \"name\": \"Front Entry\",\n \"sensorType\": \"door\",\n \"partition\": 1,\n \"zoneNumber\": 9,\n \"bypassEnabled\": true\n },\n {\n \"name\": \"Patio Door\",\n \"sensorType\": \"door\",\n \"partition\": 1,\n \"zoneNumber\": 12,\n \"bypassEnabled\": true\n },\n {\n \"name\": \"Bedroom Window\",\n \"sensorType\": \"window\",\n \"partition\": 1,\n \"zoneNumber\": 16,\n \"bypassEnabled\": false\n },\n {\n \"name\": \"Garage Door\",\n \"sensorType\": \"door\",\n \"partition\": 1,\n \"zoneNumber\": 5\n }\n]\n\n...\n","readmeFilename":"README.md"}