Connio

The Connio API Developer Hub

Welcome to the Connio API developer hub. You'll find comprehensive guides and documentation to help you start working with Connio API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Using Predefined Device Profiles

This tutorial explains how to use predefined device profiles

Predefined device profiles come with built-in logic to automate common IoT scenarios you might need when you manage your devices. Like class inheritance in OOP, inherited device profiles carries their capabilities including their alerts with them into their child.

Since predefined profiles consist of properties and not attributes, each property can be used in different alarm scenarios. For example, if you inherit your profile from Device, and create an alert connected to Active property at Device level, your profile does also benefit from this alert automatically. See alerts for details.

Beware of IS-A relationship

Similar to OOP, Connio's device profile inheritance mechanism allows profiles to be arranged in a hierarchy that represents "is-a-type-of" relationships. For example, profile CellularDevice might inherit from profile ConnectedDevice. All the data and methods available to the parent class also appear in the child class with the same names.

Device

A generic profile to represent any type of bidirectional data source. It helps device developer to monitor data-source/device activity based on communication frequency, and track inbound and outbound traffic.

It consists of the following properties:

Name
Description
Type
Values

Active

This property is set to inactive automatically if the device is not communicating with the system within the timeframe defined by its period attribute. It is always unknown if period is not set to any positive integer duration (i.e 0).

enum

active, inactive, unknown.

LastIn

Stores the details of the last write operation completed by the device. The details consist of the name of the last written property and timestamp.

string

property name

LastOut

Stores the details of the last data successfully sent to the device by the platform. The details consist of the name of the property and timestamp.

string

property name

ConnectedDevice

A generic profile to represent any type of connected device. It helps device developer to monitor connectivity of the device. It inherits Device device profile.

It consists of the following properties:

Name
Description
Type
Values

ConnectionInfo

Provides additional information about the connectivity of the device such as its remote IP and connected endpoint. It consists of ip and endpoint fields. endpoint can be mqtt or rest.

object

ConnectionStatus

If the device is connected to the platform through MQTT, it set automatically to online by the system. Otherwise it is set to offline.

enum

online, offline.

Gateway

[TBD]

Using Predefined Device Profiles


This tutorial explains how to use predefined device profiles

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.