M-Labs/nix-servo
4
1
Fork 2
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity
Firmware for Sinara Fast-Servo based on Not-OS and Linien
157 Commits 1 Branch 0 Tags 411 KiB
C 89.3%
Python 7.1%
Nix 1.9%
Verilog 1.7%
5911049456
Go to file
linuswck 5911049456 Add README Descriptions 
- Network Settings
- SSH Public Key
- Networing ports requried
- ssh is not required to access linien-server
2025-02-14 18:30:27 +08:00
fast-servo gui: do not check for new gui version 2025-01-17 11:58:47 +08:00
not-os-patches Add user-defined ip-patch 2025-02-14 18:30:24 +08:00
.gitignore add __pycache__ 2024-03-01 16:39:56 +08:00
flake.lock flake: update dependencies 2025-01-15 23:03:38 +08:00
flake.nix Add user-defined ip-patch 2025-02-14 18:30:24 +08:00
README.md Add README Descriptions 2025-02-14 18:30:27 +08:00

README.md

Firmware for the Sinara 8462 Fast-Servo

Networking Ports

Usage Port Number
ssh 3030
linien-server 18862

Building

Reproducible build with Nix

  1. Run nix build .#packages.armv7l-linux.fast-servo-sd-image to build the sd card image.
  2. Run nix develop to build a dev shell to access the GUI.

Flashing

  1. Plug in your SD card to your computer and run lsblk to locate SD card
  2. If there are any partitions on the SD card, run umount <mount point> all the related mount points.
  3. Run sudo dd if=<path to the SD Card Image> of=/dev/<SD Card Device Name in lsblk> bs=4M status=progress oflag=sync
  4. Eject the SD Card before removal

Configuration

You can modify the followings by altering the files directly on the SD card. You can do that by inserting the SD card to a computer in Linux Operating system.

  1. Network Settings
  • File Location: /etc/ip_setup
  • Description: It contains the network setup script that is run once during initialization. You can add any network related to scripts to this file.
  1. SSH Public Key
  • File Location: /etc/ssh/authorized_keys.d/root
  • Description: SSH Public key authentication file.

You should append the ssh public key of your PC here with hostname removed.

  • Instructions:
    1. Run ssh-keygen
    2. Type a filename for key to be saved. Let's say foo.
    3. Type Return(Enter) twice when it asks for your passphrase. Fast-servo's ssh authentication is passwordless.
    4. Open the generated public key file foo.pub.
    5. Append the public key to the file /etc/ssh/authorized_keys.d/root with @hostname removed. Sample ssh public key: ssh-ed25519 xxx...xxx username@hostname

Usage

  1. Make sure the onboard DIP Switch is in the following condition.

    • EN: OFF
    • MODE: ON

  2. Install the SD Card, power up the board via the power jack or PoE and plug in the RJ45 Ethernet cable.

  3. Wait for all the front panel LEDs except the termination status LEDs to turn off. It can take a minutes or two for first boot. If it does not boot up, try to flash the SD Card again.

  4. By default, linien-server starts up automatically. In case linien-server crashes, it will restart itself. Logs are stored in /root/linien-server-log. ssh access is not required for linien client if linien-server is started. If not, then linien client will ssh into the fast-servo device to start the linien-server service.

    Here are some commands to interact with the linien-server service once you ssh <fast servo ip address> -p 3030 into fast-servo.

Description Command
Start the linien-server service linien-server start
Stop the linien-server service linien-server stop
Check if the linien-server service is running linien-server status
Set the linien-server service to start at bootup linien-server enable
Set the linien-server service not to start at bootup linien-server disable
  1. In the dev shell, run linien to launch the GUI. Add new device. Username is root.
  2. Select the newly added device and click connect in the GUI to connect and start the GUI.