This Plugin is optimized to automatically decode The Things Stack v3 Uplink JSON schema (parsing items such as gateways metadata so you don’t have to!), while still allowing for full decoder customization using NodeJS.
- An active Ubidots account. This plugin is available to our free STEM users too 😎
- An active The Things Stack account
Table of Contents
- Creating a TTS Plugin
- Decoding payloads from TTS connected devices
- Editing the Plugin's device type
- Feedback & suggestions
1. Creating a TTS Plugin
A TTS plugin is a serverless function that exposes a private HTTP Endpoint URL optimized to decode The Things Stack uplink JSON payload. Every time an HTTP POST request is received at such URL, a pre-defined decoding function will be executed.
To create your private HTTP Endpoint URL:
- In your Ubidots account, go to the "Devices" tab, click on "Plugins", then click on the "+" icon to create a new Plugin. Search for the TTS Plugin and click on it:
2. The plugin instructions will appear. Click on the "Next" icon, then review the input parameters:
- Ubidots device type: An Ubidots device type will be created and linked to this plugin. This allows you to make batch changes to all of the devices that receive data through this plugin.
- Ubidots token: Select the Ubidots token you'd like to use for this plugin. We recommend creating a new token dedicated to this plugin only, should you need to increase its rate limit in the future.
3. Finish the process and a new plugin will appear in the Plugins list:
4. Click on the newly-created TTS Plugin, click on the "Decoder" tab, and copy the "HTTPs Endpoint URL". The structure of the URL is:
You'll need to use the <CODE> and <ID> later, separately.
5. Finally, go to your The Things Stack account, click on the desired Application then on "Integrations" => "Webhooks", then click on "Add webhook" => "Custom webhook". Pick a name for your webhook, and fill in these fields:
- Base URL: https://dataplugin.ubidots.com/data-plugins/plugin_code_<CODE>/function/
You'll need to replace the <CODE> with your plugin's code as seen in step 4.
- Additional headers: Add an "X-Auth-Token" header with a valid Ubidots token
- Uplink message: Mark this checkbox and enter the remaining portion of your Plugin's HTTPs endpoint URL, which in this case is simply the <ID> of the plugin as seen in step 4
2. Decoding payloads from TTS-connected devices
After creating a TTS Plugin and clicking on it, you will see a "Decoder" tab, which contains a "Decoding Function" that you can edit at will, in order to decode your data frames.
By default, you will see a pre-loaded sample decoder that does the following:
- Logs RSSI and SNR to Ubidots variable; one for each gateway receiving a signal from your device.
- Logs a Frame counter and Port to Ubidots variables.
- If found, the JSON key "uplink_message.decoded_payload" will be forwarded as-is to Ubidots, assuming it has an Ubidots-friendly format. If not, then a custom decoder can be used to decode the base64 frame sent in "uplink_message.frm_payload".
Ubidots will automatically create a device every time a payload from a new device is received. This saves you the need to manually create hundreds or thousands of devices, or copy-and-paste DevEUI's from one platform to the other.
See here how a sample TTS JSON payload is mapped to an Ubidots device and its variables:
Please note that you can change some but not all of the above mappings:
Data mapping that CAN be edited from the decoding function:
- Gateway metadata: You may choose to drop unwanted gateway data such as SNR or RSSI
- Variables: You may choose to drop variables, or even create new ones using NodeJS 10 (See supported libraries)
- Timestamp: You may choose to ignore the payload's "received_at" timestamp and have Ubidots API assign one automatically upon reception
Data mapping that CANNOT be edited in the decoding function:
- Device label and name: The Plugin always uses TTS "device_id" as Ubidots device label. Upon creation, Ubidots will inherit the device name from the device label, but you can change the name later.
- Device properties: The Plugin always uses these keys as Ubidots device properties: "end_device_ids.application_ids.application_id", "end_device_ids.dev_eui", and "end_device_ids.dev_addr".
If you wish to have control over these, you may want to build your own UbiFunction instead.
3. Editing the Plugin's device type
An Ubidots device type will be created and linked to this plugin. This allows you to make batch changes to all of the devices that receive data through this plugin.
For example, let's imagine you edited the decoding function to generate two variables: Temperature and Pressure. By default, these variables will contain default colors and icons, and no units. If you wish every future device to have an automatic and custom configuration for these variables, then you will want to change the device type:
The best way to test the plugin is by making an HTTP request to the Plugin's URL. Just grab the sample JSON payload below, and send it in an HTTP POST request using an HTTP client of your choice (Postman or similar). Make sure you add the header "Content-Type:application/json":
Sample TTS JSON payload:
Send the above payload in an HTTP POST request to the Plugin's URL:
Please note the first time the plugin is executed, it may take a few seconds to respond. To check the Plugin logs, go to the Plugin, click on the "Logs" section and you should see a list of the latest executions.
5. Feedback and suggestions
Learn more about other plugins: