TS COM - add simple communication sample

Signed-off-by: Bobby Noelte <[email protected]>

Author: b0661

zephyr/samples/simplecom/CMakeLists.txt

@@ -0,0 +1,34 @@
+# Copyright (c) 2021 Bobby Noelte.
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.13.1)
+
+# Get base directory.
+# Assumption: this file is within the zephyr/samples/basic subdir of the thingset library.
+get_filename_component(THINGSET_BASE "${CMAKE_CURRENT_SOURCE_DIR}/../../.." ABSOLUTE)
+message(STATUS "THINGSET_BASE: ${THINGSET_BASE}")
+
+# Search for Zepyhr installed side by side to thingset device library.
+# This is a fallback in case ZEPHYR_BASE is not given.
+set(zephyr_base $ENV{ZEPHYR_BASE})
+get_filename_component(MODULES_BASE "${THINGSET_BASE}/.." ABSOLUTE)
+FILE(GLOB modules LIST_DIRECTORIES true "${MODULES_BASE}/*")
+foreach(module ${modules})
+    set(full_path ${module}/Kconfig.zephyr)
+    if(EXISTS ${full_path})
+        set(zephyr_base "${module}")
+        break()
+    endif()
+endforeach()
+message(STATUS "ZEPHYR_BASE: ${zephyr_base}")
+
+# Prepare native posix testing on host
+set(BOARD "native_posix")
+set(ZEPHYR_TOOLCHAIN_VARIANT "host")
+
+set(ZEPHYR_MODULES ${THINGSET_BASE})
+
+find_package(Zephyr REQUIRED HINTS ${zephyr_base})
+project(thingset_zephyr_simplecom)
+
+target_sources(app PRIVATE src/objdb.c src/porttab.c src/main.c)

zephyr/samples/simplecom/Kconfig

@@ -0,0 +1,5 @@
+# SPDX-License-Identifier: Apache-2.0
+
+mainmenu "ThingSet for Zepyhr - samples/simplecom configuration"
+
+source "Kconfig.zephyr"

zephyr/samples/simplecom/prj.conf

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: Apache-2.0
+
+CONFIG_THINGSET=y
+
+# enable all optional features to increase test coverage
+CONFIG_THINGSET_64BIT_TYPES_SUPPORT=y
+CONFIG_THINGSET_DECFRAC_TYPE_SUPPORT=y
+CONFIG_THINGSET_BYTE_STRING_TYPE_SUPPORT=y
+
+CONFIG_LOG=n
+CONFIG_THINGSET_LOG_LEVEL_DBG=y
+
+# enable communication support
+CONFIG_THINGSET_COM=y
+
+# enable loopback port for testing
+CONFIG_THINGSET_PORT_LOOPBACK_SIMPLE=y
+
+CONFIG_STDOUT_CONSOLE=y

zephyr/samples/simplecom/sample.yaml

@@ -0,0 +1,10 @@
+sample:
+  name: Blinky Sample
+tests:
+  sample.basic.blinky:
+    tags: LED gpio
+    filter: dt_enabled_alias_with_parent_compat("led0", "gpio-leds")
+    depends_on: gpio
+    harness: led
+    integration_platforms:
+      - frdm_k64f

zephyr/samples/simplecom/src/main.c

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2021 Martin Jäger / Libre Solar
+ * Copyright (c) 2021 Bobby Noelte
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+
+#include <thingset.h>
+
+/* variables to be exposed via ThingSet */
+extern char device_id[];
+extern bool enable_switch;
+extern float ambient_temp;
+
+/* the ThingSet data objects database */
+TS_OBJ_DATABASE_DECLARE(data_objects_db);
+
+/* The ports table */
+TS_PORT_TABLE_DECLARE(ports_table);
+
+/* Create context and assign data objects and ports */
+TS_CONTEXT_DEFINE(tsc, data_objects_db, ports_table);
+
+void main(void)
+{
+    uint8_t response[100];
+
+    /* initialize ThingSet context and assign data objects */
+    tsc_init(&tsc);
+
+    /*
+     * Below requests are for demonstration of the ThingSet process function only. They would
+     * usually be received from a connected serial interface or other communication channels.
+     */
+
+    /* TBD --------------
+    const char request1[] = "= {\"HeaterEnable\":true}";
+    printf("Request:   %s\n", request1);
+    ts_process(&ts, (uint8_t *)request1, strlen(request1), response, sizeof(response));
+    printf("Response:  %s\n\n", (char *)response);
+
+    const char request2[] = "!x-reset";
+    printf("Request:   %s\n", request2);
+    ts_process(&ts, (uint8_t *)request2, strlen(request2), response, sizeof(response));
+    printf("Response:  %s\n\n", (char *)response);
+
+    const char request3[] = "?";
+    printf("Request:   %s\n", request3);
+    ts_process(&ts, (uint8_t *)request3, strlen(request3), response, sizeof(response));
+    printf("Response:  %s\n\n", (char *)response);
+    */
+
+}

zephyr/samples/simplecom/src/objdb.c

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2021 Martin Jäger / Libre Solar
+ * Copyright (c) 2021 Bobby Noelte.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <thingset.h>
+
+/* variables to be exposed via ThingSet */
+char device_id[] = "ABCD1234";
+bool enable_switch = false;
+float ambient_temp = 22.3;
+
+/* function that can be called via ThingSet */
+void reset(void)
+{
+    LOG_DBG("Reset function called!\n");
+}
+
+/* the ThingSet data objects database */
+TS_OBJ_DATABASE_DEFINE(data_objects_db,
+
+    TS_ITEM_STRING(0x1D, "DeviceID", device_id, sizeof(device_id),
+                   TS_ID_ROOT, TS_ANY_R | TS_MKR_W, 0),
+
+    TS_ITEM_FLOAT(0x71, "Ambient_degC", &ambient_temp, 1, TS_ID_ROOT, TS_ANY_R, 0),
+
+    TS_ITEM_BOOL(0x61, "HeaterEnable", &enable_switch, TS_ID_ROOT, TS_ANY_RW, 0),
+
+    TS_FUNCTION(0xE1, "x-reset", &reset, TS_ID_ROOT, TS_ANY_RW),
+
+);

zephyr/samples/simplecom/src/porttab.c

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2021 Bobby Noelte.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <thingset.h>
+#include <ports/loopback_simple/loopback_simple.h>
+
+TS_PORT_TABLE_DEFINE(ports_table,
+    TS_PORT("loopa", &loopback_simple_api, &loopback_simple_a_config, &loopback_simple_a_data),
+    TS_PORT("loopb", &loopback_simple_api, &loopback_simple_b_config, &loopback_simple_b_data),
+);