Skip to content

Commit 736c760

Browse files
committed
NSClient removal
1 parent 27fb705 commit 736c760

10 files changed

Lines changed: 22 additions & 46 deletions

File tree

docs/EN/CompatibleCgms/CgmNightscoutUpload.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# For users of other CGM uploaded to Nightscout
1+
# Other CGM uploaded to Nightscout
22

33
If you have any other CGM set up that can send your BG data **only** to [Nightscout](https://nightscout.github.io/).
44

docs/EN/CompatibleCgms/Eversense.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# For users of Eversense
1+
# Eversense
22

33
There are three different methods to access the readings from Eversense:
44

docs/EN/CompatibleCgms/MM640g.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# For users of MM640g or MM630g
1+
# MM640g or MM630g
22

33
- If not already set up then download [600SeriesAndroidUploader](https://pazaan.github.io/600SeriesAndroidUploader/)
44
and follow instructions on [Nightscout](https://nightscout.github.io/uploader/setup/?h=uploader#medtronic-600-series-with-uploader).

docs/EN/CompatibleCgms/PocTech.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# For users of PocTech CT-100
1+
# PocTech CT-100
22

33
- Install [PocTech App](https://play.google.com/store/apps/details?id=com.poctechcorp.pocct)
44
- Select PocTech App in [ConfigBuilder, BG Source](#Config-Builder-bg-source).

docs/EN/DailyLifeWithAaps/AapsScreens.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ Buttons for Insulin and Carbs are almost always visible. If the connection to th
357357

358358
Other Buttons can be setup in [Preferences > Overview > Buttons](#Preferences-buttons).
359359

360-
About using the Insulin, Carbs and Calculator buttons : If enabled in the [Preferences > Overview](#Preferences-show-notes-field-in-treatments-dialogs), the **Notes** field allows you to enter text that will show on the main graph, and may be uploaded to Nightscout - depending on your settings for NS client.
360+
About using the Insulin, Carbs and Calculator buttons : If enabled in the [Preferences > Overview](#Preferences-show-notes-field-in-treatments-dialogs), the **Notes** field allows you to enter text that will show on the main graph, and may be uploaded to Nightscout - depending on your settings for NSClient.
361361

362362
(aaps-screens-buttons-insulin)=
363363
#### Insulin
@@ -623,7 +623,7 @@ See the dedicated page [here](../DailyLifeWithAaps/Automations.md).
623623

624624
This page displays the status of the connection with your Nightscout site.
625625

626-
Settings can be changed in [Preferences > NS Client](#Preferences-nsclient).
626+
Settings can be changed in [Preferences > NSClient](#Preferences-nsclient).
627627

628628
For troubleshooting see this [page](../GettingHelp/TroubleshootingNsClient.md).
629629

docs/EN/DailyLifeWithAaps/Food.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ The food's stored **carbs** number is passed straight to the wizard — **AAPS**
6969

7070
The food database is shared through **Nightscout**, but **in one direction only**:
7171

72-
- **Download:** **AAPS** **reads** foods from your Nightscout site's **food database** and keeps the local list in sync with it. This runs as part of NSClientV3 syncing, so a paired **client/follower** ends up with the same foods too.
73-
- **Upload:** **AAPS** does **not** push foods **to** Nightscout — NSClientV3 does not support uploading food entries. Foods you create or edit **inside AAPS** therefore stay **on that device** and are not propagated to Nightscout or to your other devices.
72+
- **Download:** **AAPS** **reads** foods from your Nightscout site's **food database** and keeps the local list in sync with it. This runs as part of NSClient syncing, so a paired **client/follower** ends up with the same foods too.
73+
- **Upload:** **AAPS** does **not** push foods **to** Nightscout — NSClient does not support uploading food entries. Foods you create or edit **inside AAPS** therefore stay **on that device** and are not propagated to Nightscout or to your other devices.
7474

7575
```{admonition} Maintain your shared list in Nightscout
7676
:class: important

docs/EN/RemoteFeatures/RemoteControl.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -66,36 +66,24 @@ To build **AAPSClient** yourself, follow the same process as [regular AAPS build
6666

6767
### Synchronization- AAPSClient and AAPS set up (for Version 3.2.0.0 above)
6868

69-
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+).
69+
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 NSClientV3 using Nightscout15 but there are other options available with __AAPS__ (e.g xDrip+).
7070

71-
Within the ‘Synchronization’ located under ‘Config Builder’, the user can opt for either Synchronization options for both __AAPS__ and follower phone being:
72-
73-
- Option 1: NSClient (also known as ‘v1’) - which synchronizes the user’s data with Nightscout; or
74-
75-
- Option 2: NSClientV3 (also referred to as ‘v3’).- which synchronizes the user’s data with Nightscout using v3 API.
71+
Within the ‘Synchronization’ located under ‘Config Builder’, the user synchronizes their data with Nightscout through __NSClientV3__ (using the v3 API), set up the same way for both __AAPS__ and the follower phone.
7672

7773
![AAPS1_Screenshot 2024-05-17 133502](../images/4bdfed7e-3b2f-4fe8-b6db-6fcf0e5c7d98.png)
7874

79-
The user must ensure that __both__ the AAPS and AAPS Client phones are synched together by actioning either option for v1 or v3 being:
80-
81-
Option 1: v1 for both phones:
82-
83-
- Enter your Nightscout URL
84-
85-
- Enter your API secret
86-
87-
Option 2: v3 for both phones:
75+
The user must ensure that __both__ the AAPS and AAPS Client phones are synched together by setting up NSClientV3 on each:
8876

89-
- Enter your Nightscout URL under NSClientV3 tab
77+
- Enter your Nightscout URL under the NSClientV3 tab
9078

91-
- Enter your NS access token under ‘Config Build’ tab. Please follow the notes [here](https://nightscout.github.io/nightscout/security/#create-a-token)
79+
- Enter your NS access token under the ‘Config Build’ tab. Please follow the notes [here](https://nightscout.github.io/nightscout/security/#create-a-token)
9280

9381
If selecting Websockets (which is optional) ensure this is activated or deactivated for both __AAPS’__ and __AAPSClient’s__ phone. Activating Websockets in __AAPS__ and not within __AAPSClient__ (and vice versa) will only cause __AAPS__ to malfunction. By enabling websockets will allow for faster synchronization with Nightscout but may lead to more phone battery consumption.
9482

9583
![WB2_Screenshot 2024-05-17 140548](../images/d9a7dc5-b3ea-4bf3-9286-313f329b1966.png)
9684

9785

98-
The user should ensure that both __AAPSClient__ and __AAPS__ are showing ‘connected’ under the ‘NSClient' tab for each phone, and that ‘Profile Switches’ or ‘Temp Target' can be correctly activated in __AAPS__ once selected in __AAPSClient__.
86+
The user should ensure that both __AAPSClient__ and __AAPS__ are showing ‘connected’ under the ‘NSClientV3' tab for each phone, and that ‘Profile Switches’ or ‘Temp Target' can be correctly activated in __AAPS__ once selected in __AAPSClient__.
9987

10088
The user should also ensure that when carbs are entered in either __AAPS__ or __AAPSClient__ that the data is automatically logged in both ‘Treatments’ for both __AAPSClient__ and __AAPS__. Otherwise, this could indicate a malfunction within either the user’s __AAPS__ or __AAPSClient__ set up.
10189

docs/EN/SettingUpAaps/ConfigBuilder.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,11 @@ See [Objectives](../SettingUpAaps/CompletingTheObjectives.md) page for more info
205205

206206
In this section, you can choose if/where you want **AAPS** to send your data to.
207207

208-
### NSClient or NSClientV3
208+
### NSClientV3
209209

210210
Can be used as a [reporting server](../SettingUpAaps/SettingUpTheReportingServer.md) and/or for [remote monitoring](../RemoteFeatures/RemoteMonitoring.md), [remote control](../RemoteFeatures/RemoteControl.md).
211211

212-
See [Synchronization with the reporting server](#SetupWizard-synchronization-with-the-reporting-server-and-more) to help you choose between NSClient (v1) and NSClientV3.
212+
See [Synchronization with the reporting server](#SetupWizard-synchronization-with-the-reporting-server-and-more) to set up NSClient synchronization.
213213

214214
### Tidepool
215215

docs/EN/SettingUpAaps/Nightscout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Nightscout `API_SECRET` is your site main password: don't share it publicly.
1818

1919
You can set up AAPS to accept Nightscout commands (profile changes, treatments, ...), or fully disable it.
2020

21-
* Access the NSClient or NSClientV3 plugin settings with either
21+
* Access the NSClientV3 plugin settings with either
2222
1) Main view -> Config Builder -> Synchronization -> NSClient Cog icon
2323
2) NSCLIENT tab -> Three dots menu -> Plugin preferences
2424
* Enable all data upload to Nightscout (3) as this is now the standard method unless your BG data source is Nightscout.

docs/EN/SettingUpAaps/Preferences.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -378,26 +378,14 @@ More information on the dedicated [Tidepool](../SettingUpAaps/Tidepool.md) page.
378378
(Preferences-nsclient)=
379379
## NSClient
380380

381-
![NSClient](../images/Pref2020_NSClient.png)
381+
![NSClient](../images/Pref2024_NSClientV3.png)
382382

383-
Original communication protocol, can be used with older Nightscout versions.
383+
The NSClient plugin (shown as **NSClientV3** in the configuration menu) synchronizes your data with Nightscout. [Introduced with AAPS 3.2,](#Important-comments-on-using-v3-versus-v1-API-for-Nightscout-with-AAPS) it uses the Nightscout API v3.
384384

385-
- Set your *Nightscout URL* (i.e. <https://yoursitename.yourplaform.dom>).
386-
- **Make sure that the URL is WITHOUT /api/v1/ at the end.**
387-
- The *[API secret](https://nightscout.github.io/nightscout/setup_variables/#api-secret-nightscout-password)* (a 12 character password recorded in your Nightscout variables).
388-
- This enables data to be read and written between both the Nightscout website and **AAPS**.
389-
- Double check for typos here if you are stuck in Objective 1.
390-
391-
## NSClientV3
392-
393-
![NSClientV3](../images/Pref2024_NSClientV3.png)
394-
395-
[New protocol introduced with AAPS 3.2.](#Important-comments-on-using-v3-versus-v1-API-for-Nightscout-with-AAPS) Safer and more efficient.
396-
397-
```{admonition} V3 data uploaders
385+
```{admonition} Data uploaders
398386
:class: warning
399387
400-
When using NSClientV3, all uploaders must be using the API V3. Since most are not compatible yet, this means **you must let **AAPS** upload all data** (BG, treatments, ...) to Nightscout and disable all other uploaders if they're not V3 compliant.
388+
When using NSClient, all uploaders must be using the API V3. Since most are not compatible yet, this means **you must let **AAPS** upload all data** (BG, treatments, ...) to Nightscout and disable all other uploaders if they're not V3 compliant.
401389
```
402390

403391
- Set your *Nightscout URL* (i.e. <https://yoursitename.yourplaform.dom>).
@@ -440,7 +428,7 @@ You can select which data you want to [upload and download to or from Nightscout
440428
(Preferences-advanced-settings-nsclient)=
441429
### Advanced settings (NSClient)
442430

443-
![NS Client advanced settings](../images/Pref2024_NSClientAdv.png)
431+
![NSClient advanced settings](../images/Pref2024_NSClientAdv.png)
444432

445433
Options in advanced settings are self-explanatory.
446434

0 commit comments

Comments
 (0)