MuxPi

https://muxpi.readthedocs.io/en/latest/
Admin
MuxPi is an open-source hardware and software board for automating testing and development tasks on...
Tokens:9,847
Snippets:160
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Enable and Start muxpi-power Service

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

On the MuxPi device, enable the muxpi-power service to start on boot and then start it immediately.

```bash
# systemctl enable muxpi-power.service
# systemctl start muxpi-power.service

```

--------------------------------

### Enable and Start muxpi-power Service

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Enables the muxpi-power service to start on boot and then starts the service immediately on the MuxPi device.

```bash
systemctl enable muxpi-power.service
systemctl start muxpi-power.service
```

--------------------------------

### Get MuxPi and Navigate to Directory

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Fetch the MuxPi project using 'go get' and change the directory to the nanopi software path.

```bash
$ go get github.com/SamsungSLAV/muxpi
$ cd $GOPATH/src/github.com/SamsungSLAV/muxpi/sw/nanopi

```

--------------------------------

### Download Go Dependencies

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Downloads all necessary dependencies for the MuxPi project using 'go get'.

```bash
go get ./...
```

--------------------------------

### Download Go Dependencies

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Download all project dependencies using the 'go get ./...' command.

```bash
$ go get ./...

```

--------------------------------

### Enable and Start stm Sockets

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Reload the systemd daemon and enable/start the stm.socket and stm-user.socket services.

```bash
# systemctl daemon-reload
# systemctl enable stm.socket stm-user.socket
# systemctl start stm.socket stm-user.socket

```

--------------------------------

### Extract Armbian Image

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Uncompress the downloaded .7z file using the '7z e' command. Install p7zip-full on Debian-based systems with 'apt-get install p7zip-full'.

```console
$ 7z e Debian_*
```

--------------------------------

### Build MuxPi Software with Docker

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Builds the MuxPi software using Docker. Ensure Docker and Make are installed. Resulting binaries are placed in the 'bin' directory.

```bash
make docker-build
```

--------------------------------

### Download Armbian Image

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Use wget to download the Armbian image. Ensure wget is installed on Debian-based systems using 'apt-get install wget'.

```console
$ wget https://dl.armbian.com/nanopineo/Debian_stretch_next.7z
```

--------------------------------

### Install DHCP Server

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Install the isc-dhcp-server package on the MuxPi. This enables the device to act as a DHCP server.

```bash
# apt-get install isc-dhcp-server

```

--------------------------------

### Download Armbian OS Image

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Use wget to download the Armbian OS image. Ensure wget is installed on your system.

```bash
$ wget https://dl.armbian.com/nanopineo/Debian_stretch_next.7z

```

--------------------------------

### Uncompress Armbian OS Image

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Extract the downloaded .7z file using the 7z command. Ensure p7zip-full is installed.

```bash
$ 7z e Debian_*

```

--------------------------------

### Set Static IP Address

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Configure a static IP address for the eth0 interface by creating or editing '/etc/network/interfaces.d/eth0'. This example assumes the MuxPi will have IP 192.168.0.2 on a network with gateway 192.168.0.1.

```none
auto eth0
allow-hotplug eth0
iface eth0 inet static
	address 192.168.0.2
	netmask 255.255.255.0
	gateway 192.168.0.1
```

--------------------------------

### Enable and Start stm Sockets

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Reloads the systemd daemon and enables/starts the 'stm.socket' and 'stm-user.socket' services. These sockets are required for the stm service to operate correctly.

```bash
systemctl daemon-reload
systemctl enable stm.socket stm-user.socket
systemctl start stm.socket stm-user.socket
```

--------------------------------

### Build MuxPi Software with Docker

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Use the make command with the docker-build target to compile MuxPi software when Docker is available.

```bash
$ make docker-build

```

--------------------------------

### Build MuxPi Binaries from Source

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Compile the stm and fota binaries for the ARM architecture, specifying GOARCH and GOOARM. Ensure the bin directory exists.

```bash
$ mkdir -p bin
$ GOARCH=arm GOOARM=7 GOOS=linux go build -o bin/stm ./cmd/stm/
$ GOARCH=arm GOOARM=7 GOOS=linux go build -o bin/fota ./cmd/fota/

```

--------------------------------

### Build MuxPi Binaries from Source

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Builds the 'stm' and 'fota' binaries for the MuxPi device. Ensure the correct GOARCH, GOOARM, and GOOS environment variables are set for ARM architecture.

```bash
mkdir -p bin
GOARCH=arm GOOARM=7 GOOS=linux go build -o bin/stm ./cmd/stm/
GOARCH=arm GOOARM=7 GOOS=linux go build -o bin/fota ./cmd/fota/
```

--------------------------------

### Create stm Group and Add User

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

On the MuxPi device, create a group named 'stm' and add the user 'pi' to this group.

```bash
# groupadd stm
# usermod -aG stm pi

```

--------------------------------

### Connect via SSH

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Connect to the device using SSH with the configured IP address and root credentials.

```bash
$ ssh root@192.168.0.2

```

--------------------------------

### Clone MuxPi Repository

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Clone the MuxPi repository and navigate to the software directory for the NanoPi board.

```bash
git clone https://github.com/SamsungSLAV/muxpi.git && cd muxpi/sw/nanopi
```

--------------------------------

### Configure eth1 Interface for Static IP

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Set up the eth1 interface with a static IP address. This is typically done in a network configuration file.

```bash
# vim /etc/network/interfaces.d/eth1

```

```text
auto eth1
allow-hotplug eth1
iface eth1 inet static
  address 192.168.69.1
  netmask 255.255.255.0

```

--------------------------------

### Login to Armbian

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Log in to the Armbian system with the default credentials. The password was '1234' at the time of writing; check Armbian's FAQ if it fails.

```console
login: root
password 1234
```

--------------------------------

### Clone MuxPi Repository

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Clone the MuxPi repository and navigate to the software directory for building binaries.

```bash
$ git clone https://github.com/SamsungSLAV/muxpi.git && cd muxpi/sw/nanopi

```

--------------------------------

### Connect via Serial Console

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Connect to the device's serial console using screen or minicom. Adjust ttyUSB0 to your serial port.

```bash
# screen /dev/ttyUSB0 115200

```

```bash
# minicom -b 115200 -D /dev/ttyUSB0

```

--------------------------------

### Connect to DUT via Screen or Minicom

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Establish a serial connection to the DUT using either `screen` or `minicom`. Ensure the baud rate matches the DUT's configuration.

```bash
# screen /dev/ttyS1 115200

```

```bash
# minicom -b 115200 -D /dev/ttyUSB0

```

--------------------------------

### Configure eth1 Interface for Static IP

Source: https://muxpi.readthedocs.io/en/latest/_sources/dut-setup.txt

Configure the eth1 interface with a static IP address. This is a prerequisite for setting up a DHCP server.

```none
auto eth1
allow-hotplug eth1
iface eth1 inet static
	address 192.168.69.1
	netmask 255.255.255.0
```

--------------------------------

### Create stm Group and Add User

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Creates a new group named 'stm' and adds the user 'pi' to this group on the MuxPi device. This is a prerequisite for running the stm service.

```bash
groupadd stm
usermod -aG stm pi
```

--------------------------------

### Configure Static IP Address

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Create or edit the eth0 network interface configuration file to set a static IP address.

```bash
# vim /etc/network/interfaces.d/eth0

```

```text
auto eth0
allow-hotplug eth0
iface eth0 inet static
  address 192.168.0.2
  netmask 255.255.255.0
  gateway 192.168.0.1

```

--------------------------------

### Flash Armbian Image to SD Card

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Copy the extracted Armbian image to the SD card using the dd command. Ensure '/dev/sdX' is correctly identified as the SD card to avoid data loss. Wildcards are not supported by dd.

```console
# dd bs=1M if=Armbian_*.img of=/dev/sdX
```

--------------------------------

### Connect to DUT via UART using Screen or Minicom

Source: https://muxpi.readthedocs.io/en/latest/_sources/dut-setup.txt

Connect to the DUT using either the 'screen' or 'minicom' utility. Ensure the baud rate matches the settings configured for the UART connection.

```bash
screen /dev/ttyS1 115200
```

```bash
minicom -b 115200 -D /dev/ttyUSB0
```

--------------------------------

### Create fota Symlink

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Create a symbolic link for the fota binary, pointing from /usr/local/bin/fota to /usr/bin/fota. This allows for easier swapping of fota implementations.

```bash
# ln -s /usr/bin/fota /usr/local/bin/fota

```

--------------------------------

### Connect via Serial Console (minicom)

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Connect to the NanoPi's serial console using minicom. Adjust '/dev/ttyUSB0' to your specific serial port. The baud rate is 115200.

```console
# minicom -b 115200 -D /dev/ttyUSB0
```

--------------------------------

### Configure UARTs with armbian-config

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Use the armbian-config tool to enable UARTs for communication with MuxPi's stm and DUT. Reboot after enabling.

```bash
# armbian-config

```

--------------------------------

### Connect via Serial Console (screen)

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Connect to the NanoPi's serial console using screen. Adjust '/dev/ttyUSB0' to your specific serial port. The baud rate is 115200.

```console
# screen /dev/ttyUSB0 115200
```

--------------------------------

### Create Symlink for fota

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Creates a symbolic link for the 'fota' binary, pointing from '/usr/local/bin/fota' to '/usr/bin/fota'. This allows software to interface with fota through a consistent path.

```bash
ln -s /usr/bin/fota /usr/local/bin/fota
```

--------------------------------

### Copy stm Binary and Systemd Files to MuxPi

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Copies the 'stm' binary, and its associated systemd service and socket files to the MuxPi device using scp.

```bash
scp bin/stm root@192.168.0.2:/usr/bin/
scp stm/systemd/stm.service root@192.168.0.2:/etc/systemd/system
scp stm/systemd/stm-user.socket root@192.168.0.2:/etc/systemd/system
scp stm/systemd/stm.socket root@192.168.0.2:/etc/systemd/system
scp stm/stm root@192.168.0.2:/usr/local/bin/stm
```

--------------------------------

### Armbian Login Credentials

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Default login credentials for Armbian on Nanopi Neo. The password may change; consult Armbian FAQ if it fails.

```text
login: root
password 1234

```

--------------------------------

### Configure UARTs with armbian-config

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Use the armbian-config tool to enable UART1 and UART2. Internet connection is not required for this step. Reboot after enabling the interfaces.

```console
# armbian-config
```

--------------------------------

### List Disk Devices

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Identify the SD card device name (e.g., /dev/sdX) using the fdisk -l command.

```console
# fdisk -l
```

--------------------------------

### Verify Image Checksum

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Check the integrity of the downloaded and unpacked image using sha256sum. The output should match the contents of the sha256sum.sha file.

```console
$ sha256sum Armbian_*.img
```

--------------------------------

### Copy fota Binary to MuxPi

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Copies the 'fota' binary to the MuxPi device using scp.

```bash
scp bin/fota root@192.168.0.2:/usr/bin/
```

--------------------------------

### Copy stm Binary and Systemd Files

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Transfer the stm binary, and its associated systemd service and socket files to the MuxPi device.

```bash
$ scp bin/stm root@192.168.0.2:/usr/bin/
$ scp stm/systemd/stm.service root@192.168.0.2:/etc/systemd/system
$ scp stm/systemd/stm-user.socket root@192.168.0.2:/etc/systemd/system
$ scp stm/systemd/stm.socket root@192.168.0.2:/etc/systemd/system
$ scp stm/stm root@192.168.0.2:/usr/local/bin/stm

```

--------------------------------

### Copy fota Binary to MuxPi

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Transfer the fota binary to the MuxPi device using scp.

```bash
$ scp bin/fota root@192.168.0.2:/usr/bin/

```

--------------------------------

### Verify Image Copy

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Confirm the image was copied correctly by comparing the checksum of the SD card device with the original image checksum.

```bash
# sha256sum /dev/sdX

```

--------------------------------

### Copy Image to SD Card

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Use dd to copy the Armbian image to the SD card. Ensure the correct device path is used to avoid data loss.

```bash
# dd bs=1M if=Armbian_*.img of=/dev/sdX

```

--------------------------------

### Copy muxpi-power Files to MuxPi

Source: https://muxpi.readthedocs.io/en/latest/install-sw.html

Transfer the muxpi-power executable and its systemd service file to the MuxPi device using scp.

```bash
$ scp power/muxpi-power root@192.168.0.2:/usr/bin
$ scp power/systemd/muxpi-power.service root@192.168.0.2:/etc/systemd/system

```

--------------------------------

### Connect via SSH

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Connect to the Armbian device using SSH with the configured IP address. If connection fails, restart the device via serial console.

```console
$ ssh root@192.168.0.2
```

--------------------------------

### Verify SD Card Image Copy

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Confirm the image was copied correctly to the SD card by checking its checksum.

```console
# sha256sum /dev/sdX
```

--------------------------------

### Restart Networking Service

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Apply network configuration changes by restarting the networking service.

```console
# systemctl restart networking
```

--------------------------------

### Restart Networking Service

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Apply network configuration changes by restarting the networking service or rebooting the device.

```bash
# systemctl restart networking

```

```bash
# shutdown -r now

```

--------------------------------

### Copy muxpi-power Files to MuxPi

Source: https://muxpi.readthedocs.io/en/latest/_sources/install-sw.txt

Copies the muxpi-power executable and its systemd service file to the MuxPi device using scp. Assumes MuxPi is accessible at 192.168.0.2.

```bash
scp power/muxpi-power root@192.168.0.2:/usr/bin
scp power/systemd/muxpi-power.service root@192.168.0.2:/etc/systemd/system
```

--------------------------------

### Identify SD Card Device

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

List block devices using fdisk to identify the correct device name for your SD card.

```bash
# fdisk -l

```

--------------------------------

### Configure DHCP Address Assignment

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Set up the DHCP server to always assign a specific IP address range. This ensures consistent IP assignment for connected devices.

```bash
# vim /etc/dhcp/dhcpd.conf

```

```text
subnet 192.168.69.0 netmask 255.255.255.0 {
  range 192.168.69.10 192.168.69.10;
}

```

--------------------------------

### Change Root Password

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Prompt to change the root password immediately after the first login.

```text
You are required to change your password immediately (root enforced)
Changing password for root.
(current) UNIX password:
Enter new UNIX password:
Retype new UNIX password:

```

--------------------------------

### Configure DHCP Server Interface

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Specify the network interface that the DHCP server will use. This is configured in the default settings file for the DHCP server.

```bash
# vim /etc/default/isc-dhcp-server

```

```text
INTERFACESv4="eth1"
#INTERFACESv6=""

```

--------------------------------

### Verify Image Checksum

Source: https://muxpi.readthedocs.io/en/latest/armbian.html

Check the integrity of the unpacked image file using sha256sum.

```bash
$ sha256sum Armbian_*.img

```

--------------------------------

### Set Terminal Options for DUT Serial Connection

Source: https://muxpi.readthedocs.io/en/latest/dut-setup.html

Configure serial terminal settings for the DUT connection using the `stty` command. Adjust parameters like baud rate and character size as needed.

```bash
# stty -F /dev/ttyS1 115200 cs8 -cstopb -parenb

```

--------------------------------

### Reboot Device

Source: https://muxpi.readthedocs.io/en/latest/_sources/armbian.txt

Restart the device to apply network configuration changes or after system updates.

```console
# shutdown -r now
```

--------------------------------

### Set DHCP Server Interface

Source: https://muxpi.readthedocs.io/en/latest/_sources/dut-setup.txt

Specify the network interface on which the DHCP server will operate. This ensures the server listens on the correct interface.

```bash
INTERFACESv4="eth1"
#INTERFACESv6=""
```

--------------------------------

### Set Terminal Options for DUT Serial Connection

Source: https://muxpi.readthedocs.io/en/latest/_sources/dut-setup.txt

Configure serial terminal options for the DUT. Adjust the baud rate, data bits, stop bits, and parity to match your UART connection requirements.

```bash
stty -F /dev/ttyS1 115200 cs8 -cstopb -parenb
```

--------------------------------

### Configure DHCP Server Address Assignment

Source: https://muxpi.readthedocs.io/en/latest/_sources/dut-setup.txt

Configure the DHCP server to always assign a specific IP address within the defined subnet. This is useful for devices that require a static IP from the DHCP server.

```bash
subnet 192.168.69.0 netmask 255.255.255.0 {
  range 192.168.69.10 192.168.69.10;
}
```
Tokens:
Raw