Skip to content

Commit bd3bb70

Browse files
committed
WifiPerformance: drop stale "Adding a New Device" guide
The step-by-step onboarding guide (manual UDEV rules, Tailscale VPN enrolment, per-contributor NetBox site/device registration) no longer reflects how devices join the lab. Onboarding is now handled by the autotests scan-daemon discovering boards on the lab subnets and reconciling NetBox. Remove the outdated section and point the Contribute link at the armbian/autotests repo. Signed-off-by: Igor Pecovnik <igor@armbian.com>
1 parent 899a9ae commit bd3bb70

1 file changed

Lines changed: 1 addition & 143 deletions

File tree

docs/WifiPerformance.md

Lines changed: 1 addition & 143 deletions
Original file line numberDiff line numberDiff line change
@@ -1419,154 +1419,12 @@ This section presents the performance test results, including key metrics and te
14191419

14201420
## Contribute
14211421

1422-
- Assist us in developing and maintaining our testing system: Your expertise can help us enhance and optimize [our test infrastructure](https://github.com/armbian/armbian.github.io/actions/workflows/usb-wireless-autotest.yml). By contributing your skills, you can play a key role in ensuring the accuracy and reliability of our test results.
1422+
- Assist us in developing and maintaining our testing system: Your expertise can help us enhance and optimize [our test infrastructure](https://github.com/armbian/autotests). By contributing your skills, you can play a key role in ensuring the accuracy and reliability of our test results.
14231423

14241424
- Donate hardware: Your contribution of new hardware, whether it’s a wireless adapter or any other equipment, helps us expand our testing capabilities. We’re specifically looking for [new wireless adapters](https://www.amazon.de/hz/wishlist/ls/1GA17IGQ2MF0V?ref_=wl_share) that haven’t yet been added to our system. Your donation can directly impact the scope and depth of our tests.
14251425

14261426
- Join our team: Become part of our passionate and dedicated team. We’re looking for [individuals who share our vision and are eager to contribute to the development of innovative testing solutions](https://forum.armbian.com/staffapplications/). Whether you have technical expertise or simply a willingness to learn, there’s a place for you here!
14271427

1428-
1429-
## Adding a New Device
1430-
1431-
This guide provides step-by-step instructions to add a new device (SBC SDIO, PCI or USB adapter) to the wireless testing infrastructure.
1432-
1433-
### 1. Prepare the Host Machine
1434-
1435-
- Ensure the board and wireless device is supported by Armbian.
1436-
- Flash Armbian image and configure basic settings
1437-
- Set hostname that reflects wireless test device (eg. rtl3070, wifiserver)
1438-
1439-
```bash
1440-
sudo hostnamectl set-hostname rtl3070
1441-
```
1442-
1443-
### 2. Identify Network Interfaces
1444-
1445-
- Use `ip link` or `iw dev` to list available interfaces.
1446-
- Identify MAC address and interface name (e.g., `wlan0`, `wlxMAC`, etc.).
1447-
1448-
### 3. Create a UDEV Rule
1449-
1450-
!!! warning
1451-
1452-
This step is only necessary if your network device does not have a predictable interface name.
1453-
1454-
- Use a predictable name like `wl<MAC>` to avoid interface conflicts.
1455-
- Add rule in `/etc/udev/rules.d/70-persistent-net.rules`:
1456-
1457-
```bash
1458-
SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="xx:xx:xx:xx:xx:xx", NAME="wl<MAC>"
1459-
```
1460-
1461-
### 4. Get VPN access
1462-
1463-
The `TAILSCALE_AUTH_KEY` and access credentials for NetBox must be provided by the Armbian administration team. For assistance, please contact us via [https://www.armbian.com/contact/](https://www.armbian.com/contact/).
1464-
1465-
### 5. Prepare the machine
1466-
1467-
- Creates a new user (`ci`) with sudo privileges
1468-
- Configures SSH for key-based authentication only
1469-
- Installs and configures Tailscale for secure remote access
1470-
- Installs `iperf3` for network performance testing
1471-
1472-
```bash
1473-
#!/bin/bash
1474-
1475-
set -e
1476-
1477-
USERNAME="ci"
1478-
KEY_URL="https://github.armbian.com/ci.asc"
1479-
TAILSCALE_AUTH_KEY="tskey-auth-kXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
1480-
1481-
echo "[+] Creating user '$USERNAME' without password"
1482-
useradd -m -s /bin/bash "$USERNAME"
1483-
passwd -d "$USERNAME"
1484-
usermod -aG sudo "$USERNAME"
1485-
1486-
echo "[+] Setting up SSH key from $KEY_URL"
1487-
SSH_DIR="/home/$USERNAME/.ssh"
1488-
mkdir -p "$SSH_DIR"
1489-
curl -fsSL "$KEY_URL" -o "$SSH_DIR/authorized_keys"
1490-
chmod 700 "$SSH_DIR"
1491-
chmod 600 "$SSH_DIR/authorized_keys"
1492-
chown -R "$USERNAME:$USERNAME" "$SSH_DIR"
1493-
1494-
echo "[+] Disabling password authentication in SSH config"
1495-
sed -i 's/^#*\s*PasswordAuthentication.*/PasswordAuthentication no/' /etc/ssh/sshd_config
1496-
sed -i 's/^#*\s*PermitEmptyPasswords.*/PermitEmptyPasswords no/' /etc/ssh/sshd_config
1497-
systemctl restart ssh
1498-
1499-
echo "[+] Installing Tailscale"
1500-
curl -fsSL https://tailscale.com/install.sh | sh
1501-
1502-
echo "[+] Bringing up Tailscale with provided auth key"
1503-
tailscale up --auth-key="$TAILSCALE_AUTH_KEY"
1504-
1505-
echo "[+] Installing iperf3 (non-interactive, no daemon)"
1506-
export DEBIAN_FRONTEND=noninteractive
1507-
apt-get update -qq
1508-
apt-get install -yqq iperf3
1509-
1510-
echo "[✔] Setup complete. User '$USERNAME' added, SSH key installed, Tailscale connected."
1511-
```
1512-
1513-
### 6. Register Your Location
1514-
1515-
Access: <https://netbox.armbian.com/dcim/sites/>
1516-
1517-
- Sites in NetBox represent physical locations of wireless test equipment.
1518-
- Each site have devices such as Access Points (APs), iperf3 servers, and wireless test clients.
1519-
- Register your testing location first if it doesn't exist yet. Create a new site with a clear name (e.g., Office Berlin, Lab Maribor) and add necessary data.
1520-
1521-
!!! warning
1522-
Make sure to check if site is not already define to not clutter database!
1523-
1524-
???+ success "Update Relevant Information"
1525-
1526-
- Access point SSID: `Your SSID`
1527-
- Iperf3 server IP: your local `IP address` that runs iperf3 server and can be accessible from wireless client
1528-
1529-
### 7. Register Device Type
1530-
1531-
Add [new device type](https://netbox.armbian.com/dcim/manufacturers/61/)
1532-
1533-
???+ success "Relevant data"
1534-
1535-
- Model name (CAPS): AIC8800
1536-
- Manufacturer: Generic
1537-
- Add image of the device in full HD (1920x1080) with exact same name as model AIC8800.png (CAPS name, lowercase extension)
1538-
1539-
!!! warning
1540-
1541-
Skip this step if WiFi SoC already exists in database.
1542-
1543-
### 8. Register Device
1544-
1545-
???+ success "Relevant data"
1546-
1547-
- Name: Compex WLE900VX (use commercial name)
1548-
- Device role: WiFi DUT
1549-
- Tags: USB Wireless
1550-
- Manufacturer: Generic
1551-
- Device type: AIC8800 (select the one you added previously)
1552-
- Serial number: 04:f0:21:2c:75:14 (MAC address)
1553-
- Location: where you are
1554-
- Site: name of your office, defined in previous step
1555-
- Custom Fields / class: AC (wifi classes: AX, AC, N)
1556-
1557-
- Add virtual interface (Add Components -> Interfaces)
1558-
1559-
???+ success "Relevant data"
1560-
1561-
- Name: `tailscale0`
1562-
- Type: `virtual`
1563-
1564-
Then select interface `tailscale0` and add `IP address`. Copy `IP address` from your device (example: 100.115.0.58/32) and select: Make this the primary IP for the device/VM
1565-
1566-
### 9. Run Initial Test
1567-
1568-
Run the [Wireless Performance Autotest workflow](https://github.com/armbian/armbian.github.io/actions/workflows/wireless-performance-autotest.yml) to verify whether the newly added device has been included in the test pool.
1569-
15701428
## Other resources
15711429

15721430
- [USB WiFi Adapter Information for Linux](https://github.com/morrownr/USB-WiFi)

0 commit comments

Comments
 (0)