OpenEndec V2.1

Warning

DO NOT RELY ON THIS PROGRAM WHEN LOSS, DAMAGE, INJURY OR DEATH MAY OCCUR! ALWAYS, ALWAYS HAVE MULTIPLE METHODS TO RECEIVE EMERGENCY ALERTS.

THIS IS NOT AN EAS DECODER

An Open Source EAS ENDEC Logger to transmit News Feed messages recieved by a Sage Digital ENDEC Hardware Unit to a webhook/external destination.

News Feed spec: section 9.4 (pg. 70) of the ENDEC manual

EAS protocol specification: 47 CFR 11.31

Features

• Supports multiple concurrent transmission destinations
• Argument validation

Destinations:

• Generic webhook
• GroupMe
• Discord
• Email (SMTP)
• Twilio
• ???

Options

--trim / -t: Trim the EAS message from the body before sending, which is always the final line. EAS messages follow the format: ZCZC-ORG-EEE-PSSCCC + TTTT-JJJHHMM-LLLLLLLL-

--quiet / -q: Trim the human readable message body, leaving ONLY the EAS message.

Destinations

--webhook / -w {URL_1, URL_2, ...}: Webhook URL(s) to forward EAS messages to.

--groupme / -g {BOT_ID_1, BOT_ID_2, ...}: GroupMe bot(s) to forward EAS messages to.

Installation

Example scenario:

1. In Sage's EndecSetD, set one of the DB-9 serial COM ports on your ENDEC to output "News Feed". See section 9.4 (pg. 70) of the ENDEC manual for more info.

2. Use a USB to RS-232 serial adapter to connect the News Feed COM port of your ENDEC to a computer. We're using a Raspberry Pi Zero 2 W (with a Micro USB to female USB-A adapter), though any computer that can run Python and connect to the internet should work fine.

3. Run sudo dmesg (for macOS/Linux) to identify the the /dev/ device the adapter is plugged into. We're looking for a new USB detection for a serial device. Using the RS-232 adapter linked above, this is the log we found:

   usb 1-1.1: FTDI USB Serial Device converter now attached to ttyUSB0

   This is telling us that the ENDEC feed will come in at /dev/ttyUSB0.

4. Clone this repo and navigate to it via git clone https://github.com/WBOR-91-1-FM/wbor-endec && cd wbor-endec

5. Install necessary dependencies via pip3 install -r requirements.txt, or, better yet, activate a virtual environment for this repo and then install the dependencies.

6. Start monitoring the ENDEC by running the script:

   python3 OpenEndecV2.py -c {YOUR-DEVICE} {OPTIONS}

   {YOUR DEVICE} is the /dev/ port we found in step 3. So, in this example, we use /dev/ttyUSB0.

   {OPTIONS} specifies the destinations OpenEndec should forward EAS messages to.

Running as a System Service

sudo nano /etc/systemd/system/wbor-endec.service

Reference the template at wbor-endec.service.

You will need to change:

• ExecStart
  • PYTHON_EXEC = directory for your Python executable, e.g. /usr/bin/python3
  • SCRIPT_PATH = path to OpenEndecV2.py, e.g. /home/username/wbor-endec/OpenEndecV2.py
  • OPTIONS = options for the scripts with respective arguments, e.g. --groupme {BOT_ID}
• WorkingDirectory = path to the wbor-endec repo folder you cloned, e.g. /home/username/wbor-endec
• User = username for the user running OpenEndec

After saving, run:

sudo systemctl daemon-reload
sudo systemctl start wbor-endec.service
sudo systemctl enable wbor-endec.service
sudo systemctl status wbor-endec.service

Look for active (running) and the openendec.log file to confirm it is up and running.

After updating, run:

sudo systemctl start wbor-endec.service