https://github.com/schmupu/iobroker.contactid
Contact ID server for burglar alarm system
https://github.com/schmupu/iobroker.contactid
alarm alarm-systems burglar-alarm contactid iobroker protocol
Last synced: 2 months ago
JSON representation
Contact ID server for burglar alarm system
- Host: GitHub
- URL: https://github.com/schmupu/iobroker.contactid
- Owner: schmupu
- License: mit
- Created: 2018-05-12T17:30:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-21T05:27:13.000Z (3 months ago)
- Last Synced: 2025-02-21T06:25:23.050Z (3 months ago)
- Topics: alarm, alarm-systems, burglar-alarm, contactid, iobroker, protocol
- Language: TypeScript
- Size: 788 KB
- Stars: 30
- Watchers: 7
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ioBroker.contactid
[](https://www.npmjs.com/package/iobroker.contactid)
[](https://www.npmjs.com/package/iobroker.contactid)
[](https://snyk.io/test/github/schmupu/ioBroker.contactid)
[](https://nodei.co/npm/iobroker.contactid/)
**Tests:** 
The protocol Contact ID used by alarm systems to communicate with central stations.
This adapter is a Contact ID Server. When an alarm event is triggered, the alarm system sends over IP the Contact ID message to the central station.
You can use ioBroker with this adapter as central station. For example. you can send for a alarm by Conntact ID a telegram message.
The Contact-ID message
SSSS 18QEEEGGZZZC
- SSSS – Subscriber. These four digits identify the specific alarm system or customer to the central station. ioBroker allows longer subscriber names.
- 18 - Message Type. Basically this field should always be “18”.
- Q – Event Qualifier.
- EEE – Event Code.
- GG – Group/Partition Number.
- ZZZ – Zone Number (001 - 999). This is the number of the zone that triggered the alarm.
- C – Checksum.
[Contact ID protocol](http://www.technoimport.com.co/Producto/pdfs/ADEMCO%20-%20DC05_Contact_ID.pdf)
## Install & Configuration
1. Install the adapter
2. Configuration of the adapter:
Choose the IP-address and port for listening for Conctact-ID requests.
Register you subcriber name to identify you burglar alarm messages and
select your burglar alarm type.
3. Configure your burglar system to send Contact ID messages
Lupusec XT1:
Einstellungen -> Contact ID : rptn://subcriber@ip-address-iobroker:port
Example: rptn://[email protected]:50000
Lupusec XT1+/XT2/XT2+/XT3/XT4:
Einstellungen -> Contact ID : ip://subcriber@ip-address-iobroker:port/CID
Example: ip://[email protected]:50000/CID
4. Testing the Adpater
Open command shell and type
```
telnet ip-address-iobroker port
Example: telnet 192.168.20.1 50000
```
Now you can sen a Conntact ID Message. For Lupsec burglar alarm systems the
message begins and ends with [ and ]. Type in your telnet session:
```
[SSSS 18QEEEGGZZZC]
Example: [test 18160201010B]
```
Now you can see the message in the ioBroker objects
5. Problems / Issues
If you have problems processing ContactID messages, please create an issue.
In the issue I need the following information:
1. Manufacturer and type of alarm system
2. The ContactID message as a file. You can create a file if you activate it in the instance configuration.
3. The debug output from ioBroker when processing the message
4. Detailed description of the bug
You can test saved ContactID message with following command
```
# cat fileanme_of_cid_message | nc ip_address_of_iobroker cid_port
cat /tmp/cid/cid_msg_fa165cc0-8e3a-faa1-eb5c-fd3e47479044.txt | nc localhost 55000
```
## Changelog
### **WORK IN PROGRESS**
- (Stübi) Fixing @iobroker/adapter-dev 1.0.1 specified. 1.3.0 is required as minimum, 1.3.0 is recommended (Issue #51)
- (Stübi) Fixing dependency, (Issue #52)
### 2.0.1 (2025-02-01)
- (Stübi) Fixed Notification from ioBroker Check and Service Bot (Issue #46)
### 2.0.0 (2025-01-18)
- (Stübi) Redesign of Contact ID Adapter.
- (Stübi) Wokring now with nodejs 20 and 22
- (Stübi) js-controller in version 6 and 7 will be supported (Issue #19, #28)
- (Stübi) nodejs 20 and nodejs 22 will be suported (Issue #20, #36)
- (Stübi) states moved to channel subscriber
- (Stübi) add Lupusec XT4 to list of alarm systems
- (Stübi) migration to eslint 9 (Issue #39)
- (Stübi) change admin configuration (Issue #38)
- (Stübi) fixed dependency ot iobroker adapter-core (Issue #37)
- (Stübi) fixed iobroker notifications (Issue 35)
### 1.0.2 (2020.12.13)
- (Stübi) Bugfixing, ACK-invalid Format - Issue #14
- (Stübi) Bugfixing, Issue #9
## License
MIT License
Copyright (c) 2025 Thorsten Stueben
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.