Skip to content

Commit

Permalink
Common: network gets more titles
Browse files Browse the repository at this point in the history
also move around some wording below titles to make it consistent
  • Loading branch information
rmackay9 authored and Hwurzburg committed Jan 10, 2025
1 parent fb3a280 commit f638123
Showing 1 changed file with 22 additions and 13 deletions.
35 changes: 22 additions & 13 deletions common/source/docs/common-network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Configuration
Ethernet MAC Configuration
--------------------------

If the autopilot has an Ethernet MAC the following parameters apply:
If the autopilot has an Ethernet MAC the following parameters apply. This is the global 6 byte MAC address. The default is automatically generated from the autopilot's CPU unique id, but can be changed if desired.

- :ref:`NET_MACADDR0<NET_MACADDR0>`
- :ref:`NET_MACADDR1<NET_MACADDR1>`
Expand All @@ -45,22 +45,31 @@ If the autopilot has an Ethernet MAC the following parameters apply:
- :ref:`NET_MACADDR4<NET_MACADDR4>`
- :ref:`NET_MACADDR5<NET_MACADDR5>`

This is the global 6 byte MAC address. The default is automatically generated from the autopilot's CPU unique id, but can be changed if desired.
Autopilot IP address
--------------------

- :ref:`NET_IPADDR0<NET_IPADDR0>`
- :ref:`NET_IPADDR1<NET_IPADDR1>`
- :ref:`NET_IPADDR2<NET_IPADDR2>`
- :ref:`NET_IPADDR3<NET_IPADDR3>`
The following parameters holds the autopilot's 4 byte IP address. It defaults to ``192.168.144.14``

This is the autopilot's 4 byte IP address. It defaults to ``192.168.144.14``. It can be dynamically assigned if the network has a DHCP server by enabling ArduPilot's DHCP client using the :ref:`NET_DHCP<NET_DHCP>` parameter, or manually set as desired.
- :ref:`NET_IPADDR0<NET_IPADDR0>` (e.g. 192)
- :ref:`NET_IPADDR1<NET_IPADDR1>` (e.g. 168)
- :ref:`NET_IPADDR2<NET_IPADDR2>` (e.g. 144)
- :ref:`NET_IPADDR3<NET_IPADDR3>` (e.g. 14)

- :ref:`NET_NETMASK<NET_NETMASK>` is the number of leading bits set in the subnet mask. For example, if its set to 24, then the subnet mask is 255.255.255.0, which is the default.
- :ref:`NET_GWADDR0<NET_GWADDR0>`
- :ref:`NET_GWADDR1<NET_GWADDR1>`
- :ref:`NET_GWADDR2<NET_GWADDR2>`
- :ref:`NET_GWADDR3<NET_GWADDR3>`
These can be dynamically assigned if the network has a DHCP server by enabling ArduPilot's DHCP client using the :ref:`NET_DHCP<NET_DHCP>` parameter, or manually set as desired.

This is the gateway's IP address out of the local sub-net defined by the :ref:`NET_NETMASK<NET_NETMASK>` mask. Any destination IPs that are outside the masked subnet range will be sent to the gateway's MAC address with the final destinations IP address. The default is ``192.168.144.1``.
Subnet Mask and Gateway
-----------------------

The subnet mask limits the IP addresses that the autopilot may directly communicate with.

- :ref:`NET_NETMASK<NET_NETMASK>` is the number of leading bits set in the subnet mask. For example, if set to 24 (the default) then the subnet mask is 255.255.255.0.

The gateway IP address is used for routing when communicating with IP addresses out of the local subnet defined by :ref:`NET_NETMASK<NET_NETMASK>`. Any destination IPs that are outside the masked subnet range will be sent to the gateway's MAC address with the final destinations IP address. The default is ``192.168.144.1``.

- :ref:`NET_GWADDR0<NET_GWADDR0>` (e.g. 192)
- :ref:`NET_GWADDR1<NET_GWADDR1>` (e.g. 168)
- :ref:`NET_GWADDR2<NET_GWADDR2>` (e.g. 144)
- :ref:`NET_GWADDR3<NET_GWADDR3>` (e.g. 1)

PPP Configuration
-----------------
Expand Down

0 comments on commit f638123

Please sign in to comment.