Feature: automatic detection of Opta expansion modules and exposure via OPC/UA

.github/workflows/compile-examples.yml

@@ -25,6 +25,11 @@ jobs:
         with:
           fqbn: ${{ matrix.board.fqbn }}
           platforms: ${{ matrix.board.platforms }}
+          libraries: |
+            - source-path: ./
+            - name: Arduino_Opta_Blueprint
+            - name: Arduino_SerialUpdater
+            - name: Arduino_DebugUtils
           enable-deltas-report: true
           github-token: ${{ secrets.GITHUB_TOKEN }}
           sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }}

library.properties

@@ -10,3 +10,4 @@ url=https://github.com/bcmi-labs/Arduino_open62541
 ldflags=-lopen62541
 includes=Arduino_open62541.h
 precompiled=true
+depends=Arduino_Opta_Blueprint

src/Arduino_open62541.h

@@ -14,12 +14,16 @@
  **************************************************************************************/
 
 #include "open62541.h"
-#include "o1heap/o1heap.h"
-#include "NTPUtils.h"
-#include "cvt_time.h"
 
-#include "ArduinoOpta.h"
-#include "ArduinoOptaVariant.h"
+#include "util/o1heap/o1heap.h"
+#include "util/o1heap/o1heap_wrapper.h"
+#include "util/time/cvt_time.h"
+#include "util/time/NTPUtils.h"
+#include "util/toStr/ExpansionType.h"
+
+#include "Opta.h"
+#include "OptaVariant.h"
+#include "OptaExpansionManager.h"
 
 /**************************************************************************************
  * DEFINES

src/ArduinoOpta.cpp → src/Opta.cpp

@@ -11,7 +11,7 @@
  * INCLUDE
  **************************************************************************************/
 
-#include "ArduinoOpta.h"
+#include "Opta.h"
 
 /**************************************************************************************
  * NAMESPACE
@@ -24,7 +24,7 @@ namespace opcua
  * CTOR/DTOR
  **************************************************************************************/
 
-ArduinoOpta::ArduinoOpta(UA_Server * server, UA_NodeId const & node_id)
+Opta::Opta(UA_Server * server, UA_NodeId const & node_id)
 : _server{server}
 , _node_id{node_id}
 , _analog_input_mgr{nullptr}
@@ -34,33 +34,33 @@ ArduinoOpta::ArduinoOpta(UA_Server * server, UA_NodeId const & node_id)
 {
   _usr_button = opcua::UserButton::create(_server, _node_id);
   if (!_usr_button)
-    UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "ArduinoOpta::Ctor: UserButton::create(...) failed.");
+    UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Opta::Ctor: UserButton::create(...) failed.");
 }
 
 /**************************************************************************************
  * PUBLIC MEMBER FUNCTIONS
  **************************************************************************************/
 
-ArduinoOpta::SharedPtr ArduinoOpta::create(UA_Server * server, ArduinoOptaVariant::Type const opta_type)
+Opta::SharedPtr Opta::create(UA_Server * server, OptaVariant::Type const opta_type)
 {
   UA_StatusCode rc = UA_STATUSCODE_GOOD;
 
   UA_ObjectAttributes oAttr = UA_ObjectAttributes_default;
-  oAttr.displayName = UA_LOCALIZEDTEXT("en-US", "Arduino Opta");
+  oAttr.displayName = UA_LOCALIZEDTEXT("en-US", (char *)OptaVariant::toString(opta_type).c_str());
   UA_NodeId node_id;
   rc = UA_Server_addObjectNode(server,
                                UA_NODEID_NULL,
                                UA_NODEID_NUMERIC(0, UA_NS0ID_OBJECTSFOLDER),
                                UA_NODEID_NUMERIC(0, UA_NS0ID_ORGANIZES),
-                               UA_QUALIFIEDNAME(1, "ArduinoOpta"),
+                               UA_QUALIFIEDNAME(1, "Opta"),
                                UA_NODEID_NUMERIC(0, UA_NS0ID_BASEOBJECTTYPE),
                                oAttr,
                                NULL,
                                &node_id);
   if (UA_StatusCode_isBad(rc))
   {
     UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER,
-                 "ArduinoOpta::create: UA_Server_addObjectNode(...) failed with %s",
+                 "Opta::create: UA_Server_addObjectNode(...) failed with %s",
                  UA_StatusCode_name(rc));
     return nullptr;
   }
@@ -81,13 +81,13 @@ ArduinoOpta::SharedPtr ArduinoOpta::create(UA_Server * server, ArduinoOptaVarian
   if (UA_StatusCode_isBad(rc))
   {
     UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER,
-                 "ArduinoOpta::create: UA_Server_addVariableNode(..., \"ManufacturerName\", ...) failed with %s",
+                 "Opta::create: UA_Server_addVariableNode(..., \"ManufacturerName\", ...) failed with %s",
                  UA_StatusCode_name(rc));
     return nullptr;
   }
 
   UA_VariableAttributes modelAttr = UA_VariableAttributes_default;
-  UA_String modelName = UA_STRING((char *)ArduinoOptaVariant::toString(opta_type).c_str());
+  UA_String modelName = UA_STRING((char *)OptaVariant::toSKUString(opta_type).c_str());
   UA_Variant_setScalar(&modelAttr.value, &modelName, &UA_TYPES[UA_TYPES_STRING]);
   modelAttr.displayName = UA_LOCALIZEDTEXT("en-US", "ModelName");
   rc = UA_Server_addVariableNode(server,
@@ -102,7 +102,7 @@ ArduinoOpta::SharedPtr ArduinoOpta::create(UA_Server * server, ArduinoOptaVarian
   if (UA_StatusCode_isBad(rc))
   {
     UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER,
-                 "ArduinoOpta::create: UA_Server_addVariableNode(..., \"ModelName\", ...) failed with %s",
+                 "Opta::create: UA_Server_addVariableNode(..., \"ModelName\", ...) failed with %s",
                  UA_StatusCode_name(rc));
     return nullptr;
   }
@@ -123,58 +123,58 @@ ArduinoOpta::SharedPtr ArduinoOpta::create(UA_Server * server, ArduinoOptaVarian
   if (UA_StatusCode_isBad(rc))
   {
     UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER,
-                 "ArduinoOpta::create: UA_Server_addVariableNode(..., \"Status\", ...) failed with %s",
+                 "Opta::create: UA_Server_addVariableNode(..., \"Status\", ...) failed with %s",
                  UA_StatusCode_name(rc));
     return nullptr;
   }
 
-  auto const instance_ptr = std::make_shared<ArduinoOpta>(server, node_id);
+  auto const instance_ptr = std::make_shared<Opta>(server, node_id);
   return instance_ptr;
 }
 
-AnalogInputManager::SharedPtr ArduinoOpta::analog_input_mgr()
+AnalogInputManager::SharedPtr Opta::analog_input_mgr()
 {
   if (!_analog_input_mgr)
   {
     _analog_input_mgr = opcua::AnalogInputManager::create(_server, _node_id);
     if (!_analog_input_mgr)
-      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "ArduinoOpta::analog_input_mgr: AnalogInputManager::create(...) failed.");
+      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Opta::analog_input_mgr: AnalogInputManager::create(...) failed.");
   }
 
   return _analog_input_mgr;
 }
 
-DigitalInputManager::SharedPtr ArduinoOpta::digital_input_mgr()
+DigitalInputManager::SharedPtr Opta::digital_input_mgr()
 {
   if (!_digital_input_mgr)
   {
     _digital_input_mgr = opcua::DigitalInputManager::create(_server, _node_id);
     if (!_digital_input_mgr)
-      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "ArduinoOpta::digital_input_mgr: DigitalInputManager::create(...) failed.");
+      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Opta::digital_input_mgr: DigitalInputManager::create(...) failed.");
   }
 
   return _digital_input_mgr;
 }
 
-RelayManager::SharedPtr ArduinoOpta::relay_mgr()
+RelayManager::SharedPtr Opta::relay_mgr()
 {
   if (!_relay_mgr)
   {
     _relay_mgr = opcua::RelayManager::create(_server, _node_id);
     if (!_relay_mgr)
-      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "ArduinoOpta::relay_mgr: RelayManager::create(...) failed.");
+      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Opta::relay_mgr: RelayManager::create(...) failed.");
   }
 
   return _relay_mgr;
 }
 
-LedManager::SharedPtr ArduinoOpta::led_mgr()
+LedManager::SharedPtr Opta::led_mgr()
 {
   if (!_led_mgr)
   {
     _led_mgr = opcua::LedManager::create(_server, _node_id);
     if (!_led_mgr)
-      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "ArduinoOpta::led_mgr: LedManager::create(...) failed.");
+      UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Opta::led_mgr: LedManager::create(...) failed.");
   }
 
   return _led_mgr;

src/ArduinoOpta.h → src/Opta.h

@@ -17,12 +17,13 @@
 
 #include <memory>
 
-#include "LedManager.h"
-#include "RelayManager.h"
-#include "AnalogInputManager.h"
-#include "DigitalInputManager.h"
-#include "UserButton.h"
-#include "ArduinoOptaVariant.h"
+#include "io/led/LedManager.h"
+#include "io/button/UserButton.h"
+#include "io/relay/RelayManager.h"
+#include "io/analog/AnalogInputManager.h"
+#include "io/digital/DigitalInputManager.h"
+
+#include "OptaVariant.h"
 
 /**************************************************************************************
  * NAMESPACE
@@ -35,22 +36,27 @@ namespace opcua
  * CLASS DECLARATION
  **************************************************************************************/
 
-class ArduinoOpta
+class Opta
 {
 public:
-  typedef std::shared_ptr<ArduinoOpta> SharedPtr;
+  typedef std::shared_ptr<Opta> SharedPtr;
+
+
+  static SharedPtr create(UA_Server * server, OptaVariant::Type const opta_type);
 
-  static SharedPtr create(UA_Server * server, ArduinoOptaVariant::Type const opta_type);
 
-  ArduinoOpta(UA_Server * server, UA_NodeId const & node_id);
+  Opta(UA_Server * server, UA_NodeId const & node_id);
+
 
   AnalogInputManager::SharedPtr  analog_input_mgr();
   DigitalInputManager::SharedPtr digital_input_mgr();
   RelayManager::SharedPtr        relay_mgr();
   LedManager::SharedPtr          led_mgr();
 
+
   [[nodiscard]] UA_NodeId node_id() const { return _node_id; }
 
+
 private:
   UA_Server * _server;
   UA_NodeId _node_id;

src/OptaExpansionManager.cpp

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2024 Arduino
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ * 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/.
+ */
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include "OptaExpansionManager.h"
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+namespace opcua
+{
+
+/**************************************************************************************
+ * PUBLIC MEMBER FUNCTIONS
+ **************************************************************************************/
+
+DigitalMechExpansion::SharedPtr OptaExpansionManager::create_digital_mechanical_expansion(uint8_t const exp_num)
+{
+  auto const exp_mech_opcua = opcua::DigitalMechExpansion::create(
+    _server,
+    UA_NODEID_NUMERIC(0, UA_NS0ID_OBJECTSFOLDER),
+    exp_num);
+
+  _dig_mech_exp_list.push_back(exp_mech_opcua);
+  return exp_mech_opcua;
+}
+
+DigitalStSolidExpansion::SharedPtr OptaExpansionManager::create_digital_solid_state_expansion(uint8_t const exp_num)
+{
+  auto const exp_solid_state_opcua = opcua::DigitalStSolidExpansion::create(
+    _server,
+    UA_NODEID_NUMERIC(0, UA_NS0ID_OBJECTSFOLDER),
+    exp_num);
+
+  _dig_solid_state_exp_list.push_back(exp_solid_state_opcua);
+  return exp_solid_state_opcua;
+}
+
+AnalogExpansion::SharedPtr OptaExpansionManager::create_analog_expansion(uint8_t const exp_num)
+{
+  auto const exp_analog_opcua = opcua::AnalogExpansion::create(
+    _server,
+    UA_NODEID_NUMERIC(0, UA_NS0ID_OBJECTSFOLDER),
+    exp_num);
+
+  _analog_exp_list.push_back(exp_analog_opcua);
+  return exp_analog_opcua;
+}
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+} /* opcua */

src/OptaExpansionManager.h

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2024 Arduino
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ * 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
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include "open62541.h"
+
+#include <memory>
+
+#include "expansion/AnalogExpansion.h"
+#include "expansion/DigitalMechExpansion.h"
+#include "expansion/DigitalStSolidExpansion.h"
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+namespace opcua
+{
+
+/**************************************************************************************
+ * CLASS DECLARATION
+ **************************************************************************************/
+
+class OptaExpansionManager
+{
+public:
+  typedef std::shared_ptr<OptaExpansionManager> SharedPtr;
+
+
+  static SharedPtr create(UA_Server * server) {
+    return std::make_shared<OptaExpansionManager>(server);
+  }
+
+
+  OptaExpansionManager(UA_Server * server)
+  : _server{server}
+  { }
+
+
+  DigitalMechExpansion::SharedPtr create_digital_mechanical_expansion(uint8_t const exp_num);
+  DigitalStSolidExpansion::SharedPtr create_digital_solid_state_expansion(uint8_t const exp_num);
+  AnalogExpansion::SharedPtr create_analog_expansion(uint8_t const exp_num);
+
+private:
+  UA_Server * _server;
+
+  std::list<DigitalMechExpansion::SharedPtr> _dig_mech_exp_list;
+  std::list<DigitalStSolidExpansion::SharedPtr> _dig_solid_state_exp_list;
+  std::list<AnalogExpansion::SharedPtr> _analog_exp_list;
+};
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+} /* opcua */