network
The Network config options are: NTP Server, WiFi Enabled, WiFi SSID, WiFi PSK, Ethernet Enabled, IPv4 Networking Mode, Static Address rsyslog Server, and Protocol Flags. Network config uses an admin message sending a Config.Network protobuf.
:::info Enabling WiFi will disable Bluetooth. Only one connection method will work at a time. :::
ESP32 devices have the ability to connect to WiFi as a client. SoftAP mode is not supported by the Meshtastic firmware.
Network Config Values
NTP Server
The NTP server used if IP networking is available.
Set to meshtastic.pool.ntp.org by default. (Max Length: 32)
WiFi Enabled
Enables or Disables WiFi.
Set to false (Disabled) by default.
WiFi SSID
This is your WiFi Network's SSID.
Empty "" by default. (Case Sensitive, Max Length: 32)
WiFi PSK
This is your WiFi Network's password.
Empty "" by default. (Case Sensitive, Max Length: 64)
Ethernet Enabled
Enables or Disables Ethernet.
Set to false (Disabled) by default.
IPv4 Networking Mode
Set to DHCP by default. Change to STATIC to use a static IP address. Applies to both Ethernet and WiFi.
IPv4 Static Address configuration
Contains IP, Gateway, Subnet, and DNS server for a static configuration if selected in Networking Mode.
Rsyslog Server
To configure an rsyslog Server and Port. Default logging facility is user.
Protocol Flags
Defines which auxiliary network protocols are used to send packets. Values are stored as a bit field of boolean configuration options (bitwise OR of ProtocolFlags).
| Value | Description |
|---|---|
| NO_BROADCAST | Do not broadcast packets over any network protocol |
| UDP_BROADCAST | Enable broadcasting packets via UDP over the local network |
:::tip The first time your device restarts after enabling WiFi or Ethernet, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse. :::
Network Config Client Availability
<Icon icon="mdi:android" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Android
</>
),
value: "android",
},
{
label: (
<>
<Icon icon="mdi:apple" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Apple
</>
),
value: "apple",
},
{
label: (
<>
<Icon icon="mdi:terminal" height="1.5rem" style={{ marginRight: "0.25rem" }} /> CLI
</>
),
value: "cli",
},
{
label: (
<>
<Icon icon="mdi:internet" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Web
</>
),
value: "web",
},
]}>
Android
:::info
Network Config options are available for Android.
- Open the Meshtastic App
- Navigate to: Vertical Ellipsis (3 dots top right) > Radio Configuration > Network
:::
Apple
:::info
All Network config options are available on iOS, iPadOS and macOS at Settings > Device Configuration > Network.
:::
CLI
:::info
All Network config options are available in the python CLI.
:::
| Setting | Acceptable Values | Default |
|---|---|---|
| network.ntp_server | string | meshtastic.pool.ntp.org |
| network.wifi_enabled | true, false |
false |
| network.wifi_ssid | string | "" |
| network.wifi_psk | string | "" |
| network.eth_enabled | true, false |
false |
| network.address_mode | DHCP, STATIC |
DHCP |
:::tip
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:" meshtastic --set network.wifi_enabled true --set network.wifi_ssid "my network" --set network.wifi_psk mypassword
:::
```shell title="Set NTP Server"
meshtastic --set network.ntp_server "meshtastic.pool.ntp.org"
```shell title="Enable / Disable WiFi" meshtastic --set network.wifi_enabled true meshtastic --set network.wifi_enabled false
```shell title="Set WiFi SSID"
meshtastic --set network.wifi_ssid mynetwork
// With spaces
meshtastic --set network.wifi_ssid "my network"
shell title="Set WiFi password"
meshtastic --set network.wifi_psk mypassword
// With spaces
meshtastic --set network.wifi_psk "my password"
Web
:::info All Network config options are available in the Web UI. :::
Examples
WiFi Client
With network.wifi_ssid & network.wifi_psk populated, the device will know to connect to your network. Make sure you are in range of your WiFi and it is a 2.4GHz-only network. If you have a single Meshtastic device on your local network it's easy to connect to your device with DNS http://meshtastic.local. If you have multiple Meshtastic devices you will need to connect using their respective IP addresses.
Disable WiFi
To disable WiFi completely, set network.wifi_enabled to false.