IoTConnect

IoTConnect

How do we secure your device and application credentials?

When devices are registered or Company CPID are generated, the authentication token is salted and hashed. This means your company’s credentials can never be recovered from our systems.

What are different authentication criteria for data integration API?

There are three types of authentication methods: Key, X509 (self-signed and CA) and TPM. To learn more about this you can browse our user guide.

How can I generate push URL for Power BI?

Please contact us for more details on the same.

What is the purpose of IGNORE PREFERENCE button in notification?

If the user that you want to share notification with is not assigned permission to get notified, by clicking on this button you can overwrite the permission. This means the user(s) can get notifications if ‘ignore preference’ is selected.

What is difference between WebHook and Push notification?

If you select WebHook, you will get a textbox to enter call back URL. For Push notifications, you’ll have to enter device details to get notifications on those devices.

What is different between Data Ingestion API and Data Export API?

With Data Ingestion API, you can import data from different sources whereas with Data Export API, you can export data to specified sources.

Can we export the data older than month using Data Export API?

Yes, by using Data Export API, you can export older data as well.

What is Data Export API? How can I export data from IoTConnect data to other platform?

You can export data from IoTConnect via input server connection info.

What is Telemetry in Cosmos DB, Service Bus API, Event Hub API, Blob Storage API, and Storage Queue API

If you want to export data to Azure Cosmos DB or Blob Storage or any other APIs mentioned in the list, integrate with any third-party systems like ERP, CRM via service bus, or to service queue for further analysis depending on the use case – you can do all that from here.

What is Custom File Storage?

You can extract the telemetry data you are capturing via sensors through REST API. To extract the data, just enter your storage name in the field of custom file storage. Read our how to guide on settings and configuration to know more.

Do I need to have Power BI account to generate report in IoTConnect?

Yes, you need to have your own Power BI subscription to generate reports in IoTConnect.

What can I do with Power BI connector?

You can connect IoTConnect with your Power BI subscription and get interactive reports. Read more about connectors here.

What is telemetry in reporting database?

It allows you to export data from the IoTConnect to the MS SQL server, you can simply insert the connection string of your server and the system will start to export data.

What we can do with Data Integration API? What is the purpose of Data Integration API?

Data integration API allows you to import your data. Read more about it here.

Can we resend(re-execute) the failed commands?

You can re-execute the failed command again by entering the same parameters as defined earlier from the command segment.

Can we find the record of executed commands?

In the Commands segment, you can see the list of command history with fields like command, device, executed on, etc.

How to create commands?

You can create commands form template segment. Refer to template segment of our how to guide.

What is parameter value in commands?

Parameter is a mandatory field to be filled only if “parameter required” is selected while creating templates. The command will be executed only if the parameter is met. Read more here.

Can we execute commands for single device?

Yes, executing command on single device is possible by selecting “selected devices” radio button from Command Execution segment. Read more in how to guide – command segment.

What are commands in IoTConnect?

IoTConnect’s command feature provides the system with actions to be performed on given devices. Commands can be executed when any device receives data other than rules defined in the system.

Can we delete the rule?

Yes, you can delete rule by clicking on the delete icon which you can find in the ride side of the rule list. To get detailed insights on rules check out how to guide.

Can we update recipient rule once in action?

Yes, you can change the recipients once the rule is in action.

Can we configure rule alert for group of people?

Yes, you can notify a group of people when the rule is executed by selecting the roles that you want to share the permission.

How can we get notified once event triggers?

When an event is triggered you will be notified by the notification method that you have selected like email or UI alert.

What are different types of notification?

You can send notifications via email, push notification, UI alert that notifies you on the platform itself, MQTT, WebHook, also via executing device command.

Is it necessary to create Entity to create rule? Do I need to associate rule with Entity?

If you want to apply the rules on all the devices of an entity, it is essential to first create entity and assign devices to that entity.

What are templates in rules? Do I need to create template before creating rules?

Yes, you need to create template before creating rules for better device management. You can read more on templates here.

What is different between Standard Rule and Smart Rule?

You can set a standard rule by defining single condition for single device. While a smart rule is when you associate multiple conditions for a single device. Example: if you set temperature>50 for device1, it will be a standard rule and if you set temperature>50 and humidity>40 for device1, it will be a smart rule.

What are Rules in IoTConnect? Why do we need to create Rules?

To get notified about unusual behavior of your devices, you need to set conditions on those devices. If these conditions aren’t met, you get notified by several methods like UI alert, email, and others modes. These conditions in IoTConnect are termed as rules. Get more details in our Rules management guide.

How do I configure (create) rules?

Once you have logged in to the portal, you will be able to see Rules segment on the left of the navigation pane. You can then create rules by clicking on the Rule button given on the top right corner of the screen. For further details you can check how to guide on Rules management.

Why can’t I use one certificate for all my devices, why must I have a different certificate for every single device?

You must do this because the certificate contains what is called the “CName”. For example, www.abc.com. A common name can also be an IP address. The common name must match whatever you put into the browser’s URL box. If you put an IP address in the browser’s URL box, the certificate must then have a common name that matches. If you try to reuse one certificate it will fail because to talk to different devices, you must use different names or addresses and the common name in the certificate will not match.

How do we secure IoT information management within your company?

The browser-based GUI and REST APIs are fronted by HTTPS, with a certificate signed by one of top most SSL providers in the world, so you can trust that you’re connecting to the genuine IoT Platform. Using the REST API requires a Solution Key and basic token. Further you can use this to make authenticate REST API calls against your company.

What type of commands can we send to devices?

Below are the example of commands that we can send to the devices.

0x00 – OK
0x01 – Device Not Registered
0x02 – Auto Register
0x03 – Device Not Found
0x04 – Device Inactive
0x05 – Object Moved

How to manage software and hardware version?

You can send/schedule a new OTA update when the new firmware of the device is available. It requires the selection of hardware and software version along with the devices for any particular entity. It will be useful when you have any changes in a device’s function/parameters.

How to add template using QUICK ADD option?

By using the JSON script, you can add template without following the all UI steps. Below are the sample JSON for quickly adding the template. Read more.

{
  "code": "CODE",
  "name": "NAME",
  "tag": "TAG(to enable GatewaySupport) | NULL",
  "attributes": [
    {
      "name": "attr",
      "type": "number | string",
      "tag": "TAG(if GatewaySupport enabled) | NULL"
    },
    {
      "name": "parent",
      "type": "object",
      "tag": "TAG(if GatewaySupport enabled) | NULL",
      "childs": [
        {
          "name": "childattr",
          "type": "number | string"
        }
      ]
    }
  ]
}

Is there any way to set default settings or constants values when the device is connected?

Yes, IoTConnect provides the twin property on template edit details where you can pass your default settings or constant value to device firmware while device connect with IotConnect for the first time. Read more.

How long is devices history retained?

By default, the system will be retained 90 days data for your history, but you can contact us if you want it more.

What if the device intermittently disconnects from IoTConnect?

There many reasons behind not receiving telemetry data. The below are a few points that need to check to find out the problem.

Wrong MQTT configuration or wrong connection string
Port is not enabled on network settings
Wrong configuration on Azure IoT Hub
Wrong Topic
Timezone on server and your profile is different
Wrong JSON format

What is the use of Custom Fields? or How to add Custom Fields in the user module?

IoTConnect provides for end customers to create Custom Fields based on requirement in User/Device/Entity level. To add Custom Fields, visit knowledge base.

For example, if you want to add Title Field which consist of Mr., Mrs. or Miss value, you can create Custom Field with “Select” option and add all possible value on it.

How to import bulk devices in to the portal?

IoTConnect has a feature to add large numbers of devices by using the batch import module, read more.

What type of devices are supported? Or What are the different devices that you can monitor?

There are a huge numbers of different hardware types, firmware versions, revisions and other variations of devices that are available in the IoT market. It is very much difficult to ensure plug and play compatibility with each and every device available in the market but we ensure you to help in making the most of the devices compatible with your system. please check out article to get more details.

What are the common SDK steps to connect a device to Cloud?

SDK integration consists of 3 parts.

1. Initialize / Create IoTConnectSDK Object
2. Send Data
3. Receive Data / Callback function

All cloud communication happens through this. Go to our Client Libraries and SDK page for more information.

What is Device Simulator?

It simulates any devices for the defined interval and duration of the time. You can simulate hundreds of virtual connected devices, without having to configure and manage physical devices. To learn more, please click here.

Is there limit for define attributes or sensors in device template?

No, you can as many attributes as you want on your devices.

What are the basic requirements for creating a device?

Before creating a device, you should have at least one entity and device template. You can refer to our how-to guide on devices for more details.

How to assign specific devices to the user group?

Use device group module, allocation device feature to add device on specific group.

To create a device, you need to go to Device Template and Entity. You can create different users under the entity, it will automatically assign all devices to users who are in the selected entity at the time of creating devices.

How do we make a white label solution using IoTConnect?

Yes, IoTConnect provides the option to develop a white label solution. For more information, contact our sales team via email or call us on +1 866 345 7638

What are the best practices of using Entity?

An entity is the company/location based hierarchy where users can manage various entities/companies under which various devices and users can be managed. The entity in this portal has a feature to support multiple companies/locations in relation to parent-child architecture. This facilitates a user to manage multiple sub-companies under a parent company and provision to get analytics/reports based on single as well as the group of entities.

Below are the different use cases for Entity.

Use Case 1– The requirement is to manage devices under the person who is operating that device. You can use the entity as an operator and create a user under the entity. Next, at the time of creating a device, assign that operators entity.

Use Case 2– You can leverage the entity when you need to manage the multiple company locations or create sub companies under the parent company.

Use Case 3– The requirement is to manage services stations of the company. You can define the service station as a entity and assign the devices under the service stations.

Use Case 4– The requirement is to manage the mobile van which consist of the device. You can create the mobile van as a entity and leverage it.

What is the use of Role and Permissions?

You can create and manage the user role along with defining module wise permissions from this section. Moreover, you can manage the status of all users’ roles. Read more.

What is CPID?

IoTConnect will generate the isolated environment for each company, and for communication with a device, the system will generate the CPID (unique code for each company), which is used for further communication from device to IotConnect.

How do I get started with IoTConnect?

You need to send an email/contact us for creating an account for IoTConnect. Once you receive the account details, follow the steps as mentioned in our guide to get started.

What is OTA update?

An over-the-air (OTA) update is a mechanism for remotely updating internet-connected hardware with new settings, software, and/or firmware. The OTA update mechanism is a core part of a system’s architecture, with the remote hardware device being responsible for identifying and applying updates to itself, and the cloud server responsible for distributing updates to its connected hardware clients.

How to set data range?

In data validation, add data range with “to” keyword for integer e.g., 40 to 70, -40 to 20 for string and for character add comma separated list, e.g, Red, Blue, Green. String data is case insensitive.

What is Tumbling Window?

Tumbling windows are a series of non-overlapping and contiguous time intervals to send data from device to cloud. When you have Edged Support device template at that time, you need to give aggregation and time to send data to IoTConnect that is collected.

How does object data type work?

You can use OBJECT data type when you require to define sensors which contains more than one value, For example: gyroscope – gyro : { x : 1 , y : 2 , z : }

What are the supported data types?

IoTConnect supports three data types – 1) Number, 2) String, and 3) Object.

    1. Number : any Number data
    2. String : any string or character data
    3. Object : any JSON data ex. gyro : { x : 1 , y : 2 , z : }

What is Edge Device?

An edge device is any piece of hardware that controls data flow at the boundary between two networks. Edge devices fulfil a variety of roles, depending on what type of device they are, but they essentially serve as network entry (or exit) points. Some common functions of edge devices are the transmission, routing, processing, monitoring, filtering, translation and storage of data passing between networks.

What is the use of Device Template?

It is a JSON file which contains the device sensors, commands and default configuration information, which is used by SDK to communicate with the IoTConnect platform. In other words, it’s responsible for cloud to device and device to cloud communications.