feat: refactor thingsboard flows to modernize them (#109)

Author: reubenmiller

.release-please-manifest.json

@@ -6,7 +6,7 @@
   "flows/log-surge": "1.4.0",
   "flows/measurement-aggregator": "0.1.0",
   "flows/protobuf-xform": "0.2.1",
-  "flows/thingsboard": "0.1.0",
+  "flows/thingsboard-telemetry": "0.1.0",
   "flows/thingsboard-registration": "0.1.0",
   "flows/thingsboard-server-rpc": "0.1.0",
   "flows/uptime": "1.3.0",

flows/thingsboard-registration/README.md

@@ -38,10 +38,10 @@ Register the main device beforehand. It must be **gateway**. The device ID and a
 
 ### Flow Configuration
 
-Then, set `config.main_device_name` to your device's main name in `flow.toml`.
+Then, set `main_device_name` to your device's main name in `params.toml`.
 
 ```toml
-config.main_device_name = "{{MAIN_DEVICE_NAME}}"
+main_device_name = "{{MAIN_DEVICE_NAME}}"
 ```
 
 If you are unsure which value to use, run the following command to get your device ID:
@@ -126,7 +126,7 @@ For child devices and services, the name is determined by the following priority
 
 Device names are generated by filtering out empty path segments and joining the remaining parts with colons (`:`).
 
-Example: (Assuming `config.main_device_name` is set to **MAIN**)
+Example: (Assuming `main_device_name` is set to **MAIN**)
 
 | thin-edge.io Topic Pattern         | ThingsBoard Name                |
 | :--------------------------------- | :------------------------------ |

flows/thingsboard-registration/flow.toml

@@ -11,6 +11,6 @@ mqtt.topics = [
 
 [[steps]]
 script = "lib/main.js"
-config.main_device_name = "{{MAIN_DEVICE_NAME}}"
-config.default_device_profile = "default"
-config.max_pending_messages = 100
+config.main_device_name = "${.params.main_device_name}"
+config.default_device_profile = "${.params.default_device_profile}"
+config.max_pending_messages = "${.params.max_pending_messages}"

flows/thingsboard-registration/package.json

@@ -5,6 +5,9 @@
   "source": "src/main.ts",
   "module": "lib/main.js",
   "type": "module",
+  "tedge": {
+    "mapper": "thingsboard"
+  },
   "scripts": {
     "build": "esbuild src/main.ts --target=es2018 --bundle --outfile=lib/main.js --format=esm --drop-labels=DEV,TEST",
     "test": "jest --coverageProvider=v8 --coverage"

flows/thingsboard-registration/params.toml.template

@@ -0,0 +1,8 @@
+# Name to register the main device as
+main_device_name = "{{MAIN_DEVICE_NAME}}"
+
+# ThingsBoard device profile applied when `type` is not specified in registration payload
+default_device_profile = "default"
+
+# Maximum number of messages to buffer per unregistered device
+max_pending_messages = 100

flows/thingsboard-server-rpc/package.json

@@ -5,6 +5,9 @@
   "source": "src/main.ts",
   "module": "lib/main.js",
   "type": "module",
+  "tedge": {
+    "mapper": "thingsboard"
+  },
   "scripts": {
     "build": "esbuild src/main.ts --target=es2018 --bundle --outfile=lib/main.js --format=esm --drop-labels=DEV,TEST",
     "test": "jest --coverageProvider=v8 --coverage"

flows/thingsboard/CHANGELOG.md flows/thingsboard-telemetry/CHANGELOG.mdflows/thingsboard/CHANGELOG.md renamed to flows/thingsboard-telemetry/CHANGELOG.md

@@ -25,6 +25,8 @@ For the support of RPC/commands, use a dedicated flow [ThingsBoard RPC flow](../
 
 ## Flow Custom Configuration
 
+The following properties can be set in the flow's `params.toml` file. You can copy the `params.toml.template` file to create a new `params.toml` file to customize the values accordingly.
+
 - `add_type_to_key`: `<true|false>`
   - Determines whether the measurements/twin type is prefixed to the keys.
   - For example,

flows/thingsboard/README.md flows/thingsboard-telemetry/README.mdflows/thingsboard/README.md renamed to flows/thingsboard-telemetry/README.md

@@ -18,8 +18,7 @@ config.reformat = true
 script = "lib/main.js"
 
 interval = "10m"
-config.add_type_to_key = true
-config.alarm_prefix = "alarm::"
-config.event_prefix = "event::"
-config.enable_heartbeat = true
-
+config.add_type_to_key = "${.params.add_type_to_key}"
+config.alarm_prefix = "${.params.alarm_prefix}"
+config.event_prefix = "${.params.event_prefix}"
+config.enable_heartbeat = "${.params.enable_heartbeat}"

flows/thingsboard/flow.toml flows/thingsboard-telemetry/flow.tomlflows/thingsboard/flow.toml renamed to flows/thingsboard-telemetry/flow.toml

@@ -1,10 +1,13 @@
 {
-  "name": "thingsboard",
+  "name": "thingsboard-telemetry",
   "version": "0.1.0",
   "description": "This flow demonstrates how to map thin-edge.io data to ThingsBoard.",
   "source": "src/main.ts",
   "module": "lib/main.js",
   "type": "module",
+  "tedge": {
+    "mapper": "thingsboard"
+  },
   "scripts": {
     "build": "esbuild src/main.ts --target=es2018 --bundle --outfile=lib/main.js --format=esm --drop-labels=DEV,TEST",
     "test": "jest --coverageProvider=v8 --coverage"