How to update your OpenAPS rig in the future¶
You’ve probably heard about all kinds of cool new features that you want to try. If they’re part of the master branch already, you just need to go enable them (usually by re-running the oref0-setup script).
However, if it’s a brand-new feature that’s being tested or is recently added to master, you’ll need to install the new version of
oref0 first. By the way, if you want to check which version of oref0 you are currently running,
npm list -g oref0 and if you want to check which branch
cd ~/src/oref0 and then
If you want to view the commit records between the version you are running and the new version, run:
git fetchwill update the local git repository. This does not change anything in your working directory
git statuswill tell you which branch your working directory is on and how many commits your working directory is behind
git log origin/master(replace
masterwith the branch you are on) will print the commit descriptions. You only need to review the number of log messages corresponding to the number of commites your working directory is behind.
git diff origin/master..(replace
masterwith the branch you are on) will print the individual file differences between your working copy and the new version.
Step 1 (Master): Install the new version¶
cd ~/src/oref0 && git checkout master && git pull && sudo npm install -g oref0
(If you get a message that you need to commit or stash, use command
Alternative Step 1a (Dev): To get on “dev” branch to test even more recently added new stuff¶
Or, if the feature you want hasn’t been released yet, and you want to test the latest untested development version of
cd ~/src/oref0 && git checkout dev && git pull
npm run global-install
Alternative Step 1b (Test a feature branch): Not recommended for initial setup¶
In case you want to test even more advanced stuff you’ve read about on gitter channels (intend-to-bolus / openaps/oref0 / openaps/autotune) or on official pull request list you should follow the link, read description and in case you’ve decided to try it out, do:
- Checkout the header of pull request. It will contain author name, the branch to be merged to (dev or master) and the feature branch name that you want to test.
cd ~/src/oref0 && git fetch && git checkout <feature-branch-name> && git pull && npm run global-install
- don’t forget to replace
<feature-branch-name>with the actual name of the feature branch you want to test
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 for a guide of what the setup script will be prompting you to enter.
Step 3: Remember to set your preferences!¶
Reminder! You’ll need to re-set your preferences in
preferences.json. See the preferences page to see what preferences might have changed or become available since your last update.
To edit any of your preferences, you can enter
edit-pref (as a shortcut) or
cd ~/myopenaps && nano preferences.json