Skip to content

Update to point to Nightscout documentation. #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ELUTE wants to merge 1 commit into from
Closed

Update to point to Nightscout documentation. #200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
258 changes: 4 additions & 254 deletions docs/nightscout/new_user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,264 +8,14 @@ If you are the person who enjoys videos...here's a YouTube video that you can us
<a href="https://youtu.be/5WREY465eII" target="_blank"><img src="../img/thumbnail.png" width="650" title="How to build a Nightscout site: Loop Users" /></a>
</p>

## Step 1: Heroku Account
Please visit http://nightscout.github.io/nightscout/new_user/ for directions on how to set up your new Nightscout website.

Create an account at <a href="https://signup.heroku.com/login" target="_blank">Heroku's signup page</a>.
## Once you have a Nightscout Site: Loop Settings

Enter your name, email address, role ("Hobbyist" is fine) and choose "Node.js" as the Primary Development Language. When you get all those entered, confirm that you are not a robot and click the blue "Create Free Account" button
Don't forget to enter your new Nightscout site into your Loop settings! That way Loop can upload all the juicy great info directly to your Nightscout site.

<p align="center">
<img src="../img/heroku1.png" width="450">
</p>

Now follow the directions and check your email to confirm your Heroku account. You'll be asked to create a password...save that password somewhere. You'll likely be logging into Heroku as part of Looping in the future, so this is a good password to save.

When you finish creating the password, you'll see a screen like below.

<p align="center">
<img src="../img/heroku2.png" width="450">
</p>

We have to complete one last step...adding a credit card to your Heroku account. Don't worry, Heroku is still free...but it's only free if you leave a credit card on file. I've used Heroku for 6 years now and never been charged.

To add your credit card, click on the icon of a little ninja person in the upper right corner of the Heroku site, and then select Account Settings and then Billing...or <a href="https://dashboard.heroku.com/account/billing" target="_blank">this should take you right to the billing page for your account</a>. Then click the purple "Add credit card" button. Finish the steps to add a credit card.

<p align="center">
<img src="../img/heroku3.png" width="450">
</p>

Once you finish that, you can just leave that page/tab alone and move on down to the next step below.

## Step 2: Create an account at GitHub

Go to <a href="https://github.com/join" target="_blank">GitHub's signup page</a>. Fill out the information to create your own unique username (write it down), email address, and password (also write this one down). Verify that you are a real person by tossing an animal's image around until it is upright...and then you'll be able to click the green "create an account" at the bottom of the page

<p align="center">
<img src="../img/github1.png" width="450">
</p>

Github will then ask if you want the Free Account (duh, yes). Confirm that (and unclick the Newsletter subscription if you don't want spam).

Finally, Github will ask you a little about your programming experience and what you are going to use GitHub for...you can answer those or choose the "skip this step" option at the bottom of the screen.

Finally, you'll be sent the email to verify your new account. Go to your emails and click the link sent to you.

## Step 3: Fork and deploy cgm-remote-monitor

Now go to the <a href="https://github.com/nightscout/cgm-remote-monitor" target="_blank">Nightscout cgm-remote-monitor repository</a>. This is where the Nightscout developer's store their code that we are going to borrow a copy of. A copy of code in Github is called a "fork". In the upper right corner, you'll find a little button labeled `Fork`. Click that button and you'll see a message that GitHub is cloning/forking a copy of that code to your GitHub account. That is a good thing. Don't worry it only takes a few seconds.

<p align="center">
<img src="../img/ns_fork.jpg" width="550">
</p>
</br></br>
Once the forking is done, scroll down (below all those folder and file names) until you see the purple `Deploy to Heroku` button. Click that button.
</br></br>

<p align="center">
<img src="../img/deploy_heroku.jpg" width="650">
</p>
</br></br>
Pretty quickly, you should see a Heroku screen popup for "Create New App". If you see that, you're good to go onto the next step to start setting up the Heroku Nightscout app.
</br></br>


## Step 4: Setup your Heroku Nightscout app

Heroku calls the code that you just deployed an "app"...but probably easier for most people to imagine it as a website.

The first step is to give your "app" a name, this will be the prefix of your soon-to-be-created Nightscout site’s URL. For example, if you enter "janehasthesugars" then your Nightscout site's URL will be `https://janehasthesugars.herokuapp.com`

<p align="center">
<img src="../img/heroku4.png" width="650">
</p>

Now scroll down a bit and we are going to fill out the information lines in the `Config Vars` section (circled in red above) of that page. There are many variables listed in that section, but we will only *<b>need*</b> to edit a few of them right now to get started. You can always go back later and edit the default values of your BG alarms and other defaults (or do it now, if you'd like). The variables listed below though do need you to make some edits/entries or review that the default settings work for your situation.

<table>
<thead>
<tr>
<th>VARIABLE</th>
<th>VALUE</th>
</tr>
</thead>
<tbody>
<tr>
<th>API_SECRET</th>
<td>Create your own API_SECRET…this is like the password to your NS site. Please write it down somewhere safe or commit it to memory, you will be using it in the future. It needs to be at least 12 characters long and should NOT use the @ or ! symbols.</td>
</tr>
<tr>
<th>DISPLAY_UNITS</th>
<td>default is mg/dl, you'll need to change to mmol if that's what you use</td>
</tr>
<tr>
<th>ENABLE</th>
<td>bridge loop pump iob cob basal careportal sage cage bage openaps override</br></br>(Enter all of the words above without commas. Just add a single space between each word. Make sure autocorrect does not add space between careportal. Typically, the words basal and careportal will already be there waiting for you.)</td>
</tr>
<tr>
<th>BRIDGE_USER_NAME</th>
<td>Enter your Dexcom Share Account login name. This is not an email address. This should be the same account name used in the Looper's Dexcom app.</td>
</tr>
<tr>
<th>BRIDGE_PASSWORD</th>
<td>Enter your Dexcom Share Account password.</td>
</tr>
<tr>
<th>BRIDGE_SERVER</th>
<td>The default assumes the Dexcom user is using a US Dexcom account. <b><u>If you are outside the US, you need to change this entry to EU.</b></u></td>
</tr>
</tbody>
</table>
</br>

!!!info "MOST COMMON ERRORS"
The `BRIDGE_PASSWORD` and `BRIDGE_USER_NAME` are NOT visible from within your Dexcom app or online account. The values for them are what you entered into your Dexcom mobile app when you VERY FIRST logged into that app however long ago. The `BRIDGE_USER_NAME` is not an email address. The most common error on initial Nightscout setups is that people incorrectly use an old account or an old password. To test your username and password, go to <a href="https://clarity.dexcom.com" target="_blank">Dexcom's Clarity</a> page and try logging into your Dexcom account. If your account info doesn't let you in, or you don't see data in your Clarity account...then you need to figure out your actual credentials before moving ahead.

!!!info ""
If you are using Dexcom Share outside the United States, you will need to make sure you have EU in the BRIDGE_SERVER.
</br>
<table>
<thead>
<tr>
<th>KEY</th>
<th>VALUE</th>
</tr>
</thead>
<tbody>
<tr>
<th>BRIDGE_SERVER</th>
<p alighn="left"><td>EU</td>
</tr>
</tbody>
</table>

Now that we have all the variables fixed up, click the purple `Deploy` button at the bottom of screen
</br></br>
<p align="center">
<img src="../img/deploy_button.jpg" width="650">
</p>
</br></br>
Wait about 5 minutes while Heroku builds your Nightscout app. You’ll see some text scroll by in the Build App box, and then finally, you will have a message that the app was successfully deployed.
</br></br>
<p align="center">
<img src="../img/deploy_success.jpg" width="650">
</p>
</br></br>

Click on the `Manage App` button and then we will move onto the next step.

## Step 5: Additional Variables

Select the `Settings` tab near the top of the screen on your Heroku app. Click on `Reveal Config Vars` button that will be partway down the page.

<p align="center">
<img src="../img/heroku5.png" width="650">
</p>
</br></br>
Scroll down to the bottom of the variables list until you find the last blank one.
</br></br>

<p align="center">
<img src="../img/add_vars.jpg" width="650">
</p>
</br></br>
You are going to add several additional lines of variables specifically for Loop use; the `DEVICESTATUS_ADVANCED` is a required line, the others just make Nightscout more useful when Looping.
</br></br>
<table>
<thead>
<tr>
<th>KEY</th>
<th>VALUE</th>
</tr>
</thead>
<tbody>
<tr>
<th>DEVICESTATUS_ADVANCED</th>
<td>true</td>
</tr>
<tr>
<th>PUMP_FIELDS</th>
<td>battery reservoir clock status</td>
</tr>
<tr>
<th>PUMP_RETRO_FIELDS</th>
<td>battery reservoir clock status</td>
</tr>
<tr>
<th>SHOW_FORECAST</th>
<td>loop</td>
</tr>
<tr>
<th>SHOW_PLUGINS</th>
<td>loop pump cob iob sage cage careportal</td>
</tr>
<tr>
<th>LOOP_ENABLE_ALERTS</th>
<td>true</td>
</tr>
<tr>
<th>LOOP_WARN</th>
<td>20</br></br>(This is the minutes since Loop last successfully looped, the t1d will have a similar notification at this time through the Loop app. This will be a yellow alert in NS.)</td>
</tr>
<tr>
<th>LOOP_URGENT</th>
<td>60</br></br>(Same as the alert above, but will be red in color and have a shorter snooze option.)</td>
</tr>
</tbody>
</table>
</br></br>
Finally, I recommend deleting the `PAPERTRAIL_API_TOKEN` line. Heroku offers a free, tiny amount of Papertrail service (like a logging service for how the site is running), but really offers only confusion to most people later when they get a message that their "Free Papertrail Service has run out of room". Papertrail is not needed, and really doesn't provide useful info for Nightscout users anyways...so best to just delete that line and never have to get the useless email in the first place.

## Step 6: Setup Profile

Now that we have finished all the variable setup, scroll up to the top of the page and click on the `Open App` button in the top right corner of your Heroku site.

<p align="center">
<img src="../img/open_app.jpg" width="650">
</p>

You will see black site with a profile warning at the top of the screen. Confirm to redirect to a profile set-up page. (If it doesn't redirect automatically, refresh your webpage...might have to push the button a few times).

<p align="center">
<img src="../img/no_profile.jpg" width="450">
</p>

You do not have to enter all the information in the profile if you are using Loop (since Loop will be providing the information for IOB and COB rather than letting NS calculate them), but you do have to fill out the `TimeZone`. That one is non-negotiable. I highly recommend also filling in the `Insulin to carb ratio`, `Insulin Sensitivity Factor`, and `Basal Rates` so that your information is properly displayed in Nightscout. To be clear, those values you enter in the Profile will not affect your Loop in anyway, because Loop will not read them from Nightscout. New versions of Loop will also update these values in this Profile if you change the corresponding settings in Loop. So really, this is just a one-time setup and after that Loop will do the work of updating these values.

Click `Save` when you have entered the information. You will be prompted to authenticate, if it is the first time you’ve used the device to make changes in your profile. Click on the `Authenticate` link at the bottom of the site, and enter your API_SECRET to complete the authentication.

<p align="center">
<img src="../img/profile.jpg" width="650">
</p>

</br></br>

Close out of the Profile Editor to return to the main Nightscout page and configure your NS settings.

## Step 7: Nightscout Settings
The last step is to finish your Nightscout's settings. Click on the settings (those three horizontal lines in upper right corner). Now check that you have everything displaying correctly:

* `Render Basal` is set to either default or icicle (totally personal preference for how the temp basals show as blue lines in NS site)
* Theme is set to Colors
* Check the boxes that you’d like display pills in the SHOW PLUGINS (usually all of them except Openaps) section.

<p align="center">
<img src="../img/settings_ns.jpg" width="650">
</p>

Save the settings changes and you'll be on your way! Congrats!!

## Step 8: Loop Settings

Don't forget to enter your new Nightscout site into your Loop settings! That way Loop can upload all the juicy great info directly to your Nightscout site (except CGM data...that is all handled by that BRIDGE info you put in earlier)

Directions [here](https://loopkit.github.io/loopdocs/operation/loop-settings/services/#nightscout) as well as warnings about the two most common errors when people add the URL to Loop settings. (Hint hint hint)
Make sure that you enter your URL starting with https://

## Troubleshooting

If your site is not showing CGM (and Loop, if you are Looping) data within about 10 minutes of finishing your setup, then please follow these steps [here](https://loopkit.github.io/loopdocs/nightscout/troublehoot/) to troubleshoot.

## Future warning

At some point in the future months, your Nightscout site will likely stop in some quirky way...like CGM data won't be showing is the most common. This won't affect Looping, but it might be kind of annoying if you are a parent using Nightscout for remote info. The reason? The database Heroku gives us for free has some size limitations. After several months of Looping, you'll likely fill up that free amount of space and we will need to cleanout in order to make room.

So...keep it in your head that if you see something odd with your NS site (like no CGM even though Dexcom is working), then please check [this page to learn how you can cleanout the database](https://loopkit.github.io/loopdocs/nightscout/mlab_cleanup/). It is easy and fast...no worries.