Skip to content

Commit 9c66729

Browse files
authored
Merge pull request #1583 from openaps/master
(updating dev branch docs from master)
2 parents 83396bf + 1e27431 commit 9c66729

31 files changed

+419
-199
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Going through steps 1-3 may take about 1-3 hours depending on your internet conn
4343

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

46-
(Note: if this is your first time logging into the rig since running bootstrap script, you will have to change your rig's password on this first login. You will enter the default password first of `edison` and then be prompted to enter your new password twice in a row. If you get an error, it is likely that you forgot to enter `edison` at the first prompt for changing the password.)
46+
(Note: if this is your first time logging into the rig since running bootstrap script, you will have to change your rig's password on this first login. You will enter the default password first of `edison` and then be prompted to enter your new password twice in a row. If you get an error, you likely forgot to enter `edison` at the first prompt for changing the password.)
4747

4848
#### Be prepared to enter the following information into the setup script:
4949

@@ -57,10 +57,10 @@ The screenshot below shows an example of the questions you'll be prompted to rep
5757
* whether you are using an Explorer board
5858
* 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
5959
* if you're using a Carelink, you will NOT be using mmeowlink. After you finish setup you need to check if the line `radio_type = carelink` is present in your `pump.ini` file.
60-
* CGM method: The options are `g4-upload`, `g4-local-only`, `g5`, `mdt`, and `xdrip`.
61-
* Note: OpenAPS also attempts to get BG data from your Nightscout. OpenAPS will always use the most recent BG data regardless of the source. As a consequence, if you use FreeStyle Libre or any other CGM system that gets its data only from Nightscout, you'll be fine choosing any of the options above.
62-
* Note: For Medtronic 640G (CGM) users, it is recommended that you enter 'xdrip' - otherwise the BG values may not be read from your Nightscout. (The reason being, the 'MDT' option applies only for the enlite sensor attached to the actual pump you're looping with)
63-
* Note: G4-upload will allow you to have raw data when the G4 receiver is plugged directly into the rig.
60+
* CGM method: The options are `g4-go`, `g5`, `g5-upload`, `g6`, `g6-upload`, `mdt`, `xdrip`, and `xdrip-js`.
61+
* The various G4/G5/G6 options are for plugging a physical receiver into the rig with USB.
62+
* If you would like the rig to communicate directly with your G5/G6 transmitter over Bluetooth (most likely in place of a receiver, using Alternate Channel mode), choose xdrip-js.
63+
* Do *not* choose MDT unless you are using an Enlite sensor attached to the pump you're looping with. If you use FreeStyle Libre or Medtronic 640G as a CGM, or any other CGM system that gets its data only from Nightscout, you should choose g4-go, g5, or g6. OpenAPS also attempts to get BG data from your Nightscout. OpenAPS will always use the most recent BG data regardless of the source, so if offline looping is unavailable, if will try to pull from NS, and vice versa.
6464
* Nightscout URL and API secret (or NS authentication token, if you use that option)
6565
* BT MAC address of your phone, if you want to pair for BT tethering to personal hotspot (letters should be in all caps)
6666
* Note, you'll still need to do finish the BT tethering as outlined [here](http://openaps.readthedocs.io/en/latest/docs/Customize-Iterate/bluetooth-tethering-edison.html) after setup.

docs/docs/Build Your Rig/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,4 @@ Build your rig
66

77

88
OpenAPS-install
9-
x12-users
109
keeping-up-to-date

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

Lines changed: 5 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,14 @@
11
# Setting up a Raspberry Pi rig
22

3-
Note: there are two key ways to setup a Pi rig. One uses Pi Bakery, the other is a manual method. If your Pi Bakery process does not work, just use [Option B](#option-b).
4-
5-
## Option A - Use Pi Bakery
6-
7-
There are many ways setup Raspian (the operating system...like jubilinux is for Edison board) microSD card to use in your Raspberry Pi. One easy way for a new user is to use PiBakery, a free application you'll download from the internet. (Note that if this is not successful, you can switch to [Option B](#option-b) below).
8-
9-
Download PiBakery [here](http://pibakery.org/download.html). Follow the directions for installing PiBakery on your computer (the directions on their site include screenshots that are helpful). The download is fairly large (2.2GB) so it may take a couple minutes to complete.
10-
11-
Once you open PiBakery installer, you will be presented with a choice of installing Raspian Full or Raspian Lite. Unselect the checkbox for Raspian Full, and keep the installation for Raspian Lite. When the installation is done, you will be asked if you want to move the PiBakery installer to the trash. That is fine to do.
12-
13-
!["install piBakery"](../Images/build-your-rig/pi-raspian-lite.png)
14-
15-
When the install has finished, find and open the PiBakery app from your applications folder on the computer. You may be prompted for your computer's passcode; if so, enter it.
16-
17-
The starting screen for the PiBakery is fairly empty, but we are going to basically use visual boxes to build a puzzle of what we would like to install on our SD card. So start by clicking on the "Startup" selection on left column. Click, drag, and drop the "on first boot" box over to the white area to the right of the window.
18-
19-
!["install piBakery"](../Images/build-your-rig/pi-step1.png)
20-
21-
Next, click on the Network category and drag over the Setup Wifi box to near the On First Boot box.
22-
23-
!["install piBakery"](../Images/build-your-rig/pi-step2.png)
24-
25-
You want to have the boxes link together (if you have audio on, you'll hear a little click noise as the boxes link together). You can drag more wifi network boxes if you already know the wifi networks that you'd like to add already. Don't worry though, you'll have the opportunity to add more later...this is just an important step to get started the first time with at least one network.
26-
27-
!["install piBakery"](../Images/build-your-rig/pi-step3.png)
28-
29-
Note: Raspbian requires a Country Code (such as US, UK, DE, etc) - otherwise wifi will remain disabled on the Pi. This is different than the Edison/Jubilinux setups so be aware! The default country code is GB, because that is where the PiBakery author is from. Most users will need to change this. Wondering what the codes are? You can look up your two letter code [here](https://www.iso.org/obp/ui/#search/code/).
30-
31-
Enter in your network name, password, and country code. Capital and lowercase matter. You can leave the type as WPA/WPA2 unless you specifically know your network uses a different connection type.
32-
33-
You can add as many special "recipe ingredients" as you'd like. Advanced users may find ingredients they are specifically interested in. Shown below is a relatively simple setup that will have good utility (one wifi network and setting the OTG port to serial to make future offline-connections easier).
34-
35-
!["install piBakery"](../Images/build-your-rig/pi-step4.png)
36-
37-
Put your microSD card into a reader for your computer. Once you get your recipe completed in PiBakery, click on the "Write" icon in the upper left of the window. You'll select your SD card's name from the menu that appears and the Operating System will be Raspbian Lite. Click the Start Write button. Click yes to the warning about erasing the content of the card to begin the writing process.
38-
39-
!["install piBakery"](../Images/build-your-rig/pi-step5.png)
40-
41-
Now you will need to [boot up your Pi and connect to it](#boot-up-your-pi-and-connect-to-it).
42-
*****************************
43-
44-
## Option B
45-
463
### Download Raspbian and write it to your microSD card ###
474

48-
Following the [install instructions](https://www.raspberrypi.org/documentation/installation/installing-images/README.md), download Raspbian Lite (you do **not** want Raspbian Desktop) and write it to an microSD card using Etcher.
5+
Following the [install instructions](https://www.raspberrypi.org/documentation/installation/installing-images/README.md), download Raspbian Lite (Legacy) (you do **not** want Raspbian Desktop, and newer non-legacy versions of Raspbian will cause install to fail) and write it to an microSD card using [Raspberry Pi Imager](https://www.raspberrypi.com/documentation/computers/getting-started.html#using-raspberry-pi-imager).
496

507
### Place your wifi and ssh configs on the new microSD card ###
518

52-
Once Etcher has finished writing the image to the microSD card, remove the microSD card from your computer and plug it right back in, so the boot partition shows up in Finder / Explorer.
9+
Once Raspberry Pi Imager has finished writing the image to the microSD card, remove the microSD card from your computer and plug it right back in, so the boot partition shows up in Finder / Explorer. (You may need to restart your computer for the microSD card with the boot drive to show up.)
5310

54-
Create a file named wpa_supplicant.conf on the boot drive, with your wifi network(s) configured. The file must be in a Unix format. If creating the file in Windows, use an editor that allows you to save the file in Unix format instead of DOS format. There are many editors with this ability. `Notepad++` is one that works well. The file should look something like:
11+
Create a file named `wpa_supplicant.conf` on the boot drive, with your wifi network(s) configured. The file must be in a Unix format. If creating the file in Windows, use an editor that allows you to save the file in Unix format instead of DOS format. There are many editors with this ability. `Notepad++` is one that works well. The file should look something like:
5512

5613
```
5714
country=xx
@@ -93,7 +50,7 @@ On Mac, open Terminal and use `ssh [email protected]`
9350

9451
On Windows, use PuTTY and establish an SSH connection, with username `pi`, to hostname `raspberrypi.local`. If you receive a warning that the rig's host key is not yet cached, respond YES to add it.
9552

96-
Troubleshooting: If you have problems connecting, try rebooting your router. If you have multiple channels (2.4Ghz vs 5Ghz), you could try redoing the PiBakery setup with the other channel's network name, if the first one fails.
53+
Troubleshooting: If you have problems connecting, try rebooting your router.
9754

9855
The default password for logging in as `pi` is `raspberry`. The `pi` username and default password is only used for this initial connection: subsequently you'll log in as `root` with a password and rig hostname of your choosing.
9956

@@ -103,7 +60,7 @@ Once you're logged in, run the following commands to start the OpenAPS install p
10360

10461
```
10562
sudo bash
106-
curl -s https://raw.githubusercontent.com/openaps/oref0/master/bin/openaps-install.sh > /tmp/openaps-install.sh && bash /tmp/openaps-install.sh
63+
curl -s https://raw.githubusercontent.com/openaps/oref0/master/bin/openaps-install.sh > /tmp/openaps-install.sh && bash /tmp/openaps-install.sh dev
10764
```
10865

10966
* Change your hostname (a.k.a, your rig's name). **Make sure to write down your hostname; this is how you will log in in the future as `ssh [email protected]`**

docs/docs/Customize-Iterate/autosens.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Wouldn't it be great if the system knew when you were running sensitive or resis
55

66
When you watch your autosens log (shortcut command is `autosens-looplog`) and sensitivity changes is going to be detected, you might see something like this:
77
******************
8+
```
89
Calculating sensitivity using 8h of non-exluded data
910
Setting lastSiteChange to Tue Dec 19 2017 09:42:24 GMT-0600 (CST) using timestamp 2017-12-19T09:42:24-06:00
1011
u(xxxxxxxxxxxx11hxxxxxxxxxxxx12h=43g(xxxxxxxxxxxx13hxxxxxxxxxxxx14h=xxx45gxxxxxxxxx15hxxxxxxxxxxx16h=xxxxxxxx17hxxxxxx0gx)u(xxxxx18h=x35g(xx46gxxxxxxxxx19hxxxxxxx38gxxxxx20h=xxxxxxxxxxxx21hxxxxxx-x-x-x-x-x-x-22h=x-x-x-x-x-xxxxxxx23hxx0gx
@@ -23,6 +24,7 @@ Sensitivity normal.
2324
ISF adjusted from 120 to 120
2425
Using 24h autosens ratio of 1 (ISF 120)
2526
Autosens refreshed: {"ratio":1}
27+
```
2628
******************
2729
Here's what each symbol above means:
2830

0 commit comments

Comments
 (0)