deploy: 6c0deac

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7db4d84dc23f59e3467d9bb642c8d223
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/index.rst.txt

@@ -0,0 +1,50 @@
+==========================
+ThingSet SDK Documentation
+==========================
+
+`ThingSet <https://thingset.io>`_ is a transport-agnostic and self-explanatory remote API for
+embedded devices and humans.
+
+The
+`ThingSet software development (SDK) for Zephyr <https://github.com/ThingSet/thingset-zephyr-sdk>`_
+leverages the Zephyr RTOS APIs to provide ready-to-use implementations for multiple different
+interfaces / subsystems (see navigation at the left).
+
+Further interfaces like MQTT and WebSocket over WiFi are currently under development.
+
+The `ThingSet node library <https://github.com/ThingSet/thingset-node-c>`_ is used internally for
+data processing.
+
+This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International
+(CC BY-SA 4.0) License.
+
+.. image:: static/images/cc-by-sa-centered.png
+
+The full license text is available at `<https://creativecommons.org/licenses/by-sa/4.0/>`_.
+
+.. _Zephyr RTOS: https://zephyrproject.org
+.. _ThingSet: https://thingset.io
+
+.. toctree::
+    :caption: Interfaces
+    :hidden:
+
+    interfaces/serial
+    interfaces/shell
+    interfaces/ble
+    interfaces/can
+    interfaces/lorawan
+
+.. toctree::
+    :caption: Subsystems
+    :hidden:
+
+    subsys/sdk
+    subsys/log_backend
+    subsys/storage
+
+.. toctree::
+    :caption: Kconfig
+    :hidden:
+
+    kconfig

_sources/interfaces/ble.rst.txt

@@ -0,0 +1,14 @@
+Bluetooth LE
+############
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_BLE`
+* :kconfig:option:`CONFIG_THINGSET_BLE_RX_BUF_SIZE`
+
+API Reference
+*************
+
+.. doxygenfile:: include/thingset/ble.h
+   :project: app

_sources/interfaces/can.rst.txt

@@ -0,0 +1,15 @@
+CAN bus
+#######
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_CAN`
+* :kconfig:option:`CONFIG_THINGSET_CAN_THREAD_STACK_SIZE`
+* :kconfig:option:`CONFIG_THINGSET_CAN_THREAD_PRIORITY`
+
+API Reference
+*************
+
+.. doxygenfile:: include/thingset/can.h
+   :project: app

_sources/interfaces/lorawan.rst.txt

@@ -0,0 +1,13 @@
+LoRaWAN
+#######
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_LORAWAN`
+
+API Reference
+*************
+
+The LoRaWAN interface does not have any API functions. It runs in the background once enabled via
+Kconfig.

_sources/interfaces/serial.rst.txt

@@ -0,0 +1,16 @@
+Serial
+######
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_SERIAL`
+* :kconfig:option:`CONFIG_THINGSET_SERIAL_RX_BUF_SIZE`
+* :kconfig:option:`CONFIG_THINGSET_SERIAL_USE_CRC`
+* :kconfig:option:`CONFIG_THINGSET_SERIAL_ENFORCE_CRC`
+
+API Reference
+*************
+
+.. doxygenfile:: include/thingset/serial.h
+   :project: app

_sources/interfaces/shell.rst.txt

@@ -0,0 +1,14 @@
+Shell
+#####
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_SHELL`
+* :kconfig:option:`CONFIG_THINGSET_SHELL_CMD_BUF_SIZE`
+
+API Reference
+*************
+
+The Shell backend does not have any API functions. It runs in the background once enabled via
+Kconfig.

_sources/kconfig.rst.txt

@@ -0,0 +1,8 @@
+:orphan:
+
+.. _kconfig-search:
+
+Kconfig Search
+##############
+
+.. kconfig:search::

_sources/subsys/log_backend.rst.txt

@@ -0,0 +1,14 @@
+Log Backend
+###########
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_LOG_BACKEND`
+* :kconfig:option:`CONFIG_THINGSET_LOG_BACKEND_BUF_SIZE`
+
+API Reference
+*************
+
+The log backend does not have any API functions. It runs in the background once enabled via
+Kconfig.

_sources/subsys/sdk.rst.txt

@@ -0,0 +1,31 @@
+SDK
+===
+
+Configuration Options
+*********************
+
+The ThingSet SDK itself has to be enabled for all subsystems and interfaces:
+
+* :kconfig:option:`CONFIG_THINGSET_SDK`
+
+Below options define the general publication settings:
+
+* :kconfig:option:`CONFIG_THINGSET_SUBSET_LIVE_METRICS`
+* :kconfig:option:`CONFIG_THINGSET_REPORTING_LIVE_ENABLE_PRESET`
+* :kconfig:option:`CONFIG_THINGSET_REPORTING_LIVE_PERIOD_PRESET`
+* :kconfig:option:`CONFIG_THINGSET_SUBSET_SUMMARY_METRICS`
+* :kconfig:option:`CONFIG_THINGSET_REPORTING_SUMMARY_ENABLE_PRESET`
+* :kconfig:option:`CONFIG_THINGSET_REPORTING_SUMMARY_PERIOD_PRESET`
+
+Common options for the SDK:
+
+* :kconfig:option:`CONFIG_THINGSET_GENERATE_NODE_ID`
+* :kconfig:option:`CONFIG_THINGSET_SHARED_TX_BUF_SIZE`
+* :kconfig:option:`CONFIG_THINGSET_SDK_THREAD_STACK_SIZE`
+* :kconfig:option:`CONFIG_THINGSET_SDK_THREAD_PRIORITY`
+
+API Reference
+*************
+
+.. doxygenfile:: include/thingset/sdk.h
+   :project: app

_sources/subsys/storage.rst.txt

@@ -0,0 +1,19 @@
+Storage
+#######
+
+Configuration Options
+*********************
+
+* :kconfig:option:`CONFIG_THINGSET_STORAGE`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_EEPROM`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_FLASH`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_CHANGE`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_REGULAR`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_INTERVAL`
+* :kconfig:option:`CONFIG_THINGSET_STORAGE_DATA_VERSION`
+
+API Reference
+*************
+
+.. doxygenfile:: include/thingset/storage.h
+   :project: app

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}