search

linien-org / linien

Spectroscopy lock application using RedPitaya
GNU General Public License v3.0
74 stars 19 forks source link

README script error for linien-client 2.0.4 #411

Closed Andrew-wi closed 3 months ago

Andrew-wi commented 5 months ago

This is a very minor "bug", but the README includes a script for installing linien-server on the RedPitaya that does not execute. The script is:

from linien_client.device import Device
from linien_client.deploy import install_remote_server

device = Device(
    host="rp-xxxxxx.local",
    user="root",
    password="root"    
)
instalL_remote_server(device)

However, there are two errors. First, user is not a valid field name in the Device class constructor, as can be seen in the source code in linien/linien-client/linien-client/device.py, line 45; the correct code in the sample script should be username="root". Second, the last line in the README script has an extra capital L. This is easily fixed with replacement by install_remote_server(device), the method imported in the second line.

Minor fixes.

Device: STEMlab 125-14 LN RedPitaya OS 2.00-30

Andrew-wi commented 5 months ago

I also noticed that throughout the README documentation sample scripts, it appears that the authors have user instead of username as a field for the Device class constructor. See, for example, the script using linien-client which prints the modulation frequency and changes the voltages on the GPIO pins.

bleykauf commented 3 months ago

Thank you, will be fixed via #420.