openmrn
diff --git a/‎examples/ESP32C3CanLoadTest/.gitignore
+1 b/‎examples/ESP32C3CanLoadTest/.gitignore
+1
diff --git a/‎examples/ESP32C3CanLoadTest/ESP32C3CanLoadTest.ino
+286 b/‎examples/ESP32C3CanLoadTest/ESP32C3CanLoadTest.ino
+286
diff --git a/‎examples/ESP32C3CanLoadTest/config.h
+78 b/‎examples/ESP32C3CanLoadTest/config.h
+78
diff --git a/‎examples/ESP32C3IOBoard/.gitignore
+1 b/‎examples/ESP32C3IOBoard/.gitignore
+1
@@ -0,0 +1 @@
+wifi_params.cpp
@@ -0,0 +1,286 @@
+/** \copyright
+ * Copyright (c) 2021, Mike Dunston
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are  permitted provided that the following conditions are met:
+ *
+ *  - Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ *  - Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * \file ESP32C3CanLoadTest.ino
+ *
+ * Main file for the ESP32-C3 CAN Load Test application.
+ *
+ * @author Mike Dunston
+ * @date 2 May 2021
+ */
+
+#include <Arduino.h>
+#include <SPIFFS.h>
+#include <esp_spi_flash.h>
+
+#include <OpenMRNLite.h>
+#include <openlcb/TcpDefs.hxx>
+
+#include <openlcb/MultiConfiguredConsumer.hxx>
+#include <utils/GpioInitializer.hxx>
+#include <freertos_drivers/arduino/CpuLoad.hxx>
+
+// Pick an operating mode below, if you select USE_WIFI it will expose
+// this node on WIFI if you select USE_TWAI, this node will be available
+// on CAN.
+// Enabling both options will allow the ESP32 to be accessible from
+// both WiFi and CAN interfaces.
+
+#define USE_WIFI
+//#define USE_TWAI
+
+// Uncomment USE_TWAI_SELECT to enable the usage of select() for the TWAI
+// interface.
+//#define USE_TWAI_SELECT
+
+// uncomment the line below to have all packets printed to the Serial
+// output. This is not recommended for production deployment.
+//#define PRINT_PACKETS
+
+// If USE_TWAI_SELECT or USE_TWAI_ASYNC is enabled but USE_TWAI is not, enable
+// USE_TWAI.
+#if defined(USE_TWAI_SELECT) && !defined(USE_TWAI)
+#define USE_TWAI
+#endif // USE_TWAI_SELECT && !USE_TWAI
+
+#include "config.h"
+
+/// This is the node id to assign to this device, this must be unique
+/// on the CAN bus.
+static constexpr uint64_t NODE_ID = UINT64_C(0x05010101182c);
+
+#if defined(USE_WIFI)
+// Configuring WiFi accesspoint name and password
+// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+// There are two options:
+// 1) edit the sketch to set this information just below. Use quotes:
+//     const char* ssid     = "linksys";
+//     const char* password = "superSecret";
+// 2) add a new file to the sketch folder called something.cpp with the
+// following contents:
+//     #include <OpenMRNLite.h>
+//
+//     char WIFI_SSID[] = "linksys";
+//     char WIFI_PASS[] = "theTRUEsupers3cr3t";
+
+/// This is the name of the WiFi network (access point) to connect to.
+const char *ssid = WIFI_SSID;
+
+/// Password of the wifi network.
+const char *password = WIFI_PASS;
+
+/// This is the hostname which the ESP32 will advertise via mDNS, it should be
+/// unique.
+const char *hostname = "esp32mrn";
+
+OVERRIDE_CONST(gridconnect_buffer_size, 3512);
+//OVERRIDE_CONST(gridconnect_buffer_delay_usec, 200000);
+OVERRIDE_CONST(gridconnect_buffer_delay_usec, 2000);
+OVERRIDE_CONST(gc_generate_newlines, CONSTANT_TRUE);
+OVERRIDE_CONST(executor_select_prescaler, 60);
+OVERRIDE_CONST(gridconnect_bridge_max_outgoing_packets, 2);
+
+#endif // USE_WIFI
+
+#if defined(USE_TWAI)
+// This is the ESP32-C3 pin connected to the SN65HVD23x/MCP2551 R (RX) pin.
+// Note: Any pin can be used for this other than 11-17 which are connected to
+// the onboard flash.
+// Note: Adjusting this pin assignment will require updating the GPIO_PIN
+// declarations below for input/outputs.
+constexpr gpio_num_t TWAI_RX_PIN = GPIO_NUM_18;
+
+// This is the ESP32-C3 pin connected to the SN65HVD23x/MCP2551 D (TX) pin.
+// Note: Any pin can be used for this other than 11-17 which are connected to
+// the onboard flash.
+// Note: Adjusting this pin assignment will require updating the GPIO_PIN
+// declarations below for input/outputs.
+constexpr gpio_num_t TWAI_TX_PIN = GPIO_NUM_19;
+
+#endif // USE_TWAI
+
+// This is the primary entrypoint for the OpenMRN/LCC stack.
+OpenMRN openmrn(NODE_ID);
+
+// This tracks the CPU usage of the ESP32-C3 through the usage of a hardware
+// timer that records what the CPU is currently executing roughly 163 times per
+// second.
+CpuLoad cpu_load;
+
+// This will report the usage to the console output.
+CpuLoadLog cpu_log(openmrn.stack()->service());
+
+// ConfigDef comes from config.h and is specific to this particular device and
+// target. It defines the layout of the configuration memory space and is also
+// used to generate the cdi.xml file. Here we instantiate the configuration
+// layout. The argument of offset zero is ignored and will be removed later.
+static constexpr openlcb::ConfigDef cfg(0);
+
+#if defined(USE_WIFI)
+Esp32WiFiManager wifi_mgr(ssid, password, openmrn.stack(), cfg.seg().wifi());
+#endif // USE_WIFI
+
+#if defined(USE_TWAI)
+Esp32HardwareTwai twai(TWAI_RX_PIN, TWAI_TX_PIN);
+#endif // USE_TWAI
+
+// This will perform the factory reset procedure for this node's configuration
+// items.
+//
+// The node name and description will be set to the SNIP model name field
+// value.
+// Descriptions for intputs and outputs will be set to a blank string, input
+// debounce parameters will be set to default values.
+class FactoryResetHelper : public DefaultConfigUpdateListener {
+public:
+    UpdateAction apply_configuration(int fd, bool initial_load,
+                                     BarrierNotifiable *done) OVERRIDE {
+        AutoNotify n(done);
+        return UPDATED;
+    }
+
+    void factory_reset(int fd) override
+    {
+        cfg.userinfo().name().write(fd, openlcb::SNIP_STATIC_DATA.model_name);
+        cfg.userinfo().description().write(
+            fd, openlcb::SNIP_STATIC_DATA.model_name);
+    }
+} factory_reset_helper;
+
+namespace openlcb
+{
+    // Name of CDI.xml to generate dynamically.
+    const char CDI_FILENAME[] = "/spiffs/cdi.xml";
+
+    // This will stop openlcb from exporting the CDI memory space upon start.
+    extern const char CDI_DATA[] = "";
+
+    // Path to where OpenMRN should persist general configuration data.
+    extern const char *const CONFIG_FILENAME = "/spiffs/openlcb_config";
+
+    // The size of the memory space to export over the above device.
+    extern const size_t CONFIG_FILE_SIZE = cfg.seg().size() + cfg.seg().offset();
+
+    // Default to store the dynamic SNIP data is stored in the same persistant
+    // data file as general configuration data.
+    extern const char *const SNIP_DYNAMIC_FILENAME = CONFIG_FILENAME;
+}
+
+// Callback function for the hardware timer configured to fire roughly 163
+// times per second.
+void ARDUINO_ISR_ATTR record_cpu_usage()
+{
+#if CONFIG_ARDUINO_ISR_IRAM
+    // if the ISR is called with flash disabled we can not safely recored the
+    // cpu usage.
+    if (!spi_flash_cache_enabled())
+    {
+        return;
+    }
+#endif
+    // Retrieves the vtable pointer from the currently running executable.
+    unsigned *pp = (unsigned *)openmrn.stack()->executor()->current();
+    cpuload_tick(pp ? pp[0] | 1 : 0);
+}
+
+void setup()
+{
+    Serial.begin(115200L);
+    LOG(INFO, "[Node] ID: %s", uint64_to_string_hex(NODE_ID).c_str());
+    LOG(INFO, "[SNIP] version:%d, manufacturer:%s, model:%s, hw-v:%s, sw-v:%s"
+      , openlcb::SNIP_STATIC_DATA.version
+      , openlcb::SNIP_STATIC_DATA.manufacturer_name
+      , openlcb::SNIP_STATIC_DATA.model_name
+      , openlcb::SNIP_STATIC_DATA.hardware_version
+      , openlcb::SNIP_STATIC_DATA.software_version);
+
+    // Register hardware timer zero to use a 1Mhz resolution and to count up
+    // from zero when the timer triggers.
+    auto timer = timerBegin(0, 80, true);
+    // Attach our callback function to be called when the timer is ready to
+    // fire. Note that the edge parameter is not used/supported on the
+    // ESP32-C3.
+    timerAttachInterrupt(timer, record_cpu_usage, true);
+    // Configure the trigger point to be roughly 163 times per second.
+    timerAlarmWrite(timer, 1000000/163, true);
+    // Enable the timer.
+    timerAlarmEnable(timer);
+
+    // Initialize the SPIFFS filesystem as our persistence layer
+    if (!SPIFFS.begin())
+    {
+        LOG(WARNING, "SPIFFS failed to mount, attempting to format and remount");
+        if (!SPIFFS.begin(true))
+        {
+            LOG_ERROR("SPIFFS mount failed even with format, giving up!");
+            while (1)
+            {
+                // Unable to start SPIFFS successfully, give up and wait
+                // for WDT to kick in
+            }
+        }
+    }
+
+    // Create the CDI.xml dynamically
+    openmrn.create_config_descriptor_xml(cfg, openlcb::CDI_FILENAME);
+
+    // Create the default internal configuration file
+    openmrn.stack()->create_config_file_if_needed(cfg.seg().internal_config(),
+        openlcb::CANONICAL_VERSION, openlcb::CONFIG_FILE_SIZE);
+
+#if defined(USE_TWAI)
+    twai.hw_init();
+#endif // USE_TWAI
+
+    // Start the OpenMRN stack
+    openmrn.begin();
+
+#if defined(PRINT_PACKETS)
+    // Dump all packets as they are sent/received.
+    // Note: This should not be enabled in deployed nodes as it will
+    // have performance impact.
+    openmrn.stack()->print_all_packets();
+#endif // PRINT_PACKETS
+
+#if defined(USE_TWAI_SELECT)
+    // add TWAI driver with select() usage
+    openmrn.add_can_port_select("/dev/twai/twai0");
+
+    // start executor thread since this is required for select() to work in the
+    // OpenMRN executor.
+    openmrn.start_executor_thread();
+#else
+    // add TWAI driver with non-blocking usage
+    openmrn.add_can_port_async("/dev/twai/twai0");
+#endif // USE_TWAI_SELECT
+}
+
+void loop()
+{
+    // Call the OpenMRN executor, this needs to be done as often
+    // as possible from the loop() method.
+    openmrn.loop();
+}
@@ -0,0 +1,78 @@
+#ifndef _ARDUINO_EXAMPLE_ESP32IOBOARD_CONFIG_H_
+#define _ARDUINO_EXAMPLE_ESP32IOBOARD_CONFIG_H_
+
+#include "openlcb/ConfiguredConsumer.hxx"
+#include "openlcb/ConfiguredProducer.hxx"
+#include "openlcb/ConfigRepresentation.hxx"
+#include "openlcb/MemoryConfig.hxx"
+
+#include "freertos_drivers/esp32/Esp32WiFiConfiguration.hxx"
+
+// catch invalid configuration at compile time
+#if !defined(USE_TWAI) && !defined(USE_WIFI)
+#error "Invalid configuration detected, USE_CAN or USE_WIFI must be defined."
+#endif
+
+namespace openlcb
+{
+
+/// Defines the identification information for the node. The arguments are:
+///
+/// - 4 (version info, always 4 by the standard
+/// - Manufacturer name
+/// - Model name
+/// - Hardware version
+/// - Software version
+///
+/// This data will be used for all purposes of the identification:
+///
+/// - the generated cdi.xml will include this data
+/// - the Simple Node Ident Info Protocol will return this data
+/// - the ACDI memory space will contain this data.
+extern const SimpleNodeStaticValues SNIP_STATIC_DATA =
+{
+    4,
+    "OpenMRN",
+#if defined(USE_WIFI) && !defined(USE_TWAI)
+    "Arduino Load Test (WiFi)",
+#elif defined(USE_TWAI) && !defined(USE_WIFI)
+    "Arduino Load Test (TWAI)",
+#else
+    "Arduino Load Test (WiFi/TWAI)",
+#endif
+    ARDUINO_VARIANT,
+    "1.00"
+};
+
+/// Modify this value every time the EEPROM needs to be cleared on the node
+/// after an update.
+static constexpr uint16_t CANONICAL_VERSION = 0x100b;
+
+/// Defines the main segment in the configuration CDI. This is laid out at
+/// origin 128 to give space for the ACDI user data at the beginning.
+CDI_GROUP(IoBoardSegment, Segment(MemoryConfigDefs::SPACE_CONFIG), Offset(128));
+/// Each entry declares the name of the current entry, then the type and then
+/// optional arguments list.
+CDI_GROUP_ENTRY(internal_config, InternalConfigData);
+#if defined(USE_WIFI)
+CDI_GROUP_ENTRY(wifi, WiFiConfiguration, Name("WiFi Configuration"));
+#endif
+CDI_GROUP_END();
+
+/// The main structure of the CDI. ConfigDef is the symbol we use in main.cxx
+/// to refer to the configuration defined here.
+CDI_GROUP(ConfigDef, MainCdi());
+/// Adds the <identification> tag with the values from SNIP_STATIC_DATA above.
+CDI_GROUP_ENTRY(ident, Identification);
+/// Adds an <acdi> tag.
+CDI_GROUP_ENTRY(acdi, Acdi);
+/// Adds a segment for changing the values in the ACDI user-defined
+/// space. UserInfoSegment is defined in the system header.
+CDI_GROUP_ENTRY(userinfo, UserInfoSegment, Name("User Info"));
+/// Adds the main configuration segment.
+CDI_GROUP_ENTRY(seg, IoBoardSegment, Name("Settings"));
+CDI_GROUP_END();
+
+} // namespace openlcb
+
+#endif // _ARDUINO_EXAMPLE_ESP32IOBOARD_CONFIG_H_
@@ -0,0 +1 @@
+wifi_params.cpp