General reorganization and cleanup - hardware, install steps, flashing, background reading #1537

kimberscott · 2020-02-22T21:18:36Z

Replacement for previous PR #1494 after integrating new changes - rebasing was a little complicated because I'd combined and eliminated some files, so this was more straightforward for me. I've manually reviewed the changes here af8322e...openaps:master to make sure everything's up to date.

Previous description - As a new OpenAPS user I spent a lot of time reading the docs, and found some of the organization confusing - e.g., classification of various reference material under "While You Wait For Gear," information split or duplicated across various setup and troubleshooting sections. Some very helpful information was hard to find on my own initially (e.g., how to actually use a profile after updating the pump) - people very graciously helped me (thanks!) but shouldn't have had to. It seems like the docs were clearly organized at one point, but have grown organically for some time to the point where that wasn't as evident to a newcomer, and were ready for a routine cleanup.

Here is a proposed reorganization; you can see it hosted at https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/index.html

I have tried not to change anything substantive or remove any information in this PR, although I've added some minor clarifications in places. The main changes are:

Consolidating info about hardware (what to get, how to put it together, how to improve battery life of Pi, etc.)
Consolidating flashing instructions for Mac, Windows, & all platforms and separating out the "how to log in over serial" instructions
Separating "While You Wait For Gear" and "Customize-Iterate" headers into preparation, "how it works," "usage/maintenance", and "customization/advanced" sections for clarity in referencing later. The preparation section still includes a reading list of what pieces you should read and understand before installing/using OpenAPS, which I think will be easier to maintain than notes in pages on e.g. monitoring the rig that you don't need to understand everything yet. If there are additional particular sections it's important to read, skim, or be aware of ahead of time they can just go on the reading list.
Organizing the two autotune pages more clearly into "how it works" and "how to make it go"
Making some information about day-to-day usage more prominent ("Tips and Tricks" which was hiding in Resources had some info I'd seen asked about repeatedly; some were moved to appropriate sections and rest were made into a section in usage/maintenance)
Clarifying the overview of steps. As noted in the commit this is more like personal taste, but as a beginner I found the image at https://openaps.readthedocs.io/en/latest/docs/Understanding%20OpenAPS-Overview/overview-of-build-process.html very confusing and, even though some people strongly prefer pictures over text, I'm concerned this would confuse other people too. (I ran this by other people locally, but admit the people I know skew text-preferring.)

Obviously happy to make (/remove) any changes as requested, and to handle merging in existing PRs if that would be helpful.

…ure changes are applied here

…penaps/docs@af8322e...openaps:master) to ensure they are added

StephenBrown2 · 2020-02-24T17:00:02Z

docs/docs/Understanding OpenAPS-Overview/communication-support-channels.md

-There is a [Slack channel](https://omniapsslack.azurewebsites.net/) that you can add yourself to - then look for the `#OpenAPS` channel to post questions. That slack can also be used to stay up to date on other, broader DIY diabetes projects such as communication around other pumps that are being explored and worked on, but aren't yet DIY loopable.
+There is a [Slack channel](https://omniapsslack.azurewebsites.net/) that you can add yourself to - then look for the `#OpenAPS` channel to post questions. This is the best place to get real-time support with anything related to OpenAPS. It is a great place to introduce yourself and get some help from those who are a few steps further down the road. That slack can also be used to stay up to date on other, broader DIY diabetes projects such as communication around other pumps that are being explored and worked on, but aren't yet DIY loopable.
+
+### Google Group 


This got duplicated from Lines 80-81

Fixed I think, sorry about that!

Ah, no I meant the Google Group section. The same text is in two places. You can see it in the generated docs with Google Group Heading 1 vs Google Group Heading 2 and in the sidebar:

Oh darn it, I'm sorry! Actually fixed although I guess not directing people to both Slack and Gitter as the best place is good too.

StephenBrown2 · 2020-02-24T18:05:03Z

docs/docs/Build Your Rig/step-1-flashing.md

+### If you’re using a Mac - starting flash:
+  - In the "flash window" from the Download Image instructions above, run `./flashall.sh`.  
+    - If you receive an `dfu-util: command not found` error, you can install dfu-util by following [the Mac instructions here](https://software.intel.com/en-us/node/637974#manual-flash-process). 
+    - If you receive an `Error: Running Homebrew as root is extremely dangerous and no longer supported. As Homebrew does not drop privileges on installation you would be giving all build scripts full access to your system.` see the troubleshooting section below.


This runs off the page, perhaps it could be broken up or made to use triple-ticks instead?

StephenBrown2 · 2020-02-24T18:07:29Z

docs/docs/Build Your Rig/step-1-flashing.md

+in something closer to 10 seconds than 10 minutes, then you likely didn't set up swap properly.  To verify, `cat flash.log` and look for `dfu-util: Cannot allocate memory of size 1610612736 bytes` near the end.
+Alternatively, [this newer version of DFU Util](https://sourceforge.net/projects/dfu-util/files/latest/download) (DFU Util v0.9) seems to work better on computers with lots of RAM.
+
+c) If you recieve an `Error: Running Homebrew as root is extremely dangerous and no longer supported. As Homebrew does not drop privileges on installation you would be giving all build scripts full access to your system.` it means that you have a recent copy of homebrew (that's good) which doesn't allow sudo to even do a `brew list`. 


Same issue with running off the page here.

StephenBrown2 · 2020-02-24T18:16:03Z

docs/docs/Build Your Rig/step-3-setup-script.md

+
+Log in to your rig and run the following command (aka "the setup script"):
+
+    `cd && ~/src/oref0/bin/oref0-setup.sh`


This is already a code block due to the four space indent, recommend changing it to triple-ticks

Suggested change

`cd && ~/src/oref0/bin/oref0-setup.sh`

```

cd && ~/src/oref0/bin/oref0-setup.sh

```

…rotate fix in header

StephenBrown2

Looking pretty good. A major thing to be aware of is link rot due to the reorg, so I've run a link checker on the draft rtd site, and came up with the following results. Not all of them are related to changes you made, so I've commented on each line available in the diff for potential changes.

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/usability-considerations.html
	id #how-do-i-switch-to-a-different-medtronic-pump- not found	https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/usability-considerations.html#how-do-i-switch-to-a-different-medtronic-pump-
	id #what-do-you-do-when-you-change-sites- not found	https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/usability-considerations.html#what-do-you-do-when-you-change-sites-

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/preferences-and-safety-settings.html
	id #editing-your-preferencesjson not found	https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/preferences-and-safety-settings.html#editing-your-preferencesjson
	id #maxUAMSMBBasalMinutes not found	https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/preferences-and-safety-settings.html#maxUAMSMBBasalMinutes

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/update-your-rig.html
	id #be-prepared-to-enter-the-following-information-into-oref0-setup not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Build%20Your%20Rig/step-3-setup-script.html#be-prepared-to-enter-the-following-information-into-oref0-setup

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Resources/technical-resources.html
	404	https://www.codecademy.com/tracks/python
	lookup www.overlooksoft.com: no such host	http://www.overlooksoft.com/download

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Build%20Your%20Rig/step-4-watching-log.html
	id #summary-of-outputs not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/How%20it%20works/understand-determine-basal.html#summary-of-outputs

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/While%20You%20Wait%20For%20Gear/nightscout-setup.html
	id #bridge-share2nightscout-bridge not found	https://github.com/nightscout/cgm-remote-monitor#bridge-share2nightscout-bridge

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/running-autotune.html
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Usage%20and%20maintenance/understanding-autotune.html
	id #before-you-get-started not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Understanding%20OpenAPS-Overview/overview-of-build-process.html#before-you-get-started
	id #phase-c-running-autotune-for-suggested-adjustments-without-an-openaps-rig not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/How%20it%20works/autotune.html#phase-c-running-autotune-for-suggested-adjustments-without-an-openaps-rig

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Resources/history.html
	Moved to https://github.com/openaps/decocare:	http://www.github.com/bewest/decoding-carelink

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Customize-Iterate/useful-mobile-apps.html
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Troubleshooting/general_linux_troubleshooting.html#directories-on-your-rig

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/How%20it%20works/understanding-insulin-on-board-calculations.html
	404	https://github.com/openaps/oref0/tree/0.6.0-dev

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Gear%20Up/pi-based-rigs.html
	id #sd-card not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Gear%20Up/edison-explorer-board.html#sd-card
	id #buy-now-modal not found	https://www.raspberrypi.org/products/#buy-now-modal

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Resources/switching-between-DIY-systems.html
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Build%20Your%20Rig/index.html
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/walkthrough/phase-4/ifttt-integration.md.html
	id #advanced-meal-assist-or-ama not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/How%20it%20works/autosens.html#advanced-meal-assist-or-ama
	id #auto-sensitivity-mode not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/How%20it%20works/autosens.html#auto-sensitivity-mode
	id #eating-soon-and-activity-mode-temporary-targets not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/How%20it%20works/autosens.html#eating-soon-and-activity-mode-temporary-targets
	id #override-high-target-with-low not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Usage%20and%20maintenance/preferences-and-safety-settings.html#override-high-target-with-low
	id #understanding-your-preferences-json not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Usage%20and%20maintenance/preferences-and-safety-settings.html#understanding-your-preferences-json

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Troubleshooting/oref0-setup-troubleshooting.html
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Customize-Iterate/update-your-rig.html#step-2-re-run-oref0-setup
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Troubleshooting/carelink.html

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Gear%20Up/rig-options.html
	id #hardware-information-for-pi-based-setups-with-the-adafruit-rfm69hcw-bonnet not found	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Gear%20Up/pi-based-rigs.html#hardware-information-for-pi-based-setups-with-the-adafruit-rfm69hcw-bonnet

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/monitoring-OpenAPS.html
	404	https://play.google.com/store/apps/details?id=crosien.HotButton
	id #if-your-iphone-and-rig-are-on-the-same-wifi-network not found	https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/monitoring-OpenAPS.html#if-your-iphone-and-rig-are-on-the-same-wifi-network

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Troubleshooting/Common-error-messages.html
	404 GitHub URL used	https://github.com/openaps/docs/blob/master/docs/Automate-system/vizualization.md

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Customize-Iterate/offline-looping-and-monitoring.html
	id #usb-otg-flakiness not found	https://github.com/EnhancedRadioDevices/915MHzEdisonExplorer/wiki#usb-otg-flakiness

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Build%20Your%20Rig/step-2-wifi-dependencies.html
	403	http://www.cs.upc.edu/lclsi/Manuales/wireless/files/wpa_supplicant.conf
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Gear%20Up/edison.html#soldering
	500	http://www.geeked.info/raspberry-pi-add-multiple-wifi-access-points/

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Gear%20Up/edison-explorer-board.html
	404	http://www.ebay.com/itm/272062812611
	404	https://drive.google.com/drive/folders/0BxeFg9yJZ_FZdWJEcG5KMXdUMjg?usp=sharing
	404	https://www.amazon.com/Battery-Packs-Lithium-3-7v-2000mAh/dp/B0137ITW46
	timed out	https://www.wirelessthings.net/erf-0-1-pin-spaced-radio-module
	timed out	https://www.wirelessthings.net/slice-of-radio-wireless-rf-transciever-for-the-raspberry-pi

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Resources/Deprecated-Pi/Pi-setup.html
	404	http://www.interlockroc.org/2012/12/06/raspberry-pi-macgyver/
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Resources/Resources/Deprecated-Pi/pi-setup.html#newer-path
	404	https://draft-openaps-reorg.readthedocs.org/en/reapply-cleanup/docs/Resources/Resources/Deprecated-Pi/pi-setup.html#older-instructions-for-original-pi-based-setups
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/2NoobsKeyboard.JPG
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/3NoobsWarning.JPG
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/Configuration.jpg
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/InkedPowerSave_LI.jpg
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/InkedTerminal_LI.jpg
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/Noobs1.JPG
	404	https://github.com/jcorbett80/docs/blob/master/docs/docs/Images/UpdateWarning.JPG

StephenBrown2 · 2020-02-24T21:07:56Z

docs/docs/Usage and maintenance/usability-considerations.md

- [How do I open loop?](#how-do-i-open-loop-)
- [How can you make adjustments to insulin delivery while on the go? - Optimizing with Temporary Targets:](#how-can-you-make-adjustments-to-insulin-delivery-while-on-the-go----optimizing-with-temporary-targets-)
- [How do I improve the range of my Edison/Explorer Board?](#how-do-i-improve-the-range-of-my-edison-explorer-board-)
- [How do I switch between insulin types, or switch to Fiasp? What should I change?](#how-do-i-switch-between-insulin-types--or-switch-to-fiasp--what-should-i-change-)
 - [How do I switch to a different Medtronic pump?](#how-do-i-switch-to-a-different-medtronic-pump-)


This ID doesn't exist

StephenBrown2 · 2020-02-24T21:08:15Z

docs/docs/Usage and maintenance/usability-considerations.md

- [What do you do with your loop when you travel across timezones? How do you update devices for a time zone change?](#what-do-you-do-with-your-loop-when-you-travel-across-timezones--how-do-you-update-devices-for-a-time-zone-change-)
- [What do you do with the loop when you shower?](#what-do-you-do-with-the-loop-when-you-shower-)
+- [What do you do with your loop when you travel across timezones? How do you update devices for a time zone change?](#what-do-you-do-with-your-loop-when-you-travel-across-timezones-how-do-you-update-devices-for-a-time-zone-change)
+- [What do you do with the loop when you shower?](#what-do-you-do-with-the-loop-when-you-shower)
 - [What do you do when you change sites?](#what-do-you-do-when-you-change-sites-)


This ID doesn't exist

StephenBrown2 · 2020-02-24T21:13:11Z

docs/docs/Usage and maintenance/update-your-rig.md

@@ -46,11 +46,11 @@ In case you want to test even more advanced stuff you've read about on gitter ch

 ## Step 2: Re-run oref0-setup

-Now that you've updated your `oref0` version, you will want to run the oref0-setup script (`cd && ~/src/oref0/bin/oref0-setup.sh`) again. See [this section](http://openaps.readthedocs.io/en/latest/docs/Build%20Your%20Rig/OpenAPS-install.html#be-prepared-to-enter-the-following-information-into-oref0-setup) for a guide of what the setup script will be prompting you to enter.
+Now that you've updated your `oref0` version, you will want to run the oref0-setup script (`cd && ~/src/oref0/bin/oref0-setup.sh`) again. See [this section](<../Build Your Rig/step-3-setup-script#be-prepared-to-enter-the-following-information-into-oref0-setup>) for a guide of what the setup script will be prompting you to enter.


#be-prepared-to-enter-the-following-information-into-oref0-setup Title got modified, so now the ID is broken

StephenBrown2 · 2020-02-24T21:16:12Z

docs/docs/Build Your Rig/step-4-watching-log.md

+
+![Successful pump-loop](../Images/build-your-rig/loop-success.png)
+
+Reading these should give you an idea for what OpenAPS knows: current BG, changes in BG, information about netIOB (taking into account any temp basals it has set along with any boluses you have done), carbs on board, etc. Plus, it will give you information about the predictions and show you the data points it is using to draw the "purple prediction lines" in Nightscout. It also will tell you what, if anything, is limiting it's ability to give more insulin - e.g. if you have maxIOB at 0, or it is capped by one of the safety settings, etc. This information is a longer version of the information that will show in the "OpenAPS pill" on Nightscout. And - this is where it will tell you what insulin it thinks you need (more/less and how much) and what temporary basal rate (temp basal) it will try to set next to adjust and bring your eventualBG prediction into your target range. ([For more details on how to interpret the OpenAPS math and information, see this page for understanding OpenAPS determine-basal](<../How it works/understand-determine-basal#summary-of-outputs>).)


#summary-of-outputs ID does not exist

Fixed to link to the overall page which seems more appropriate

StephenBrown2 · 2020-02-24T21:18:57Z

docs/docs/Troubleshooting/Common-error-messages.md

+
+## Errors during `openaps report invoke monitor/ns-glucose.json` or `ns-upload.sh`
+
+If you are getting your BG from Nightscout or you want to upload loop status/results to Nightscout, among other things you'll need to set 2 environment variables: `NIGHTSCOUT_HOST` and `API_SECRET`. This is handled in the setup script. If you do not set and export these variables you will receive errors while running `openaps report invoke monitor/ns-glucose.json` and while executing `ns-upload.sh` script which is most probably part of your `upload-recent-treatments` alias.Make sure your `API_SECRET` is in hashed format. Please see [this page](https://github.com/openaps/oref0#ns-upload-entries) or [this issue](https://github.com/openaps/oref0/issues/397) for details. Additionally, your `NIGHTSCOUT_HOST` should be in a format like `http://yourname.herokuapp.com` (without trailing slash). For the complete visualization guide use [this page](https://github.com/openaps/docs/blob/master/docs/Automate-system/vizualization.md) from the OpenAPS documentation.


Should https://github.com/openaps/docs/blob/master/docs/Automate-system/vizualization.md be converted to a relative RTD link (or removed, as it currently 404s)?

I think the appropriate document is the nightscout-setup page so I linked to that. In casually looking through openaps/docs versions going back to 2016 I didn't see this directory...

StephenBrown2 · 2020-02-24T21:24:27Z

docs/docs/Gear Up/edison-explorer-board.md

+
+* [RadioShack Project Enclosure (3x2x1 inch)](https://www.radioshack.com/products/radioshack-project-enclosure-3x2x1?utm_medium=cpc&utm_source=googlepla&variant=20332262405&gclid=Cj0KEQiA-MPCBRCZ0q23tPGm6_8BEiQAgw_bAkpDZCXfIgbEw8bq76VHtV5mLwR2kHKfJrsGsF3uqqgaAtxP8P8HAQ) 
+* [Small clear plastic case perfect for larger Sparkfun 2000 mAh battery: #8483](http://www.ebay.com/itm/272062812611)
+* [Small Plastic Clear Case for 2500 mAh battery](http://www.ebay.com/itm/272062812611) - Since a Tic-Tac box is too small for the 2500 mAh battery.


This is the same link as above, does not exist

Removed these and replaced with a general note about there being such cases

StephenBrown2 · 2020-02-24T21:24:47Z

docs/docs/Gear Up/edison-explorer-board.md

+* [Sulka Haro's 3D design](https://www.tinkercad.com/things/4a6VffpcuNt)
+* [tazitoo's 3D design: CAD](https://www.tinkercad.com/things/aRYGnHXt7Ta-explorer-case/editv2) ([or STL for 3D printing](http://www.thingiverse.com/thing:2106917))
+* [danimaniac's Protective Cases & Accessories](https://github.com/danimaniac/OpenAPS-Explorer-Board-Edison-vented-case)
+* [Luis's ventilated acrylic simple design](https://drive.google.com/drive/folders/0BxeFg9yJZ_FZdWJEcG5KMXdUMjg?usp=sharing)


This link 404s

Removing for now but trying to contact Luis to see if he wants to share an updated link. These Google Drive links are annoyingly easy to break.

StephenBrown2 · 2020-02-24T21:25:45Z

docs/docs/Gear Up/edison-explorer-board.md

+
+The Explorer Boards have battery charger circuitry on board, making it easy to use a LiPo battery.
+
+* The example setup uses a [2000mah LiPo battery](http://www.robotshop.com/en/37v-2000mah-5c-lipo-battery.html); also [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/products/2011) or [Adafruit Battery Packs Lithium Ion Battery 3.7v 2000mAh](https://www.amazon.com/Battery-Packs-Lithium-3-7v-2000mAh/dp/B0137ITW46) are similar options. A 2000 mAh LiPo will get you about 12-14 hours of use, assuming you have the standard setup (which is what you get following these docs) running. Many people prefer a higher capacity battery to get a full day from the rig (such as [Adafruit Lithium Ion Polymer Battery - 3.7v 2500mAh (PRODUCT ID: 328) and the Adafruit Lithium Ion Cylindrical Battery - 3.7v 2200mAh (PRODUCT ID: 1781)](https://www.adafruit.com/category/574)). This battery uses a 2mm 2 pin JST connector to match the Explorer boards' power plugs. 


The Amazon link (https://www.amazon.com/Battery-Packs-Lithium-3-7v-2000mAh/dp/B0137ITW46) doesn't exist anymore

Removed this one (I checked on amazon and there isn't an equivalent listing)

StephenBrown2 · 2020-02-24T21:27:26Z

docs/docs/Gear Up/edison-explorer-board.md

+
+The following options are not yet documented for oref0 versions < 0.7.0, and may not work anymore:
+
+If you don't use an Explorer board, you can use a number of radio sticks: a [TI-USB-Sticks](http://www.ti.com/tool/cc1111emk868-915), running [subg_rfspy](https://github.com/ps2/subg_rfspy); [Wireless Things ERF](https://www.wirelessthings.net/erf-0-1-pin-spaced-radio-module); [Wireless Things Slice of Radio](https://www.wirelessthings.net/slice-of-radio-wireless-rf-transciever-for-the-raspberry-pi) a Slice of Radio; or a Rileylink. For details about setup with these other stick and board options, [the best instructions will be found in the mmeowlink wiki](https://github.com/oskarpearson/mmeowlink/wiki) for setting up your board and stick. Note you may also need a CC debugger for these, and also note that it will be more work as the documentation is designed for the Edison/Explorer Board setup as the easiest path forward. 


The wirelessthings.net domain appears to have gone away, and is now parked.

Removed links and noted these aren't currently available, but still list them

StephenBrown2 · 2020-02-24T21:28:55Z

docs/docs/Resources/Deprecated-Pi/Pi-setup.md

@@ -2,7 +2,7 @@

 ## WARNING - THIS DOCUMENT IS DEPRECATED (NOT RECOMMENDED) AND UNMAINTAINED. We suggest you look to the top of the docs for information on the currently recommended hardware setup instead. As of November 2017 there are new and simplified Raspberry Pi setup instructions linked from there. The instructions below should only be used for troubleshooting purposes if the new instructions aren't working.

-Note: There are two setup flows described on this page. The [one toward the bottom of the page is the older setup instructions](http://openaps.readthedocs.io/en/latest/docs/Resources/Deprecated-Pi/Pi-setup.html#older-instructions-for-original-pi-based-setups) that worked back in the day. The [one at the top of the page (all prefaced with "newer path")](http://openaps.readthedocs.io/en/latest/docs/Resources/Deprecated-Pi/Pi-setup.html#newer-path) is an attempt by someone to make the Pi instructions work for Pi3 and Pi0W. There may be issues with BOTH setups, so please do make PRs to this page and/or discuss on Gitter about which setup flow works. 
+Note: There are two setup flows described on this page. The [one toward the bottom of the page is the older setup instructions](<../Resources/Deprecated-Pi/pi-setup#older-instructions-for-original-pi-based-setups>) that worked back in the day. The [one at the top of the page (all prefaced with "newer path")](<../Resources/Deprecated-Pi/pi-setup#newer-path>) is an attempt by someone to make the Pi instructions work for Pi3 and Pi0W. There may be issues with BOTH setups, so please do make PRs to this page and/or discuss on Gitter about which setup flow works. 


The ../Resources/Deprecated-Pi/pi-setup page 404s because it's actually a capital Pi the second time, but these are links on the same page and should be made relative, i.e. <#older-instructions-for-original-pi-based-setups> and <#newer-path>

fixed--and thank you so much for the careful review!! I'm looking through the rest of the broken links now since might as well.

… few that are already noted in the text as not working (e.g. hot button app link) and images in the deprecated pi setup page

StephenBrown2 · 2020-02-26T18:12:20Z

docs/docs/Usage and maintenance/usability-considerations.md

- [How do I switch to a different Medtronic pump?](#how-do-i-switch-to-a-different-medtronic-pump-)
+- [What do you do when you change sites?](#what-do-you-do-when-you-change-sites)
+- [How do I switch to a different Medtronic pump?](#how-do-i-switch-to-a-different-medtronic-pump)
+https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/usability-considerations.html#how-do-i-switch-to-a-different-medtronic-pump


Whoops, looks like remnant of editing got left behind...

Suggested change

https://draft-openaps-reorg.readthedocs.io/en/reapply-cleanup/docs/Usage%20and%20maintenance/usability-considerations.html#how-do-i-switch-to-a-different-medtronic-pump

Ack, I'm sorry! thanks for catching that.

StephenBrown2 · 2020-02-26T18:18:35Z

Looks great to me, but sadly I'm not one of the main approvers. I think it's definitely in a spot where it can be reviewed/approved by @danamlewis or @scottleibrand though, once #1537 (comment) gets resolved.

Kim Scott added 4 commits February 5, 2020 17:54

apply changes from general-cleanup to current master branch

de0ca6f

manually review all commits to master from sep 2019 - present and ens…

21269a4

…ure changes are applied here

review links

159d0a3

finish resolving conflicts and reviewing all changes since September (o…

95e7059

…penaps/docs@af8322e...openaps:master) to ensure they are added

kimberscott mentioned this pull request Feb 22, 2020

Reorganization/cleanup of docs #1494

Closed

kimberscott changed the title ~~Reapply cleanup~~ General reorganization and cleanup - hardware, install steps, flashing, background reading Feb 22, 2020

finish applying changes to sneaky files that did not get saved

0c05e51

StephenBrown2 reviewed Feb 24, 2020

View reviewed changes

Kim Scott added 2 commits February 24, 2020 12:10

Preserve text primarily directing people to Gitter for real-time support

17d69be

de-duplicate Google Group info

b8e8122

StephenBrown2 reviewed Feb 24, 2020

View reviewed changes

Kim Scott added 3 commits February 24, 2020 13:16

fix long error lines that run off the page

0875fca

fix typo to make sure oref0-setup actually shows up in TOC

aea8426

fix quoted tick marks in setup script command; put who should do log …

2818d00

…rotate fix in header

StephenBrown2 suggested changes Feb 24, 2020

View reviewed changes

Kim Scott added 2 commits February 26, 2020 10:12

fix or remove broken links

0b613bf

update or remove most remaining broken links, with the exception of a…

147033e

… few that are already noted in the text as not working (e.g. hot button app link) and images in the deprecated pi setup page

StephenBrown2 reviewed Feb 26, 2020

View reviewed changes

remove url accidentally left in from editing links

e12e3bf

monjur321 approved these changes Mar 22, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

General reorganization and cleanup - hardware, install steps, flashing, background reading #1537

General reorganization and cleanup - hardware, install steps, flashing, background reading #1537

kimberscott commented Feb 22, 2020 •

edited

StephenBrown2 Feb 24, 2020

kimberscott Feb 24, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 24, 2020

StephenBrown2 Feb 24, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 24, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 24, 2020

StephenBrown2 left a comment

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020 •

edited

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 24, 2020

kimberscott Feb 26, 2020

StephenBrown2 Feb 26, 2020

kimberscott Feb 26, 2020

StephenBrown2 commented Feb 26, 2020


		Log in to your rig and run the following command (aka "the setup script"):

		`cd && ~/src/oref0/bin/oref0-setup.sh`


		![Successful pump-loop](../Images/build-your-rig/loop-success.png)

		Reading these should give you an idea for what OpenAPS knows: current BG, changes in BG, information about netIOB (taking into account any temp basals it has set along with any boluses you have done), carbs on board, etc. Plus, it will give you information about the predictions and show you the data points it is using to draw the "purple prediction lines" in Nightscout. It also will tell you what, if anything, is limiting it's ability to give more insulin - e.g. if you have maxIOB at 0, or it is capped by one of the safety settings, etc. This information is a longer version of the information that will show in the "OpenAPS pill" on Nightscout. And - this is where it will tell you what insulin it thinks you need (more/less and how much) and what temporary basal rate (temp basal) it will try to set next to adjust and bring your eventualBG prediction into your target range. ([For more details on how to interpret the OpenAPS math and information, see this page for understanding OpenAPS determine-basal](<../How it works/understand-determine-basal#summary-of-outputs>).)


		## Errors during `openaps report invoke monitor/ns-glucose.json` or `ns-upload.sh`

		If you are getting your BG from Nightscout or you want to upload loop status/results to Nightscout, among other things you'll need to set 2 environment variables: `NIGHTSCOUT_HOST` and `API_SECRET`. This is handled in the setup script. If you do not set and export these variables you will receive errors while running `openaps report invoke monitor/ns-glucose.json` and while executing `ns-upload.sh` script which is most probably part of your `upload-recent-treatments` alias.Make sure your `API_SECRET` is in hashed format. Please see [this page](https://github.com/openaps/oref0#ns-upload-entries) or [this issue](https://github.com/openaps/oref0/issues/397) for details. Additionally, your `NIGHTSCOUT_HOST` should be in a format like `http://yourname.herokuapp.com` (without trailing slash). For the complete visualization guide use [this page](https://github.com/openaps/docs/blob/master/docs/Automate-system/vizualization.md) from the OpenAPS documentation.


		The Explorer Boards have battery charger circuitry on board, making it easy to use a LiPo battery.

		* The example setup uses a [2000mah LiPo battery](http://www.robotshop.com/en/37v-2000mah-5c-lipo-battery.html); also [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/products/2011) or [Adafruit Battery Packs Lithium Ion Battery 3.7v 2000mAh](https://www.amazon.com/Battery-Packs-Lithium-3-7v-2000mAh/dp/B0137ITW46) are similar options. A 2000 mAh LiPo will get you about 12-14 hours of use, assuming you have the standard setup (which is what you get following these docs) running. Many people prefer a higher capacity battery to get a full day from the rig (such as [Adafruit Lithium Ion Polymer Battery - 3.7v 2500mAh (PRODUCT ID: 328) and the Adafruit Lithium Ion Cylindrical Battery - 3.7v 2200mAh (PRODUCT ID: 1781)](https://www.adafruit.com/category/574)). This battery uses a 2mm 2 pin JST connector to match the Explorer boards' power plugs.


		The following options are not yet documented for oref0 versions < 0.7.0, and may not work anymore:

		If you don't use an Explorer board, you can use a number of radio sticks: a [TI-USB-Sticks](http://www.ti.com/tool/cc1111emk868-915), running [subg_rfspy](https://github.com/ps2/subg_rfspy); [Wireless Things ERF](https://www.wirelessthings.net/erf-0-1-pin-spaced-radio-module); [Wireless Things Slice of Radio](https://www.wirelessthings.net/slice-of-radio-wireless-rf-transciever-for-the-raspberry-pi) a Slice of Radio; or a Rileylink. For details about setup with these other stick and board options, [the best instructions will be found in the mmeowlink wiki](https://github.com/oskarpearson/mmeowlink/wiki) for setting up your board and stick. Note you may also need a CC debugger for these, and also note that it will be more work as the documentation is designed for the Edison/Explorer Board setup as the easiest path forward.

General reorganization and cleanup - hardware, install steps, flashing, background reading #1537

Are you sure you want to change the base?

General reorganization and cleanup - hardware, install steps, flashing, background reading #1537

Conversation

kimberscott commented Feb 22, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenBrown2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenBrown2 Feb 24, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenBrown2 commented Feb 26, 2020

kimberscott commented Feb 22, 2020 •

edited

StephenBrown2 Feb 24, 2020 •

edited