forked from nightscout/cgm-remote-monitor
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from nightscout/master
Funnel Cake
- Loading branch information
Showing
65 changed files
with
4,162 additions
and
338 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,6 +58,7 @@ Community maintained fork of the | |
- [Environment](#environment) | ||
- [Required](#required) | ||
- [Features/Labs](#featureslabs) | ||
- [Alarms](#alarms) | ||
- [Core](#core) | ||
- [Predefined values for your browser settings (optional)](#predefined-values-for-your-browser-settings-optional) | ||
- [Plugins](#plugins) | ||
|
@@ -142,18 +143,35 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm | |
|
||
* `MONGO_CONNECTION` - Your mongo uri, for example: `mongodb://sally:[email protected]:99999/nightscout` | ||
* `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. | ||
* `BASE_URL` - Used for building links to your sites api, ie pushover callbacks, usually the URL of your Nightscout site you may want https instead of http | ||
|
||
### Features/Labs | ||
|
||
* `ENABLE` - Used to enable optional features, expects a space delimited list, such as: `careportal rawbg iob`, see [plugins](#plugins) below | ||
* `DISABLE` - Used to disable default features, expects a space delimited list, such as: `direction upbat`, see [plugins](#plugins) below | ||
* `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 | ||
* `TREATMENTS_AUTH` (`off`) - possible values `on` or `off`. When on device must be authenticated by entering `API_SECRET` to create treatments | ||
|
||
|
||
### Alarms | ||
|
||
These alarm setting effect all delivery methods (browser, pushover, maker, etc), some settings can be overridden per client (web browser) | ||
|
||
* `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 | ||
* `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 | ||
* `BASE_URL` - Used for building links to your sites api, ie pushover callbacks, usually the URL of your Nightscout site you may want https instead of http | ||
* `ALARM_URGENT_HIGH` (`on`) - possible values `on` or `off` | ||
* `ALARM_URGENT_HIGH_MINS` (`30 60 90 120`) - Number of minutes to snooze urgent high alarms, space separated for options in browser, first used for pushover | ||
* `ALARM_HIGH` (`on`) - possible values `on` or `off` | ||
* `ALARM_HIGH_MINS` (`30 60 90 120`) - Number of minutes to snooze high alarms, space separated for options in browser, first used for pushover | ||
* `ALARM_LOW` (`on`) - possible values `on` or `off` | ||
* `ALARM_LOW_MINS` (`15 30 45 60`) - Number of minutes to snooze low alarms, space separated for options in browser, first used for pushover | ||
* `ALARM_URGENT_LOW` (`on`) - possible values `on` or `off` | ||
* `ALARM_URGENT_LOW_MINS` (`15 30 45`) - Number of minutes to snooze urgent low alarms, space separated for options in browser, first used for pushover | ||
* `ALARM_URGENT_MINS` (`30 60 90 120`) - Number of minutes to snooze urgent alarms (that aren't tagged as high or low), space separated for options in browser, first used for pushover | ||
* `ALARM_WARN_MINS` (`30 60 90 120`) - Number of minutes to snooze warning alarms (that aren't tagged as high or low), space separated for options in browser, first used for pushover | ||
|
||
|
||
### Core | ||
|
@@ -165,6 +183,7 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm | |
* `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 | ||
* `HEARTBEAT` (`60`) - Number of seconds to wait in between database checks | ||
|
||
|
||
### Predefined values for your browser settings (optional) | ||
|
@@ -173,10 +192,6 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm | |
* `SHOW_RAWBG` (`never`) - possible values `always`, `never` or `noise` | ||
* `CUSTOM_TITLE` (`Nightscout`) - Usually name of T1 | ||
* `THEME` (`default`) - possible values `default` or `colors` | ||
* `ALARM_URGENT_HIGH` (`on`) - possible values `on` or `off` | ||
* `ALARM_HIGH` (`on`) - possible values `on` or `off` | ||
* `ALARM_LOW` (`on`) - possible values `on` or `off` | ||
* `ALARM_URGENT_LOW` (`on`) - possible values `on` or `off` | ||
* `ALARM_TIMEAGO_WARN` (`on`) - possible values `on` or `off` | ||
* `ALARM_TIMEAGO_WARN_MINS` (`15`) - minutes since the last reading to trigger a warning | ||
* `ALARM_TIMEAGO_URGENT` (`on`) - possible values `on` or `off` | ||
|
@@ -198,6 +213,10 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm | |
* `direction` (BG Direction) - Displays the trend direction. | ||
* `upbat` (Uploader Battery) - Displays the most recent battery status from the uploader phone. | ||
* `errorcodes` (CGM Error Codes) - Generates alarms for CGM codes `9` (hourglass) and `10` (???). | ||
* Use [extended settings](#extended-settings) to adjust what errorcodes trigger notifications and alarms: | ||
* `ERRORCODES_INFO` (`1 2 3 4 5 6 7 8`) - By default the needs calibration (blood drop) and other codes below 9 generate an info level notification, set to a space separate list of number or `off` to disable | ||
* `ERRORCODES_WARN` (`off`) - By default there are no warning configured, set to a space separate list of numbers or `off` to disable | ||
* `ERRORCODES_URGENT` (`9 10`) - By default the hourglass and ??? generate an urgent alarm, set to a space separate list of numbers or `off` to disable | ||
* `ar2` ([Forcasting using AR2 algorithm](https://github.com/nightscout/nightscout.github.io/wiki/Forecasting)) - Generates alarms based on forecasted values. | ||
* Enabled by default if no thresholds are set **OR** `ALARM_TYPES` includes `predict`. | ||
* Use [extended settings](#extended-settings) to adjust AR2 behavior: | ||
|
@@ -253,11 +272,18 @@ To learn more about the Nightscout API, visit https://YOUR-SITE.com/api-docs.htm | |
|
||
* `ENABLE` - `pushover` should be added to the list of plugin, for example: `ENABLE="pushover"`. | ||
* `PUSHOVER_API_TOKEN` - Used to enable pushover notifications, this token is specific to the application you create from in [Pushover](https://pushover.net/), ***[additional pushover information](#pushover)*** below. | ||
* `PUSHOVER_USER_KEY` - Your Pushover user key, can be found in the top left of the [Pushover](https://pushover.net/) site, this can also be a pushover delivery group key to send to a group rather than just a single user. This also support a space delimited list of keys. | ||
* `PUSHOVER_ANNOUNCEMENT_KEY` - An optional Pushover user/group key, will be used for system wide user generated announcements. If not defined this will fallback to `PUSHOVER_USER_KEY`. A possible use for this is sending important messages and alarms to a CWD that you don't want to send all notification too. This also support a space delimited list of keys. | ||
* `PUSHOVER_USER_KEY` - Your Pushover user key, can be found in the top left of the [Pushover](https://pushover.net/) site, this can also be a pushover delivery group key to send to a group rather than just a single user. This also supports a space delimited list of keys. To disable `INFO` level pushes set this to `off`. | ||
* `PUSHOVER_ALARM_KEY` - An optional Pushover user/group key, will be used for system wide alarms (level > `WARN`). If not defined this will fallback to `PUSHOVER_USER_KEY`. A possible use for this is sending important messages and alarms to a CWD that you don't want to send all notification too. This also support a space delimited list of keys. To disable Alarm pushes set this to `off`. | ||
* `PUSHOVER_ANNOUNCEMENT_KEY` - An optional Pushover user/group key, will be used for system wide user generated announcements. If not defined this will fallback to `PUSHOVER_USER_KEY` or `PUSHOVER_ALARM_KEY`. This also support a space delimited list of keys. To disable Announcement pushes set this to `off`. | ||
* `BASE_URL` - Used for pushover callbacks, usually the URL of your Nightscout site, use https when possible. | ||
* `API_SECRET` - Used for signing the pushover callback request for acknowledgments. | ||
|
||
|
||
If you never want to get info level notifications (treatments) use `PUSHOVER_USER_KEY="off"` | ||
If you never want to get an alarm via pushover use `PUSHOVER_ALARM_KEY="off"` | ||
If you never want to get an announcement via pushover use `PUSHOVER_ANNOUNCEMENT_KEY="off"` | ||
|
||
If only `PUSHOVER_USER_KEY` is set it will be used for all info notifications, alarms, and announcements | ||
|
||
For testing/development try [localtunnel](http://localtunnel.me/). | ||
|
||
#### IFTTT Maker | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.