add Config.h

fabik111 · fabik111 · commit 1c2f0fb2ae1f · 2025-04-08T09:29:23.000+02:00
diff --git a/src/ANetworkConfigurator_Config.h b/src/ANetworkConfigurator_Config.h
@@ -0,0 +1,128 @@
+/*
+  Copyright (c) 2024 Arduino SA
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*/
+#pragma once
+
+#define NETWORK_CONFIGURATOR_COMPATIBLE 0
+#define ZERO_TOUCH_ENABLED 0
+
+#if defined(ARDUINO_SAMD_MKRWIFI1010)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 7
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED 25
+  #define BLUE_LED 27
+  #define RED_LED 26
+  #define BOARD_USE_NINA
+  #define LED_ON HIGH
+  #define LED_OFF LOW
+#endif
+
+#if defined(ARDUINO_SAMD_NANO_33_IOT)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define GREEN_LED LED_BUILTIN
+  #define LED_ON HIGH
+  #define LED_OFF LOW
+#endif
+
+#if defined(ARDUINO_NANO_RP2040_CONNECT)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED 25
+  #define BLUE_LED 26
+  #define RED_LED 27
+  #define BOARD_USE_NINA
+  #define LED_ON LOW
+  #define LED_OFF HIGH
+#endif
+
+#if defined(ARDUINO_UNOR4_WIFI)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define GREEN_LED LED_BUILTIN
+  #define LED_ON HIGH
+  #define LED_OFF LOW
+  #define BOARD_HAS_LED_MATRIX
+#endif
+
+#if defined(ARDUINO_PORTENTA_H7_M7)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define ZERO_TOUCH_ENABLED 1
+  #define PIN_RECONFIGURE 2 //TODO update doc and test
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED LEDG
+  #define BLUE_LED  LEDB
+  #define RED_LED LEDR
+  #define LED_ON LOW
+  #define LED_OFF HIGH
+#endif
+
+#if defined(ARDUINO_OPTA)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define ZERO_TOUCH_ENABLED 1
+  #define PIN_RECONFIGURE BTN_USER
+  #define LED_RECONFIGURE LED_USER
+  #define BOARD_HAS_RGB
+  #define GREEN_LED LED_BUILTIN
+  #define BLUE_LED  LED_USER
+  #define RED_LED LEDR
+  #define LED_ON HIGH
+  #define LED_OFF LOW
+#endif
+
+
+#if defined(ARDUINO_GIGA)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED LEDG
+  #define BLUE_LED  LEDB
+  #define RED_LED LEDR
+  #define LED_ON LOW
+  #define LED_OFF HIGH
+#endif
+
+#if defined(ARDUINO_NICLA_VISION)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED LEDG
+  #define BLUE_LED  LEDB
+  #define RED_LED LEDR
+  #define LED_ON LOW
+  #define LED_OFF HIGH
+#endif
+
+#if defined(ARDUINO_PORTENTA_C33)
+  #define NETWORK_CONFIGURATOR_COMPATIBLE 1
+  #define ZERO_TOUCH_ENABLED 1
+  #define PIN_RECONFIGURE 2
+  #define LED_RECONFIGURE LED_BUILTIN
+  #define BOARD_HAS_RGB
+  #define GREEN_LED LEDG
+  #define BLUE_LED  LEDB
+  #define RED_LED LEDR
+  #define LED_ON LOW
+  #define LED_OFF HIGH
+#endif
+
+#ifndef RESET_HOLD_TIME
+#define RESET_HOLD_TIME 3000000
+#endif
+
+#ifndef BCP_DEBUG_PACKET
+#define BCP_DEBUG_PACKET 0
+#endif
diff --git a/src/ConfiguratorAgents/AgentsManager.cpp b/src/ConfiguratorAgents/AgentsManager.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include <Arduino_DebugUtils.h>
 #include <algorithm>
@@ -408,3 +410,5 @@ void AgentsManagerClass::startBLEAgent() {
     }
   });
 }
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/ConfiguratorAgents/NetworkOptionsDefinitions.h b/src/ConfiguratorAgents/NetworkOptionsDefinitions.h
@@ -11,8 +11,7 @@
 #define MAX_WIFI_NETWORKS 20
 
 enum class NetworkOptionsClass { NONE,
-                                 WIFI,
-                                 LAN };
+                                 WIFI };
 
 typedef struct {
   char *SSID;
diff --git a/src/ConfiguratorAgents/agents/BLE/BLEAgent.h b/src/ConfiguratorAgents/agents/BLE/BLEAgent.h
@@ -20,7 +20,6 @@
 #include "Utility/LEDFeedback/LEDFeedback.h"
 #include "ConfiguratorAgents/agents/BoardConfigurationProtocol/cbor/CBORInstances.h"
 
-#define DEBUG_PACKET
 #define BASE_LOCAL_NAME "Arduino"
 #define ARDUINO_COMPANY_ID 0x09A3
 
diff --git a/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/BoardConfigurationProtocol.cpp b/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/BoardConfigurationProtocol.cpp
@@ -5,15 +5,14 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
+
 #include "BoardConfigurationProtocol.h"
 #include "Arduino_DebugUtils.h"
 #include "CBORAdapter.h"
 #include "cbor/CBOR.h"
 
-#ifndef BCP_DEBUG_PACKET
-#define BCP_DEBUG_PACKET 0
-#endif
-
 #define PACKET_VALIDITY_MS 30000
 
 /******************************************************************************
@@ -370,3 +369,5 @@ void BoardConfigurationProtocol::printPacket(const char *label, const uint8_t *d
   }
   Debug.newlineOn();
 }
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/CBORAdapter.cpp b/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/CBORAdapter.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include "CBORAdapter.h"
 #include "cbor/MessageEncoder.h"
@@ -147,3 +149,5 @@ bool CBORAdapter::adaptWiFiOptions(const WiFiOption *wifiOptions, uint8_t *data,
 
   return status == MessageEncoder::Status::Complete ? true : false;
 }
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/PacketManager.cpp b/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/PacketManager.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include <Arduino_DebugUtils.h>
 #include "PacketManager.h"
@@ -199,3 +201,5 @@ namespace PacketManager {
     return ReceivingState::WAITING_END;
   }
 }
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/cbor/Decoder.cpp b/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/cbor/Decoder.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include "Decoder.h"
 #include <settings/settings_default.h>
@@ -403,3 +405,5 @@ MessageDecoder::Status GSMConfigProvisioningMessageDecoder::decode(CborValue* it
   return extractCellularFields(iter, &provisioningNetworkConfig->networkSetting.gsm);
 }
 #endif
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/cbor/Encoder.cpp b/src/ConfiguratorAgents/agents/BoardConfigurationProtocol/cbor/Encoder.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include "Encoder.h"
 
@@ -132,3 +134,5 @@ MessageEncoder::Status WiFiFWVersionProvisioningMessageEncoder::encode(CborEncod
 
   return MessageEncoder::Status::Complete;
 }
+
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/NetworkConfigurator.cpp b/src/NetworkConfigurator.cpp
@@ -5,6 +5,8 @@
   License, v. 2.0. If a copy of the MPL was not distributed with this
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
+#include "ANetworkConfigurator_Config.h"
+#if NETWORK_CONFIGURATOR_COMPATIBLE
 
 #include <Arduino_DebugUtils.h>
 #include "ConnectionHandlerDefinitions.h"
@@ -66,15 +68,15 @@ bool NetworkConfiguratorClass::begin() {
 
   _agentsManager->addRequestHandler(RequestType::GET_WIFI_FW_VERSION, getWiFiFWVersionHandler);
 
-  if (!_agentsManager->begin(SERVICE_ID_FOR_AGENTMANAGER)) {
+  if (!_agentsManager->begin(SERVICE_ID_FOR_AGENTMANAGER)) { //TODO check if this is needed if the counter is enough
     DEBUG_ERROR("NetworkConfiguratorClass::%s Failed to initialize the AgentsManagerClass", __FUNCTION__);
   }
 
   _connectionTimeout.begin(NC_CONNECTION_TIMEOUT_ms);
   _connectionRetryTimer.begin(NC_CONNECTION_RETRY_TIMER_ms);
   _resetInput->begin();
 
-#ifdef BOARD_HAS_ETHERNET
+#ifdef BOARD_HAS_ETHERNET //TODO Generalize
   _networkSetting.type = NetworkAdapter::ETHERNET;
   _networkSetting.eth.timeout = 250;
   _networkSetting.eth.response_timeout = 500;
@@ -90,7 +92,7 @@ bool NetworkConfiguratorClass::begin() {
 
 NetworkConfiguratorStates NetworkConfiguratorClass::poll() {
   NetworkConfiguratorStates nextState = _state;
-  LEDFeedbackClass::getInstance().poll();
+  LEDFeedbackClass::getInstance().poll();//TODO rename in update
 
   switch (_state) {
 #ifdef BOARD_HAS_ETHERNET
@@ -590,7 +592,7 @@ void NetworkConfiguratorClass::printNetworkSettings() {
 #if defined(BOARD_HAS_WIFI)
     case NetworkAdapter::WIFI:
       DEBUG_INFO("WIFI");
-      DEBUG_INFO("SSID: %s PSW: %s", _networkSetting.wifi.ssid, _networkSetting.wifi.pwd);
+      DEBUG_INFO("SSID: %s PSW: %s", _networkSetting.wifi.ssid, _networkSetting.wifi.pwd);//TODO remove psw
       break;
 #endif
 
@@ -663,3 +665,4 @@ void NetworkConfiguratorClass::printNetworkSettings() {
       break;
   }
 }
+#endif // NETWORK_CONFIGURATOR_COMPATIBLE
diff --git a/src/NetworkConfigurator.h b/src/NetworkConfigurator.h
diff --git a/src/Utility/LEDFeedback/LEDFeedback.cpp b/src/Utility/LEDFeedback/LEDFeedback.cpp
diff --git a/src/Utility/ResetInput/ResetInput.cpp b/src/Utility/ResetInput/ResetInput.cpp

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@`
`5`	`5`	`License, v. 2.0. If a copy of the MPL was not distributed with this`
`6`	`6`	`file, You can obtain one at http://mozilla.org/MPL/2.0/.`
`7`	`7`	`*/`
	`8`	`+#include "ANetworkConfigurator_Config.h"`
	`9`	`+#if NETWORK_CONFIGURATOR_COMPATIBLE`
`8`	`10`
`9`	`11`	`#include <Arduino_DebugUtils.h>`
`10`	`12`	`#include <algorithm>`
`@@ -408,3 +410,5 @@ void AgentsManagerClass::startBLEAgent() {`
`408`	`410`	`}`
`409`	`411`	`});`
`410`	`412`	`}`
	`413`	`+`
	`414`	`+#endif // NETWORK_CONFIGURATOR_COMPATIBLE`