Skip to content

Commit

Permalink
starting organization of install steps (just committing & pushing to …
Browse files Browse the repository at this point in the history
…transfer to home comp)
  • Loading branch information
Kim Scott committed Aug 9, 2019
1 parent baa4f97 commit ec30c64
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 28 deletions.
26 changes: 9 additions & 17 deletions docs/docs/Build Your Rig/OpenAPS-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,11 @@

Getting your rig with OpenAPS takes generally six steps:

1. Jubilinux installation (called "flashing" the Edison - Pi users can skip to step 2)
2. Getting first wifi network connection
3. Installing "dependencies" (helper code that make all the OpenAPS code function)
4. Installing your OpenAPS loop
5. Watching Pump-loop Log
6. Finish your setup

* The **first step** may already be done for you if you purchased a pre-flashed Edison board.
* The **second and third steps** are accomplished through what is called the "bootstrap" script.
* The **fourth step** is accomplished through what is called the "setup script".
* The **fifth step** is an important, required step. You need to be familiar with how to read and access your logs.
* The **sixth step** is all the polishing steps to your OpenAPS setup. Things like optimizing your settings, preferences, BT-tethering, IFTTT, etc.

1. **Jubilinux installation** (called "flashing" the Edison - Pi users can skip to step 2). This may already be done for you if you purchased a pre-flashed Edison board.
2. **Getting first wifi network connection and installing "dependencies"** (helper code that make all the OpenAPS code function). This is done using what is called the "bootstrap" script.
3. **Installing your OpenAPS loop**. This is done using what is called the "setup" script.
4. **Watching the Pump-loop Log**. This is an important, required step. You need to be familiar with how to read and access your logs.
5. **Finish your setup**: all the polishing steps to your OpenAPS setup. Things like optimizing your settings, preferences, BT-tethering, IFTTT, etc.

### Some conventions used in these docs:

Expand All @@ -32,7 +24,7 @@ If you purchased a pre-flashed Edison, you can also skip on down to [step 2](htt

If you need to flash your Edison, the directions are slightly different depending on the computer you are using. Please see the [Mac-specific flashing page](http://openaps.readthedocs.io/en/latest/docs/Resources/Edison-Flashing/mac-flash.html) or the [Windows-specific flashing page](http://openaps.readthedocs.io/en/latest/docs/Resources/Edison-Flashing/PC-flash.html) for detailed info on how to flash jubilinux. There is also a more general flashing page [here](http://openaps.readthedocs.io/en/latest/docs/Resources/Edison-Flashing/all-computers-flash.html) that has some good [troubleshooting tips](http://openaps.readthedocs.io/en/latest/docs/Resources/Edison-Flashing/all-computers-flash.html#troubleshooting) at the end of the page, if you flashing stalls out.

### Steps 2-3: Wifi and Dependencies
### Step 2: Wifi and Dependencies

Steps 2-3 are covered in the page links below, dependent on which type of rig you are using.

Expand All @@ -42,7 +34,7 @@ Steps 2-3 are covered in the page links below, dependent on which type of rig yo

Going through steps 1-3 may take about 1-3 hours depending on your internet connection, whether the edison was pre-flashed, and comfort level with the instructions. At the end of the bootstrap script (step 3), you will be asked if you want to continue on with the set-up script (step 4). If you need to take a break and come back to step 4 later, you can answer "no" to continuing on and come back later...picking up at the directions below for running the setup script.

### Step 4: Setup script
### Step 3: Setup script

* **If you pressed `enter` to continuing on with the setup script at the end of the bootstrap script**, you do **NOT** need to specifically enter the command in the box below. By pressing `enter` to continuing on with setup script, the command was automatically started for you.

Expand Down Expand Up @@ -109,7 +101,7 @@ Make sure that at the end of the setup script, your log rotate file is set to `d

**************************

## Step 5: Watch your Pump-Loop Log
## Step 4: Watch your Pump-Loop Log

THIS IS A REQUIRED MUST-LEARN HOW-TO STEP - DO NOT MOVE ON WITHOUT DOING THIS! This is a key skill for monitoring your OpenAPS setup to "check" or "monitor" or "watch" the logs.

Expand Down Expand Up @@ -259,7 +251,7 @@ These logs and other files are things you may frequently access. There are short
```
To use these shortcuts, just type in the phrase you see on the left - i.e. `edit-wifi` and hit enter.

## Step 6: Finish your OpenAPS setup
## Step 5: Finish your OpenAPS setup

You're looping? Congrats! However, you're not done quite done yet.

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/Gear Up/edison.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

You have two main options for hardware:

`1.` The most recommended rig has been an Edison + Explorer Board. Unfortunately Intel stopped making the Edison boards as of 2018. If you can find an Intel Edison (eBay, local stores, etc - this is still very possible), this is still a highly recommmended rig. It is the smallest rig (and easily portable), with better battery life because it is power efficient. [See below for the list of hardware for Edison setups](http://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#hardware-information-for-intel-edison-based-setups).
1. The most recommended rig has been an Edison + Explorer Board. Unfortunately Intel stopped making the Edison boards as of 2018. If you can find an Intel Edison (eBay, local stores, etc - this is still very possible), this is still a highly recommmended rig. It is the smallest rig (and easily portable), with better battery life because it is power efficient. [See below for the list of hardware for Edison setups](http://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#intel-edison-based-setups).

`2.` The other option is a Raspberry Pi-based setup, with the new Explorer HAT. This rig setup makes it easier to see information when offline because it has an onboard screen for displaying readouts. [See below for the list of hardware required for Pi/HAT setups](http://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#hardware-information-for-pi-based-setups-with-the-explorer-hat).
2. The other option is a Raspberry Pi-based setup, with the new Explorer HAT. This rig setup makes it easier to see information when offline because it has an onboard screen for displaying readouts. [See below for the list of hardware required for Pi/HAT setups](http://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#pi-based-setups-with-the-explorer-hat).

**Note** - there is an experimental alternative to an Explorer HAT, which can serve as the radio on a Pi-based rig, but will not have the screen, and requires you to solder. See [below](https://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#hardware-information-for-pi-based-setups-with-rfm69hcw-experimental) for more details on a setup with RFM69HCW.
**Note** - there is an experimental alternative to an Explorer HAT, which can serve as the radio on a Pi-based rig, but will not have the screen, and requires you to solder. See [below](https://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#pi-based-setups-with-rfm69hcw-experimental) for more details on a setup with RFM69HCW.

****

## Hardware information for Pi-based setups with the Explorer HAT
## Pi-based setups with the Explorer HAT

Summary of what you need for a Pi/HAT rig:
* [Explorer HAT](http://openaps.readthedocs.io/en/latest/docs/Gear%20Up/edison.html#hat)
Expand Down Expand Up @@ -41,7 +41,7 @@ Because we are still optimizing the software to be as power-efficient as possibl

***

## Hardware information for Pi-based setups with RFM69HCW (experimental)
## Pi-based setups with RFM69HCW (experimental)

The Pi + RFM69HCW is still experimental!

Expand Down Expand Up @@ -115,7 +115,7 @@ After that, you're ready to install OpenAPS.

***

## Hardware information for Intel Edison-based setups
## Intel Edison-based setups

The high level parts list (see below for more details, and links):

Expand Down Expand Up @@ -214,6 +214,6 @@ Cases for Edison plus G4 receiver:

* [jimrandomh's 3D printed design for Edison and a G4 receiver together](http://conceptspacecartography.com/my-openaps-g4-case/)

### Other non-case protection options
Other non-case protection options

* [Heat Shrink Tubing](https://www.amazon.com/gp/product/B009IILEVY)
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ When you build an OpenAPS rig, you run through the setup described in this docum
* configure it to talk to YOUR devices and have your information and safety settings on it (based on your preferences)

The open source software is designed to make it easy for the computer to do the work you used to do to calculate what needs to be done. It runs a series of reports to collect data from all the devices and places. Then it prepares the data and runs the calculations. Then it attempts to communicate and send any necessary adjustments to your pump. Then it reads the data back, and does it over and over again. You can see what it's doing in the logs of the rig, or by viewing the information on your watch or on Nightscout.


1 change: 0 additions & 1 deletion docs/docs/Understanding OpenAPS-Overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Contents:

.. toctree::
:maxdepth: 2
:glob:
:hidden:

How OpenAPS works <how-openaps-works-overview>
Expand Down
4 changes: 1 addition & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ Welcome to OpenAPS's documentation!

This documentation supports a self-driven Do-It-Yourself (DIY) implementation of an artificial pancreas based on the OpenAPS reference design. By proceeding to use these tools or any piece within, you agree to `the copyright <https://github.com/openaps/docs/blob/master/license.txt>`_ for more information; and `the full README here <https://github.com/openaps/docs/blob/master/README.md>`_ and release any contributors from liability, and assume full responsibility for all of your actions and outcomes related to usage of these tools or ideas.



.. note::
**A Note on DIY and the "Open" Part of OpenAPS**

Expand Down Expand Up @@ -32,7 +30,7 @@ This documentation supports a self-driven Do-It-Yourself (DIY) implementation of

While You Wait For Gear <docs/While You Wait For Gear/index>

Build your rig <docs/Build Your Rig/index>
Installing OpenAPS on your rig <docs/Build Your Rig/index>

Customize-Iterate <docs/Customize-Iterate/index>

Expand Down

0 comments on commit ec30c64

Please sign in to comment.