Configuration Parameters for Devices

Configuration Parameters for Devices

Configuration Parameters are key-value pairs that enable you to customize the behavior of your Devices in different scenarios. For example, you can use them to specify how to decode data or send downlink messages, filter your devices on Widgets, or interact with API & Analysis scripts.

1. How it works

Configuration Parameters are stored on the configuration page of your device. You can access it by clicking on the Devices module on the left menu and selecting a device. You will see a tab called Configuration Parameters, where you can add, edit, or delete them.



Each Configuration Parameter has three configurable fields:
  1. Key:  name of the parameter that you can use to reference in your code or widgets.
  2. Value: the value of the parameter you want to assign to your device.
  3. Read & Unread: boolean value (true or false) that indicates whether the parameter has been sent to the device or not.
Alert
The maximum number of parameters per Device is 60.
If you attempt to add additional items beyond the limit, a notification will appear indicating that the maximum capacity has been reached.

2. Using parameters for different scenarios

You can use Configuration Parameters in different ways depending on your application design. Here are some common use cases:

2.1. Payload Parser

This script runs on TagoIO every time a device sends data. It allows you to decode and transform the raw data into meaningful information. You can use Configuration Parameters to change how the parser works based on some conditions. For example, you can have a parameter called mode with values normal or debug and then write different parsing logic depending on its value.
NotesRead more about Payload Parser.

2.2. Device List Widget

This widget displays a list of devices with some information about them. Configuration Parameters can show additional details about each device, such as its firmware version or battery level. You can also use them to filter or sort devices based on their parameters. 
NotesRead more about the Device List Widget.

2.3. API and Analysis

These tools allow you to interact with your devices programmatically using HTTP requests or JavaScript code. You can use Configuration Parameters to send commands or queries to your devices using their Device-Token only. For example, you can have a parameter called downlink with a payload value that you want to send to your device as an instruction. After sending it successfully, you can change its sent value from false to true.
Notes
Check our API and Analysis documentation.

3. How to manage your parameters

There are different ways to manage Configuration Parameters for your devices:
  1. Manually: You can add, edit, or delete parameters directly from the device page on TagoIO using its user interface. 
  2. Analysis SDK: You can use JavaScript code to create an analysis script that runs on TagoIO and performs actions on your parameters using methods like paramList, paramSet, paramRemove, etc. 
  3. API endpoint: You can use HTTP requests (GET, POST, PUT, DELETE) with JSON payloads to communicate with TagoIO's API endpoint for managing parameters. 
  4. Widgets: Some widgets allow you to natively edit your device configuration parameters such as the Device List Widget​.
You can choose any of these methods depending on your preference and needs.

Idea
Need help? Visit our Community to access useful resources, tips, and tutorials, and connect with other developers for valuable insights.


    • Related Articles

    • Devices

      Device is the link between your external things and the data in your account. To allow anything to send or receive data from TagoIO, you need to create a device. The communication between external devices and TagoIO is done via HTTP or MQTT methods ...

    • Blueprint Devices

      Blueprint Devices are dynamic Devices available on Blueprint Dashboards. They can be changed by the user in realtime, and by doing so, the Dashboard will reload the data for the Widgets that use them. You can change the Blueprint Devices by selecting ...

    • Managing Devices

      Using the account-token, you can manage your devices through API requests. It’s possible to create, edit, delete, and get info of it. Create Create a device through POST method. POST - https://api.tago.io/device Request { "name": "My first device", ...

    • Custom Widget Parameters

      Parameters allow you to send a list of keys and values to your custom widget. One use of these parameters is to change the way your code behaves. You can have two widgets pointing to the same link, but exhibiting different behaviors. Each parameter ...

    • RadioBridge Devices

      TagoIO is fully integrated with RadioBridge devices, that are connected over Sigfox or LoRaWAN, by providing the perfect integration with the Radio Bridge backend.  Read more about Radio Bridge. All data sent by your device will be readily available ...