From c9d99434b935e1e69bdac1114e8d4d20a7cbdc01 Mon Sep 17 00:00:00 2001 From: peterleimbach Date: Sat, 9 Dec 2023 18:08:47 +0100 Subject: [PATCH] restructuring of markdown files --- .../change-configuration.md | 17 + .../configuring-the-AAPS-loop.md | 504 +++++++++++++++++- docs/EN/Installing-AndroidAPS/setup-wizard.md | 10 + docs/EN/index.md | 4 +- 4 files changed, 532 insertions(+), 3 deletions(-) create mode 100644 docs/EN/Installing-AndroidAPS/change-configuration.md diff --git a/docs/EN/Installing-AndroidAPS/change-configuration.md b/docs/EN/Installing-AndroidAPS/change-configuration.md new file mode 100644 index 000000000000..cf5a6dbeeaca --- /dev/null +++ b/docs/EN/Installing-AndroidAPS/change-configuration.md @@ -0,0 +1,17 @@ +# change configuration + +After you completed the setup wizard you don't need to run it again if you want to change only parts of the configuration. + +There exists three options too change the configuration + +1. config builder, +1. three dot menu on the right and select "preferences" and +1. three dot menu on the right and select "plugin preferences". + +Here we explain which option to use best for which use case. + +## config builder + +## preferences + +## plugin preferences \ No newline at end of file diff --git a/docs/EN/Installing-AndroidAPS/configuring-the-AAPS-loop.md b/docs/EN/Installing-AndroidAPS/configuring-the-AAPS-loop.md index 253bc927e13b..5f6062c297f9 100644 --- a/docs/EN/Installing-AndroidAPS/configuring-the-AAPS-loop.md +++ b/docs/EN/Installing-AndroidAPS/configuring-the-AAPS-loop.md @@ -12,6 +12,508 @@ Even writers of the documentation themselves had to setup AAPS and decided to jo ## setup wizard +### Welcome message + +![image](../images/setup-wizard/Screenshot_20231202_125636.png) + +### license agreement +This is just the welcome message which you can skip with the "NEXT" button. + +![image](../images/setup-wizard/Screenshot_20231202_125650.png) + +In the end user license agreement you find important information about the legacl aspects of using AAPS. + +Please read it carefully. + +If you don't understand or can't agree to the end user license agreement please don't use AAPS at all! + +If you understand and agree please click the "I UNDERSTAND AND AGREE" button and follow the setup wizard. + +### required permissions + +![image](../images/setup-wizard/Screenshot_20231202_125709.png) + +AAPS needs some requirements to operate correctly. + +In the following screens you are asked several question you have to agree to get AAPS working. The wizard itself explains why he asks for the relevant setting. + +We try here to give some more background information, translate more technical speak into common language or explain the reason. + +Please click the "NEXT" button. + +![image](../images/setup-wizard/Screenshot_20231202_125721.png) + +Battery consumption on cell phones is still a sensitive issue, as the performance of the batteries is still quite limited. Therefore, Android is quite restrictive about the circumstances under which it allows applications to run and consume CPU time and therefore battery power. + +However, since AAPS needs to run regularly, e.g. to receive the blood sugar every few minutes, to apply the algorithm with which it decides how to deal with it on your behalf based on your specifications, it must be allowed to do so by Android. + +You do this by confirming the setting. + +Please click the "ASK FOR PERMISSION" button. + +![image](../images/setup-wizard/Screenshot_20231202_125750.png) + +Please select "AlloW". + +![image](../images/setup-wizard/Screenshot_20231202_125813.png) + +Android requires special permission for apps if they want to send you notifications. + +While it is a good feature to disable notifications e.g. by social media apps it is essential that you allow AAPS to send you notifications, + +Please click the "ASK FOR PERMISSION" button. + +![image](../images/setup-wizard/Screenshot_20231202_125833.png) + +Please select the "AAPS" app. + +![image](../images/setup-wizard/Screenshot_20231202_125843.png) + +Please enable "Allow display over other apps" by sliding the slider to the right. + +![image](../images/setup-wizard/Screenshot_20231202_125851.png) + +The slider should look this way if it is enabled. + +![image](../images/setup-wizard/Screenshot_20231202_125924.png) + +Android binds the usage of blutetooth communication on the ability to use location services. Perhaps you have seen it by others apps too. It's a common task you have to do if you want to access bluetooth. + +AAPS uses bluetooth to communicatte in general with your CGMS and pump if it is directly controlled by AAPS and not another app which is used by AAPS. Details may differ from setup to setup. + +Please click the "ASK FOR PERMISSION" button. + +![image](../images/setup-wizard/Screenshot_20231202_125939.png) + +This is important. Otherwise AASP can not work properly at all. + +Please click "While using the app". + +![image](../images/setup-wizard/Screenshot_20231202_130002.png) + +Please click the "NEXT" button. + +![image](../images/setup-wizard/Screenshot_20231202_130012.png) + +AAPS needs to write logging information to the permanent storage of you smartphone. Permanent storage means that it will be available even after rebooting your mobile. Other information is just lost as it was not saved to permanent storage. + +Please click the "ASK FOR PERMISSION" button. + +![image](../images/setup-wizard/Screenshot_20231202_130022.png) + +Please click "Allow". + +![image](../images/setup-wizard/Screenshot_20231202_130031.png) + +You are getting informed that you have to reboot your smartphone after this change to take effect. + +Please don't stop the setup wizard now. You can do it after finishing the setup wizard. + +Please click "OK" and then the "NEXT" button. + +### master password + +![image](../images/setup-wizard/Screenshot_20231202_130122.png) + +As the configuration of AAPS contains some sensitive data (e.g. API_KEY for accessing the application programming interface of your nightscout server) it is encrypted by a password you can set here. + +The second sentence is very important. Please make a backup copy of it e.g. on Google Drive. Google Drive is a good place as it is backuped by Google for you. Your smartphone or pc can crash and may be you have no actual copy. + +After filling in the password twice please click the "NEXT" button. + +### fabric upload + +![image](../images/setup-wizard/Screenshot_20231202_130136.png) + +Here you can setup the usage of an automated crash and usage reporting service. + +It's not mandatory but good practice to use it. + +It helps the developer to better understand your usage of the app and informs them about crashes which are happen. + +They get +1. the information that the app crashed where they otherwise don't get the information because in their own environment all works fine and +1. in the send data (crash information) their is information about under which circumstances the crash happened and what kind of configuration is used. + +Though it's really helpful. + +Please enable the "Fabric Uload" by sliding the slider to the right. + +![image](../images/setup-wizard/Screenshot_20231202_130147.png) + +Furthermore you can identify yourself that just in case the developers want to reach out to you for questions or urgent concerns. + +![image](../images/setup-wizard/Screenshot_20231202_135748.png) + +After filling in your "contact information" click the "OK" button. Contact information can be your identification on Facebook, on Discord, ... Just the information you think is helpful to contact you best. + +![image](../images/setup-wizard/Screenshot_20231202_135807.png) + +Please click the "NEXT" button. + +### units (mg/dl <-> mmol/dL + +![image](../images/setup-wizard/Screenshot_20231202_135830.png) + +Please select if your blood sugar values are in mg/dl or mmol/L and then please click the "NEXT" button. + +![image](../images/setup-wizard/Screenshot_20231202_135853.png) + +### display settings + + Here you select the range for the blood sugar diagram between values are shown as in range. You can leave it in the begining at the standard and adapt later. + +It is here only for the graphical persentation of the diagram and nothing else. + +Your blood sugar target e.g. is configured in your profile. + +Your range to analyze TIR (time in range) is configured in your reporting server. + +Please press the "NEXT" button. + +### synchronization with the reporting server and more + +![image](../images/setup-wizard/Screenshot_20231202_140916.png) + +Here you are configuring the data upload to the reporting server. + +You could do other configurations here too but for the first run that's all you should do. + +If you are not able to do it at the moment skip it please. It will not work but you can configure it later. + +If you select an item here on the left, you can enable on the right the visibility in the upper menu on the AAPS home screen. In the begining please select the visibility too if you configure your reporting server here. + +In this case we select Nightscout as reporting server and will configure it. + +For Tidepool it is even simpler as you only need your personal login information. + +Please press the "NEXT" button. + +![image](../images/setup-wizard/Screenshot_20231202_140952.png) + +Here you are configuring the Nightscout reporting server. + +Please click on "Nightscout URL". + +![image](../images/setup-wizard/Screenshot_20231202_141051.png) + +Enter you Nightscout URL which is your personal nightscout server. It's just an URL you setup yourself or you got from your service provider for nightscout. + +Please click the "OK" button. + +![image](../images/setup-wizard/Screenshot_20231202_141131.png) + + +Enter your nightscout access token. This is the access token for your nightscout server you configured. Without this token the access will not work. + +If you don't have got it at the moment please check the documentation for setting up the reporting server in the AAPS documenation. + +After filling in the "NS access token" please click on the "Synchronization" button. + +![image](../images/setup-wizard/Screenshot_20231202_141219.png) + +Please select "Upload data to NS" if you already configured nightscout in the steps of the setup wizard before. + +If you have stored profiles on nightscout and want to download them to AAPS enable "Receive profile store". + +Go back to the screen beore and select "Alarm option". + +![image](../images/setup-wizard/Screenshot_20231202_141310.png) + +At the moment let the switches disabled. We only walked to the screen to make you familar with possible options you might configure in the future. + +At the moment there is no need to do it. + +Go back to the screen beore and select "Connection settings". + +![image](../images/setup-wizard/Screenshot_20231202_141326.png) + +Here you can configure how to transfer your data to the reporting server. + +Caregivers must enable "use cellular connection" as otherwise the smartphone which serves the cared person can not upload data outside of the WiFi range e.g. at the way to school. + +Others can disable the tranfer via cellular connection if they want to save data rate or battery. + +If in doubt just leave all enabled. + +Go back to the screen before and select "Advanced Settings". + +![image](../images/setup-wizard/Screenshot_20231202_141351.png) + +Enable "Log app start to NS" is you want get information about this in the reporting server. + +It might be interesting to see if AAPS is correctly configured but later it is not really important. + +Enable "Create announcements from errors" and "Create announcements from carbs required alerts". + +Let "Slow down uploads" disabled. You only use it if for some untypical reasons a lot of information is to be transfered to the nightscout server and the nightscout server is slow in processing this data. + +Go back to the screen before and select "NEXT" to go to the next screen. + +### patient name + +![image](../images/setup-wizard/Screenshot_20231202_141445.png) + +Here you can setup your name in AAPS. + +It can be anything. It's just for differantiation. + +To keep it simple just enter prename and lastname. + +Press "NEXT" to go to the next screen. + +### patient type + +![image](../images/setup-wizard/Screenshot_20231202_141817.png) + +Here you select your "Patient type" which is important as in the software are different limits defined depending on the age of the patient. This is important for security reason. + +Further you configure the maximum allowed bolus for a meal. That means how much is the greatest blous you need to take to cover your typical meals? It's a security feature that you are not accidently overdose your selve when you are bolusing for meal. + +the second limit is similar but now for the max carb intake you expect. + +Press "NEXT" to go to the next screen. + +### used insulin + +![image](../images/setup-wizard/Screenshot_20231202_141840.png) + +Select the type of insulin you take. + +The names on the screen should be self-explaing. + +:::{admonition} don't use the Free-Peak Oref unless you know what you do +:class: danger +For advanced users or medical studies there is the possibility to define with Free-Preak Ored your own profil how insulin acts. Please don't use it. +::: + +Press "NEXT" to go to the next screen. + +### blood sugar source + +![image](../images/setup-wizard/Screenshot_20231202_141912.png) + +Select the BG source you are using. + +As there are several options available we don't explain the configuration for all of them here. We are using Dexcom G6 with the BYODA app in our example here. + +Please look in the documentation of AAPS for your BG source. + +Press "NEXT" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_141925.png) + +If you are using Dexcom G6 with BYODA too enable the visibility in the top level menu by clicking the checkbox on the right side. + +Press "NEXT" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_141958.png) + +If you are using Dexcom G6 with BYODA too click on the gearwheel to access the settings for BYODA. + +Enable the "Upload BG data to NS" and "Log sensor change to NS". + +Press "NEXT" to go to the next screen. + +### profile + +![image](../images/setup-wizard/Screenshot_20231202_142027.png) + +Now we are entering a very sensitive part of the setup wizard. + +Please read the documentation about profiles before you try to enter your profile on the following screen. + +:::{admonition} working profile required - no excetions here ! +:class: danger +Your profile is necessary to control AAPSs action. + +It's required that you determined and discussed your profile with your doctor and that it has been proven to work by HbA1c measurement and successful basal rate testing! + +You have no chance to be successfully with AAPS either. + +If a robot has got a wrong setup of control set he will fail - consistenly. +::: + +Press "NEXT" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_142143.png) + +Enter a "profile name". + +You can have several profiles if needed. We only create one hear. + +:::{admonition} profile only for documentation purpose - not for your useage +:class: information +The used profile here is only to show you how to enter data. + +It is not a general good profile or something very well. + +Don't use it! +::: + +Enter your (!) DIA in hours. + +Press "IC". + +![image](../images/setup-wizard/Screenshot_20231202_142903.png) + +Enter your IC values. + +Press "ISF". + +![image](../images/setup-wizard/Screenshot_20231202_143009.png) + +Enter your ISF values. + +Press "BAS". + +![image](../images/setup-wizard/Screenshot_20231202_143623.png) + +Enter your basal values. + +Press "TARG". + +![image](../images/setup-wizard/Screenshot_20231202_143709.png) + +Enter your blood sugar target values. + +For open looping it can be a wider range as otherwise AAPS notifies you permanently to change the temporary basal rate or another setting which can be exhausting. + +Later (!) for closed looping you will have in general only one value for top and bottom. That makes it AAPS easier to hit the target and you to have better diabetes control overall. + +Confirm the target. + +![image](../images/setup-wizard/Screenshot_20231202_143724.png) + +Save the profile by clicking on "SAVE". + +After saving a new buttom "Activate Profile" occurs. + + +:::{admonition} several defined but only one active profile +:class: information +You can have several profiles been defined but only one activated profile. +::: + +![image](../images/setup-wizard/Screenshot_20231202_143741.png) + +Press "Activate Profile". + +![image](../images/setup-wizard/Screenshot_20231202_143808.png) + +The profile switch dialog appears. In this case let it as preset. + +:::{admonition} several defined but only one active profile +:class: information +You will learn later how to use this general dialog to handle situations like illness or sport where you need to change your profile suitable for the circumstances. +::: + +Press "OK". + +![image](../images/setup-wizard/Screenshot_20231202_143822.png) + +A confirmation dialog for the profile switch appears. + +You can confirm it with pressing "OK". + +![image](../images/setup-wizard/Screenshot_20231202_143833.png) + +Press "NEXT" to go to the next screen. + +### insulin pump + +![image](../images/setup-wizard/Screenshot_20231202_143909.png) + +Now you are selecting your insulin pump. + +You get an important warning dialog. Please read it and press "OK". + +If your have alread setup your profile in the steps before and you know how to connect your pump as you already read the documentation about this feel free to connect it now. It will not harm if you followed the instruction in the setup wizard until here. + +Otherwise leave the setup wizard with the arrow in the top left corner and let AAPS first show you only some blood glucose values. You can come back anytime or use one of the direct configuration options (not using the wizard). + +Press "NEXT" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_143935.png) + +In this case I select "Virtual Pump". + +Press "NEXT" to go to the next screen. + +### APS algortihm + +![image](../images/setup-wizard/Screenshot_20231202_144014.png) + +Let the standard OpenAPS SMB algorithm seleced. + +:::{admonition} only use the older algorithm AMA if you know what you are doing +:class: information +OpenAPS AMA is an older algorithm which has not supported micro bolus to correct high values. Only use it if you know what you are doing e.g. an experienced OpenAPS user who migrated to AAPS. +::: + +Press "NEXT" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_144025.png) + +Only read the text and change nothing here. + +Through the limitations which are imposed by the objectives you can't use neither closed loop nor SMB features at the moment anyway. + +:::{admonition} several defined but only one active profile +:class: information +Please be patient and trust us that patience will pay off for you. It's a proven experience of thousands of users who are successful looping with AAPS. +::: + +Press "NEXT" to go to the next screen. + +### APS mode + +![image](../images/setup-wizard/Screenshot_20231202_144049.png) + +Let "Open Loog" selected. + +Press "NEXT" to go to the next screen. + +### sensitivity detection + +![image](../images/setup-wizard/Screenshot_20231202_144101.png) + +Let "Sensitivity Oref1" the standard for the sensitivty plugins selected. + +Press "NEXT" to go to the next screen. + +### start objective 1 + +![image](../images/setup-wizard/Screenshot_20231202_144113.png) + +You are entering now the Objectives. The qulification for access to further features. + +Here we start Objective 1 even if know that at the moment our setup is not ready to successfully complete this objective. + +But this is the start. + +Press "START" to to start objective 1. + +![image](../images/setup-wizard/Screenshot_20231202_144135.png) + +You see that you already made some improvements but other areas are to be done. + +Press "FINISH" to go to the next screen. + +![image](../images/setup-wizard/Screenshot_20231202_144156.png) + +You are coming to the home screen of AAPS. + +Here you find the information message in AAPS that you set your profile. + +This was done when we switchted to our new profile. + +You can click "SNOOZE" and it will disappear. + +Please read further in the secion ["Completing the objectives"](../Usage/completing-the-objectives.md). + +### setup wizard + Please follow the documentation for the setup wizard [here](./setup-wizard). (Smoothing-Blood-Glucose-Data-in-xDrip-smoothing-blood-glucose-data)= @@ -29,7 +531,7 @@ When using [BYODA](DexcomG6-if-using-g6-with-build-your-own-dexcom-app) your BG #### xDrip+ with Dexcom G6 or Dexcom ONE Noise-level data and smooth BG readings are only shared with AAPS if you use xDrip+ [native mode](https://navid200.github.io/xDrip/docs/Native-Algorithm). Using native mode, there are no restrictions in using SMBs. -#### Dexcom G6 or Dexcom ONE with xDrip+ Companion Mode +##### Dexcom G6 or Dexcom ONE with xDrip+ Companion Mode The noise-level data is not shared with AAPS using this method. Therefore 'Enable SMB always' and 'Enable SMB after carbs' are disabled. ### Freestyle Libre sensors diff --git a/docs/EN/Installing-AndroidAPS/setup-wizard.md b/docs/EN/Installing-AndroidAPS/setup-wizard.md index 879a7719a73c..f78eb591a4f6 100644 --- a/docs/EN/Installing-AndroidAPS/setup-wizard.md +++ b/docs/EN/Installing-AndroidAPS/setup-wizard.md @@ -1,5 +1,15 @@ # setup wizard +When you first start AAPS you are guided through the setup wizward to setup the basic configuration. + +It's not mandatory to get all things configured in the first run as +- you can always go back to the setup wizard or +- change only relevant part of the configuration in a direct approach the relevant part. + +Though please relax if your are setting up AAPS the first time and expect that you might ask the community for help to answer some of your questions. + +Even writers of the documentation themselves had to setup AAPS and decided to joint the documentation team to bring their experiences back to improve the documenation for other new starters. + ## Welcome message ![image](../images/setup-wizard/Screenshot_20231202_125636.png) diff --git a/docs/EN/index.md b/docs/EN/index.md index 72c584bc5ac7..a828d1500def 100644 --- a/docs/EN/index.md +++ b/docs/EN/index.md @@ -46,8 +46,8 @@ Preparing Setting up the reporting server <./Installing-AndroidAPS/setting-up-the-reporting-server.md> Building AAPS <./Installing-AndroidAPS/building-AAPS.md> Installing AAPS <./Installing-AndroidAPS/installing-AAPS.md> -Configuring the AAPS loop<./Installing-AndroidAPS/configuring-the-AAPS-loop.md> - +Setup Wizard <./Installing-AndroidAPS/setup-wizard.md> +Change configuration <./Installing-AndroidAPS/change-configuration.md> Completing the objectives <./Usage/completing-the-objectives.md> ```