Interact with a GE/Interlogix Simon XT using a REST API.
The only usable remote interface to the Simon XT (other than cellular modules) is the POTS/PSTN line, so we use Asterisk and a SIP ATA to communicate with the unit.
This package includes:
- The WSGI server (app)
- A client library
- An event handler script to parse Asterisk's
alarmreceiverevents and submit them to the API
With this API, you can:
- Get a list of sensors, and their state (open/closed)
- Submit new events
- List events
- Get a single event using its UID
- Send the following commands:
- arm_home
- arm_away
- disarm
Sample outputs:
# http localhost:8000/events
HTTP/1.1 200 OK
Connection: close
Date: Sun, 03 Jan 2021 21:24:23 GMT
Server: gunicorn/20.0.4
content-length: 274
content-type: application/json
[
{
"account": 1234,
"checksum": 3,
"code": 601,
"code_description": "Manual trigger test report Zone",
"extension": "100",
"msg_type": 18,
"partition": 0,
"qualifier": 1,
"status": null,
"timestamp": 1609709046.0,
"uid": "mpCeGa",
"user": null,
"zone": 0,
"zone_name": null
}
]
# http localhost:8000/sensors
HTTP/1.1 200 OK
Connection: close
Date: Mon, 18 Jan 2021 22:57:15 GMT
Server: gunicorn/20.0.4
content-length: 951
content-type: application/json
[
{
"name": "nothing",
"number": 0,
"state": "closed"
},
{
"name": "front door",
"number": 1,
"state": "closed"
},
]
This API uses Redis to store and persist events.
The server can be run either as a Docker container, or directly on the host, once the library is installed.
The Docker container includes an Asterisk instance. The easiest way to get up and running is cloning the repo and using docker-compose.
Before you run the container, copy the sample config.ini and edit it with your sensor information:
cp config.ini.sample config.ini
EDITOR config.ini
...
You will also need to provide your own Asterisk configurations:
cp /path-to-my-asterisk-configs ./asterisk_configs
A working alarmreceiver.conf file should be:
[general]
timestampformat = %a %b %d, %Y @ %H:%M:%S %Z
eventcmd = python3 /app/bin/simon_event_handler
eventspooldir = /var/spool/asterisk/alarm_events
logindividualevents = yes
fdtimeout = 2000
sdtimeout = 40000
answait = 1250
loudness = 4096
And then:
docker-compose up -d
pip install simon_says
Here is a short script that can be used to schedule arming/disarming the alarm using a cron job:
#!/usr/bin/env python3
from simon_says.client import Client
import argparse
def parse_args() -> argparse.Namespace:
""" Parse command line arguments """
parser = argparse.ArgumentParser(description="Alarm Schedule")
parser.add_argument(
"-a", "--action", type=str, help="Action to execute", required=True, choices=["arm", "disarm"],
)
parser.add_argument(
"-c", "--code", type=str, help="Acccess code", required=True
) return parser.parse_args()
if __name__ == "__main__":
args = parse_args()
client = Client(url="http://localhost:8000")
if args.action == "arm":
client.arm_home(args.code)
elif args.action == "disarm":
client.disarm(args.code)
And the corresponding cron jobs:
# m h dom mon dow command
# Arm/Disarm alarm every day at the same times
0 6 * * * /home/username/alarm_schedule.py -a disarm
0 22 * * * /home/username/alarm_schedule.py -a arm
Carlos Vicente