0.6.0 docs

docs/docs/Build Your Rig/OpenAPS-install.md

@@ -86,7 +86,7 @@ The screenshot below shows an example of the questions you'll be prompted to rep
 * email address for github commits
 * directory name for your openaps - we recommend the default `myopenaps` (see note above)
 * serial number of your pump
-* whether or not you are using an Explorer board
+* whether you are using an Explorer board
    * if not an Explorer board, and not a Carelink stick, you'll need to enter the mmeowlink port for TI stick.  See [here](https://github.com/oskarpearson/mmeowlink/wiki/Installing-MMeowlink) for directions on finding your port
     * if you're using a Carelink, you will NOT be using mmeowlink
 * CGM method:  The options are `g4-upload`, `g4-local-only`, `g5`, `mdt`, and `xdrip`.  Note:  OpenAPS also attempts to get BG data from your Nightscout.  OpenAPS will always use the most recent BG data regardless of the source.  G4-upload will allow you to have raw data when the G4 receiver is plugged directly into the rig.
@@ -144,7 +144,7 @@ Or how about the fact that autotune hasn't run yet, but you enabled it during se
 ```
 Old settings refresh Could not parse autotune_data
 ```
-Autotune only runs at 12:05am every evening.  So, unless you're building your rig at midnight, you'll probably have to wait overnight for that error message to clear out.  Not a big deal.  You can still loop while that message is showing.  Additionally, you'll have to wait until Autotune runs before SMBs can be enacted (SMBs won't enact unless an Autotune directory exists).
+Autotune only runs at 4:05am every morning. So if autotune has not yet run, you must wait for that error message to clear out, or run it manually. You can still loop while that message is showing. Additionally, you'll have to wait until autotune runs before SMBs can be enacted. (SMBs won't enact unless an Autotune directory exists.)
 
 And then you may have an issue about the time on your pump not matching your rig's time:
 ```

docs/docs/Build Your Rig/x12-users.md

@@ -1,65 +1,56 @@
 # 512 and 712 Pump users
 
-If you have one of the x12 model pumps, you can still successfully use OpenAPS for basic looping (but not some advanced featuers like SMB).  You'll need to complete some extra setup steps before your loop will be successful, however. There are TWO major steps; (1) creating the files and (2) adjusting aliases.  x12 users will have to be aware that the files will need to be manually updated anytime the pump user wants to change basal rate schedules, ISFs, or other pump settings.  
+If you have one of the x12 model pumps, you can still successfully use OpenAPS for basic looping (but not some advanced featuers like SMB).  You'll need to complete some extra setup tweaks before your loop will be successful, however.
 
-## Add pump files manually
+Note: If you have an old rig running oref0 0.5.3 or below, you'll need to follow historical instructions. The instructions below reflect the adjusted oref0-setup.sh in 0.6.0 and beyond, that does some of this work manually.
 
-Certain commands like Read Settings, BG Targets and certain Read Basal Profile are not available for x12 pumps.  Therefore, you will create new files (called static json files) for the missing information.  Specifically, you'll be creating three files called settings.json, bg_targets_raw.json, and basal_profile.json.  To do this:
-
-* Create a new subdirectory to your myopenaps directory.  We are going to name the subdirectory `raw-pump`.  After we create the new sub-directory, we will be changing into that newly created directory.  The following command will do all those things at once: `cd ~/myopenaps && mkdir raw-pump && cd raw-pump`  You can confirm the successful completion of this step by looking at your terminal prompt and it should show `root:~/myopenaps/raw-pump#`
+## Most important step - make sure you said yes (y) in oref0-setup.sh 
 
-* `nano settings.json` to create a new settings.json file by using the nano editor. This will open a text editor where you can add your pump settings.  Use the sample files below to copy and paste into the editor.  **WARNING**: Make sure you change the values within the sample files to match YOUR settings and what is on YOUR pump. The loop is going to use the content of these files, so this needs to be correct for safe looping.  Some hints are provided within the sample files to help you notice which items will need your personalized settings.
+During the interactive setup script, one early question is about whether you have an x12 pump. This means you, if you have a 512 or 712 pump you're setting up. Make sure to type Y or y and see the confirmation that you'll be using an x12 pump.
 
- * To finish and save the new file, press `Ctl-X`, and when it asks if you want to save `Y` for yes, and `return` to keep the settings.json name.
-
- * Repeat the steps above for also creating the following files (sample files for these are below, as well): bg_targets_raw.json and basal_profile.json.
-
-Once complete, type `ls` and you should see the following files:
+## Edit the three (3) necessary files: basal, settings, and targets
+
+At the end of the oref0-setup.sh script, it will open the most important file for you to edit - your basal profile. Edit this file to match your preferred basal rates and timing. 
 
 ```
- settings.json     bg_targets_raw.json     basal_profile.json
+Note: The "minutes" is "minutes from midnight". e.g., a basal starting at 5:00am 
+will have a minutes entry of 5 x 60 = 300 minutes and a basal starting at 7:30am 
+will have a minutes entry of 7.5 x 60 = 450 minutes. 
+If you have a basal rate less than 1.0 unit/hour, 
+make sure to include a zero before the decimal point such as `0.55`
 ```
 
-* Finish our work with these files by copying them into the settings directory:
+After you ctrl-x and hit "y" to save the file, you'll also see a reminder to further adjust other files with your settings in order to loop off of your information. 
+
+* If you need to edit your basal rate file in the future, simply type `nano ~/myopenaps/settings/basal_profile.json` from the command line.
+
+To edit and set your maxBasal or your DIA:
+* `nano ~/myopenaps/settings/settings.json`
 
-`cd ~/myopenaps && cp ./raw-pump/bg_targets_raw.json ./settings/ && cp ./raw-pump/basal_profile.json ./settings/ && cp ./raw-pump/settings.json ./settings/`
+Finally, to set your targets:
+* `nano ~/myopenaps/settings/bg_targets_raw.json`
 
 
-### Sample file for settings.json
+### Examples of the three file types
+
+To see examples of each of these three files, see below.
+
+#### Sample file for settings.json
 
 notes are added with `#` on the lines you want to adjust or pay attention to in particular
 
 ```
 {
-  "low_reservoir_warn_point": 5, #adjust to your warning level of units remaining
-  "keypad_lock_status": 0, 
   "maxBasal": 1.5,  #adjust to your preferred max temp basal rate
   "temp_basal": {
-    "percent": 100, #leave as-is
-    "type": "Units/hour" #leave as-is
-  }, 
-  "low_reservoir_warn_type": 0, 
-  "insulinConcentration": 100, 
-  "audio_bolus_enable": false, 
-  "variable_bolus_enable": true, 
-  "alarm": {
-    "volume": -1, 
-    "mode": 1
+    "percent": 100,
+    "type": "Units/hour"
   }, 
-  "rf_enable": true,  #you will want this set to true or else your pump will not tune properly 
-  "auto_off_duration_hrs": 0, 
-  "block_enable": false, 
-  "timeformat": 1, 
-  "insulin_action_curve": 3, #adjust to your selected duration of insulin action in whole hour increments
-  "audio_bolus_size": 0, 
-  "selected_pattern": 0, 
-  "patterns_enabled": true, 
-  "maxBolus": 3.0,  #adjust to your preferred max single bolus units
-  "paradigm_enabled": 1
+  "insulin_action_curve": 6 #adjust to your selected duration of insulin action in whole hour increments
 }
 ```
 
-### Sample file for bg-targets-raw.json
+#### Sample file for bg-targets-raw.json
 
 Note: the "offset" entry is the minutes since midnight for that particular target to start.  The profile always starts with a midnight rate first, offset is 0.  The next BG target, in this example, starts at 6 am and therefore has an offset of 360 minutes (6 hours from midnight at 60 minutes per hour).  Target range can have the same bg value for high and low, if desired, but be careful not to have a high target set lower than the low target.
 
@@ -98,7 +89,7 @@ You can add or delete bg targets to the sample file below, but pay close attenti
 }
 ```
 
-### Sample file for selected-basal-profile.json
+#### Sample file for selected-basal-profile.json
 
 Note:  The format for the basal rates is the "minutes" value refers to the "minutes from midnight" for whatever rate schedule you are setting.  For example, the 6:00 am rate in the example file below is a rate of 1.15 units/hour and 6:00 am is 360 minutes since midnight passed (6 hours x 60 minutes per hour).  
 
@@ -158,19 +149,3 @@ You can add or delete basal rates to the sample file below, but pay close attent
   }
   ]
 ```
-
-## Adapt the aliases 
-
-The last steps are to edit the standard openaps aliases so they don't call for non-existing pump files
-
-* First, copy and paste each of these three lines individually to adjust the "get-settings" alias:
-
-  ```
-  cd ~/myopenaps && killall -g openaps
-  openaps alias remove get-settings
-  openaps alias add get-settings "report invoke settings/model.json settings/bg_targets.json settings/insulin_sensitivities_raw.json settings/insulin_sensitivities.json settings/carb_ratios.json settings/profile.json"
-  ```
-
-## Updating your pump settings
-
-If you need to make changes to the settings contained in your pump, specifically those covered by the three files you've created (basal rates, bg-targets, max temp basal rate, or insulin duration), then you will need to edit the files and update their contents in the settings directory.  For example, if you change your basal schedule or rates in the pump...simply editing them in the pump manually will not be enough to let OpenAPS know the basal profile has been altered.  You'll need to login to the rig, access the files and update the information manually in the files.  You can make the adjustments to the file(s) you created in the raw-pump subdirectory by using `cd ~/myopenaps/raw-pump`, then the same nano command(s), and then using the same file copy command to push the edited files into the settings directory.

docs/docs/Customize-Iterate/oref1.md

@@ -7,7 +7,7 @@ NOTE OF CAUTION:
 
 ## Only run oref1 with the following caveats in mind: 
 
-* Remember that you are choosing to test a still-in-development feature. Do so at your own risk & with due diligence to keep yourself safe. The number one rule (and the first pass phrase for enabling oref1 features) is "s@fety".
+* Remember that you are choosing to test a still-in-development feature. Do so at your own risk & with due diligence to keep yourself safe. 
 * You should have run oref0 (basic OpenAPS looping) for more than two weeks, and be very aware of all the types of situations in which your rig might fail.
 * **We are requiring that you also have run autotune prior to enabling SMB.** Why? Because if you have wonky ISF settings, for example, you may be more likely to go low or high with SMB. It will help a lot to have run autotune and be aware if the algorithm is recommending changes to ISF, basal, and/or carb ratio. You are not required to run autotune automatically/nightly as part of your loop with SMB; but you should at least run it manually and get an idea for how confident you are in your settings being right or not; and keep that in mind when evaluating SMB outcomes for yourself.
 * You should have basals of > 0.5 U/hr. (SMB is *not* advisable for those with very small basals; since 0.1U is the smallest increment that can be bolused by SMB.  We also added a basal check to disable SMB when basals are < 0.3 U/hr.  If your "regular" basal in the pump is 0.3 U/hr and autosens or autotune has adjusted your basal rate to below 0.3 U/hr, SMBs will be disabled as well.)
@@ -40,7 +40,7 @@ UAM will be triggered if the preference is toggled on and there is carb activity
 
 ## How to turn on SMB/UAM
 
-* As of July 13, 2017, SMB/UAM are in the master branch of oref0 (oref0 0.5.0). They are under the advanced features menu, and require you to read these docs carefully from top to bottom on this page in order to enable it during the setup script. Afterward, you also need to turn on the relevant settings in preferences.json. You may want to experiment with turning only one of them on at a time so you can closely observe the behavior (via both Nightscout and pump-loop.log) in the enabled situation. In addition to testing oref1 in "normal" situations, pay special attention to how it behaves in more extreme situations, such as with rescue carbs (announced or not), post-meal activity, etc. 
+* As of July 13, 2017, SMB/UAM are in the master branch of oref0 (oref0 0.5.0 and later). In oref0 0.6.0 and later, you will enable SMBs by adding the related preferences to your preferences.json. You may want to experiment with turning only one of them on at a time so you can closely observe the behavior (via both Nightscout and pump-loop.log) in the enabled situation. In addition to testing oref1 in "normal" situations, pay special attention to how it behaves in more extreme situations, such as with rescue carbs (announced or not), post-meal activity, etc. 
 
 There are multiple preference toggles for SMB/UAM. Check out the [preferences page](http://openaps.readthedocs.io/en/latest/docs/While%20You%20Wait%20For%20Gear/preferences-and-safety-settings.html#advanced-oref1-preferences) for more details on all the settings, but the short version is:
 
@@ -52,7 +52,7 @@ There are multiple preference toggles for SMB/UAM. Check out the [preferences pa
  Conversely, a higher temp target (101 if your target is 100) will disable SMB. 
 ```
 
-* To test UAM, you'll need to toggle to "true" the enableUAM in preferences.json. UAM can be enabled without SMB, but it won't be very effective without enableSMB_with_bolus. You'll probably also want to make sure your nightscout is updated to the latest version to make sure that you can take advantage of UAM prediction lines. To test UAM, you'll first want to be familiar with SMB's "normal" behavior (related, the second safety phrase you need to know is "gate"), and then test, with a small meal, giving an up-front bolus (of more than 30m worth of basal, so it can be distinguished from an SMB) and not entering carbs. You'll probably also want to do an "eating soon mode" temporary target or bolus beforehand. You can then observe, by watching the NS purple line predictions and the pump-loop.log, whether your OpenAPS rig is SMB'ing appropriately when it starts to see UAM carb impact.
+* To test UAM, you'll need to toggle to "true" the enableUAM in preferences.json. UAM can be enabled without SMB, but it won't be very effective without enableSMB_with_bolus. You'll probably also want to make sure your nightscout is updated to the latest version to make sure that you can take advantage of UAM prediction lines. To test UAM, you'll first want to be familiar with SMB's "normal" behavior, and then test, with a small meal, giving an up-front bolus (of more than 30m worth of basal, so it can be distinguished from an SMB) and not entering carbs. You'll probably also want to do an "eating soon mode" temporary target or bolus beforehand. You can then observe, by watching the NS purple line predictions and the pump-loop.log, whether your OpenAPS rig is SMB'ing appropriately when it starts to see UAM carb impact.
 
 ## Troubleshooting
 

docs/docs/Customize-Iterate/usability-considerations.md

@@ -10,7 +10,7 @@ Now that you've closed the loop, you probably have a lot of new "first" experien
 
 
 ## **What do you do with your loop when you travel across timezones? How do you update devices for a time zone change?**
-<br>You have a couple of options. If you are traveling briefly, or only across a couple of timezones, and would not normally feel the need to adjust the timing of your basals, then you may choose to simply leave your pump, receiver, and Pi/Edison on your home timezone. But, if you would like to adjust to the new timezone (perhaps for a longer trip or a move), you can adjust your rig's timezone using `sudo dpkg-reconfigure tzdata` and then either run `killall -g openaps; oref0-set-device-clocks` to set the devices to match, or just change your pump and receiver time manually.  Make sure to test in your new location to make sure everything is working! We also recommend planning to do this when you have some extra time for troubleshooting, in case you have issues. Also, it's worth noting that your body only changes about an hour or so of timezone a day, so even if you go abroad, there's not a rush to change timezones/the time on your devices - you can wait until 2-3 days into your trip to make the swap, at a time when you have some room to update your rigs.</br>
+<br>You have a couple of options. If you are traveling briefly, or only across a couple of timezones, and would not normally feel the need to adjust the timing of your basals, then you may choose to simply leave your pump, receiver, and Pi/Edison on your home timezone. But, if you would like to adjust to the new timezone (perhaps for a longer trip or a move), you can adjust your rig's timezone using `sudo dpkg-reconfigure tzdata` and then either run `killall -g oref0-pump-loop; oref0-set-device-clocks` to set the devices to match, or just change your pump and receiver time manually.  Make sure to test in your new location to make sure everything is working! We also recommend planning to do this when you have some extra time for troubleshooting, in case you have issues. Also, it's worth noting that your body only changes about an hour or so of timezone a day, so even if you go abroad, there's not a rush to change timezones/the time on your devices - you can wait until 2-3 days into your trip to make the swap, at a time when you have some room to update your rigs.</br>
 <br>After the timezone change OpenAPS sometimes gets confused about the BG and/or pump data being "in the future".  The pump and CGM data are not timestamped in UTC, so being unsynchronized with the OpenAPS can cause incorrect behavior.  When the BG or pump data is "in the future" the software may stop pulling current information from the pump, and stop functioning (until the current time in the system reaches the time when the monitor data is no longer "in the future"). It often makes sense to remove all files from OpenAPS <i>monitor</i> folder after changing the timezone.  However, this is sometimes insufficient, as the devices will still have records that are "in the future" from the perspective of your new timezone.  As a result, you should expect Nightscout uploads to fail until the system time catches up to the previous device time, particularly when traveling west.</br>
 
 ## **What do you do with the loop when you shower?**