From be7f71a101eb2fd9e2c02b36699e64abd6157253 Mon Sep 17 00:00:00 2001 From: emilisev Date: Mon, 6 Jan 2025 10:36:47 +0100 Subject: [PATCH 1/5] accessing logfiles - AAPS+AAPSClient vs keystore - quick wizard long press option - unattended setting export --- docs/EN/DailyLifeWithAaps/Automations.md | 3 ++- docs/EN/GettingHelp/AccessingLogFiles.md | 6 ++++-- docs/EN/Maintenance/DocumentationUpdate.md | 4 ++++ docs/EN/Maintenance/ExportImportSettings.md | 16 +++++----------- docs/EN/Maintenance/ReleaseNotes.md | 7 ++++--- docs/EN/RemoteFeatures/RemoteControl.md | 14 ++++++++------ docs/EN/SettingUpAaps/Preferences.md | 14 ++++++++++++++ 7 files changed, 41 insertions(+), 23 deletions(-) diff --git a/docs/EN/DailyLifeWithAaps/Automations.md b/docs/EN/DailyLifeWithAaps/Automations.md index 74185248a7f4..0f1ebc542de4 100644 --- a/docs/EN/DailyLifeWithAaps/Automations.md +++ b/docs/EN/DailyLifeWithAaps/Automations.md @@ -298,7 +298,8 @@ Screenshots detailing the Automation triggers: ![Export on Pod activation](../images/Automations/automation_settingsexport_podactivation_400px.png) -Note: Export execution will be logged on Careportal +Note: Export execution will be logged on Careportal. +Note : Automation will not trigger **at all** if you have not done a manual settings export before. See [Preferences > Maintenance](#preferences-maintenance-settings) for proper activation of unattended settings export. # Automation Logs diff --git a/docs/EN/GettingHelp/AccessingLogFiles.md b/docs/EN/GettingHelp/AccessingLogFiles.md index 010964f8b79e..4f60d9b0977e 100644 --- a/docs/EN/GettingHelp/AccessingLogFiles.md +++ b/docs/EN/GettingHelp/AccessingLogFiles.md @@ -2,8 +2,10 @@ # Accessing logfiles * Connect phone to a computer in file transfer mode -* Locate the log files in the AAPS data directory, at the location you chose in the [Maintenance tab](#preferences-maintenance-logdirectory).
-The naming of the root storage folder may vary a little depending on the phone. +* Locate the log files in the AAPS data directory, in `Android\data\info.nightscout.androidaps\files`.
+ The naming of the root storage folder may vary a little depending on the phone. +* The location is `Android\data\info.nightscout.aapsclient\files` for [AAPSClient](#RemoteControl_aapsclient). +* Note : log location has changed in **AAPS 3.3**. See the previous versions' documentation if needed. ![logs](../images/aapslog.png) diff --git a/docs/EN/Maintenance/DocumentationUpdate.md b/docs/EN/Maintenance/DocumentationUpdate.md index c084334ab671..966bf24632d6 100644 --- a/docs/EN/Maintenance/DocumentationUpdate.md +++ b/docs/EN/Maintenance/DocumentationUpdate.md @@ -1,5 +1,9 @@ # Docs updates & changes +## January 2025 + +- Quick wizard [long press feature](#Preferences-quick-wizard) @emilise + ## December 2024 - Documentation of [3.3 version](#version3300) @emilise diff --git a/docs/EN/Maintenance/ExportImportSettings.md b/docs/EN/Maintenance/ExportImportSettings.md index c679ea5853ee..c5b201932258 100644 --- a/docs/EN/Maintenance/ExportImportSettings.md +++ b/docs/EN/Maintenance/ExportImportSettings.md @@ -79,23 +79,17 @@ files by copying them off your phone to for instance a cloud storage location. **Note**: _The exported settings will be encrypted with your AAPS master password: without the master password used for exporting you will be unable to import the settings file!_ -### Exporting or Importing Settings: ### +### Exporting or Importing Settings ### To export or import settings, use the **import or export buttons** in the AAPS **maintenance menu** ![Maintenance menu export/import buttons](../images/Maintenance/maintenance_menu_import_export_400px.png) -### Automating Settings Export: ### -For doing automating settings exports [(**see Automation**)](../DailyLifeWithAaps/Automations.md#automating-preference-settings-export) enable the option "**Unattended Settings Exports**" -in the maintenance menu preferences. +(ExportImportSettings-Automating-Settings-Export)= +### Automating Settings Export ### -By enabling this feature you allow AAPS to execute settings exports without user intervention. For this the master password -is securely stored on your phone (only) at the next manually export. The stored password will be used for up to 4 weeks. -After 4 weeks you will be notified the password is about to expire. During a grace period of 1 week, the password can then be refreshed by -manually exporting settings from the maintenance menu. +For doing automating settings exports [(**see Automation**)](../DailyLifeWithAaps/Automations.md#automating-preference-settings-export) enable the option "**Unattended Settings Exports**" in [Preferences > Maintenance](#preferences-maintenance-settings). -After the grace period of 1 week has passed the stored password expires and any automated settings export will abort while notifying the user, asking -to reenter the password. [(**Automated settings exports**)](../DailyLifeWithAaps/Automations.md#automating-preference-settings-export) will be logged -to the AAPS 'Careportal' and 'User entry' lists under Treatments. +You can now configure [Automation](../DailyLifeWithAaps/Automations.md#automating-preference-settings-export) to export settings, either on a regular basis (_i.e._ each week), or after a pod change. _**Note:** On importing settings to user always needs to enter the AAPS password!_ diff --git a/docs/EN/Maintenance/ReleaseNotes.md b/docs/EN/Maintenance/ReleaseNotes.md index 81d2afed1b51..2f27212badd5 100644 --- a/docs/EN/Maintenance/ReleaseNotes.md +++ b/docs/EN/Maintenance/ReleaseNotes.md @@ -73,8 +73,8 @@ Release date: 29-12-2024 * **[Dynamic ISF](../DailyLifeWithAaps/DynamicISF.md)** feature is no more a dedicated plugin, but is now included as an option of [OpenAPS SMB](#Config-Builder-aps) plugin, along with some changes in its behaviour: * **Profile Switch** and **Profile Percentage** is now taken into account for **Dynamic ISF** in respect of dynamic sensitivity strengthness * The average **ISF** of the last 24h is calculated and this value is used for bolus wizard and **COB** calculation. **Profile ISF** value is not used at all (except fallback when history data is not available) - * If you use **DynamicISF** and you have **Automation** set for a **Profile %** in relation to **BG**: Turn It Off. This is already part of dynamic sensitivity algorithm - * *** AGAIN: Turn off all **Automations** which activates a **Profile %** in relation to **BG** because it will be too aggressive and may over deliver in insulin! ***** + * Reminder: If you use **DynamicISF** and you have **Automation** set for a **Profile %** in relation to **BG**: Turn It Off. This is already part of dynamic sensitivity algorithm + * *** AGAIN: When using DynamicISF, turn off all **Automations** which activates a **Profile %** in relation to **BG** because it will be too aggressive and may over deliver in insulin! ***** * Do not use a **Profile %** increase of greater than 100% for a long time. If you determine that your **Profile** has changed, create a new **Profile** with your revised values in order to replicate the **Profile** with % * Enable “SMB always” and “SMB after carbs” for FreeStyle Libre 2 and Libre 3 users * Note : Although the limitation was removed on **AAPS** side, this functionality is not fully operational yet, since **AAPS** needs to receive proper identification of the CGM used. See the [bug opened on xDrip+ project](https://github.com/NightscoutFoundation/xDrip/issues/3841). @@ -123,7 +123,7 @@ Release date: 29-12-2024 #### Other functionalities -* Unattended exports @vanelsberg +* [Unattended settings exports]() @vanelsberg * New [Automation trigger](#automations-automation-triggers) @vanelsberg * Pod Activation (patch pump only) * New [Automation triggers](#automations-automation-triggers) @jbr77rr @@ -146,6 +146,7 @@ Release date: 29-12-2024 #### Technical changes +* [log files location change](#Accessing-logfiles-accessing-logfiles) * new internal modules structure @MilosKozak * split persistence layer from main code @MilosKozak * build files rewritten to kts @MilosKozak diff --git a/docs/EN/RemoteFeatures/RemoteControl.md b/docs/EN/RemoteFeatures/RemoteControl.md index 62158bc602b3..97604deaf21d 100644 --- a/docs/EN/RemoteFeatures/RemoteControl.md +++ b/docs/EN/RemoteFeatures/RemoteControl.md @@ -19,20 +19,19 @@ See the dedicated [SMS Commands](../RemoteFeatures/SMSCommands.md) page. (RemoteControl_aapsclient)= ## 2) AAPSClient -_Note that **NSClient** has been replaced by **AAPSClient** for AAPS version 3.2 and higher, check the version release notes for more information._ - -For versions of **AAPS** which are older than AAPS 3.2, if you have a caregiver/parent Android phone you can directly download and install the [**AAPSClient**](https://github.com/nightscout/AndroidAPS/releases/) apk. **AAPSClient** looks very similar in appearance to **AAPS** itself, offering the caregiver tabs that will remotely action commands in **AAPS**: +**AAPSClient** looks very similar in appearance to **AAPS** itself, offering the caregiver tabs that will remotely action commands in **AAPS**: ![NSCLIENT_ 2024-05-17 134512](../images/6c66a27c-21d7-4c43-ac66-001669c0634f.png) +### Download and installation -There are 2 versions of the apk that can be [downloaded from here](https://github.com/nightscout/AndroidAPS/releases/), **AAPSClient** & **AAPSClient2** which have a subtle but important difference as explained below. +**AAPSClient** can be installed on a single phone or multiple follower phones (i.e. parent 1’s follower phone and parent 2’s follower phone) in order for both caregivers to be granted access and remote control a patient's **AAPS** phone. -**AAPSClient** can be installed on a single phone or multiple follower phones (i.e. parent 1’s follower phone and parent 2’s follower phone) in order for both caregivers to be granted access and remote control a patient's **AAPS** phone. +There are 2 versions of the apk that can be [downloaded from the GitHUb repository](https://github.com/nightscout/AndroidAPS/releases/), **AAPSClient** & **AAPSClient2** which have a subtle but important difference as explained below. Should a caregiver require a second copy of **AAPSClient** to remote control an additional patient with a Nightscout account, they should install **AAPSClient2** in addition to **AAPSClient**. **AAPSClient 2** allows a single caregiver to install the **AAPSClient** apk twice on the same follower phone in order to be given simultaneous access and remote control to two different patients. -To download **AAPSClient**, navigate to [here](https://github.com/nightscout/AndroidAPS/releases/) and click on the asset +To download **AAPSClient**, navigate to the [GitHUb repository](https://github.com/nightscout/AndroidAPS/releases/) and click on the asset **“app-AAPSClient-release_x.x.x.x”** (it may be a newer version to that shown in the screenshot below): ![image](../images/remote_control_and_following/AAPSClient_download_02.png) @@ -48,6 +47,9 @@ The **AAPSClient** apk can now be either: Transferred by a USB cable onto the follower phone; or Dragged into Google drive folder, and then added onto the follower phone by clicking on the "app-AAPSClient-release" file. +Should you be needing **AAPS** for yourself, and **AAPSClient** for monitoring someone else, you will need to build **AAPSClient** yourself instead of downloading it from the Github repository as described above. The reason is that you can't install both **AAPS** and **AAPSClient** on the same phone, signed by a different key.
+To build **AAPSClient** yourself, follow the same process as [regular AAPS build](../SettingUpAaps/BuildingAaps.md). On the **Generate signed App Bundle or APK** page, select **aapsclientRelease** instead of **fullRelease**. + ### Synchronization- AAPSClient and AAPS set up (for Version 3.2.0.0 above) Once __AAPSClient__ apk is installed on the follower phone, the user must ensure their ‘Preferences’ in Config Builder are correctly set up and aligned with __AAPS__ for Nightscout 15 (see Release Notes [here](../Maintenance/UpdateToNewVersion)). The example below provides Synchronization guidance for NSClient and NSClientV3 using Nightscout15 but there are other options available with __AAPS__ (e.g xDrip+). diff --git a/docs/EN/SettingUpAaps/Preferences.md b/docs/EN/SettingUpAaps/Preferences.md index e469b079c50d..7229db7e1983 100644 --- a/docs/EN/SettingUpAaps/Preferences.md +++ b/docs/EN/SettingUpAaps/Preferences.md @@ -156,6 +156,8 @@ The proposal has to be confirmed before insulin is delivered. ![Preferences > Quick Wizard Button](../images/Pref2020_OV_QuickWizard2.png) +Only one QuickWizard button can show up at the same time. If you want to execute a different one : long press on the Quick Wizard button currently showing. It will take you to the list of all Quick Wizard options. To execute one, long press on it. You will have to confirm before execution. + (Preferences-default-temp-targets)= ### Default temp targets @@ -491,6 +493,18 @@ Settings should be self-explanatory. You can help develop **AAPS** further by sending crash reports to the developers. +**Unattended Settings Export**
+By enabling this feature, you allow **AAPS** to execute settings exports without user intervention. For this the master password +is securely stored on your phone (only) at the next manually export. The stored password will be used for up to 4 weeks. +After 4 weeks you will be notified the password is about to expire. During a grace period of 1 week, the password can then be refreshed by +manually exporting settings from the maintenance menu. + +After the grace period of 1 week has passed the stored password expires and any automated settings export will abort while notifying the user, asking +to reenter the password. [(**Automated settings exports**)](../DailyLifeWithAaps/Automations.md#automating-preference-settings-export) will be logged +to the AAPS 'Careportal' and 'User entry' lists under Treatments. + +After enabling this option, make sure to perform a manual settings export, where you will be requested for your password, so that **AAPS** can store it. + (preferences-maintenance-logdirectory)= Maintenance settings also include the **AAPS** directory, which can be found directly under the Maintenance tab. This setting allows the user to choose a directory on their phone where **AAPS** will store preferences, logs, and other files. From 6bb836670d19214e372c49d505cacd9919871049 Mon Sep 17 00:00:00 2001 From: emilisev Date: Mon, 6 Jan 2025 10:39:38 +0100 Subject: [PATCH 2/5] forgot link --- docs/EN/Maintenance/ReleaseNotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/EN/Maintenance/ReleaseNotes.md b/docs/EN/Maintenance/ReleaseNotes.md index 2f27212badd5..0bc823321b0b 100644 --- a/docs/EN/Maintenance/ReleaseNotes.md +++ b/docs/EN/Maintenance/ReleaseNotes.md @@ -123,7 +123,7 @@ Release date: 29-12-2024 #### Other functionalities -* [Unattended settings exports]() @vanelsberg +* [Unattended settings exports](#ExportImportSettings-Automating-Settings-Export) @vanelsberg * New [Automation trigger](#automations-automation-triggers) @vanelsberg * Pod Activation (patch pump only) * New [Automation triggers](#automations-automation-triggers) @jbr77rr From 5383b758f32071c477e2c4ef296947c75b913b36 Mon Sep 17 00:00:00 2001 From: emilisev Date: Mon, 6 Jan 2025 11:06:33 +0100 Subject: [PATCH 3/5] patient name on dual watchface --- docs/EN/SettingUpAaps/Preferences.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/EN/SettingUpAaps/Preferences.md b/docs/EN/SettingUpAaps/Preferences.md index 7229db7e1983..e922dd9bc1cb 100644 --- a/docs/EN/SettingUpAaps/Preferences.md +++ b/docs/EN/SettingUpAaps/Preferences.md @@ -47,6 +47,7 @@ The **simple mode** is activated by default when you first install **AAPS**. In **Patient name** - Can be used if you have to differentiate between multiple setups (i.e. two T1D kids in your family). +- Displayed in the [Dual Watchface](../WearOS/WearOsSmartwatch.md). (Preferences-skin)= #### Skin From a425bf8c2be50d0072174490e8a256439ce8eeb1 Mon Sep 17 00:00:00 2001 From: emilisev Date: Mon, 6 Jan 2025 11:18:18 +0100 Subject: [PATCH 4/5] note on update aaps on a new computer --- docs/EN/Maintenance/UpdateToNewVersion.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/EN/Maintenance/UpdateToNewVersion.md b/docs/EN/Maintenance/UpdateToNewVersion.md index b39d6cff7f08..4e609168a8d3 100644 --- a/docs/EN/Maintenance/UpdateToNewVersion.md +++ b/docs/EN/Maintenance/UpdateToNewVersion.md @@ -10,6 +10,10 @@ * The new version will also be announced on Facebook at the time of release. * Following the release, please read the [Release Notes](ReleaseNotes.md) in detail, and clarify any queries with the community on Facebook or Discord, before proceeding with the update. + ```{note} + In case you want to build **AAPS** on a new computer : copy your back-up keystore file to the new computer. Then follow the [Initial build **AAPS** procedure](../SettingUpAaps/BuildingAaps.md) instead of this guide. With the only difference that instead of creating a new keystore, you can select the one you have copied on the new computer. + ``` + ## Overview for updating to a new version of AAPS ```{contents} Steps for updating to a new version of AAPS From f2d0ff4921c83ed466006803c7542f0582565831 Mon Sep 17 00:00:00 2001 From: emilisev Date: Mon, 6 Jan 2025 15:08:27 +0100 Subject: [PATCH 5/5] more explicit wording regarding NSv1/v3 --- docs/EN/SettingUpAaps/SetupWizard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/EN/SettingUpAaps/SetupWizard.md b/docs/EN/SettingUpAaps/SetupWizard.md index 72ca85cf2bff..1bb3075bc004 100644 --- a/docs/EN/SettingUpAaps/SetupWizard.md +++ b/docs/EN/SettingUpAaps/SetupWizard.md @@ -215,7 +215,7 @@ In this example we select Nightscout as reporting server, and will configure it. Click [here](#version3200) for the release notes of **AAPS** 3.2.0.0 which explain the differences between the top option **NSClient** (this is "v1", although it is not explicitly labelled) and the second option, **NSClient v3**. -Nightscout users should choose **NSClient v3**, unless you want to monitor or send remote treatments (_e.g._ as a parent or caregiver using **AAPS** for a child) through Nightscout, in which case, choose the first option "**NSClient**" until further notice. +Nightscout users should choose **NSClient v3**, unless you want to monitor or send remote treatments (_e.g._ as a parent or caregiver using **AAPS** for a child) through Nightscout web interface, in which case, choose the first option "**NSClient**" until further notice. ``` For Tidepool it is even simpler, as you only need your personal login information.