Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert HTML tables to Markdown tables #1532

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Convert HTML tables to Markdown tables #1532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e678a27
Convert HTML tables to Markdown tables
StephenBrown2 Feb 4, 2020
f46aa4f
Fix RPi pinout table
StephenBrown2 Feb 5, 2020
c56a098
Fix example safety caps table
StephenBrown2 Feb 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ _book
*.mobi
*.pdf
.*.sw[op]
build/
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,6 @@ pseudoxml:
.PHONY: serve
serve:
@echo
make clean build html
make clean html
(cd $(BUILDDIR)/html/; python -m SimpleHTTPServer 8000 )

1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
'sphinx.ext.ifconfig',
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx_markdown_tables',
# 'alabaster',
]

Expand Down
55 changes: 26 additions & 29 deletions docs/docs/Customize-Iterate/bluetooth-tethering-edison.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<TABLE border="1"
summary="This table gives details about various cellphones used with BT Tethering with OpenAPS rigs">
<TR><TH>Cellphone<TH>Works with Bluetooth Tethering?<TH>Issues/Experiences with BT<TH>Use with xDrip/xDripAPS and Dexcom G5
<TR><TH>Google Pixel 3XL with Android 9<TD>Yes<TD>Supports tethering to both Wifi and Cellular network. No issues switching.<TD>
<TR><TH>Google Pixel 2 with Android 8<TD>Yes<TD>Supports tethering to both Wifi and Cellular network. No issues switching.<TD>
<TR><TH>LG Nexus 5X with Android 7<TD>Yes<TD>Supports tethering to both Wifi and Cellular network. No issues switching.<TD>Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate.
<TR><TH>Google Pixel with Android 7<TD>Yes<TD>Supports tethering to both Wifi and Cellular network. No issues switching.<TD>Works well with Dexcom G5 and xDrip. No issues with compatibility. 90%+ capture rate.
<TR><TH>Sony Xperia Z5 Compact with Android 7<TD>Yes<TD>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.<TD>No issues running xDrip/xDripAPS alongside the tethered connection. Achieves 90%+ packet collection from Dexcom G5.
<TR><TH>Xiaomi Redmi 4 with MIUI 8 (Android 6)<TD>No<TD>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.<TD>Significant packet drops and data becomes almost unusable.
<TR><TH>Xiaomi Redmi Note 4(X) -Snapdragon SoC version!!!<TD>Yes<TD>Tethering works in same time with Blukon(Nightrider) and SW3 connected. Also, read Notes for MIUI below*<TD>Excellent coverage.
<TR><TH>Xiaomi Redmi 3 with MIUI 6 (Android 5)<TD>Yes<TD>No issues seen when tethered to cellular network. Doesn't allow tethering to wifi.<TD>Works fine with Dexcom G5 - 90% collection rate.
<TR><TH>Xiaomi Mi A1 with AndroidOne (vanilla Android 8.0)<TD>Yes<TD>OpenAPS bluetooth tethering works fine with Blue Car Autotether.<TD>Not tested with Dexcom.
<TR><TH>Samsung Galaxy S6 (Android 7)<TD>Yes<TD>Tethering to rig and cellular works okay. No data on swapping between cellular and wifi connections.<TD>Use with Dexcom G5 and rig not effective. Significant packet loss.
<TR><TH>Samsung Galaxy Junior<TD>Yes<TD>Phone tethering switching between wifi and mobile not elegant and causes some issues<TD>Difficulties found when using xDrip with the OpenAPS tethering. Packet loss occurs.
<TR><TH>iPhone<TD>Yes<TD>Users have experienced various levels of success with the iPhone bluetooth tethering and when the rig switches between wifi and BT<TD>Not Applicable. Experimental version of Loop to do something similar doesn't yet have feedback.
<TR><TH>Acer Phone<TD>No<TD>Many data drops on the bluetooth connection for rig. Recommended to avoid.<TD>xDrip compatibility is poor - numerous drops throughout the day.
<TR><TH>Samsumg Galaxy S7 Edge (G935F) Android 7.0<TD>Yes<TD>Excellent BT tether using apps 'Bt AutoTether' and 'BT Tether'<TD>xDrip+ with G5 > 95% capture.
<TR><TH>Samsung Galaxy A3 (2016) Android 6<TD>Yes<TD>Excellent BT tether using app 'Blue Car Tethering'<TD>xDrip+ with G4, reliable capture using xDrip+ and using normal tether when running with Dexcom in G4-upload mode
<TR><TH>Elephone P9000 Android 7<TD>Yes<TD>Seems to work well, switching on/off BT tehethering as expected. Using 'Blue Car Tethering' with rig selected. Tested with phone screen off, works fine.<TD>
<TR><TH>Samsung Galaxy A5 (2017) Android 7.0<TD>Yes<TD>Excellent BT tether, intermitent disconnecting when the area is flooded with other bluetooth devices. Use 'BT AutoTether' app along side to maintain connection<TD>xDrip+ with G5, works really well with G5 transmitter directly, no compatibility issues and 95%+ consistent capture rate.
<TR><TH>Samsung Galaxy S8 Android 7.0<TD>Yes<TD>Excellent BT tether, no need for 3rd party app to keep BT teter alive, can be set in settings<TD>xDrip+ with Libre/RFDuino transmitter, 99%+ capture rate,
<TR><TH>Motorolo Moto Z Play<TD>Yes<TD>Excellent BT tethering; highly reliable using Blue Car Tethering.<TD>Not tested (using Enlite sensor).
<TR><TH>Wiko Wim Lite<TD>Intermittent<TD>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.<TD>Not tested (using Enlite sensor).
<TR><TH>Xiaomi Mi Mix 2 with LineageOS 15.1<TD>Yes<TD>Excellent connectivity - has worked almost flawlessly with tethering. Battery life has also been very good.<TD>Works brilliantly with xDrip+ and G6 - capture rate typically more than 95%.
<TR><TH>Nokia 2.1 with Android 8.1 Oreo Go Edition<TD>Yes<TD>Excellent bluetooth tethering to cellular network. No noted network drops. Works excellent as an offline option with XDripAPS. Awesome battery life(4000mAH)<TD>Works well with Dexcom G5 and xDrip. No issues with compatibility. Generally 95%+ capture rate.
<TR><TH>OnePlus 6 (A6003) with OxygenOS 9.0 <TD>Yes<TD>Excellent connectivity - Tethering has been good and picks up right away. Battery life very good and really fast charge.<TD>xDrip+ w/ G5 - capture rates generally better than 98% on current nightlies.
<TR><TH>Samsung S10/S10e with Android Pie<TD>Not on TMobile Native<TD>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.<TD>Verizon and OEM Unlocked phones may work.

</TABLE>
| **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:
Expand Down
127 changes: 23 additions & 104 deletions docs/docs/Customize-Iterate/offline-looping-and-monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<table>
<tr>
<th>Feature</th>
<th>Lookout</th>
<th>Logger</th>
</tr>
<tr>
<td>Still unfinished, i.e., a work-in-progress?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Rig continues updating BG and looping while offline using xdripAPS?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Offline (network) mode supports backfill to Nightscout?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Offline (away from transmitter times) supports backfill?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Uses Dexcom official calibration?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Can use with expired/battery replaced transmitter?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Can interact with rig-hosted web page? (e.g., for calibration, start/stop sensor)</td>
<td>Yes</td>
<td>No, can use rig cmd line while offline</td>
</tr>
<tr>
<td>Also able to calibrate and start/stop sensor thru receiver?</td>
<td>Yes</td>
<td>Yes, for non-expired transmitter/session</td>
</tr>
<tr>
<td>Calibrate through Web/Nightscout?</td>
<td>Yes (local rig Web UI)</td>
<td>Yes</td>
</tr>
<tr>
<td>Calibrate through pump-connected meter (e.g., Contour Next Link)?</td>
<td>No</td>
<td>Yes</td>
</tr>
<tr>
<td>Calibrate from command line?</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Linear Squared Regression Calibration</td>
<td>Yes, for > 7 day extension</td>
<td>Yes</td>
</tr>
<tr>
<td>Single Point Linear Calibration</td>
<td>Yes, for > 7 day extension</td>
<td>Yes</td>
</tr>
<tr>
<td>Calculate and send Noise with entries</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Calculate glucose trending</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Start Stop Sensor</td>
<td>Yes via UI</td>
<td>Yes via NS/cmd line</td>
</tr>
<tr>
<td>Reset Expired Transmitter</td>
<td>Yes via UI</td>
<td>Yes via cmd line</td>
</tr>
<tr>
<td>Support mmol</td>
<td>Yes</td>
<td>Yes, in NS and for Meter-Pump Calibration</td>
</tr>
<tr>
<td>View transmitter battery/resistance levels</td>
<td>Yes via NS CGM pill</td>
<td>Yes</td>
</tr>
</table>


| 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)
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/Gear Up/edison.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
30 changes: 5 additions & 25 deletions docs/docs/Resources/switching-between-DIY-systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,11 @@ If you’re coming to try OpenAPS from a Loop system, there’s going to be some

### Main Hardware Differences:

<table>
<thead>
<tr>
<th></th>
<th>Built using</th>
<th>Brains sit</th>
<th>Communications reside</th>
</tr>
</thead>
<tbody>
<tr>
<th>Loop<sup></th>
<td>xCode on an Apple computer</td>
<td>on your iPhone</td>
<td>on the Rileylink</td>
</tr>
<tr>
<th>OpenAPS</th>
<td>any computer</td>
<td>on the “rig” (can be multiple kinds of rigs)</td>
<td>on the rig (usually with a built-in radio stick)</td>
</tr>

</tbody>
</table>
| 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.

Expand Down
Loading