[SYS] User friendly manual network configuration (#1715)

* User friendly manual network configuration * Add manual network config to the docs * Add manual network config to the test env Co-authored-by: DigiH <github@digih.net>
2023-08-05 13:41:57 -05:00
1 parent fac602e457
commit 2aa4368538
@@ -95,7 +95,7 @@ build_flags =
  '-DLED_RECEIVE_ON=LOW'             ; Comment 2
  '-DRF_RECEIVER_GPIO=13'
  '-DRF_EMITTER_GPIO=15'
-  '-DsimpleReceiving=false'          
+  '-DsimpleReceiving=false'
  '-UZmqttDiscovery'                 ; Disable HA discovery
 monitor_speed = 115200

@@ -114,6 +114,18 @@ Adding manual WiFi and MQTT credentials to an environment also requires to defin
 for the credetials to be registered correctly.
 :::

+::: warning Note
+Manual network configuration (IP, netmask, gateway, DNS) requires to define
+`'-DNetworkAdvancedSetup=true'`
+and related network parameters, e.g.:
+```
+'-DNET_IP="192.168.1.99"'
+'-DNET_MASK="255.255.255.0"'
+'-DNET_GW="192.168.1.1"'
+'-DNET_DNS="1.1.1.1"'
+```
+:::
+
 The first new environment we create, `nodemcuv2-pilight-bme280`, inherits the default `nodemcuv2-pilight` environment in `platformio.ini` with the `extends = env:nodemcuv2-pilight` line. In the `lib_deps` section, it imports all the `lib_deps` of `nodemcuv2-pilight` with the `${env:nodemcuv2-pilight.lib_deps}` line, and adds BME280 on top of it. (Since the environment we're extending already has this `lib_deps` attribute, specifying it again would normally replace it completely with our new attribute; instead, to keep its value but simply append to it, we import the original in the beginning of our `lib_deps` attribute.) In the `build_flags` section, it again imports all the `build_flags` of `nodemcuv2-pilight` and many of its own overrides, e.g. changing `Base_Topic` found in `User_config.h` from the default to "rf/" by using the `'-DBase_Topic="rf/"'` line. It also unsets previously set configurations (i.e. `mqttDiscovery`) by using `'-UZmqttDiscovery'`. This environment will work over serial upload.

 The second new environment, `nodemcuv2-pilight-bme280-ota`, inherits everything we specified in the first environment (with the line `extends = env:nodemcuv2-pilight-bme280`), but modifies it to upload over OTA (Wi-Fi). We also specified this as the `default_env` in the beginning of the file, so PlatformIO will choose this environment to build and upload if we don't specify otherwise.
@@ -150,7 +162,7 @@ board = esp32dev
 lib_deps =
  ${com-esp.lib_deps}
  ${libraries.rc-switch}
-build_flags = 
+build_flags =
  ${com-esp.build_flags}
  '-DZgatewayRF="RF"'
  '-DZgatewayIR="IR"'
@@ -173,7 +185,7 @@ This can be useful especially before the first upload or when you change the boa

 Once done the gateway should connect to your network and your broker, you should see it into the broker in the form of the following messages:
 ```
-home/OpenMQTTGateway/LWT Online 
+home/OpenMQTTGateway/LWT Online
 home/OpenMQTTGateway/version
 ```

@@ -239,7 +251,7 @@ You can deactivate Json or simple mode following theses instructions:
 #define jsonPublishing true //define false if you don't want to use Json publishing (one topic for all the parameters)
 //example home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4 {"rssi":-63,"servicedata":"fe0000000000000000000000000000000000000000"}
 #define simplePublishing false //define true if you want to use simple publishing (one topic for one parameter)
-//example 
+//example
 // home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4/rssi -63.0
 // home/OpenMQTTGateway_ESP32_DEVKIT/BTtoMQTT/4XXXXXXXXXX4/servicedata fe0000000000000000000000000000000000000000
 #define simpleReceiving true //define false if you don't want to use old way reception analysis
@@ -260,7 +272,7 @@ Note that depending on the environment the default platformio.ini has common opt
 [com-esp]
 ```

-If you want to use HASS MQTT discovery you need to have 
+If you want to use HASS MQTT discovery you need to have
 `#define jsonPublishing true`
 &
 `#define ZmqttDiscovery "HADiscovery"`
@@ -118,6 +118,12 @@ build_flags =
  '-DESP32_EXT0_WAKE_PIN=GPIO_NUM_14' ;Should a water leak be detected immediatly wake the ESP32 and report the problem
  '-DESP32_EXT0_WAKE_PIN_STATE=0' ;Should a water leak be detected immediatly wake the ESP32 and report the problem, sensor state to look for wakeup
  '-UMQTT_HTTPS_FW_UPDATE' ;disable HTTPS firmware updating
+  '-DNetworkAdvancedSetup=true'
+  '-DNET_IP="192.168.1.99"'
+  '-DNET_MASK="255.255.255.0"'
+  '-DNET_GW="192.168.1.1"'
+  '-DNET_DNS="1.1.1.1"'
+
 [env:esp32dev-rf]
 platform = ${com.esp32_platform}
 board = esp32dev
@@ -591,7 +597,7 @@ custom_hardware = M5 ATOM Lite

 [env:esp32doitv1-aithinker-r01-sx1278]
 platform = ${com.esp32_platform}
-board = esp32doit-devkit-v1 
+board = esp32doit-devkit-v1
 board_build.partitions = min_spiffs.csv
 lib_deps =
  ${com-esp32.lib_deps}
@@ -607,7 +613,7 @@ build_flags =
  '-DZgatewayRTL_433="rtl_433"'
  '-DZradioSX127x="SX127x"'
 ; *** rtl_433_ESP Options ***
-   '-DONBOARD_LED=LED_BUILTIN'  
+   '-DONBOARD_LED=LED_BUILTIN'
 ;  '-DRTL_DEBUG=4'           ; rtl_433 verbose mode
 ;  '-DRTL_VERBOSE=58'          ; LaCrosse TX141-Bv2, TX141TH-Bv2, TX141-Bv3, TX141W, TX145wsdth sensor
 ;  '-DRAW_SIGNAL_DEBUG=true'   ; display raw received messages
@@ -979,7 +985,7 @@ lib_deps =
  ${com-esp32.lib_deps}
  ${libraries.ble}
  ${libraries.decoder}
-build_flags = 
+build_flags =
  ${env.build_flags}
  ${com-esp32.build_flags}
  '-DZgatewayBT="BT"'
@@ -1571,7 +1577,7 @@ build_flags =
  '-DWM_DEBUG_LEVEL=1' ;DEBUG_NOTIFY=1, default value
 ; Serial output via USB
  '-DCONFIG_ESP_CONSOLE_USB_SERIAL_JTAG=true'
-  '-DCONFIG_ESP_CONSOLE_UART=ESP_CONSOLE_USB_SERIAL_JTAG'   
+  '-DCONFIG_ESP_CONSOLE_UART=ESP_CONSOLE_USB_SERIAL_JTAG'

 [env:thingpulse-espgateway]
 platform = ${com.esp32_platform}
@@ -1633,4 +1639,4 @@ build_flags =
 ;  '-DsimplePublishing=true'
 custom_description = BLE Gateway using ethernet, requires PIO configuration
 custom_hardware = ThingPulse gateway single ESP32
-  
+
@@ -68,12 +68,18 @@

 //#define NetworkAdvancedSetup true //uncomment if you want to set advanced network parameters, not uncommented you can set the IP and MAC only
 #ifdef NetworkAdvancedSetup
-#  if defined(ESP8266) || defined(ESP32)
-const byte ip[] = {192, 168, 1, 99}; //IP address of the gateway, already defined for arduino below
+#  ifndef NET_IP
+#    define NET_IP "192.168.1.99"
+#  endif
+#  ifndef NET_MASK
+#    define NET_MASK "255.255.255.0"
+#  endif
+#  ifndef NET_GW
+#    define NET_GW "192.168.1.1"
+#  endif
+#  ifndef NET_DNS
+#    define NET_DNS "192.168.1.1"
 #  endif
-const byte gateway[] = {0, 0, 0, 0};
-const byte Dns[] = {0, 0, 0, 0};
-const byte subnet[] = {255, 255, 255, 0};
 #endif

 #if defined(ESP8266) || defined(ESP32) // for nodemcu, weemos and esp8266
@@ -1348,10 +1348,15 @@ void setup_wifi() {
  // We start by connecting to a WiFi network

 #  ifdef NetworkAdvancedSetup
-  IPAddress ip_adress(ip);
-  IPAddress gateway_adress(gateway);
-  IPAddress subnet_adress(subnet);
-  IPAddress dns_adress(Dns);
+  IPAddress ip_adress;
+  IPAddress gateway_adress;
+  IPAddress subnet_adress;
+  IPAddress dns_adress;
+  ip_adress.fromString(NET_IP);
+  gateway_adress.fromString(NET_GW);
+  subnet_adress.fromString(NET_MASK);
+  dns_adress.fromString(NET_DNS);
+
  if (!WiFi.config(ip_adress, gateway_adress, subnet_adress, dns_adress)) {
    Log.error(F("Wifi STA Failed to configure" CR));
  }
@@ -1589,10 +1594,15 @@ void setup_wifimanager(bool reset_settings) {
 //set static IP
 #  ifdef NetworkAdvancedSetup
  Log.trace(F("Adv wifi cfg" CR));
-  IPAddress gateway_adress(gateway);
-  IPAddress subnet_adress(subnet);
-  IPAddress ip_adress(ip);
-  wifiManager.setSTAStaticIPConfig(ip_adress, gateway_adress, subnet_adress);
+  IPAddress ip_adress;
+  IPAddress gateway_adress;
+  IPAddress subnet_adress;
+  IPAddress dns_adress;
+  ip_adress.fromString(NET_IP);
+  gateway_adress.fromString(NET_GW);
+  subnet_adress.fromString(NET_MASK);
+  dns_adress.fromString(NET_DNS);
+  wifiManager.setSTAStaticIPConfig(ip_adress, gateway_adress, subnet_adress, dns_adress);
 #  endif

 #  ifndef WIFIMNG_HIDE_MQTT_CONFIG
@@ -1691,6 +1701,15 @@ void setup_ethernet_esp32() {
  bool ethBeginSuccess = false;
  WiFi.onEvent(WiFiEvent);
 #    ifdef NetworkAdvancedSetup
+  IPAddress ip_adress;
+  IPAddress gateway_adress;
+  IPAddress subnet_adress;
+  IPAddress dns_adress;
+  ip.fromString(NET_IP);
+  gateway.fromString(NET_GW);
+  subnet.fromString(NET_MASK);
+  Dns.fromString(NET_DNS);
+
  Log.trace(F("Adv eth cfg" CR));
  ETH.config(ip, gateway, subnet, Dns);
  ethBeginSuccess = ETH.begin();
@@ -1736,6 +1755,15 @@ void WiFiEvent(WiFiEvent_t event) {
 #else // Arduino case
 void setup_ethernet() {
 #  ifdef NetworkAdvancedSetup
+  IPAddress ip_adress;
+  IPAddress gateway_adress;
+  IPAddress subnet_adress;
+  IPAddress dns_adress;
+  ip.fromString(NET_IP);
+  gateway.fromString(NET_GW);
+  subnet.fromString(NET_MASK);
+  Dns.fromString(NET_DNS);
+
  Log.trace(F("Adv eth cfg" CR));
  Ethernet.begin(mac, ip, Dns, gateway, subnet);
 #  else