Add parameter logging to influxdb

.github/actions/build-linien/action.yml

@@ -0,0 +1,38 @@
+name: Build Linien
+description: Build all linien packages
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Update pip
+      shell: bash
+      run: python -m pip install --upgrade pip
+
+    - name: Install build dependencies
+      shell: bash
+      run: pip install build wheel
+
+    - name: Build linien-common
+      shell: bash
+      working-directory: linien-common
+      run: python -m build
+
+    - name: Build linien-server
+      shell: bash
+      working-directory: linien-server
+      run: python -m build
+
+    - name: Build linien-client
+      shell: bash
+      working-directory: linien-client
+      run: python -m build
+
+    - name: Build linien-gui
+      shell: bash
+      working-directory: linien-gui
+      run: python -m build

.github/actions/install-linien/action.yml

@@ -5,10 +5,14 @@ runs:
   using: "composite"
   steps:
     - name: Set up Python 3.10
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: "3.10"
 
+    - name: Update pip
+      shell: bash
+      run: python -m pip install --upgrade pip
+
     - name: Install linien-common
       shell: bash
       working-directory: linien-common

.github/workflows/mypy.yml

@@ -4,31 +4,38 @@ on:
   workflow_dispatch:
   push:
     paths:
+      - .github/workflows/mypy.yml
+      - .github/actions/install-linien/**
       - linien-common/**
+      - linien-client/**
+      - linien-gui/**
+      - linien-server/**
 
 permissions:
   contents: read
 
 jobs:
-  build:
+  mypy:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v3
-        with:
-          python-version: "3.10"
+      - name: Check out repository
+        uses: actions/checkout@v3
 
-      - name: Install linien-common
-        working-directory: linien-common
-        run: pip install .
+      - name: Install Linien
+        uses: ./.github/actions/install-linien
 
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install mypy types-appdirs  
+      - name: Install additional dependencies
+        run: pip install mypy types-appdirs pyqt5-stubs types-requests
 
       - name: mypy for linien-common
-        run: mypy linien-common
+        run: mypy linien-common/linien_common
 
+      - name: mypy for linien-server
+        run: mypy linien-server/linien_server
+
+      - name: mypy for linien-client
+        run: mypy linien-client/linien_client
+
+      - name: mypy for linien-gui
+        run: mypy linien-gui/linien_gui      

.github/workflows/publish-pypi.yml

@@ -15,31 +15,8 @@ jobs:
         with:
           lfs: "true"
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build wheel
-
-      - name: Build linien-common
-        working-directory: linien-common
-        run: python -m build
-
-      - name: Build linien-server
-        working-directory: linien-server
-        run: python -m build
-
-      - name: Build linien-client
-        working-directory: linien-client
-        run: python -m build
-
-      - name: Build linien-gui
-        working-directory: linien-gui
-        run: python -m build
+      - name: Build Linien
+        uses: ./.github/actions/build-linien
 
       - name: Publish linien-common
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/publish-test-pypi.yml

@@ -15,56 +15,33 @@ jobs:
         with:
           lfs: "true"
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install build wheel
-
-      - name: Build linien-common
-        working-directory: linien-common
-        run: python -m build
-
-      - name: Build linien-server
-        working-directory: linien-server
-        run: python -m build
-
-      - name: Build linien-client
-        working-directory: linien-client
-        run: python -m build
-
-      - name: Build linien-gui
-        working-directory: linien-gui
-        run: python -m build
+      - name: Build Linien
+        uses: ./.github/actions/build-linien
 
       - name: Publish linien-common to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: linien-common/dist/
           password: ${{ secrets.TEST_PYPI_API_TOKEN_COMMON }}
-          repository_url: https://test.pypi.org/legacy/
+          repository-url: https://test.pypi.org/legacy/
 
       - name: Publish linien-server to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: linien-server/dist/
           password: ${{ secrets.TEST_PYPI_API_TOKEN_SERVER }}
-          repository_url: https://test.pypi.org/legacy/
+          repository-url: https://test.pypi.org/legacy/
 
       - name: Publish linien-client to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: linien-client/dist/
           password: ${{ secrets.TEST_PYPI_API_TOKEN_CLIENT }}
-          repository_url: https://test.pypi.org/legacy/
+          repository-url: https://test.pypi.org/legacy/
 
       - name: Publish linien-gui to TestPyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           packages-dir: linien-gui/dist/
           password: ${{ secrets.TEST_PYPI_API_TOKEN_GUI }}
-          repository_url: https://test.pypi.org/legacy/
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/pyinstaller-linux.yml

@@ -21,10 +21,10 @@ jobs:
         with:
           python-version: "3.10"
 
-      - name: Install dependencies
-        run: sudo apt-get install -y qt5-default qttools5-dev-tools binutils libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 libegl1-mesa
-
-      - run: pip install pyinstaller
+      - name: Install additional dependencies
+        run: |
+          sudo apt-get install -y qt5-default qttools5-dev-tools binutils libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 libegl1-mesa
+          pip install pyinstaller
 
       - name: Install linien-common
         working-directory: linien-common

.github/workflows/pyinstaller-windows.yml

@@ -4,6 +4,8 @@ on:
   workflow_dispatch:
   push:
     paths:
+      - .github/workflows/pyinstaller-windows.yml
+      - .github/actions/install-linien/**      
       - linien-common/**
       - linien-client/**
       - linien-gui/**
@@ -17,24 +19,11 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-
-      - run: pip install pyinstaller
-
-      - name: Install linien-common
-        working-directory: linien-common
-        run: pip install .
+      - name: Install Linien
+        uses: ./.github/actions/install-linien
 
-      - name: Install linien-client
-        working-directory: linien-client
-        run: pip install .
-
-      - name: Install linien-gui
-        working-directory: linien-gui
-        run: pip install .
+      - name: Install Pyinstaller
+        run: pip install pyinstaller
 
       - run: pyinstaller pyinstaller.spec
         working-directory: linien-gui

.github/workflows/pytest.yml

@@ -4,6 +4,8 @@ on:
   workflow_dispatch:
   push:
     paths:
+      - .github/workflows/pytest.yml
+      - .github/actions/install-linien/**
       - gateware/**
       - linien-common/**
       - linien-server/**
@@ -17,25 +19,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python 3.10
-        uses: actions/setup-python@v3
-        with:
-          python-version: "3.10"
+      - name: Check out repository
+        uses: actions/checkout@v3
 
-      - name: Install linien-common
-        working-directory: linien-common
-        run: pip install .
-
-      - name: Install linien-server
-        working-directory: linien-server
-        run: pip install .
+      - name: Install Linien
+        uses: ./.github/actions/install-linien
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install pytest migen pytest-plt git+https://github.com/m-labs/misoc
 
       - name: Test with pytest
-        run: |
-          pytest .
+        run: pytest .

README.md

@@ -26,13 +26,11 @@ Features
 -   **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.
+-   **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
     used to implement [combined
     FMS+MTS](https://arxiv.org/pdf/1701.01918.pdf)
--   **Logging**: Use
-    [linien-influxdb](https://github.com/linien-org/linien-influxdb)
-    to log the lock status to influxdb.
+-   **Logging**: Lock status and parameters can be logged to InfluxDB v2.
 -   **Second integrator** for slow control of piezo in an ECDL
 -   **Additional analog outputs** may be used using the GUI or python client (ANALOG_OUT 1, 2 and 3)
 -   **16 GPIO outputs** may be programmed (e.g. for controlling other devices)
@@ -137,7 +135,7 @@ The bright red line is the demodulated spectroscopy signal. The dark red area is
 
 Fast mode is intended for bare PID operation (no demodulation or filtering), bypassing most of the FPGA functionality. If enabled, the signal flow is FAST IN 1 → PID → FAST OUT 2. This is useful, if aiming for a high control bandwidth: fast mode reduces propagation delay from 320 ns to 125 ns which may make a difference when phase-locking lasers.
 
-### Optimization of spectroscopy parameters using machine learning (optional)
+### Optimization of spectroscopy parameters using machine learning
 
 Linien may use machine learning to maximize the slope of a line. As for the autolock, click and drag over the line you want to optimize. Then, the line is centered and the optimization starts. Please note that this only works if initially a distinguished zero-crossing is visible.
 
@@ -170,6 +168,12 @@ Linien implements two different autolock algorithms:
 
 If you have problems with the autolock, you may also lock manually. Activate the *Manual* tab and use the controls in the top (*Zoom* and *Position*) to center the line you want to lock to. Choose whether the target slope is rising or falling and click the green button.
 
+### Logging
+
+Linien has to option to log the lock status and parameters to an InfluxDB. Currently, only InfluxDB 2.x is supported. Logging can be configured via the Logging menu in the Linien GUI, but logging will continue even if the client is closed. Time stamps of the data points are determined by the InfluxDB, not by the RedPitaya. If updating/checking the InfluxDB credentials fails, there is additional information in the tool-tip of the fail indicator ❌.
+
+The parameter names are documented in [`parameters.py`](https://github.com/linien-org/linien/blob/master/linien-server/linien_server/parameters.py). The `signal_stats` parameter does contain statistics of the input and output signals, e.g. `control_signal_mean` or `monitor_signal_max`.
+
 Transfer function
 -----------------
 
@@ -230,19 +234,19 @@ c.parameters.gpio_p_out.value = 0b01010101 # 4 on, 4 off
 c.connection.root.write_registers()
 
 # it is also possible to set up a callback function that is called whenever a
-# parameter changes (remember to call `call_listeners()` periodically)
-def on_change(value):
+# parameter changes (remember to call `check_for_changed_parameters()` periodically)
+def callback(value):
     # this function is called whenever `my_param` changes on the server.
-    # note that this only works if `call_listeners` is called from
+    # note that this only works if `check_for_changed_parameters` is called from
     # time to time as this function is responsible for checking for
     # changed parameters.
     print('parameter arrived!', value)
 
-c.parameters.modulation_amplitude.on_change(on_change)
+c.parameters.modulation_amplitude.add_callback(callback)
 
 from time import sleep
 for i in range(10):
-    c.parameters.call_listeners()
+    c.parameters.check_for_changed_parameters()
     if i == 2:
         c.parameters.modulation_amplitude.value = 0.1 * Vpp
     sleep(.1)