diff --git a/docs/NETWORK_TREE.md b/docs/NETWORK_TREE.md index e61ca6c9..cbf1fcfe 100755 --- a/docs/NETWORK_TREE.md +++ b/docs/NETWORK_TREE.md @@ -1,6 +1,6 @@ ## How to Set Up Your Network Page -The **Network** page lets you map how devices connect — visually and logically. +The **Network** page lets you map how devices connect — visually and logically. It’s especially useful for planning infrastructure, assigning parent-child relationships, and spotting gaps. ![Network tree details](./img/NETWORK_TREE/Network_Sample.png) @@ -9,11 +9,11 @@ To get started, you’ll need to define at least one root node and mark certain --- -Start by creating a root device with the MAC address `Internet`, if the application didn’t create one already. -This special MAC address (`Internet`) is required for the root network node — no other value is currently supported. +Start by creating a root device with the MAC address `Internet`, if the application didn’t create one already. +This special MAC address (`Internet`) is required for the root network node — no other value is currently supported. Set its **Type** to a valid network type — such as `Router` or `Gateway`. -> [!TIP] +> [!TIP] > If you don’t have one, use the [Create new device](./DEVICE_MANAGEMENT.md#dummy-devices) button on the **Devices** page to add a root device. --- @@ -21,15 +21,15 @@ Set its **Type** to a valid network type — such as `Router` or `Gateway`. ## ⚡ Quick Setup 1. Open the device you want to use as a network node (e.g. a Switch). -2. Set its **Type** to one of the following: - `AP`, `Firewall`, `Gateway`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` +2. Set its **Type** to one of the following: + `AP`, `Firewall`, `Gateway`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` *(Or add custom types under **Settings → General → `NETWORK_DEVICE_TYPES`**.)* 3. Save the device. 4. Go to the **Network** page — supported device types will appear as tabs. 5. Use the **Assign** button to connect unassigned devices to a network node. 6. If the **Port** is `0` or empty, a Wi-Fi icon is shown. Otherwise, an Ethernet icon appears. -> [!NOTE] +> [!NOTE] > Use [bulk editing](./DEVICES_BULK_EDITING.md) with _CSV Export_ to fix `Internet` root assignments or update many devices at once. --- @@ -42,20 +42,22 @@ Let’s walk through setting up a device named `raspberrypi` to act as a network ### 1. Set Device Type and Parent -- Go to the **Devices** page +- Go to the **Devices** page - Open the device detail view for `raspberrypi` - In the **Type** dropdown, select `Switch` ![Device details](./img/NETWORK_TREE/Network_Device_Details.png) -- Optionally assign a **Parent Node** (where this device connects to) and the **Relationship type** of the connection. +- Optionally assign a **Parent Node** (where this device connects to) and the **Relationship type** of the connection. The `nic` relationship type can affect parent notifications — see the setting description and [Notifications documentation](./NOTIFICATIONS.md) for more. +- A device’s parent MAC will be overwritten by plugins if its current value is any of the following: "null", "(unknown)" "(Unknown)". +- If you want plugins to be able to overwrite the parent value (for example, when mixing plugins that do not provide parent MACs like `ARPSCAN` with those that do, like `UNIFIAPI`), you must set the setting `NEWDEV_devParentMAC` to None. -![Device details](./img/NETWORK_TREE/Network_Device_Details_Parent.png) +![Device details](./img/NETWORK_TREE/Network_Device_Details_Parent.png) -> [!NOTE] -> Only certain device types can act as network nodes: -> `AP`, `Firewall`, `Gateway`, `Hypervisor`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` +> [!NOTE] +> Only certain device types can act as network nodes: +> `AP`, `Firewall`, `Gateway`, `Hypervisor`, `PLC`, `Powerline`, `Router`, `Switch`, `USB LAN Adapter`, `USB WIFI Adapter`, `WLAN` > You can add custom types via the `NETWORK_DEVICE_TYPES` setting. - Click **Save** @@ -81,7 +83,7 @@ You can confirm that `raspberrypi` now acts as a network device in two places: ### 3. Assign Connected Devices - Use the **Assign** button to link other devices (e.g. PCs) to `raspberrypi`. -- After assigning, connected devices will appear beneath the `raspberrypi` switch node. +- After assigning, connected devices will appear beneath the `raspberrypi` switch node. ![Assigned nodes](./img/NETWORK_TREE/Network_Assigned_Nodes.png) @@ -92,9 +94,9 @@ You can confirm that `raspberrypi` now acts as a network device in two places: > Hovering over devices in the tree reveals connection details and tooltips for quick inspection. > [!NOTE] -> Selecting certain relationship types hides the device in the default device views. -> You can change this behavior by adjusting the `UI_hide_rel_types` setting, which by default is set to `["nic","virtual"]`. -> This means devices with `devParentRelType` set to `nic` or `virtual` will not be shown. +> Selecting certain relationship types hides the device in the default device views. +> You can change this behavior by adjusting the `UI_hide_rel_types` setting, which by default is set to `["nic","virtual"]`. +> This means devices with `devParentRelType` set to `nic` or `virtual` will not be shown. > All devices, regardless of relationship type, are always accessible in the **All devices** view. ---