From 980235f6b7e1e0c7b0ffd0039164870590a8da4a Mon Sep 17 00:00:00 2001 From: Bastian Leykauf Date: Thu, 5 May 2022 16:38:53 +0200 Subject: [PATCH 1/4] doc: add note about disabled loss-of-lock detection --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5f5b081f..4540621b 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Features automatically lock to it. This algorithm is built to be noise and jitter tolerant. - **IQ demodulation**: Optimize demodulation phase in an instant - **Noise analysis**: Record power spectral density (PSD) of the error signal for analyzing noise of the locked laser and for optimizing PID parameters -- **Lock detection**: Linien is capable of detecting loss of lock. -- **Automatic relocking**: in that case, it relocks autonomously (temporarily disabled, use [v0.3.2](https://github.com/linien-org/linien/releases/tag/v0.3.2) if you rely in this feature) +- **Lock detection**: Linien is capable of detecting loss of lock (temporarily disabled, use [v0.3.2](https://github.com/linien-org/linien/releases/tag/v0.3.2) if you rely in this feature +- **Automatic relocking**: if lock is lost, it relocks autonomously (temporarily disabled, use [v0.3.2](https://github.com/linien-org/linien/releases/tag/v0.3.2) if you rely in this feature) - **Machine learning** is used to tune the spectroscopy parameters in order to optimize the signal - **Remote-controllable**: the client libraries can be used to control or monitor the spectroscopy lock with python. - **Combined FMS+MTS**: Linien supports dual-channel spectroscopy that can be From 546b2298f029d7e83fb0b92710839164a40c088e Mon Sep 17 00:00:00 2001 From: Bastian Leykauf Date: Thu, 5 May 2022 16:41:13 +0200 Subject: [PATCH 2/4] doc: remove putty link --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 4540621b..afefd05c 100644 --- a/README.md +++ b/README.md @@ -402,9 +402,7 @@ can ping it by executing ping rp-f0xxxx.local ``` -in a command line. If this works, check whether you can connect via SSH. -On Windows, you have to [install a SSH client](https://www.putty.org), -on linux you can execute +in a command line. If this works, check whether you can connect via SSH: ```bash ssh rp-f0xxxx.local From a9a06304df81ec807a2873b3672081b736a08405 Mon Sep 17 00:00:00 2001 From: Bastian Leykauf Date: Thu, 5 May 2022 16:51:56 +0200 Subject: [PATCH 3/4] doc: improve troubleshooting section --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index afefd05c..82fdf9c9 100644 --- a/README.md +++ b/README.md @@ -395,8 +395,8 @@ Troubleshooting ### Connection problems -If the client fails to connect to a RedPitaya, first check whether you -can ping it by executing +If the client fails to connect to a RedPitaya, first check whether you can ping it by +executing ```bash ping rp-f0xxxx.local @@ -408,7 +408,12 @@ in a command line. If this works, check whether you can connect via SSH: ssh rp-f0xxxx.local ``` -on the command line. +on the command line. If this is succesful, in order to to check whether the +`linien-server` is running, first confirm that there is a running `screen` session with +the name `linien-server` by executing `screen -ls`. If that is the case attach it by +running `screen -r linien-server`. If any errors occured on the server side, they will +be displayed here. Please provide the output if you are reporting an +[issue](https://github.com/linien-org/linien/issues) related to connection problems. ### Updating or installing fails From 6d484ff4ce26b6acb7663a26972439cedfbaf25c Mon Sep 17 00:00:00 2001 From: Bastian Leykauf Date: Thu, 5 May 2022 17:02:53 +0200 Subject: [PATCH 4/4] doc: fix typos --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82fdf9c9..7df86d06 100644 --- a/README.md +++ b/README.md @@ -408,10 +408,10 @@ in a command line. If this works, check whether you can connect via SSH: ssh rp-f0xxxx.local ``` -on the command line. If this is succesful, in order to to check whether the +on the command line. If this is successful, in order to to check whether the `linien-server` is running, first confirm that there is a running `screen` session with the name `linien-server` by executing `screen -ls`. If that is the case attach it by -running `screen -r linien-server`. If any errors occured on the server side, they will +running `screen -r linien-server`. If any errors occurred on the server side, they will be displayed here. Please provide the output if you are reporting an [issue](https://github.com/linien-org/linien/issues) related to connection problems.