Skip to content

Commit

Permalink
get all links working
Browse files Browse the repository at this point in the history
  • Loading branch information
Kim Scott committed Aug 30, 2019
1 parent cb833f3 commit 6491d1a
Show file tree
Hide file tree
Showing 41 changed files with 161 additions and 198 deletions.
12 changes: 10 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,13 @@
'sphinx.ext.autodoc',
'sphinx.ext.todo',
# 'alabaster',
'sphinx.ext.autosectionlabel', # Auto-generate section labels.
]

# Prefix document path to section labels, otherwise autogenerated labels would look like 'heading'
# rather than 'path/to/file:heading'
autosectionlabel_prefix_document = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down Expand Up @@ -145,6 +150,8 @@
'titles_only': False
}



# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# html_theme_path = [alabaster.get_path( )]
Expand Down Expand Up @@ -403,11 +410,12 @@
#epub_use_index = True

github_doc_root = 'https://github.com/openaps/docs/tree/master/'
hosted_root = 'http://localhost:8000/'
hosted_root = os.environ.get('HOSTEDROOT', 'http://localhost:8000/') # Allow setting custom root in local .env file
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
rtd_version = os.environ.get('READTHEDOCS_VERSION')
hosted_root = 'https://openaps.readthedocs.org/en/%s/' % rtd_version
rtd_domain = draft-openaps-reorg # TEMPORARY to keep links working on RTD preview. os.environ.get('RTDDOMAIN', 'openaps')
hosted_root = 'https://%s.readthedocs.org/en/%s/' % rtd_domain, rtd_version
def setup(app):
app.add_config_value('recommonmark_config', {
# 'url_resolver': lambda url: github_doc_root + url,
Expand Down
6 changes: 5 additions & 1 deletion docs/docs/Build Your Rig/logging-into-rig-serial.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,8 @@ Note: If you are using a Macbook with a USB-C Hub you may encounter some issues
- Now you will see a login prompt for the edison on the console screen.
- Don't resize your console window: it will likely mess up your terminal's line wrapping. (Once you get wifi working and connect with SSH you can resize safely.)

If you have a problem getting to the Edison login prompt, and possibly get a warning like "can't find a PTY", exit your console window. Then unplug the usb cables from your computer (not from the Edison... leave those ones as is) and swap the USB ports they were plugged into. Then try the above directions again. Usually just changing the USB ports for the cables will fix that "can't find a PTY" error.
If you have a problem getting to the Edison login prompt, and possibly get a warning like "can't find a PTY", exit your console window. Then unplug the usb cables from your computer (not from the Edison... leave those ones as is) and swap the USB ports they were plugged into. Then try the above directions again. Usually just changing the USB ports for the cables will fix that "can't find a PTY" error.

### Not sure of your password?

You should have changed your rig's root password during setup; if not, please [go back and do so now](../Build Your Rig/step-1-flashing). The default password is most likely "edison" without quotes, but check the slip of paper that might have come with your pre-flashed Edison.
2 changes: 1 addition & 1 deletion docs/docs/Build Your Rig/step-1-flashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The above instructions are based on [these instructions](https://software.intel.
## 3. Connecting cables to the Explorer Board and starting console

Now we move to the rig. You'll need to connect two cables from the rig to your computer.
Follow the [console login directions](<../Build Your Rig/logging-into-rig-serial:Accessing your online rig via SSH>) to get set up.
Follow the [console login directions](<../Build Your Rig/logging-into-rig-serial>) to get set up.

Once you get to the login prompt, log in using the username "root" (all lowercase) and no password. This will have us ready to reboot from the command line when we are ready. This is your "console window" - keep it open.

Expand Down
26 changes: 13 additions & 13 deletions docs/docs/Build Your Rig/step-2-wifi-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The directions for this step depend on which type of rig you are using:

### Prep Computer and Login to rig

To get your first wifi connection set up and install OpenAPS, you'll need to log in to the rig via the console. Follow the [console login directions](../Build Your Rig/logging-into-rig-serial) to get a console window open, then the rest of the instructions below.
To get your first wifi connection set up and install OpenAPS, you'll need to log in to the rig via the console. Follow the [console login directions](<../Build Your Rig/logging-into-rig-serial>) to get a console window open, then the rest of the instructions below.

### Bootstrap script

Expand Down Expand Up @@ -75,9 +75,9 @@ Now that step 2 is done, the bootstrap script will then continue to run awhile l

![End of Bootstrap script](../Images/Edison/bootstrap-end.png)

At the completion, you will be prompted to press `enter` if you want to continue the setup script (oref0-setup). If you don't have time to run the setup script (a fresh install of setup script can take about an hour to run), then you can cancel and come back to it later. Regardless of your answer, you should now return to [the Setup Script section](http://openaps.readthedocs.io/en/latest/docs/Build%20Your%20Rig/OpenAPS-install.html#run-oref0-setup) for finishing step 4.
At the completion, you will be prompted to press `enter` if you want to continue the setup script (oref0-setup). If you don't have time to run the setup script (a fresh install of setup script can take about an hour to run), then you can cancel and come back to it later. Regardless of your answer, you should now return to [the Setup Script section](<../Build Your Rig/step-3-setup-script>) for finishing step 3.

Now that you have a wifi connection to your rig, you have the option of [logging into it using SSH](../While%20You%20Wait%20For%20Gear/monitoring-OpenAPS#accessing-your-online-rig-via-ssh) from a computer on the same network, rather than using a cable.
Now that you have a wifi connection to your rig, you have the option of [logging into it using SSH](<../While You Wait For Gear/monitoring-OpenAPS#accessing-your-online-rig-via-ssh>) from a computer on the same network, rather than using a cable.

### Manual instructions for Intel Edison

Expand Down Expand Up @@ -152,7 +152,7 @@ network={
}
```

The networks you enter here are the wifi networks that your rig will be able to use to stay connected to internet. After getting your initial wireless connection set up, you can return to [the instructions for adding additional wireless connections ](http://openaps.readthedocs.io/en/latest/docs/Customize%20Iterate/on-the-go-wifi-adding.html) to add more options to your rig at any point.
The networks you enter here are the wifi networks that your rig will be able to use to stay connected to internet. After getting your initial wireless connection set up, you can return to [the instructions for adding additional wireless connections ](<../Customize-Iterate/on-the-go-wifi-adding>) to add more options to your rig at any point.

![Wifi edit screen](../Images/Edison/Wifi_add.png)

Expand Down Expand Up @@ -206,7 +206,7 @@ And these three (the first two will be fast, the last line will take you to a sc
dpkg-reconfigure tzdata # Set local time-zone
Use arrow button to choose zone then arrow to the right to make cursor highlight <OK> then hit ENTER

![Time zone examples](../../Images/Edison/Time_zone.png)
![Time zone examples](../Images/Edison/Time_zone.png)

Enter `vi /etc/logrotate.conf`, press “i” for INSERT mode, and make the following changes:

Expand All @@ -219,7 +219,7 @@ Press ESC and then type “:wq” to save and quit

If you're *not* using the Explorer board and want to run everything as `edison` instead of `root`, log out and log back in as edison (with the password you just set above). (If you're using an Explorer board you'll need to stay logged in as root and run everything that follows as root for libmraa to work right.)

If you have an ssh key and want to be able to log into your Edison without a password, copy your ssh key to the Edison ([directions you can adapt are here](http://openaps.readthedocs.io/en/latest/docs/Resources/Deprecated-Pi/Pi-setup.html#mac-and-linux)). For Windows/Putty users, you can use these instructions: [https://www.howtoforge.com/ssh_key_based_logins_putty](https://www.howtoforge.com/ssh_key_based_logins_putty).
If you have an ssh key and want to be able to log into your Edison without a password, copy your ssh key to the Edison ([directions you can adapt are here](<../Resources/Deprecated-Pi/Pi-setup#mac-and-linux>)). For Windows/Putty users, you can use these instructions: [https://www.howtoforge.com/ssh_key_based_logins_putty](https://www.howtoforge.com/ssh_key_based_logins_putty).

If you're *not* using the Explorer board, are running as the `edison` users, and want to be able to run sudo without typing a password, run:
```
Expand All @@ -235,11 +235,11 @@ and add to the end of the file:

## Raspberry Pi instructions

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).
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>).

### Option A - Use Pi Bakery

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).
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).

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.

Expand Down Expand Up @@ -344,11 +344,11 @@ Answer all the setup questions. A successful setup script will finish asking yo
**Troubleshooting**: If your rig gets stuck at the point shown below, simply login to the rig again and run the setup script one more time. Usually, running the setup script a second time will clear that glitch.
!["install piBakery"](../Images/build-your-rig/pi-setup-stuck.png)

Once your setup script finishes, **make sure to [watch the pump loop logs](http://openaps.readthedocs.io/en/latest/docs/Build%20Your%20Rig/OpenAPS-install.html#step-5-watch-your-pump-loop-log)**
Once your setup script finishes, **make sure to [watch the pump loop logs](<../Build Your Rig/step-4-watching-log>)**

**NOTE**: If you are using RFM69HCW as RF module:

If you have connected your RFM69HCW module as described in [Soldering RFM69HCW](https://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#soldering), while running interactive setup use following options:
If you have connected your RFM69HCW module as described in [Soldering RFM69HCW](<../Gear Up/pi-based-rigs#soldering>), while running interactive setup use following options:
```Are you using an Explorer Board? [Y]/n n
Are you using an Explorer HAT? [Y]/n n
Are you using mmeowlink (i.e. with a TI stick)? If not, press enter. If so, paste your full port address: it looks like "/dev/ttySOMETHING" without the quotes.
Expand Down Expand Up @@ -448,8 +448,8 @@ You'll be prompted to set a password. You'll want to change it to something per

The script will then continue to run awhile longer (~10+ minutes) before asking you to press `enter` to run oref0-setup.

Return to the [OpenAPS Install page](http://openaps.readthedocs.io/en/latest/docs/Build%20Your%20Rig/OpenAPS-install.html#step-3-setup-script) to complete oref0-setup.
Return to the [setup script page](<../Build Your Rig/step-3-setup-script>) to complete oref0-setup.

**If you are installing to a Pi with a legacy radio (Ti-stick, SliceOfRadio, etc.) - Press enter. [Jump to finishing the installation](#finish-installation)**
**If you are installing to a Pi with a legacy radio (Ti-stick, SliceOfRadio, etc.) - Press enter. [Jump to finishing the installation](<#finish-installation>)**

**If you are installing to a newer Pi with a HAT as radio: Do not press enter! [Continue on to Pi-Hat instructions.](#switch-to-dev-branch-for-your-pi-hat).**
**If you are installing to a newer Pi with a HAT as radio: Do not press enter! [Continue on to Pi-Hat instructions.](<#switch-to-dev-branch-for-your-pi-hat>).**
2 changes: 1 addition & 1 deletion docs/docs/Build Your Rig/step-3-setup-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The screenshot below shows an example of the questions you'll be prompted to rep
* Note: G4-upload will allow you to have raw data when the G4 receiver is plugged directly into the rig.
* Nightscout URL and API secret (or NS authentication token, if you use that option)
* BT MAC address of your phone, if you want to pair for BT tethering to personal hotspot (letters should be in all caps)
* 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.
* Note, you'll still need to do finish the BT tethering as outlined [here](<../Customize-Iterate/bluetooth-tethering-edison>) after setup.
* Your desired max-iob
* whether you want Autosensitivity and/or Autotune enabled
* whether you want any carbs-required Pushover notifications (and if you do, you'll need your Pushover API token and User Key)
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/Build Your Rig/step-4-watching-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ Finally, you should eventually see colorful indications of successful looping, w

![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 - i.e. 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](http://openaps.readthedocs.io/en/latest/docs/While%20You%20Wait%20For%20Gear/Understand-determine-basal.html#summary-of-outputs).)
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 - i.e. 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](<../While You Wait For Gear/understand-determine-basal#summary-of-outputs>).)

If after 20 minutes, you still have some errors showing instead of the above successful looping information, it may be time to head over to the [Troubleshooting oref0-setup tips page](http://openaps.readthedocs.io/en/latest/docs/Troubleshooting/oref0-setup-troubleshooting.html) for ideas on your error messages and how to resolve them. IF you aren't able to resolve your errors, please make sure that you have captured the error messages before heading over to Gitter or Facebook to get help. Troubleshooting is far more successful when you come prepared with the error messages.
If after 20 minutes, you still have some errors showing instead of the above successful looping information, it may be time to head over to the [Troubleshooting oref0-setup tips page](<../Troubleshooting/oref0-setup-troubleshooting>) for ideas on your error messages and how to resolve them. IF you aren't able to resolve your errors, please make sure that you have captured the error messages before heading over to Gitter or Facebook to get help. Troubleshooting is far more successful when you come prepared with the error messages.

**Done watching the logs? Type control-C to exit the pump-loop log.**

Expand Down

0 comments on commit 6491d1a

Please sign in to comment.