diff --git a/.gitignore b/.gitignore index 95a36d069..4a31df57b 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ _book *.mobi *.pdf .*.sw[op] +build/ diff --git a/Makefile b/Makefile index cd56958a6..17f835c27 100644 --- a/Makefile +++ b/Makefile @@ -220,6 +220,6 @@ pseudoxml: .PHONY: serve serve: @echo - make clean build html + make clean html (cd $(BUILDDIR)/html/; python -m SimpleHTTPServer 8000 ) diff --git a/docs/conf.py b/docs/conf.py index a21419c34..e718624c7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,6 +40,7 @@ 'sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.todo', + 'sphinx_markdown_tables', # 'alabaster', ] diff --git a/docs/docs/Customize-Iterate/bluetooth-tethering-edison.md b/docs/docs/Customize-Iterate/bluetooth-tethering-edison.md index 9400ae9bf..8948c6bd4 100644 --- a/docs/docs/Customize-Iterate/bluetooth-tethering-edison.md +++ b/docs/docs/Customize-Iterate/bluetooth-tethering-edison.md @@ -32,35 +32,32 @@ Below is an image that shows how a rig automatically switches from a known wifi Certain phones don't work well using bluetooth tethering with OpenAPS. Various users have experimented, and the list below shows those that have been found to work okay, those that don't and those with variable effectiveness. If you have something that is not on the list, please feel free to add it. - -
CellphoneWorks with Bluetooth Tethering?Issues/Experiences with BTUse with xDrip/xDripAPS and Dexcom G5 -
Google Pixel 3XL with Android 9YesSupports tethering to both Wifi and Cellular network. No issues switching. -
Google Pixel 2 with Android 8YesSupports tethering to both Wifi and Cellular network. No issues switching. -
LG Nexus 5X with Android 7YesSupports tethering to both Wifi and Cellular network. No issues switching.Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate. -
Google Pixel with Android 7YesSupports tethering to both Wifi and Cellular network. No issues switching.Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate. -
Sony Xperia Z5 Compact with Android 7YesWorks with tethering for network access. It regularly disconnects from the rig (which doesn't seem to affect data flow) and roughly every 24-36 hours this results in complete loss of connectivity and requires a full reboot of the rig and the phone. Doesn't work well with phone swapping between Wifi and mobile - causes BT dropouts that require a reboot of the rig.No issues running xDrip/xDripAPS alongside the tethered connection. Achieves 90%+ packet collection from Dexcom G5. -
Xiaomi Redmi 4 with MIUI 8 (Android 6)NoTethering can be set up, but it drops regularly requiring rig reboots. When phone switches between Wifi and cellular signal requires rig to be rebooted.Significant packet drops and data becomes almost unusable. -
Xiaomi Redmi Note 4(X) -Snapdragon SoC version!!!YesTethering works in same time with Blukon(Nightrider) and SW3 connected. Also, read Notes for MIUI below*Excellent coverage. -
Xiaomi Redmi 3 with MIUI 6 (Android 5)YesNo issues seen when tethered to cellular network. Doesn't allow tethering to wifi.Works fine with Dexcom G5 - 90% collection rate. -
Xiaomi Mi A1 with AndroidOne (vanilla Android 8.0)YesOpenAPS bluetooth tethering works fine with Blue Car Autotether.Not tested with Dexcom. -
Samsung Galaxy S6 (Android 7)YesTethering to rig and cellular works okay. No data on swapping between cellular and wifi connections.Use with Dexcom G5 and rig not effective. Significant packet loss. -
Samsung Galaxy JuniorYesPhone tethering switching between wifi and mobile not elegant and causes some issuesDifficulties found when using xDrip with the OpenAPS tethering. Packet loss occurs. -
iPhoneYesUsers have experienced various levels of success with the iPhone bluetooth tethering and when the rig switches between wifi and BTNot Applicable. Experimental version of Loop to do something similar doesn't yet have feedback. -
Acer PhoneNoMany data drops on the bluetooth connection for rig. Recommended to avoid.xDrip compatibility is poor - numerous drops throughout the day. -
Samsumg Galaxy S7 Edge (G935F) Android 7.0YesExcellent BT tether using apps 'Bt AutoTether' and 'BT Tether'xDrip+ with G5 > 95% capture. -
Samsung Galaxy A3 (2016) Android 6YesExcellent BT tether using app 'Blue Car Tethering'xDrip+ with G4, reliable capture using xDrip+ and using normal tether when running with Dexcom in G4-upload mode -
Elephone P9000 Android 7YesSeems to work well, switching on/off BT tehethering as expected. Using 'Blue Car Tethering' with rig selected. Tested with phone screen off, works fine. -
Samsung Galaxy A5 (2017) Android 7.0YesExcellent BT tether, intermitent disconnecting when the area is flooded with other bluetooth devices. Use 'BT AutoTether' app along side to maintain connectionxDrip+ with G5, works really well with G5 transmitter directly, no compatibility issues and 95%+ consistent capture rate. -
Samsung Galaxy S8 Android 7.0YesExcellent BT tether, no need for 3rd party app to keep BT teter alive, can be set in settingsxDrip+ with Libre/RFDuino transmitter, 99%+ capture rate, -
Motorolo Moto Z PlayYesExcellent BT tethering; highly reliable using Blue Car Tethering.Not tested (using Enlite sensor). -
Wiko Wim LiteIntermittentWorks most of the time. Note, several issues with this phone: 1) NSClient has a tendency to crash on this phone and 2) Bluetooth tethering works intermittently with Blue Car Autotether and not at all with BT AutoTether. Note that this phone has a tendency to freeze and reboot on its own, so I think the phone itself is the issue.Not tested (using Enlite sensor). -
Xiaomi Mi Mix 2 with LineageOS 15.1YesExcellent connectivity - has worked almost flawlessly with tethering. Battery life has also been very good.Works brilliantly with xDrip+ and G6 - capture rate typically more than 95%. -
Nokia 2.1 with Android 8.1 Oreo Go EditionYesExcellent bluetooth tethering to cellular network. No noted network drops. Works excellent as an offline option with XDripAPS. Awesome battery life(4000mAH)Works well with Dexcom G5 and xDrip. No issues with compatibility. Generally 95%+ capture rate. -
OnePlus 6 (A6003) with OxygenOS 9.0 YesExcellent connectivity - Tethering has been good and picks up right away. Battery life very good and really fast charge.xDrip+ w/ G5 - capture rates generally better than 98% on current nightlies. -
Samsung S10/S10e with Android PieNot on TMobile NativeBoth the S10 and S10e are fully capable of bluetooth pairing and tethering, but unlike Verizon, T-Mobile deprovisions bluetooth tethering for unknown and inexplicable reasons. On all of their phones as far as we know.Verizon and OEM Unlocked phones may work. - -
+| **Cellphone** | Works with Bluetooth Tethering? | Issues/Experiences with BT | Use with xDrip/xDripAPS and Dexcom G5 | +| ------------- | ------------------------------- | -------------------------- | ------------------------------------- | +| **Google Pixel 3XL with Android 9** | Yes | Supports tethering to both Wifi and Cellular network. No issues switching. | +| **Google Pixel 2 with Android 8** | Yes | Supports tethering to both Wifi and Cellular network. No issues switching. | +| **LG Nexus 5X with Android 7** | Yes | Supports tethering to both Wifi and Cellular network. No issues switching. | Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate. | +| **Google Pixel with Android 7** | Yes | Supports tethering to both Wifi and Cellular network. No issues switching. | Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate. | +| **Sony Xperia Z5 Compact with Android 7** | Yes | Works with tethering for network access. It regularly disconnects from the rig (which doesn't seem to affect data flow) and roughly every 24-36 hours this results in complete loss of connectivity and requires a full reboot of the rig and the phone. Doesn't work well with phone swapping between Wifi and mobile - causes BT dropouts that require a reboot of the rig. | No issues running xDrip/xDripAPS alongside the tethered connection. Achieves 90%+ packet collection from Dexcom G5. | +| **Xiaomi Redmi 4 with MIUI 8 (Android 6)** | No | Tethering can be set up, but it drops regularly requiring rig reboots. When phone switches between Wifi and cellular signal requires rig to be rebooted. | Significant packet drops and data becomes almost unusable. | +| **Xiaomi Redmi Note 4(X) -Snapdragon SoC version!!!** | Yes | Tethering works in same time with Blukon(Nightrider) and SW3 connected. Also, read Notes for MIUI below* | Excellent coverage. | +| **Xiaomi Redmi 3 with MIUI 6 (Android 5)** | Yes | No issues seen when tethered to cellular network. Doesn't allow tethering to wifi. | Works fine with Dexcom G5 - 90% collection rate. | +| **Xiaomi Mi A1 with AndroidOne (vanilla Android 8.0)** | Yes | OpenAPS bluetooth tethering works fine with Blue Car Autotether. | Not tested with Dexcom. | +| **Samsung Galaxy S6 (Android 7)** | Yes | Tethering to rig and cellular works okay. No data on swapping between cellular and wifi connections. | Use with Dexcom G5 and rig not effective. Significant packet loss. | +| **Samsung Galaxy Junior** | Yes | Phone tethering switching between wifi and mobile not elegant and causes some issues | Difficulties found when using xDrip with the OpenAPS tethering. Packet loss occurs. | +| **iPhone** | Yes | Users have experienced various levels of success with the iPhone bluetooth tethering and when the rig switches between wifi and BT | Not Applicable. Experimental version of Loop to do something similar doesn't yet have feedback. | +| **Acer Phone** | No | Many data drops on the bluetooth connection for rig. Recommended to avoid. | xDrip compatibility is poor - numerous drops throughout the day. | +| **Samsumg Galaxy S7 Edge (G935F) Android 7.0** | Yes | Excellent BT tether using apps 'Bt AutoTether' and 'BT Tether' | xDrip+ with G5 > 95% capture. | +| **Samsung Galaxy A3 (2016) Android 6** | Yes | Excellent BT tether using app 'Blue Car Tethering' | xDrip+ with G4, reliable capture using xDrip+ and using normal tether when running with Dexcom in G4-upload mode | +| **Elephone P9000 Android 7** | Yes | Seems to work well, switching on/off BT tethering as expected. Using 'Blue Car Tethering' with rig selected. Tested with phone screen off, works fine. | +| **Samsung Galaxy A5 (2017) Android 7.0** | Yes | Excellent BT tether, intermittent disconnecting when the area is flooded with other bluetooth devices. Use 'BT AutoTether' app along side to maintain connection | xDrip+ with G5, works really well with G5 transmitter directly, no compatibility issues and 95%+ consistent capture rate. | +| **Samsung Galaxy S8 Android 7.0** | Yes | Excellent BT tether, no need for 3rd party app to keep BT tether alive, can be set in settings | xDrip+ with Libre/RFDuino transmitter, 99%+ capture rate, | +| **Motorolo Moto Z Play** | Yes | Excellent BT tethering; highly reliable using Blue Car Tethering. | Not tested (using Enlite sensor). | +| **Wiko Wim Lite** | Intermittent | Works most of the time. Note, several issues with this phone: 1) NSClient has a tendency to crash on this phone and 2) Bluetooth tethering works intermittently with Blue Car Autotether and not at all with BT AutoTether. Note that this phone has a tendency to freeze and reboot on its own, so I think the phone itself is the issue. | Not tested (using Enlite sensor). | +| **Xiaomi Mi Mix 2 with LineageOS 15.1** | Yes | Excellent connectivity - has worked almost flawlessly with tethering. Battery life has also been very good. | Works brilliantly with xDrip+ and G6 - capture rate typically more than 95%. | +| **Nokia 2.1 with Android 8.1 Oreo Go Edition** | Yes | Excellent bluetooth tethering to cellular network. No noted network drops. Works excellent as an offline option with XDripAPS. Awesome battery life(4000mAH) | Works well with Dexcom G5 and xDrip. No issues with compatibility. Generally 95%+ capture rate. | +| **OnePlus 6 (A6003) with OxygenOS 9.0** | Yes | Excellent connectivity - Tethering has been good and picks up right away. Battery life very good and really fast charge. | xDrip+ w/ G5 - capture rates generally better than 98% on current nightlies. | +| **Samsung S10/S10e with Android Pie** | Not on TMobile Native | Both the S10 and S10e are fully capable of bluetooth pairing and tethering, but unlike Verizon, T-Mobile deprovisions bluetooth tethering for unknown and inexplicable reasons. On all of their phones as far as we know. | Verizon and OEM Unlocked phones may work. | ********************************************************************************************** *Notes for MIUI users. MIUI kills processes in background to save battery. To get best results: diff --git a/docs/docs/Customize-Iterate/offline-looping-and-monitoring.md b/docs/docs/Customize-Iterate/offline-looping-and-monitoring.md index 90d97c91a..daf09e885 100644 --- a/docs/docs/Customize-Iterate/offline-looping-and-monitoring.md +++ b/docs/docs/Customize-Iterate/offline-looping-and-monitoring.md @@ -88,110 +88,29 @@ The oref0-setup option for `xdrip-js` installs Logger by default. > NOTE: Lookout, Logger (xdrip-js-logger), and xdrip-js library should be considered a WIP (Work In Progress), i.e., do not use if you cannot watch your BG and loop very carefully, and tolerate issues, failures, idiosynchrosies. Also please plan on contributing either through testing and feedback, updates, documentation, etc. A summary of their features: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FeatureLookoutLogger
Still unfinished, i.e., a work-in-progress?YesYes
Rig continues updating BG and looping while offline using xdripAPS?YesYes
Offline (network) mode supports backfill to Nightscout?YesYes
Offline (away from transmitter times) supports backfill?YesYes
Uses Dexcom official calibration?YesYes
Can use with expired/battery replaced transmitter?YesYes
Can interact with rig-hosted web page? (e.g., for calibration, start/stop sensor)YesNo, can use rig cmd line while offline
Also able to calibrate and start/stop sensor thru receiver?YesYes, for non-expired transmitter/session
Calibrate through Web/Nightscout?Yes (local rig Web UI)Yes
Calibrate through pump-connected meter (e.g., Contour Next Link)?NoYes
Calibrate from command line?YesYes
Linear Squared Regression CalibrationYes, for > 7 day extensionYes
Single Point Linear CalibrationYes, for > 7 day extensionYes
Calculate and send Noise with entriesYesYes
Calculate glucose trendingYesYes
Start Stop SensorYes via UIYes via NS/cmd line
Reset Expired TransmitterYes via UIYes via cmd line
Support mmolYesYes, in NS and for Meter-Pump Calibration
View transmitter battery/resistance levelsYes via NS CGM pillYes
- + +| Feature | Lookout | Logger | +| ------- | ------- | ------ | +| Still unfinished, i.e., a work-in-progress? | Yes | Yes | +| Rig continues updating BG and looping while offline using xdripAPS? | Yes | Yes | +| Offline (network) mode supports backfill to Nightscout? | Yes | Yes | +| Offline (away from transmitter times) supports backfill? | Yes | Yes | +| Uses Dexcom official calibration? | Yes | Yes | +| Can use with expired/battery replaced transmitter? | Yes | Yes | +| Can interact with rig-hosted web page? (e.g., for calibration, start/stop sensor) | Yes | No, can use rig cmd line while offline | +| Also able to calibrate and start/stop sensor thru receiver? | Yes | Yes, for non-expired transmitter/session | +| Calibrate through Web/Nightscout? | Yes (local rig Web UI) | Yes | +| Calibrate through pump-connected meter (e.g., Contour Next Link)? | No | Yes | +| Calibrate from command line? | Yes | Yes | +| Linear Squared Regression Calibration | Yes, for > 7 day extension | Yes | +| Single Point Linear Calibration | Yes, for > 7 day extension | Yes | +| Calculate and send Noise with entries | Yes | Yes | +| Calculate glucose trending | Yes | Yes | +| Start Stop Sensor | Yes via UI | Yes via NS/cmd line | +| Reset Expired Transmitter | Yes via UI | Yes via cmd line | +| Support mmol | Yes | Yes, in NS and for Meter-Pump Calibration | +| View transmitter battery/resistance levels | Yes via NS CGM pill | Yes | + * Lookout and Logger (xdrip-js-logger) are documented separately: * Lookout: [https://github.com/xdrip-js/Lookout/blob/dev/README.md](https://github.com/xdrip-js/Lookout/blob/dev/README.md) * Logger: [https://github.com/xdrip-js/Logger/blob/dev/README.md](https://github.com/xdrip-js/Logger/blob/dev/README.md) diff --git a/docs/docs/Gear Up/edison.md b/docs/docs/Gear Up/edison.md index d1bf3ff9e..c27013675 100644 --- a/docs/docs/Gear Up/edison.md +++ b/docs/docs/Gear Up/edison.md @@ -106,11 +106,11 @@ Solder it to the board. It's the hole near the "o" from Radio. Make sure to not This is your connection scheme for the RPi to RFM69HCW. Stick the RFM69HCW on a bread board, and connect: -Board | Connect | Connect | Connect | Connect | Connect | Connect | Connect | Connect -------|------|------|------|------|------|------|------|------ -RPi | 3.3V | GND | MOSI | MISO | SCLK | | CE1_N || -RPi PIN | 17 | 25 | 19 | 21 | 23 | 15 | 26 | 22 -RFM69HCW | VIN or 3.3V | GND | MOSI | MISO | SCK or CLK | G0 or DIO0 | CS or NSS | RST or RESET +| Board | Connect | Connect | Connect | Connect | Connect | Connect | Connect | Connect | +| ----- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | +| RPi | 3.3V | GND | MOSI | MISO | SCLK | | CE1_N | | +| RPi PIN | 17 | 25 | 19 | 21 | 23 | 15 | 26 | 22 | +| RFM69HCW | VIN or 3.3V | GND | MOSI | MISO | SCK or CLK | G0 or DIO0 | CS or NSS | RST or RESET | ![Picture of RPI0WH with FM69HCW connection diagram](../Images/build-your-rig/rpii2RFM69HCW.JPG) diff --git a/docs/docs/Resources/switching-between-DIY-systems.md b/docs/docs/Resources/switching-between-DIY-systems.md index b050764e3..566ad3689 100644 --- a/docs/docs/Resources/switching-between-DIY-systems.md +++ b/docs/docs/Resources/switching-between-DIY-systems.md @@ -16,31 +16,11 @@ If you’re coming to try OpenAPS from a Loop system, there’s going to be some ### Main Hardware Differences: - - - - - - - - - - - - - - - - - - - - - - - - -
Built usingBrains sitCommunications reside
LoopxCode on an Apple computeron your iPhoneon the Rileylink
OpenAPSany computeron the “rig” (can be multiple kinds of rigs)on the rig (usually with a built-in radio stick)
+| System | Built using | Brains sit | Communications reside | +| ------ | ----------- | ---------- | --------------------- | +| Loop | xCode on an Apple computer | on your iPhone | on the Rileylink | +| OpenAPS | any computer | on the "rig" (can be multiple kinds of rigs) | on the rig (usually with a built-in radio stick) | + **Loop** is built using XCode app on an Apple computer. The brains of the system sit on your iPhone. The communications reside in the RileyLink, acting as a communicator between the iPhone and pump. diff --git a/docs/docs/While You Wait For Gear/example-max-safety-chart.md b/docs/docs/While You Wait For Gear/example-max-safety-chart.md deleted file mode 100644 index 3e6e92150..000000000 --- a/docs/docs/While You Wait For Gear/example-max-safety-chart.md +++ /dev/null @@ -1,12 +0,0 @@ -(This chart is what the image in the preferences page is. This renders in MarkDown but not ReadTheDocs, so leaving a copy here in case we want to modify in future. ) - - ->| | Example 1 | Example 2 | Example 3 | Example 4 | ->|------------------------------------------------------------|---------------|--------------|--------------|--------------| ->| user's max basal safety setting (in pump) | 2 .0 | 2.0 | 3.0 | 2.5 | ->|`max_daily_safety_multiplier` | 3 | 3 | 3 | 3 | ->|`current_basal_safety_multiplier` | 4 | 4 | 4 | 4 | ->| user's current basal rate | 1.0 | 0.4 | 1.2 | 0.7 | ->|user's highest programmed basal rate | 1.5 | 1.0 | 1.2 | 0.8 | ->|OpenAPS recommended temp basal rate | 3.0 | 1.8 | 2.4 | 2.6 | ->|Actual temp basal rate allowed | 2.0 | 1.6 | 2.4 | 2.4 | diff --git a/docs/docs/While You Wait For Gear/examples_safety_caps_in_play.png b/docs/docs/While You Wait For Gear/examples_safety_caps_in_play.png deleted file mode 100644 index 2d9f5902c..000000000 Binary files a/docs/docs/While You Wait For Gear/examples_safety_caps_in_play.png and /dev/null differ diff --git a/docs/docs/While You Wait For Gear/nightscout-setup.md b/docs/docs/While You Wait For Gear/nightscout-setup.md index 9464509b7..aa46fccfb 100644 --- a/docs/docs/While You Wait For Gear/nightscout-setup.md +++ b/docs/docs/While You Wait For Gear/nightscout-setup.md @@ -51,80 +51,24 @@ your data, customized watchfaces with your OpenAPS data, and integration with IF Click here to expand the list of the `Config Variables` you need to enter:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KEYVALUE
API_SECRETCreate your own API_SECRET. This is like the password to your NS site. Please write it down somewhere safe or commit it to memory, you will be using it in the future. It needs to be at least 12 characters long and should NOT use the `@` or `&` symbols.
AUTH_DEFAULT_ROLESWhen `readable`, anyone can view Nightscout without a token. Setting it to `denied` will require authentication. Setting it to `denied` requires oref 0.5.0-dev.
DISPLAY_UNITSenter either mg/dl or mmol
ENABLEbridge openaps pump iob basal careportal sage cage maker

(Enter all of the words without commas. Just a single space between each word. Make sure autocorrect does not add space between careportal.
**Notice we are not including cob here.**
If you are use Lookout or Logger, add xdrip-js to enable the CGM status pill
If you have other plugins that you would like to enable, please add them here.)
DISABLELeave blank
ALARM_TYPESsimple
BG_HIGHEnter the numeric value of BG you’d like as an urgent high alarm. (Note: For users outside the US, this needs to be set in mgdl. Take your desired mmol number and multiply it by 18).
BG_TARGET_TOPEnter the numeric value of the top of your target BG.(Note: For users outside the US, this needs to be set in mgdl. Take your desired mmol number and multiply it by 18).
BG_TARGET_BOTTOMEnter the numeric value of the bottom of your target BG.(Note: For users outside the US, this needs to be set in mgdl. Take your desired mmol number and multiply it by 18).
BG_LOWEnter the numeric value of the BG you’d like as an urgent low alarm.(Note: For users outside the US, this needs to be set in mgdl. Take your desired mmol number and multiply it by 18).
PUSHOVER linesCan be left blank for now. If you decide to use Pushover later, you can come back and add your info to these lines.
CUSTOM_TITLEThis will be the text displayed in the upper left part of the NS website.
THEMEchange from default to colors
BRIDGE_USER_NAMEEnter your Dexcom Share Account login name. This should be the same account name used in the Share2 or G5 Mobile app.
BRIDGE_PASSWORDEnter your Dexcom Share Account password.
BRIDGE_MAX_COUNTDefault value is 1. Setting this to 7 will update the last 35 minutes of data.
+| KEY | VALUE | +| --- | ----- | +| **API_SECRET** | Create your own API_SECRET. This is like the password to your NS site. Please write it down somewhere safe or commit it to memory, you will be using it in the future. It needs to be at least 12 characters long and should NOT use the `@` or `&` symbols. | +| **AUTH_DEFAULT_ROLES** | When `readable`, anyone can view Nightscout without a token. Setting it to `denied` will require authentication. Setting it to `denied` requires oref 0.5.0-dev. | +| **DISPLAY_UNITS** | Units will be mg/dL by default. If you want mmol/L, enter `mmol` or `mmol/L` here. | +| **ENABLE** | `bridge openaps pump iob basal careportal sage cage maker`

(Enter all of the words without commas. Just a single space between each word. Make sure autocorrect does not add space between `careportal`.
**Notice we are not including `cob` here.**
If you are use Lookout or Logger, add `xdrip-js` to enable the CGM status pill.
If you have other plugins that you would like to enable, please add them here.) | +| **DISABLE** | Leave blank | +| **ALARM_TYPES** | `simple` | +| **BG_HIGH** | Enter the numeric value of BG you'd like as an urgent high alarm.
(Note: For users outside the US, this needs to be set in mg/dL. Take your desired mmol number and multiply it by 18). | +| **BG_TARGET_TOP** | Enter the numeric value of the top of your target BG.
(Note: For users outside the US, this needs to be set in mg/dL. Take your desired mmol number and multiply it by 18). | +| **BG_TARGET_BOTTOM** | Enter the numeric value of the bottom of your target BG.
(Note: For users outside the US, this needs to be set in mg/dL. Take your desired mmol number and multiply it by 18). | +| **BG_LOW** | Enter the numeric value of the BG you’d like as an urgent low alarm.
(Note: For users outside the US, this needs to be set in mg/dL. Take your desired mmol number and multiply it by 18). | +| **PUSHOVER_\*** lines | Can be left blank for now. If you decide to use Pushover later, you can come back and add your info to these lines. | +| **CUSTOM_TITLE** | This will be the text displayed in the upper left part of the NS website. | +| **THEME** | Change from `default` to `colors` | +| **BRIDGE_USER_NAME** | Enter your Dexcom Share Account login name. This should be the same account name used in the Share2 or G5 Mobile app. | +| **BRIDGE_PASSWORD** | Enter your Dexcom Share Account password. | +| **BRIDGE_MAX_COUNT** | Default value is 1. Setting this to 7 will update the last 35 minutes of data. |
@@ -160,72 +104,22 @@ You do not have to enter all the information in the profile if you are using Ope ![Add vars](../Images/nightscout/add_vars.jpg) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KEYVALUE
DEVICESTATUS_ADVANCEDtrue
PUMP_FIELDSbattery reservoir clock status
PUMP_RETRO_FIELDSbattery reservoir clock status
SHOW_FORECASTopenaps
SHOW_PLUGINSopenaps pump iob sage cage careportal
PUMP_ENABLE_ALERTStrue
PUMP_URGENT_BATT_V1.3

(This is the pump battery voltage that will trigger a red, urgent alert in NS.)
PUMP_URGENT_RES10

(This is the reservoir volume that will trigger a red, urgent alert in NS.)
PUMP_URGENT_CLOCK30
OPENAPS_ENABLE_ALERTStrue
OPENAPS_FIELDSstatus-symbol status-label iob meal-assist rssi
OPENAPS_RETRO_FIELDSstatus-symbol status-label iob meal-assist rssi
OPENAPS_WARN20

(This is the minutes since OpenAPS last successfully looped. This will be a yellow alert in NS.)
OPENAPS_URGENT60

(Same as the alert above, but will be red in color and have a shorter snooze option.)
+| KEY | VALUE | +| --- | ----- | +| **DEVICESTATUS_ADVANCED** | `true` | +| **SHOW_FORECAST** | `openaps` | +| **SHOW_PLUGINS** | `openaps pump iob sage cage careportal` | +| **PUMP_ENABLE_ALERTS** | `true` | +| **PUMP_FIELDS** | `battery reservoir clock status` | +| **PUMP_RETRO_FIELDS** | `battery reservoir clock status` | +| **PUMP_URGENT_BATT_V** | `1.3`

(This is the pump battery voltage that will trigger a red, urgent alert in NS.) | +| **PUMP_URGENT_CLOCK** | `30` | +| **PUMP_URGENT_RES** | `10`

(This is the reservoir volume that will trigger a red, urgent alert in NS.) | +| **OPENAPS_ENABLE_ALERTS** | `true` | +| **OPENAPS_FIELDS** | `status-symbol status-label iob meal-assist rssi` | +| **OPENAPS_RETRO_FIELDS** | `status-symbol status-label iob meal-assist rssi` | +| **OPENAPS_WARN** | `20`

(This is the minutes since OpenAPS last successfully looped. This will be a yellow alert in NS.) | +| **OPENAPS_URGENT** | `60`

(Same as the alert above, but will be red in color and have a shorter snooze option.) | If you are using the Nightscout Bridge to bring in CGM data from Dexcom servers (G4 Share2 app or G5 Mobile app) and are outside the US, you will need to add a setting for `BRIDGE_SERVER` and set the value to `EU`. diff --git a/docs/docs/While You Wait For Gear/preferences-and-safety-settings.md b/docs/docs/While You Wait For Gear/preferences-and-safety-settings.md index 5fcbfc9cd..afd67ef28 100644 --- a/docs/docs/While You Wait For Gear/preferences-and-safety-settings.md +++ b/docs/docs/While You Wait For Gear/preferences-and-safety-settings.md @@ -138,7 +138,15 @@ You can also view this message in the Nightscout OpenAPS pill (which pops up a d #### A few examples: -![Example safety cap image - see raw file in the same folder of docs if needs editing](examples_safety_caps_in_play.png) +| | Example 1 | Example 2 | Example 3 | Example 4 | +| --- | --------- | --------- | --------- | --------- | +| user's max basal safety setting (in pump) | 2.0 | 2.0 | 3.0 | 2.5 | +| `max_daily_safety_multiplier` | 3 | 3 | 3 | 3 | +| `current_basal_safety_multiplier` | 4 | 4 | 4 | 4 | +| user's current basal rate | 1.0 | 0.4 | 1.2 | 0.7 | +| user's highest programmed basal rate | 1.5 | 1.0 | 1.2 | 0.8 | +| OpenAPS recommended temp basal rate | 3.0 | 1.8 | 2.4 | 2.6 | +| Actual temp basal rate allowed | 2.0 | 1.6 | 2.4 | 2.4 | * In **Example 1**, the user's max basal safety setting is the constraining limit on the OpenAPS recommended temp basal rate. * In **Example 2**, 4x the user's current basal rate is the constraining limit on the OpenAPS recommended temp basal rate. diff --git a/requirements.txt b/requirements.txt index 96cb917bd..0c9b4cd3e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ recommonmark==0.4.0 sphinx==1.5.6 +sphinx-markdown-tables==0.0.12 git+git://github.com/bewest/decoding-carelink.git@dev openaps