Skip to content

Commit cbd08fc

Browse files
committed
Refresh net devices docs
1 parent 1db7c97 commit cbd08fc

File tree

4 files changed

+14
-17
lines changed

4 files changed

+14
-17
lines changed

docs/images/net-devices-clone.png

58.5 KB
Loading

docs/images/net-devices-list.png

225 KB
Loading

docs/images/net-devices-mobile.png

105 KB
Loading

docs/net-devices.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,21 @@ The following network devices are supported:
1515
- Mobile data adapter with built-in router
1616
- USB connected smartphone (USB tethering)
1717

18-
All devices require a driver in order to be available for use with RaspAP.
18+
!!! note "Note"
19+
All devices require a compatible Linux driver in order to be available for use with RaspAP.
1920

2021
## Listing detected devices
21-
The **Networking > Devices** tab displays a list of available devices with their attributes and assumed adapter type. The adapter type as well as the device name may be changed.
22-
Incorrect device types might appear for some devices, which advertise themselves to the system as an ethernet (e.g. `eth0`) or usb (e.g. `usb0`) device. This often happens for USB connected phones and external routers.
23-
24-
![Networking: Network devices](https://user-images.githubusercontent.com/229399/116096642-bf0e4780-a6a9-11eb-9794-6935b0858b9b.png)
22+
The **Networking > Devices** tab displays a list of available devices with their attributes and assumed adapter type. Incorrect device types might appear for some devices, which advertise themselves to the system as an ethernet (for example, `eth0`) or usb (`usb0`) device. This often happens for USB connected phones and external routers.
2523

26-
### Changing the device name
27-
Changing the name helps to distinguish different devices. This is especially important if, for example, the **Access Point** device is connected via USB and the automatically assigned name is changed.
28-
This can sometimes occur when devices are connected in varying order.
24+
![Networking: Network devices](images/net-devices-list.png)
2925

30-
To modify a device's name, enter a value in the **Fixed name** field and choose **Change**.
26+
### Changing the device type
27+
The type may be changed for devices with an associated Vendor ID (vid) and Product ID (pid). To modify a device's type, select an option from the **Device type** drop-down and choose **Update**.
3128

32-
The only restriction for the device name is that it must only contain lowercase letters and numbers. The maximal length is limited to 20 characters. Devices names are automatically filtered accordingly.
29+
This will read from RaspAP's canonical UDEV [prototype definitions](net-devices.md#configuration-files) and assign the desired type to the device. These values are persisted in RaspAP's custom UDEV rules located in `/etc/udev/rules.d/80-raspap-net-devices.rules`.
3330

3431
### Changing the MAC address
35-
Sometimes you might need to set the MAC address of the WLAN interface to be the same as your PC or some other device on your network. This is known as MAC address cloning.
32+
Sometimes you might need to set the MAC address of the WLAN interface to be the same as your PC or some other device on your network. This is known as _MAC address cloning_.
3633

3734
For example, some ISPs register your computer's MAC address when the service is first installed. When you place a router behind the cable or ADSL modem, the MAC address from the device WLAN port will not be recognized by the ISP.
3835

@@ -42,10 +39,10 @@ You can clone the MAC address of the WLAN interface (or any other valid interfac
4239

4340
1. Open the **Networking > Devices** tab.
4441
2. Choose a MAC address for the interface you wish to clone.
45-
3. Enter a valid address in the **MAC** field and click or tap **Change**.
42+
3. Enter a valid address in the **MAC** field and choose **Update**.
4643
4. The new MAC address will be configured immediately.
4744

48-
![image](https://user-images.githubusercontent.com/229399/193248142-8838f585-aeef-4ef0-8aef-109ff9dd338e.png){: style="width:575px"}
45+
![MAC address cloning](images/net-devices-clone.png)
4946

5047
!!! note "Note"
5148
Virtual interfaces such as OpenVPN's `tun0` or WireGuard's `wg0` do not have this capability. To avoid potential conflicts, change the MAC address and reconnect the device before modifying any other settings.
@@ -61,14 +58,14 @@ These devices are usually listed with the automatically assigned device name pre
6158
name to the device.
6259

6360
Wireless devices will only appear if a supported driver exists in the currently installed OS. If your device does not appear in the list, this usually indicates that a required device driver is missing.
64-
The helper script [install_wlan_driver_modules.sh](https://github.com/RaspAP/raspap-tools/blob/main/install_raspap_ram_wlan.sh) available in [RaspAP/raspap-tools](https://github.com/RaspAP/raspap-tools)
65-
can be used to search for and install existing driver modules.
6661

6762
## Mobile data modems
68-
Modems or Point-to-Point Protocol (ppp) devices require login data. This includes a PIN number to unlock the SIM card, the Access Point Name (APN) and login data of your mobile network provider.
63+
Modems or Point-to-Point Protocol (`ppp`) devices require login data. This includes a PIN number to unlock the SIM card, the Access Point Name (APN) and login data of your mobile network provider.
6964
These values may be entered under the **Networking > Mobile Data** tab.
7065

71-
![image](https://user-images.githubusercontent.com/229399/116100321-182baa80-a6ad-11eb-9fd5-4a3bc22b9388.png){: style="width:375px"}
66+
![Mobile data settings](images/net-devices-mobile.png){: style="width:375px"}
67+
68+
Enter the SIM card PIN number, specify the your provider's APN and login credentials, then choose **Save settings**.
7269

7370
Values entered here are stored in the file `/etc/wvdial.conf`. This configuration file contains the basic configuration needed to unlock the SIM card and connect
7471
to the network. This has been tested with a Huawei E1550. If your device requires different AT-commands, you will need to manually change this configuration.

0 commit comments

Comments
 (0)