Skip to content

Latest commit

 

History

History
139 lines (83 loc) · 5.79 KB

README.md

File metadata and controls

139 lines (83 loc) · 5.79 KB
Raw

logo PERSEUS

Push Electronic Relay for Smart Alarms for End User Situational Awareness

Derek Merck
Leo Kobayashi

https://github.com/derekmerck/PERSEUS

Overview

Everything old is new again. Convert unnetworked vitals monitors into connected smart alarms.

Original test site is at Rhode Island Hospital Emergency Department.

Dependencies

General:

  • Python 2.7.10+
  • PyYAML for configuration info
  • splunk-sdk (optional for event routing)

For Dispatch:

For Listener:

  • pyserial for RS232 serial connection protocol
  • numpy for array math functions
  • scipy (optional for quality of signal post-processing)
  • matplotlib (optional for simple GUI display)

Setup

A PERSEUS system has three components:

  1. A set of client systems running the PERSEUS Listener daemon or other decoder for bedside monitors.
  2. A central event store, such as Splunk or an open-source "ELK" stack (Elastic, Logstash, and Kibana).
  3. A central dispatch server running the PERSEUS Dispatch daemon.

In testing, the event and dispatch servers are separate components running on a single central machine.

General Setup

On Windows or Mac machines without a pre-installed git client, a binary distribution is available at git-scm.

Anaconda is a package manager that simplifies cross-platform installation of the Python binary library dependencies required for the client systems. pip can be used to install any pure-Python packages and for PERSEUS itself.

Client Setup

Setup each client with a separate host name that will be used in the zone descriptions.

PERSEUS Listener bedside clients for Philips Intellivue monitors can be setup quickly by installing the Anaconda Python distribution as above, manually installing the numpy, scipy, and matplotlib dependencies, and using pip to install the Python dependencies, and git to clone the latest PERSEUS scripts.

$ conda update conda
$ conda install numpy scipy matplotlib
$ pip install pyserial pyyaml splunk-sdk
$ git clone https://github.com/derekmerck/PERSEUS

Running listener command with the flags --port sample --gui SimpleStripChart will generate and display a pair of sinusoidal sample functions for testing.

$ python PERSEUS.py listener --port sample --gui SimpleStripChart

Setting up variables for a Splunk connection (SPLUNK_HOST, SPLUNK_PORT, SPLUNK_USER, SPLUNK_PWORD) in the environment or in shadow.yaml and running the listener command with the flags --port COM3 --splunk perseus will connect to a monitor attached via a USB-to-serial connection and start sending data to an index called perseus in a central Splunk event store.

$ python PERSEUS.py listener --port COM3 --splunk perseus

See the TelemetryStream README for more details on the Intelivue serial protocol and setup instructions for using PERSEUS Listener with Raspberry Pi hardware.

PERSEUS Dispatch Setup

Install PERSEUS Dispatch and dependencies on the central server.

$ pip install pyyaml splunk-sdk twilio
$ pip install git+https://github.com/derekmerck/PERSEUS

Modify the example config.yaml file to represent the local rules, zone topology, and alert roles.

Credentials for the event store, any email relays, Twilio auth tokens, and Slack webhook urls can be provided as environment variables or using a shadow.yaml file. Both Twilio and Slack provide free trial services.

Once the event store (Splunk, for example) is setup and the clients are running, Dispatch can be started from the command line:

$ python PERSEUS.py dispatch --config my_config.yaml

Future work includes developing an Ansible-based system to deploy and bring up the entire PERSEUS network automatically.

Security

Using Gmail for Email-SMS Alerts

Using gmail as an SMS relay requires either turning off app security in gmail, or assigning a unique relay password in the context of 2-step auth.

Code Organization Overview

Network organization

Acknowledgements

License

MIT