Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Within our myDevices Console, you have the ability to create device templates and codecs for various devices, such as sensors, actuators, gateways, tags, and more, as well as services for storing data, setting up alerts, visualizing data using custom dashboards, and transmitting data to other business intelligence (BI), artificial intelligence (AI), computerized maintenance management system (CMMS), or asset management software. Users can create templates and codecs for any use case or customer requirement, and manufacturers can easily onboard their complete hardware catalog and make it publicly available for widespread use. The possibilities are limitless. Follow the steps below to get started.

What is a Device Template?
A Device Template is a configuration blueprint for an IoT device, sensor, or gateway. It provides a structured way to define and manage the characteristics and capabilities of that device within myDevices' application. A Device Template is comprised of the following:

General information about the device, such as name, description, and manufacturer, etc.
Codec: used to decode or parse the payload of the device. See Codecs
Capabilities: Sensors or Actuators the device supports.
Attributes: UI settings conditions for specific use cases.
Alert Types: Alerts are generated based on capabilities.
Device Uses: used to define the use case of the device.


What is a Codec?
A codec for a device template is a script or set of instructions used to decode the raw data payload from IoT devices into a more meaningful and structured format. This ensures that the incoming data can be correctly interpreted and utilized by myDevices.

Why do I need a Device Template and Codec?
Device templates and codecs are required to onboard devices into myDevices. They are used to define the capabilities of the device, how the data is decoded, and how the data is displayed in the UI. Device templates and codecs are also used to define the use case of the device, which is used to determine the appropriate alert types and attributes for the device.

Get Started Steps

  1. Log into console.mydevices.com

  2. Create a Device Template (add screenshot): Go to the Device Templates Tab. Here, you can access all templates you've created for your applications and organization. You'll also find example templates that can serve as starting points. To begin, click on "Add Device Template" in the top-right corner.

...

  1. Import or create a Codec into Codec Editor

...

Sample and Minimal Codec

Here is a minimal source code for the decoder.js file, with included comments explaining things.

...

Since it’s running in a sandbox, you can also use usual console.log and console.error JavaScript function, and see the result directly in the editor. However those functions will be ignored when decoding real data (from real device) in order to speed up execution time.

Using LoRaWAN Codec API

In order to use LoRaWAN type-of Codec, you just have to include the function in your myDevices codec, call it with proper arguments, and then map and send the result into sensor objects (with channel/type/unit/value).

...