3.1.0 • Published 4 years ago

homebridge-texecom v3.1.0

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

homebridge-texecom

A plugin for Homebridge that creates HomeKit motion, contact, smoke, or carbon monoxide sensors for alarm zones from a Texecom Premier intruder alarm via a serial connection or COM-IP module. homebridge-texecom was originated by Kieran Jones.

You can receive notifications, which can be set to work only when you're away from home:

example of notifications

Another great use is to use the alarm's motion sensors to switch lights on automatically:

example of automation

You can also set automations to happen when you arm the alarm and when the alarm goes off.

IMPORTANT - To use this plugin you will require a Texecom alarm system and a PC-COM, COM-IP or USB-COM serial interface. If using the PC-COM or USB-COM, you must also have nothing already utilising COM1 on the alarm panel, or be able to move existing modules connected to COM1 to a different COM port on the alarm panel. The support for IP is new and is intended for use with the COM-IP -- we don't know if it works with the SmartCom, so let us know if you get it working.

Configuration

Texecom zones must be configured individually in the Homebridge config.json file with the appropriate zone number from Texecom. Configuring areas is optional, but is required if you want to see if the alarm if set or have automations or notifications when the alarm is armed, disarmed or triggered. You probably have many zones and only one area.

Example:

"platforms": [
    {
        "platform": "Texecom",
        "serial_device": "/dev/ttyUSB0",
        "baud_rate": 19200,
        "zones": [
            {
                "name": "Living Room",
                "zone_number": "7",
                "zone_type": "motion",
                "dwell": 1000
            },
            {
                "name": "Front Door",
                "zone_number": "15",
                "zone_type": "contact",
                "dwell": 1000
            }
        ],
        "areas": [
            {
                "name": "Texecom Alarm",
                "area_number": "1",
                "area_type": "securitysystem",
                "dwell": 0
            }
        ]
    }
]

Global Configuration

For serial connections:

KeyDefaultDescription
serial_deviceN/AThe serial device on which to connect to Texecom
baud_rateN/AThe baud rate configured in Texecom (Usually 19200)
zonesN/AThe individual configuration for each zone in Texecom

For IP connections:

KeyDefaultDescription
ip_addressN/AThe IP address of the COM-IP Texecom module
ip_portN/AThe TCP port of the COM-IP Texecom module

Per-zone Configuration

This plugin is a platform plugin so you must configure each zone from your Texecom intruder alarm into your config individually.

KeyDefaultDescription
nameN/AThe name of the area as it will appear in HomeKit, e.g. 'Texecom Alarm'.
zone_numberN/AThe zone number from Texecom
zone_type"motion"The type of zone; motion, contact, smoke, or carbonmonoxide
dwell0The amount of time in ms that a zone stays active after zone activation is cleared by Texecom

Per-area Configuration

KeyDefaultDescription
nameN/AThe name of the sensor as it will appear in HomeKit.
area_numberN/AThe area number from Texecom, usually 1.
area_type"securitysystem"The type of area; only securitysystem is supported.
dwell0

Configuring Texecom

Ensure your intruder alarm is fully configured and operational, connect a USB-Com or PC-Com cable to COM1 on the panel PCB and then connect to the computer running Homebridge.

To configure your COM1 port for the Crestron protocol:

  1. Enter your engineer code
  2. Scroll until you find "UDL/Digi Options"
  3. Press 8 to jump to "Com Port Setup"
  4. Scroll to "Com Port 1"
  5. Press "No" to edit the port
  6. Press 8 to jump to "Crestron System"
  7. Press "Yes" to confirm and save.

Press "Menu" repeatedly to exit the engineer menu.

If connecting to a COM-IP, set up the COM-IP as usual and ensure it is working. Then change the configuration for the port the COM-IP is connected to to Crestron as detailed above. This allows the panel to configure the IP address into the module, then changing to Crestron will allow the panel to input/output the correct commands.

Future features

Alarm systems are complicated and have a lot of features, not all them are suitable for integrating to HomeKit but many of them can be integrated.

  • Panic buttons - Investigate the possibility of integrating the medical, panic, and fire buttons into HomeKit as buttons/switches to manually trigger those alerts.