-
Notifications
You must be signed in to change notification settings - Fork 3
RaftNetworkManagerSettings
Rob Dobson edited this page Oct 24, 2024
·
2 revisions
| Setting | Description | Type | Default | Example |
|---|---|---|---|---|
enableEthernet |
Enables or disables Ethernet functionality. | boolean | false |
true |
enableWifiSTAMode |
Enables or disables WiFi in STA (Station) mode. | boolean | false |
true |
enableWifiAPMode |
Enables or disables WiFi in AP (Access Point) mode. | boolean | false |
true |
defaultHostname |
The default hostname for the system. | string | "" |
"myDevice" |
wifiSTAScanThreshold |
The WiFi STA scan threshold based on authentication mode. | wifi_auth_mode_t | WIFI_AUTH_WPA2_PSK |
WIFI_AUTH_OPEN |
wifiAPAuthMode |
The WiFi AP authentication mode. | wifi_auth_mode_t | WIFI_AUTH_WPA2_PSK |
WIFI_AUTH_WPA3_PSK |
wifiAPMaxConn |
The maximum number of connections allowed on the WiFi AP. | uint32_t | 4 |
10 |
wifiAPChannel |
The WiFi AP channel number. | uint32_t | 1 |
6 |
ethLanChip |
The type of Ethernet chip used. | EthLanChip enum | ETH_CHIP_TYPE_NONE |
ETH_CHIP_TYPE_LAN87XX |
powerPin |
GPIO pin used to control power for the Ethernet chip (not specified or -1 if not used). | int | -1 |
5 |
smiMDCPin |
GPIO pin used for SMI MDC (Management Data Clock) in Ethernet (not specified or -1 if not used). | int | -1 |
23 |
smiMDIOPin |
GPIO pin used for SMI MDIO (Management Data Input/Output) in Ethernet (not specified or -1 if not used). | int | -1 |
18 |
phyAddr |
The address of the Ethernet PHY. | int | 0 |
1 |
phyRstPin |
GPIO pin used to reset the Ethernet PHY (not specified or -1 if not used). | int | -1 |
16 |
ntpServer |
The NTP server used for time synchronization. | string | "pool.ntp.org" |
"time.google.com" |
timezone |
The timezone used for the system clock. | string | "UTC" |
"PST" |
enableMDNS |
Enables or disables mDNS (Multicast DNS) functionality. | boolean | true |
false |
| Auth Mode | Description |
|---|---|
WIFI_AUTH_OPEN |
No authentication (open network). |
WIFI_AUTH_WEP |
Wired Equivalent Privacy (WEP) encryption. |
WIFI_AUTH_WPA_PSK |
WPA Pre-Shared Key (WPA-Personal). |
WIFI_AUTH_WPA2_PSK |
WPA2 Pre-Shared Key (WPA2-Personal). |
WIFI_AUTH_WPA_WPA2_PSK |
WPA/WPA2 mixed mode. |
WIFI_AUTH_WPA3_PSK |
WPA3 Pre-Shared Key (WPA3-Personal). |
WIFI_AUTH_WPA2_WPA3_PSK |
WPA2/WPA3 mixed mode. |
WIFI_AUTH_WAPI_PSK |
WAPI (WLAN Authentication and Privacy Infrastructure). |
WIFI_AUTH_WPA2_ENTERPRISE |
WPA2 Enterprise (using EAP). |
| Chip Type | Description |
|---|---|
ETH_CHIP_TYPE_NONE |
No Ethernet chip is used. |
ETH_CHIP_TYPE_LAN87XX |
LAN87XX Ethernet chip series. |
Getting Started
- Quick Start
- Architecture at a Glance
- Writing Your First SysMod
- Adding a Comms Channel
- Adding an I2C Device Type
- PlatformIO / Arduino
Scaffolding & Building
- Raft CLI
- SysTypes
- Top-Level SysType
- Build Process
- WebUI Build Pipeline
- File System
- Partitions & Flash
- Local Dev Libraries
- Library Developer Guide
Architecture
Built-in SysMods
- NetworkManager
- BLEManager
- WebServer
- MQTTManager
- SerialConsole
- CommandSerial
- CommandSocket
- CommandFile
- FileManager
- LogManager
- ESPOTAUpdate
- StatePublisher
- Remote Logging
- Data Source Registration
Comms & Protocols
- Stack Overview
- Comms Channels
- ProtocolExchange
- RICREST Protocol
- Real-Time Streams
- Adding REST Endpoints
- Built-in REST Endpoints
- File Download (OKTO)
- OTA Update Flow
Devices & Buses
- DeviceManager
- Device Manager REST API
- Device Factory & Classes
- Device Type Records
- Adding an I2C Device Type
- Device Data Publishing
- Data Logger
- I2C Bus
- I2C Device Scanning
- I2C ID & Polling
- MotorControl Overview
- MotorControl Config
- MotorControl Commands
Helpers
Reference