Skip to content

justingshreve/cgm-remote-monitor

 
 

Repository files navigation

cgm-remote-monitor (a.k.a. Nightscout)

Build Status Dependency Status Coverage Status Gitter chat Stories in Ready Stories in Progress

Deploy to Heroku

This acts as a web-based CGM (Continuous Glucose Monitor) to allow multiple caregivers to remotely view a patient's glucose data in real time. The server reads a MongoDB which is intended to be data from a physical CGM, where it sends new SGV (sensor glucose values) as the data becomes available. The data is then displayed graphically and blood glucose values are predicted 0.5 hours ahead using an autoregressive second order model. Alarms are generated for high and low values, which can be cleared by any watcher of the data.

Community maintained fork of the original cgm-remote-monitor.

Install

Requirements:

Clone this repo then install dependencies into the root of the project:

$ npm install

Usage

The data being uploaded from the server to the client is from a MongoDB server such as mongolab. In order to access the database, the appropriate credentials need to be filled into the JSON file in the root directory. SGV data from the database is assumed to have the following fields: date, sgv. Once all that is ready, just host your web app on your service of choice.

Updating my version?

The easiest way to update your version of cgm-remote-monitor to our latest recommended version is to use the update my fork tool. It even gives out stars if you are up to date.

What is my mongo string?

Try the what is my mongo string tool to get a good idea of your mongo string. You can copy and paste the text in the gray box into your MONGO_CONNECTION environment variable.

Configure my uploader to match

Use the autoconfigure tool to sync an uploader to your config.

Environment

VARIABLE (default) - description

Required

  • MONGO_CONNECTION - Your mongo uri, for example: mongodb://sally:[email protected]:99999/nightscout

Features/Labs

  • ENABLE - Used to enable optional features, expects a space delimited list such as: careportal rawbg (also rawbg-on to show raw data by default)
  • API_SECRET - A secret passphrase that must be at least 12 characters long, required to enable POST and PUT; also required for the Care Portal
  • BG_HIGH (260) - must be set using mg/dl units; the high BG outside the target range that is considered urgent
  • BG_TARGET_TOP (180) - must be set using mg/dl units; the top of the target range, also used to draw the line on the chart
  • BG_TARGET_BOTTOM (80) - must be set using mg/dl units; the bottom of the target range, also used to draw the line on the chart
  • BG_LOW (55) - must be set using mg/dl units; the low BG outside the target range that is considered urgent
  • ALARM_TYPES (simple if any BG_* ENV's are set, otherwise predict) - currently 2 alarm types are supported, and can be used independently or combined. The simple alarm type only compares the current BG to BG_ thresholds above, the predict alarm type uses highly tuned formula that forecasts where the BG is going based on it's trend. predict DOES NOT currently use any of the BG_* ENV's
  • PUSHOVER_API_TOKEN - Used to enable pushover notifications for Care Portal treatments, this token is specific to the application you create from in Pushover
  • PUSHOVER_USER_KEY - Your Pushover user key, can be found in the top left of the Pushover site

Core

  • DISPLAY_UNITS (mg/dl) - Choices: mg/dl and mmol. Setting to mmol puts the entire server into mmol mode by default, no further settings needed.
  • MONGO_COLLECTION (entries) - The collection used to store SGV, MBG, and CAL records from your CGM device
  • MONGO_TREATMENTS_COLLECTION (treatments) -The collection used to store treatments entered in the Care Portal, see the ENABLE env var above
  • MONGO_DEVICESTATUS_COLLECTION(devicestatus) - The collection used to store device status information such as uploader battery
  • PORT (1337) - The port that the node.js application will listen on.
  • SSL_KEY - Path to your ssl key file, so that ssl(https) can be enabled directly in node.js
  • SSL_CERT - Path to your ssl cert file, so that ssl(https) can be enabled directly in node.js
  • SSL_CA - Path to your ssl ca file, so that ssl(https) can be enabled directly in node.js

Setting environment variables

Easy to emulate on the commandline:

    echo 'MONGO_CONNECTION="mongodb://sally:[email protected]:99999/nightscout"' >> my.env

From now on you can run using

    $ env $(cat my.env) PORT=1337 node server.js

Your hosting provider probably has a way to set these through their GUI.

Vagrant install

Optionally, use Vagrant with the included Vagrantfile and setup.sh to install OS and node packages to a virtual machine.

host$ vagrant up
host$ vagrant ssh
vm$ setup.sh

The setup script will install OS packages then run npm install.

The Vagrant VM serves to your host machine only on 192.168.33.10, you can access the web interface on http://192.168.33.10:1337

More questions?

Feel free to post an issue, but read the wiki first.

License

cgm-remote-monitor - web app to broadcast cgm readings
Copyright (C) 2015 The Nightscout Foundation, http://www.nightscoutfoundation.org.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

About

nightscout web monitor

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 74.8%
  • HTML 12.6%
  • CSS 9.4%
  • Shell 2.8%
  • Makefile 0.4%