NAV undefined
undefined
bash python javascript java

INTRODUCTION

Overview

Internet of Things ecosystems consists of many components and require different expertise to provide a good and valuable solution. One of the main components is the middleware which glues together the hardware and the application. It should have many tools that allows developers to manage and deploy devices and data efficiently. However, if one has to develop it from scratch, it will be a long winding and time consuming.

FAVORIOT PLATFORM is a middleware platform specifically designed for any Internet of Things (IoT) and Machine to Machine (M2M) solutions. The platform is developed to support the integration of data from various sensors, actuators and other sources of data. Collecting and storing data from IOT devices become much easier. Moreover, the platform also helps developers to build vertical applications. Develops does not need to worry about hosting and storing the data generated by their IoT devices.

FAVORIOT PLATFORM enables the devices to aggregates data using its REST API and other protocol available. The external application can also pull the data from Favoriot Platform using REST API.

Architecture of FAVORIOT PLATFORM

Architecture
Figure 1:  Components in FAVORIOT PLATFORM

As shown in Figure 1 above, the FAVORIOT Platform consists of several components:

How Does it Work?

Favoriot Platform Hierarchy

Device is central entity in FAVORIOT. It is used to represent the physical devices in IOT realms within the IOT middleware. Hence, the data produced by devices can be aggregated easily. FAVORIOT PLATFORM is built based on hierarchy that allows easy and efficient handling at different level.


Figure 2:  FAVORIOT PLATFORM Hierarchy

REST API

The Favoriot platform provides a REST API to manage and interact with IoT data and devices. This API allows developers to perform tasks like sending data from IoT devices, creating projects, managing applications, setting up device groups, and retrieving historical data. REST APIs in Favoriot use HTTP requests and return JSON responses, making it easy for developers to integrate IoT data into their own applications or manage devices directly.Thus section will explains the various endpoints that are involved in Favoriot Platform.

Project

A Project is the highest-level entity in Favoriot Platform and serves as a container to manage related IoT activities. Each project can hold multiple applications, groups, and devices, making it ideal for organizing devices based on objectives, users, or purposes (e.g., a smart city project or an environmental monitoring project).

Video: [HOW-TO] - Create Project

Project APIs endpoints

Get all projects

Favoriot Platform expects for the API key to be included in all API requests to the server in a header that looks like the following:

apikey: <YOUR API KEY HERE>

Make sure to replace with your API key.

# With shell, you can just pass the correct header with each request
curl -X GET --header 
'Accept: application/json' --header 
'apikey: <YOUR API KEY HERE>' 
'https://apiv2.favoriot.com/v2/'

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/projects',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});



OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects")
  .get()
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

The above command returns JSON structured like this:

{
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "project_name": "projectDefault",
      "active": true,
      "description": "No desc",
      "project_created_at": "2019-09-23T03:58:22.009Z",
      "project_developer_id": "projectDefault@favoriot",
      "project_id": "1b247924-1f9c-48d6-ae52-52c73c35768e",
      "project_updated_at": "2019-09-23T03:58:22.009Z"
    }
  ]
}

This endpoint retrieves all Project.

HTTP Request

GET /projects

QUERY PARAMETERS

Name Description Type Data Type
project_name project name query string
project_developer_id project Developer ID query string
active status of the project query boolean
created_at filter the list of results by field created_at (timestamp) query string
created_from_to Allow to specify a range of project creation query string
max define the number of results to be returned query number
order sorting the results by creation date (asc or desc) query string { ASC , DESC }
offset list project at given offset query number

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Operation Failed
503 Service Unavailable Error: Something wrong with the database or the query

Get specific project

curl -X GET --header 
'Accept: application/json' --header 
'apikey: <YOUR API KEY HERE>' 
'https://apiv2.favoriot.com/v2/projects/{project_developer_id}'


var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});




OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects/{project_developer_id}")
  .get()
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects/{project_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

The above command returns JSON structured like this:

{
  "user_id": "favoriot",
  "project_name": "Project-1",
  "active": true,
  "description": "Captures stream of IOT data",
  "project_created_at": "2019-09-24T01:41:50.613Z",
  "project_developer_id": "Project-1@favoriot",
  "project_id": "a0b7c716-cad6-43fb-b013-58d8f0cb57b9",
  "project_updated_at": "2019-09-24T01:41:50.613Z"
}

This endpoint retrieves a specific project.

HTTP Request

GET /projects/{project_developer_id}

URL Parameters

Name Description Type Data Type Required
project_developer_id ID of the project path string Yes

Responses

Status Meaning Description
200 OK Success
400 Bad Request Operation Failed
503 Service Unavailable Error: Something wrong with the database or the query

Creating a project

This endpoint creates a Project.

HTTP Request

POST /projects

curl -X POST --header 
'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
-d '{
  "project_name": "PROJECT NAME",
  "active": true,
  "description": "DESCRIPTION",
  "user_id": "USER ID"
}' 'https://apiv2.favoriot.com/v2/projects'


var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/projects',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Body parameter

{
  "project_name": "string",
  "active": true,
  "description": "string",
  "user_id": "string"
}

The above command returns JSON structured like this:

{
  "statusCode": 201,
  "message": "Project Created"
}

Description of body parameter

Name Description
project_name Name of the project.
This should be unique.
Example: Parkingproject
active true or false.
Indicate whether project is active or not.
default true. Example: true
description Brief description of project.
Example: Parking project for my house
user_id Your username for FAVORIOT platform.
Example: @FAVORIOT

URL Parameters

Name Description Type Data Type Required
project_developer_id ID of the project path string Yes

Responses

Status Meaning Description
201 Created Success
400 Bad Request Operation Failed
422 [Unprocessable Entity] validationError : Empty string or invalid character
503 Service Unavailable Error: Something wrong with the database or the query

Deleting a project

This endpoint deletes a project.

HTTP Request

DELETE /projects/{project_developer_id}

# You can also use wget
curl -X DELETE --header 
'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/projects/{project_developer_id}'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});



OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects/{project_developer_id}")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects/{PROJECT DEVELOPER ID}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

The above command returns JSON structured like this:

{
  "code": 201,
  "message": "Project Deleted"
}

Parameters

Name Description Type Data Type Required
project_developer_id ID of the project path string Yes

Responses

Status Meaning Description
201 Deleted Success
400 Bad Request Operation Failed
422 Unprocessable Entity Delete Failed: The project is currently being referred by one or more applications entity
503 Service Unavailable Error: Something wrong with the database or the query

Updating a project

Alter and update a project -- Only fields 'active','description', and 'project_updated_at' allowed to be changed.

HTTP request

PUT /projects/{project_developer_id}

# You can also use wget
curl -X PUT --header 'Content-Type: application/json' 
--header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
-d '{
  "description": "No Desc",
  "active": true
}' 
'https://apiv2.favoriot.com/v2/projects/{project_developer_id}'

var request = require("request");

var options = { method: 'PUT',
  url: 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects/{project_developer_id}")
  .put(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects/{PROJECT DEVELOPER ID}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("PUT", url, headers=headers)

print(response.text)

Body parameter

{
  "description": "No Desc",
  "active": true
}

The above command returns JSON structured like this:

{
  "code": 201,
  "message": "Project Updated"
}

Parameters

Name Description Type Data Type Required
project_developer_id ID of the project path string Yes
Body Body of the data Object Object Yes

Responses

Status Meaning Description
201 Updated Success
400 Bad Request Operation Failed
404 Not Found Updated failed : Couldn't find rows as specified by parameters in the body
503 Service Unavailable Error: Something wrong with the database or the query

Return a list of all applications from a project

HTTP request

GET /projects/{project_developer_id}/apps

# You can also use wget
curl -X GET --header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE' 
 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps'


var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

The above command returns JSON structured like this:

{
  "statusCode": 200,
  "numResults": 1,
  "results": [
    {
      "user_id": "favoriot",
      "application_name": "Application1",
      "active": true,
      "application_created_at": "2019-09-23T08:15:10.062Z",
      "application_developer_id": "Application1@favoriot",
      "application_id": "7b65056d-89c5-4ff0-bcab-93e709f7224f",
      "application_updated_at": "2019-09-23T08:15:10.062Z",
      "description": "No desc",
      "project_developer_id": "Project1@favoriot"
    }
  ]
}

Parameters

Name Description Type Data Type Required
project_developer_id ID of the project path string Yes

Responses

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Show an application from a specific project

HTTP request

GET /projects/{project_developer_id}/apps/{application_developer_id}

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE'
 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps/{application_developer_id}'


var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps/{application_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps/{application_developer_id}")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/projects/{project_developer_id}/apps/{application_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

The above command returns JSON structured like this:

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "application_name": "Application1",
      "active": true,
      "application_created_at": "2019-09-23T08:15:10.062Z",
      "application_developer_id": "Application1@favoriot",
      "application_id": "7b65056d-89c5-4ff0-bcab-93e709f7224f",
      "application_updated_at": "2019-09-23T08:15:10.062Z",
      "description": "No desc",
      "project_developer_id": "Project1@favoriot"
    }
  ]
}

Parameters

Parameter In Type Required Description
project_developer_id path string true Project developer ID
application_developer_id path string true application ID

Responses

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Applications

An Application represents a specific functionality or feature within a project. It is where you define how data will be handled, processed, and displayed. Applications can collect data from various devices and provide endpoints for integrating with other platforms.

Video: [HOW-TO] - Create Application

Application APIs endpoints

Creating application

Create an application by passing necessary information in the HTTP body

HTTP REQUEST

POST /apps

# You can also use wget
curl -X POST --header 'Content-Type: application/json' 
--header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE' 
 -d '{
  "application_name": "string",
  "active": true,
  "project_developer_id": "string",
  "description": "string",
  "user_id": "string"
}' 
'https://apiv2.favoriot.com/v2/apps'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/apps")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/apps',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/apps"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Body parameter

{ 
 "application_name": "string",
  "active": true,
  "project_developer_id": "string",
  "description": "string",
  "user_id": "string"
}

Example responses

{
  "statusCode": 201,
  "message": "Application Created"
}

Description of body parameter

Name Description
application_name Name of the project.
This should be unique.
Example: parkingApplication
active true or false.
Indicate whether application is active or not.
default true. Example: true
project_developer_id ID of the project to which the application will be associated.
Example: projectDefault@FAVORIOT
description Brief description of Application.
Example: Parking application for my house
user_id Your username for FAVORIOT platform.
Example: @FAVORIOT

QUERY PARAMETERS

Parameter In Type Required Description
body body object true No description

RESPONSES

Status Meaning Description
201 Created Created
400 Bad Request Request not valid
422 Unprocessable Entity validationError : project_developer_id can not be empty. It is used as reference
404 Not Found Either <user_id> or <project_developer_id> that's referred in this application is not exists
409 Conflict <application_name> has been used by this user
503 Service Unavailable Error: Something wrong with the database or the query

Get all applications

Return a list containing all applications

HTTP REQUEST

GET /apps

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/apps'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/apps")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/apps',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/apps"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "application_name": "Application1",
      "active": true,
      "application_created_at": "2019-09-26T08:30:36.091Z",
      "application_developer_id": "Application1@favoriot",
      "application_id": "7c6ebfd1-c70b-4ab3-a789-444a47d29c83",
      "application_updated_at": "2019-09-26T08:30:36.091Z",
      "description": "No desc",
      "project_developer_id": "Project1@favoriot"
    },
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
application_name query string false application name
application_developer_id query string false application developer ID
created_at query number false filter the list of results by field created_at (timestamp)
created_from_to query string false Allow to specify a range of creation (created_at_from, e.g. value 13370093222)
max query integer false define the number of results to be returned
sort query string false sorting the results by the given field
order query string false sorting the results by creation date (asc or desc)
offset query number false list applications at given offset

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Get a particular application

Show an application as specified by app_id

HTTP REQUEST

GET /apps/{application_developer_id}

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE'
'https://apiv2.favoriot.com/v2/apps/{application_developer_id}'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/apps/{application_developer_id}")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/apps/{application_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/apps/{application_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "application_name": "Application1",
      "active": true,
      "application_created_at": "2019-09-23T08:15:10.062Z",
      "application_developer_id": "Application1@favoriot",
      "application_id": "7b65056d-89c5-4ff0-bcab-93e709f7224f",
      "application_updated_at": "2019-09-23T08:15:10.062Z",
      "description": "No desc",
      "project_developer_id": "Project1@favoriot"
    }
  ]
}

Parameters

Parameter In Type Required Description
application_developer_id path string true application developer ID

Responses

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Updating an application

Alter and update an application

HTTP REQUEST

PUT /apps/{application_developer_id}

# You can also use wget
curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'apikey: YOUR API KEY HERE' -d '{
  "application_name": "string",
  "active": true,
  "description": "string"
}' 'https://apiv2.favoriot.com/v2/apps/{application_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/apps/{application_developer_id}")
  .put(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'PUT',
  url: 'https://apiv2.favoriot.com/v2/{application_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/apps/{application_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, headers=headers)

print(response.text)

Body parameter

{
  "application_name": "string",
  "active": true,
  "description": "string"
}

Example responses

{
  "statusCode": 201,
  "message": "Application Updated"
}

QUERY PARAMETERS

Parameter In Type Required Description
application_developer_id path string true application developer ID
body body object true No description

RESPONSES

Status Meaning Description
201 Updated Success
400 Bad Request Operation Failed
404 Not Found Updated failed : Couldn't find Rows as specified by parameters in the body
503 Service Unavailable Error: Something wrong with the database or the query

Deleting an application

Delete an application

HTTP REQUEST

DELETE /apps/{application_developer_id}

Code samples

# You can also use wget
curl -X DELETE --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE'
'https://apiv2.favoriot.com/v2/apps/{application_developer_id}'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/apps/{application_developer_id}")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/apps/{application_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/apps/{application_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 201,
  "message": "Application Deleted"
}

QUERY PARAMETERS

Parameter In Type Required Description
application_developer_id path string true application developer ID

RESPONSES

Status Meaning Description
201 Deleted Success
400 Bad Request Operation Failed
422 Unprocessable Entity Delete Failed: This application is currently being referred by one or more groups
503 Service Unavailable Error: Something wrong with the database or the query

Get all groups of an application

Return a list of all groups from an application

HTTP REQUEST

GET /applications/{application_developer_id}/groups

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "numResults": 1,
  "results": [
    {
      "group_id": "b771141b-aa8b-44f3-a18a-3b29bb7579a2",
      "application_developer_id": "applicationDefault@zeldi",
      "group_developer_id": "groupDefault@zeldi",
      "description": "no description",
      "group_name": "groupDefault",
      "active": true,
      "user_id": "FAVORIOT"
    }
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
application_developer_id path string true Application developer ID

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Groups

A Group is a logical grouping of devices, which helps in managing and organizing devices under specific categories. This feature is especially useful when dealing with a large number of devices, as it enables easier device management.

Video: [HOW-TO] - Create Group

Group APIs endpoints

Creating a group

Create a group of devices by passing necessary information in the HTTP body

HTTP request

POST /groups

# You can also use wget
curl -X POST --header 'Content-Type: application/json' 
--header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE'
 -d '{
  "group_name": "groupDefault",
  "active": true,
  "application_developer_id": "APPLICATION NAME",
  "description": "none"
}' 'https://apiv2.favoriot.com/v2/groups'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/groups',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Body parameter

{
  "group_name": "groupDefault",
  "active": true,
  "application_developer_id": "applicationDefault@FAVORIOT",
  "description": "none"
}

Description of body parameter

Name Description
group_name Name of the group.
This should be unique.
Example: parkingGroup
active true or false.
Indicate whether application is active or not.
default true. Example: true
application_developer_id ID of the group to which the application will be associated.
Example: groupDefault@FAVORIOT
description Brief description of Application.
Example: Parking application for my house
user_id Your username for FAVORIOT platform.
Example: @FAVORIOT

RESPONSES

Status Meaning Description
201 Created Created
400 Bad Request Request not valid
404 Not Found Either specified <user_id> or <application_developer_id> that's referred in this Group Hierarchy is not exists
409 Conflict <group_name> has been used by this user
503 Service Unavailable Error: Something wrong with the database or the query

Example responses

{
  "statusCode": 201,
  "message": "Group Created"
}

QUERY PARAMETERS

Parameter In Type Required Description
body body object true No description

Get all groups

Return a list containing all groups

HTTP request

GET /groups

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE' 
 'https://apiv2.favoriot.com/v2/groups'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/groups',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "group_name": "group1",
      "active": true,
      "application_developer_id": "Application1@favoriot",
      "description": "Group description",
      "group_created_at": "2019-09-27T00:31:54.863Z",
      "group_developer_id": "group1@favoriot",
      "group_id": "e3cf0853-6fe3-4867-9c1b-a7eae31a754b",
      "group_updated_at": "2019-09-27T00:31:54.863Z"
    },
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
group_name query string false Group name
group_developer_id query string false Group ID
created_at query number false filter the list of results by field created_at (timestamp)
created_from_to query string false Allow to specify a range of group creation (e.g. [ 2016-09-03T01:39:39.473Z TO NOW] )
max query integer false define the number of results to be returned
order query string false sorting the results (asc or desc)
offset query number false list of groups at given offset

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Get a specific group

show a group as specified by group_developer_id

HTTP request

GET /groups/{group_developer_id}

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/groups/{group_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups/{group_developer_id}")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups/{group_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
 "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "group_name": "Group1",
      "active": true,
      "application_developer_id": "Application1@favoriot",
      "description": "Group description",
      "group_created_at": "2019-09-27T00:24:10.153Z",
      "group_developer_id": "Group1@favoriot",
      "group_id": "98af0cff-e0a0-4696-bd58-45daf0febac1",
      "group_updated_at": "2019-09-27T00:24:10.153Z"
    }
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
group_developer_id path string true group developer ID

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Updating a group

This API endpoint is used to update information about the group.

HTTP request

PUT /groups/{group_developer_id}

# You can also use wget
curl -X PUT --header 'Content-Type: application/json' 
--header 'Accept: application/json' --header 'apikey: YOUR API KEY HERE'
 -d '{
  "description": "No Desc",
  "active": true
}' 
'https://apiv2.favoriot.com/v2/groups/group_developer_id'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups/{group_developer_id}")
  .put(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'PUT',
  url: 'https://apiv2.favoriot.com/v2/{group_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/{group_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, headers=headers)

print(response.text)

Body parameter

{
  "description": "No Desc",
  "active": true
}

Example responses

{
  "statusCode": 201,
  "message": "Group Updated"
}

QUERY PARAMETERS

Parameter In Type Required Description
group_developer_id path string true Group developer ID
body body object true No description

RESPONSES

Status Meaning Description
201 Update Success
400 Bad Request Operation Failed
404 Not Found Updated failed : Couldn't find Rows as specified by parameters in the body
503 Service Unavailable Error: Something wrong with the database or the query

Deleting a group

Delete a particular group. -- NB: Once a particular group is removed, all entities under that group will also be removed.

HTTP request

DELETE /groups/{group_developer_id}

# You can also use wget
curl -X DELETE --header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE'
 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups/{group_developer_id}")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups/{group_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 201,
  "message": "Group Deleted"
}

QUERY PARAMETERS

Parameter In Type Required Description
group_developer_id path string true Group ID

RESPONSES

Status Meaning Description
201 Deleted Success
400 Bad Request Operation Failed
503 Service Unavailable Error: Something wrong with the database or the query
422 Unprocessable Entity Delete Failed: The group is currently being referred by one or more devices

Get a group from particular application

show a group from a specific application

HTTP request

GET /applications/{application_developer_id}/groups/{group_developer_id}

# You can also use wget
curl -X GET --header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE' 
 'https://apiv2.favoriot.com/v2/applications/{APPLICATION ID}/groups/{group_developer_id}'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups/{group_developer_id}")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups/{group_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/applications/{application_developer_id}/groups/{group_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
 "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "group_name": "Group1",
      "active": true,
      "application_developer_id": "Application1@favoriot",
      "description": "Group description",
      "group_created_at": "2019-09-24T00:49:41.231Z",
      "group_developer_id": "Group1@favoriot",
      "group_id": "ca4d511d-8bc3-4201-ac0c-692c1f2a2490",
      "group_updated_at": "2019-09-24T00:49:41.231Z"
    }
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
application_developer_id path string true application developer ID
group_developer_id path string true Group developer ID

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Get all device of a group

Return a list of all devices from a specific group.

HTTP request

GET /groups/{group_developer_id}/devices

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE'
'https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
  // "numResults": 1,
  // "results": [
  //   {
  //     "device_id": "b771141b-aa8b-44f3-a18a-3b29bb7579a2",
  //     "group_developer_id": "groupDefault@FAVORIOT",
  //     "device_developer_id": "deviceDefault@FAVORIOT",
  //     "description": "no description",
  //     "device_name": "deviceDefault",
  //     "active": true,
  //     "user_id": "FAVORIOT"
  //   }
  // ]
}

QUERY PARAMETERS

Parameter In Type Required Description
group_developer_id path string true Group developer ID

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Get a device for specific group

Show a specific device from a specific group.

HTTP request

GET /groups/{group_developer_id}/devices/{device_developer_id}

# You can also use wget
curl -X GET --header 'Accept: application/json'
 --header 'apikey: YOUR API KEY HERE' 
 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices/{device_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices/{device_developer_id}")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices/{device_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/groups/{group_developer_id}/devices/{device_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "muqrizIOT",
      "device_name": "deviceMusicMaster",
      "active": true,
      "description": "Device for music nerds and sound geeks to check.",
      "device_created_at": "2019-09-27T01:07:38.114Z",
      "device_developer_id": "deviceMusicMaster@muqrizIOT",
      "device_id": "0f6e8a70-e208-4544-8b14-a8e16a976f0b",
      "device_type": "others",
      "device_updated_at": "2019-09-27T01:07:38.114Z",
      "group_developer_id": "GroupAudio@muqrizIOT",
      "sensor_type": "others",
      "timezone": "Kuala Lumpur, Singapore"
    }
  ]
}

QUERY PARAMETERS

Parameter In Type Required Description
group_developer_id path string true Group developer ID
device_developer_id path string true device developer ID

RESPONSES

Status Meaning Description
200 OK Success
400 Bad Request Request not valid
503 Service Unavailable Error: Something wrong with the database or the query

Devices

A Device represents an individual IoT device within Favoriot. Devices are the primary data sources, and they can send or receive data via APIs. Each device is associated with a unique identifier and belongs to a project and a group.

Video: [HOW-TO] - Create Device

Device APIs endpoints

Create a device

Code samples

# You can also use wget
curl -X POST --header 'Content-Type: application/json'
 --header 'Accept: application/json'
  --header 'apikey: YOUR API KEY' 
  -d '{
  "device_name": "string",
  "active": true,
  "group_developer_id": "groupDefault@FAVORIOT",
  "description": "string",
  "device_type": "arduino",
  "sensor_type": "temperature",
  "timezone": "Asia/Kuala_Lumpur",
  "latitude": 0,
  "longitude": 0
}' 
'https://apiv2.favoriot.com/v2/devices'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/devices',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Body parameter

{
  "device_name": "string",
  "active": true,
  "group_developer_id": "groupDefault@FAVORIOT",
  "description": "string",
  "device_type": "arduino",
  "sensor_type": "temperature",
  "timezone": "Asia/Kuala_Lumpur",
  "latitude": 0,
  "longitude": 0
}

Example responses

{
  "statusCode": 201,
  "message": "Device Created"
}

Create a device by passing necessary information in the HTTP body

URL: https://apiv2.favoriot.com/v2/devices
Method: POST

QUERY PARAMETERS

In Type Required Description
HTTP body JSON object true All attributes related to device are declared as JSON object

The following are attributes that can be stored within the HTTP body when creating a device.

Attribute Description
device_name String
Device name
Example:device-1
if device_name is not defined, default name will be set.
active Boolean
true or false
Enables or disables the device.
Default is true.
group_developer_id String
Group identifier.
A device should be structured under certain group, default is groupDefault@username
Example: group-01@FAVORIOT
description String
Device description.
device_type String
Can be one of the device types available
Example: Arduino
sensor_type String
Can be any types of sensor attached to the device
Example: Temperature
timezone String
Defines device time zone. Default value is “Asia/Kuala_Lumpur”.
Value must be one defined by FAVORIOT: https://apiv2.favoriot.com/timezones
latitude Number - Defines the Latitude coordinate.
Example:43.170
longitude Number - Defines the longitude coordinate.
Example:-3.101

RESPONSES

Status Description
201 Created
409 Device name has been used by the current user
422 Unable to process the contained instructions

Get all device

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/devices'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/devices',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "device_name": "Device1",
      "active": true,
      "description": "Device description",
      "device_created_at": "2019-09-27T01:18:09.893Z",
      "device_developer_id": "Device1@favoriot",
      "device_id": "c6d831d7-7246-41ae-802c-acbf453f33f6",
      "device_type": "others",
      "device_updated_at": "2019-09-27T01:18:09.893Z",
      "group_developer_id": "Group1@favoriot",
      "sensor_type": "others",
      "timezone": "Asia/Kuala_Lumpur"
    },
  ]
}

Return a list containing all devices, max 10000.

URL: https://apiv2.favoriot.com/v2/devices
Method: GET
Response: JSON

QUERY PARAMETERS

To narrow the query, the following parameters can be appended as query parameters in the URL.

Parameter Description
device_name Type:String
Required:optional
Device name
device_developer_id Type:String
Required:optional
Device developer ID
created_at Type:Timestamp
Required:optional
filter the list of results by field created_at (timestamp)
created_from_to Type:String
Required:optional
Allow to specify a range of device creation (e.g. [ 2016-09-03T01:39:39.473Z TO NOW] )
max Type:Integer
Required:optional
define the number of results to be returned
order Type:String
Required:optional
sorting the results by creation date either ascending or descending ( asc or desc)
offset Type:Integer
Required:optional
list devices at given offset

Example of API usage:
To return 10 devices, the following API is used:
https://apiv2.favoriot.com/v2/devices?max=10

RESPONSES CODE

Status Description
200 Success
refer to example responses for the result format
422 Unable to process the contained instructions

Get a specific device

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE'
'https://apiv2.favoriot.com/v2/devices/{device_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices/{device_developer_id}")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/devices/{device_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices/{device_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
 "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "device_name": "Device1",
      "active": true,
      "description": "No desc",
      "device_created_at": "2019-09-27T01:18:09.893Z",
      "device_developer_id": "Device1@favoriot",
      "device_id": "c6d831d7-7246-41ae-802c-acbf453f33f6",
      "device_type": "others",
      "device_updated_at": "2019-09-27T01:18:09.893Z",
      "group_developer_id": "Group1@favoriot",
      "sensor_type": "others",
      "timezone": "Asia/Kuala_Lumpur"
    }
  ]
}

URL: https://apiv2.favoriot.com/v2/devices/{device_developer_id}
Method: GET
Response: JSON

As can be seen from the URL above, with this API, the query parameter (device_developer_id) part of the URL.

QUERY PARAMETERS

Parameter In Type Required Description
device_developer_id path String true Device developer ID

RESPONSES

Status Description
200 Success
refer to example responses for the result format
422 Unable to process the contained instructions

Update a device

# You can also use wget
curl -X PUT --header 'Content-Type: application/json' 
--header 'Accept: application/json' --header 'apikey: YOUR API KEY HERE'
 -d '{
  "description": "No Desc",
  "active": true,
  "device_type": "arduino",
  "sensor_type": "temperature",
  "timezone": "Asia/Kuala_Lumpur",
  "latitude": 0,
  "longitude": 0
}' 
'https://apiv2.favoriot.com/v2/devices/{device_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices/{device_developer_id}")
  .put(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'PUT',
  url: 'https://apiv2.favoriot.com/v2/devices/{device_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices/{device_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, headers=headers)

print(response.text)

Body parameter

{
  "description": "No Desc",
  "active": true,
  "device_type": "arduino",
  "sensor_type": "temperature",
  "timezone": "Asia/Kuala_Lumpur",
  "latitude": 0,
  "longitude": 0
}

Example responses

{
  "statusCode": 201,
  "message": "Device is successfully updated"
}

URL: https://apiv2.favoriot.com/v2/devices/{device_developer_id}
Method: PUT
Response: JSON

QUERY PARAMETERS

Parameter In Type Required Description
device_developer_id path string true device developer ID
HTTP Body body JSON true The attributes meant for updating device is stored in HTTP Body

Attributed for Updating A Device

The following are attributes that can be mentioned within the HTTP body in order to change the information about a device.

Attribute Type Description
description String
 Device description.
active Boolean
 true or false
Enables or disables the device.
Default is true.
device_type String
 Can be one of the device types available
Example: Arduino
sensor_type String
 Can be any types of sensor attached to the device
Example: Temperature
timezone String
 Defines device time zone. Default value is “Asia/Kuala_Lumpur”.
Value must be one defined by FAVORIOT: https://apiv2.favoriot.com/v2/time_zones/
latitude Number Defines the Latitude coordinate.
Example:43.170
longitude Number Defines the longitude coordinate.
Example:-3.101

RESPONSES

Status Description
201 Updated
422 Failed to update the device

Delete a device

# You can also use wget
curl -X DELETE --header 'Accept: application/json'
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/devices/{device_developer_id}'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices/{device_developer_id}")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/devices/{device_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices/{device_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "code": 201,
  "message": "Device Deleted"
}

URL: https://apiv2.favoriot.com/v2/devices/{device_developer_id}
Method: DELETE

As can be seen from the URL above, with this API, the query parameter (device_developer_id) part of the URL.

QUERY PARAMETERS

Parameter In Description
device_developer_id path Type:String - Required:true
Device developer ID

RESPONSES

Status Description
201 Deleted
422 Unable to deleted the device

Get all data stream of a device

Code samples

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams'
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams")
  .get(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

import requests

url = "https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
   "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "year": 2019,
      "timestamp": 1569289513493,
      "data": {
        "grip": "99",
        "pressure": "15",
        "strength": "32",
        "tear": "83"
      },
      "device_developer_id": "Device1@favoriot",
      "stream_created_at": "2019-09-24T01:45:13.493Z",
      "stream_developer_id": "19ce1d03-fcf8-4668-8e5b-21c22ffbfa9c@muqrizIOT",
      "stream_id": "19ce1d03-fcf8-4668-8e5b-21c22ffbfa9c"
    },
  ]
}

URL:
https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams
Method: GET
Response: JSON

As can be seen from the URL above, with this API, the query parameter (device_developer_id) part of the URL.

Parameter In Description
device_developer_id path Type:String - Required:true
Device developer ID

RESPONSES

Status Description
200 Success.
422 Unable to process the contained instructions

Data

Data Streams refer to the continuous flow of data from IoT devices to the platform, where it's stored, processed, and made available for analysis, visualization, and integration. Data streams are central to the IoT ecosystem on Favoriot, allowing real-time data collection and management. Below is Data stream endpoints

Send data from a device

Code samples

# You can also use wget
curl -X POST --header 'Content-Type: application/json'
 --header 'Accept: application/json' 
 --header 'apikey: YOUR API KEY HERE' 
 -d '{
  "device_developer_id": "deviceDefault@FAVORIOT",
  "data": { "temperature": "31","humidity": "70"}
  }' 
'https://apiv2.favoriot.com/v2/streams'

var request = require("request");

var options = { method: 'POST',
  url: 'https://apiv2.favoriot.com/v2/streams',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/streams")
  .post(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/streams"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache",
    'postman-token': "b404ce24-2b0b-b9c8-8895-6324a6900c47"
    }

response = requests.request("POST", url, headers=headers)

print(response.text)

Example of Body parameter

{
  "device_developer_id": "deviceDefault@FAVORIOT",
  "data": { "temperature": "31",
            "humidity": "70"
          }
}

Example responses

{
  "statusCode": 20150,
  "message": "A stream created"
}
{
  "statusCode": 4002,
  "message": "Invalid JSON"
}
{
  "statusCode": 4002,
  "message": "There entities are not enabled"
}
{
  "statusCode": 40450,
  "message": "Stream Creation Failed: either specified <user_id> or <device_developer_id> that's referred in the data stream is not exists"
}

URL: https://apiv2.favoriot.com/v2/streams
Method: POST

QUERY PARAMETERS

Parameter In Type Required Description
body body JSON true data stream from a device

RESPONSES

Status Description
201 Data Stream Created
400 Invalid JSON or Data format
401 Un-authorized user or API-key
422 Request not valid

Get all data of a device

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/streams'

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/streams',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/streams")
  .get()
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/streams"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
 "statusCode": 200,
  "numFound": 38,
  "results": [
    {
      "user_id": "favoriot",
      "year": 2019,
      "timestamp": 1569548452393,
      "data": {
        "temperature": 20,
        "humidity": 10,
      }
    }
  ]
}
{
  "statusCode": 400,
  "message": "Request not valid"
}

URL: https://apiv2.favoriot.com/v2/streams
Method: GET

QUERY PARAMETERS

Parameter In Type Required Description
device_developer_id query string false Device developer ID
created_at query string false filter the list of results by field created_at (timestamp)
created_from_to query string false Allow to specify a range of streams creation (e.g. [ 2016-09-03T01:39:39.473Z TO NOW] )
max query integer false define the number of results to be returned
order query string false sorting the results by creation date either ascending or descending (asc or desc)
offset query number false list the streams at given offset

Example of API usage with specific parameters:

To return 10 streams, the following API is used:
https://apiv2.favoriot.com/v2/streams?max=10&order=asc

RESPONSES

Status Description
200 Success
401 Un-authorized user or API-key
422 Request not valid

Get specific data stream

# You can also use wget
curl -X GET --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/streams/{stream_developer_id}'

var request = require("request");

var options = { method: 'GET',
  url: 'https://apiv2.favoriot.com/v2/streams/{stream_developer_id}',
  headers: 
   { 'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});



OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/streams/{stream_developer_id}")
  .get()
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/streams/{stream_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

Example responses

{
 "statusCode": 200,
  "numFound": 1,
  "results": [
    {
      "user_id": "favoriot",
      "year": 2019,
      "timestamp": 1569548452393,
      "data": {
        "temperature": 100,
        "acceleration": 50,
      },
      "device_developer_id": "Device1@favoriot",
      "stream_created_at": "2019-09-27T01:40:52.393Z",
      "stream_developer_id": "1a11e047-9ec4-4003-b7ec-81cad869689a@favoriot",
      "stream_id": "1a11e047-9ec4-4003-b7ec-81cad869689a"
    }
  ]
}
{
  "statusCode": 400,
  "message": "Error!!"
}

URL: https://apiv2.favoriot.com/v2/streams/{stream_developer_id}
Method: GET Response: JSON Object

QUERY PARAMETERS

Parameter In Type Required Description
stream_developer_id path string true Stream developer ID

RESPONSES

Status Description
200 Success
401 Un-authorized user or API-key
422 Request not valid

Delete data sent by a device

# You can also use wget
curl -X DELETE --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/streams/{stream_developer_id}'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/streams/{stream_developer_id}',
  headers: 
   { 'postman-token': '683948a5-70d7-0080-15f3-b2929bac016c',
     'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/streams/{stream_developer_id}")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/streams/{stream_developer_id}"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 20050,
  "message": "Stream deleted"
}
{
  "statusCode": 400,
  "message": Operation failed
  }
{
  "statusCode": 40452,
  "message": "Delete Failed: The stream is not exists"
  }

URL: https://apiv2.favoriot.com/v2/streams/{stream_developer_id}
Method: DELETE

QUERY PARAMETERS

Parameter In Type Required Description
stream_developer_id path string true stream developer ID

RESPONSES

Status Description
200 Success
401 Un-authorized user or API-key
422 Request not valid
404 Not Found

Delete all streams for specific device

# You can also use wget
curl -X DELETE --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams',
  headers: 
   { 'postman-token': '683948a5-70d7-0080-15f3-b2929bac016c',
     'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 20050,
  "message": "Stream deleted"
}
{
  "statusCode": 400,
  "message": Operation failed
  }
{
  "statusCode": 40452,
  "message": "Delete Failed: The stream is not exists"
  }

URL: https://apiv2.favoriot.com/v2/devices/{device_developer_id}/streams
Method: DELETE

QUERY PARAMETERS

Parameter In Type Required Description
device_developer_id path string true device developer ID

RESPONSES

Status Description
200 Success
401 Un-authorized user or API-key
422 Request not valid
404 Not Found

Delete all streams

# You can also use wget
curl -X DELETE --header 'Accept: application/json' 
--header 'apikey: YOUR API KEY HERE' 
'https://apiv2.favoriot.com/v2/streams'

var request = require("request");

var options = { method: 'DELETE',
  url: 'https://apiv2.favoriot.com/v2/streams',
  headers: 
   { 'postman-token': '683948a5-70d7-0080-15f3-b2929bac016c',
     'cache-control': 'no-cache',
     'content-type': 'application/json',
     'apikey': 'YOUR API KEY HERE' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});


OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://apiv2.favoriot.com/v2/streams")
  .delete(null)
  .addHeader("apikey", "YOUR API KEY HERE")
  .addHeader("content-type", "application/json")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();
import requests

url = "https://apiv2.favoriot.com/v2/streams"

headers = {
    'apikey': "YOUR API KEY HERE",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

response = requests.request("DELETE", url, headers=headers)

print(response.text)

Example responses

{
  "statusCode": 20050,
  "message": "Stream deleted"
}
{
  "statusCode": 400,
  "message": Operation failed
  }
{
  "statusCode": 40452,
  "message": "Delete Failed: The stream is not exists"
  }

URL: https://apiv2.favoriot.com/v2/streams
Method: DELETE

RESPONSES

Status Description
200 Success
401 Un-authorized user or API-key
422 Request not valid
404 Not Found

Errors

The FAVORIOT API uses the following error codes. The error code are separated according to functionality of the APIs.

User Authentication

Type of Status HTTP Code status Code
Database Error 503 -
Not Unique Field 409 409xx
Unable to find user 404 404xx
Wrong password (Un-authenticated) 401 401xx
Token Related (Un-authenticated) 401 401xx
Validation error 422 422xx
Invalid token on changing passwd 422 422xx
Token un-authorized (forbidden) 403 403xx

Validation Error

Project Creation

Type of Status HTTP Code status Code
Unable to create project 422
ERROR: Database Error 503 5031x
ERROR: Unable to find user 404 4041x
ERROR: Not Unique Field 409 4091x
ERROR: Validation error 422 4221x
ERROR: Unable to update 400 4001x
ERROR:(Field speciefied not found) 404 4041x

Application

Type of Status HTTP Code status Code
ERROR: Database Error 503 5032x
ERROR: Unable to update 400 4002x
ERROR:(Specified field not found) 404 4042x
ERROR: Validation error 422 4223x

Group

Type of Status HTTP Code status Code
ERROR: Database Error 503 5033x
ERROR: Unable to find user 404 4043x
ERROR: Not Unique Field 409 4093x
ERROR: Validation error 422 4223x

Device

Type of Status HTTP Code status Code
ERROR: Database Error 503 5034x
ERROR: Unable to find user 404 4044x
ERROR: Not Unique Field 409 4094x
ERROR: Validation error 422 4224x

Data Stream

Type of Status HTTP Code status Code
ERROR: Database Error 503 5035x
ERROR: Unable to find user 404 4045x
ERROR: Not Unique Field 409 4095x
ERROR: Validation error 422 4225x

SECURITY

API keys

API keys are essential for managing and securing access to the platform's resources and functionalities. API keys act as authentication credentials that allow applications, devices, or users to interact with the Favoriot API. There are generally two types of API keys: read/write API keys and read-only API keys. Here's a breakdown of each:

  1. Read/Write API key

    • A Read/Write API key grants full access to the API, allowing users to perform both read and write operations. This means that applications or devices using this key can retrieve data from the Favoriot Platform and also send data or make changes to the resources.
  1. Read-Only API Key
    • A Read-Only API key allows access only to read data from the API. With this key, users or applications can retrieve information but cannot make any modifications to the resources on the Favoriot platform.

How to find API keys


Access Token

An access token is a secure, unique identifier used to authenticate and authorize requests made to the platform's API. It allows IoT devices and gateways to access resources and perform actions on behalf of a user without needing to continuously send sensitive credentials like usernames and passwords. Access tokens enhance security and streamline the process of interacting with the platform's services.

Additionally, access tokens are utilized for sending data streams to the platform. They also serve as credentials for MQTT, allowing users to authenticate their username and password and manage topic authorization effectively. This integration ensures that only authorized users and devices can publish or subscribe to specific topics, maintaining the security and integrity of the communication.

Importantly, each device or gateway has its own access token, ensuring that access is granted on an individual basis, thereby enhancing security and control over device interactions with the platform.

Device Access Token

How to find device access token

Navigate to "Devices" page and click on the view button (eye icon) to check the device's Access Token and popup will appear.

Show Device Information

Take a look at the 'Access Token' label, now you can copy the access token by click copy button at the end.

Show Device Information

Regenerate access token

Click on the edit icon in the "Devices" page.

Edit Device Information

Then click on the refresh icon to generate a new Access Token.

Success Access Token

Note: To use the new device Access Token, include a property called 'accesstoken' or 'apikey' and its value in the http header.

Edge Gateway Access Token

How to find edge gateway access token

Navigate to "Edge Gateway" page and click on the view button (eye icon) to check the device's Access Token and popup will appear.

Show Edge Gateway Information

Take a look at the 'Access Token' label, now you can copy the access token by click copy button at the end.

Show Edge Gateway Information

Regenerate access token

Click on the edit icon in the "Edge Gateway" page.

Edit Edge Gateway Information

Then click on the refresh icon to generate a new Access Token.

Success Access Token

HTTP(S) Connection

To establish secure HTTP(S) connection to the Favoriot platform, create ca.crt file, copy and paste the following certificate inside it. remark: If your programme unable to handle self signed ssl/tls

-----BEGIN CERTIFICATE----- MIIF3TCCA8WgAwIBAgIIeyyb0xaAMpkwDQYJKoZIhvcNAQELBQAwfDELMAkGA1UE BhMCVVMxDjAMBgNVBAgMBVRleGFzMRAwDgYDVQQHDAdIb3VzdG9uMRgwFgYDVQQK DA9TU0wgQ29ycG9yYXRpb24xMTAvBgNVBAMMKFNTTC5jb20gUm9vdCBDZXJ0aWZp Y2F0aW9uIEF1dGhvcml0eSBSU0EwHhcNMTYwMjEyMTczOTM5WhcNNDEwMjEyMTcz OTM5WjB8MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hv dXN0b24xGDAWBgNVBAoMD1NTTCBDb3Jwb3JhdGlvbjExMC8GA1UEAwwoU1NMLmNv bSBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IFJTQTCCAiIwDQYJKoZIhvcN AQEBBQADggIPADCCAgoCggIBAPkP3aMrfcvQKv7sZ4Wm5y4bunfh4/WvpOz6Sl2R xFdHaxh3a3by/ZPkPQ/CFp4LZsNWlJ4Xg4XOVu/yFv0AYvUiCVToZRdOQbngT0aX qhvIuG5iXmmxX9sqAn78bMrzQdjt0Oj8P2FI7bADFB0QDksZ4LtO7IZl/zbzXmcC C52GVWH9ejjt/uIZALdvoVBidXQ8oPrIJZK0bnoix/geoeOy3ZExqysdBP+lSgQ3 6YWkMyv94tZVNHwZpEpox7Ko07fKoZOI68GXvIz5HdkihCR0xwQ9aqkpk8zruFvh /l8lqjRYyMEjVJ0bmBHDOJx+PYZspQ9AhnwC9FwCTyjLrnGfDzrIM/4RJTXq/LrF YD3ZfBjVsqnTdXgDciLKOsMf7yzlLqn6niy2UUb9rwPW6mBo6oUWNmuF6R7As93E JNyAKoFBbZQ+yODJgUEAnl6/f8UImKIYLEJAs/lvOCdLToD0PYFH4Ih86hzOtXVc US4cK38acijnALXRdMbX5J+tB5O2UzU1/Dfkw/ZdFr4hc96SCvigY2q8lpJqPvi8 ZVWb3vUNiSYE/CUapiVpy8JtynziWV+XrOvvLsi81xtZPCvM8hnIk2snYxnP/Okm +Mpxm3+T/jRnhE6Z6/yzeAkzcLpmpnbtG3PrGqUNxCITIJRWCk4sbE6x/c+cCbqi M+2HAgMBAAGjYzBhMB0GA1UdDgQWBBTdBAkHovV6fVJTEpKV7jiAJQ2mWTAPBgNV HRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFN0ECQei9Xp9UlMSkpXuOIAlDaZZMA4G A1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAIBgRlCn7Jp0cHh5wYfGV cpNxJK1ok1iOMq8bs3AD/CUrdIWQPXhq9LmLpZc7tRiRux6n+UBbkflVma8eEdBc Hadm47GUBwwyOabqG7B52B2ccETjit3E+ZUfijhDPwGFpUenPUayvOUiaPd7nNgs PgohyC0zrL/FgZkxdMF1ccW+sfAjRfSda/wZY52jvATGGAslu1OJD7OAUN5F7kR/ q5R4ZJjT9ijdh9hwZXT7DrkT66cPYakylszeu+1jTBi7qUD3oFRuIIhxdRjqerQ0 cuAjJ3dctpDqhiVAq+8zD8ufgr6iIPv2tS0a5sKFsXQP+8hlAqRSAUfdSSLBv9jr a6x+3uxjMxW3IwiPxg+NQVrdjsW5j+VFP3jbutIbQLH+cU0/4IGiul607BXgk90I H37hVZkLId6Tngr75qNJvTYw/ud3sqB1l7UtgYgXZSD32pAAn8lSzDLKNXz1PQ/Y K9f1JmzJBjSWFupwWRoyeXkLtoh/D1JIPb9s2KJELtFOt3JY04kTlf5Eq/jXixtu nLwsoFvVagCvXzfh1foQC5ichucmj87w7G6KVwuA406ywKBjYZC6VWg3dGq2ktuf oYYitmUnDuy2n0Jg5GfCtdpBC8TTi2EbvPofkSvXRAdeuims2cXp71NIWuuA8ShY Ic2wBlX7Jz9TkHCpBB5XJ7k= -----END CERTIFICATE-----

MQTT(S) Connection

To establish secure MQTT connection to the platform, create ca.crt file, copy and paste the following certificate inside it.

-----BEGIN CERTIFICATE----- MIIDmTCCAoGgAwIBAgIJAMPWVA80Rf38MA0GCSqGSIb3DQEBDQUAMGMxGzAZBgNV BAMMElNlY3VyZSBNUVRUIGJyb2tlcjERMA8GA1UECgwIRmF2b3Jpb3QxDDAKBgNV BAsMA0lvVDEjMCEGCSqGSIb3DQEJARYUc3VwcG9ydEBmYXZvcmlvdC5jb20wHhcN MTcwNjIwMDcxMjQyWhcNMzIwNjE2MDcxMjQyWjBjMRswGQYDVQQDDBJTZWN1cmUg TVFUVCBicm9rZXIxETAPBgNVBAoMCEZhdm9yaW90MQwwCgYDVQQLDANJb1QxIzAh BgkqhkiG9w0BCQEWFHN1cHBvcnRAZmF2b3Jpb3QuY29tMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAw6jfao9GPyXR2oIjFseVN2wGHHf321VaOB21NwS9 hobsh7o37mOJUurDon2j2cnwj3PzRLxr5+1jtMlTh18KR7YvtI4QNVC0yZ1kfeYw doTVZ0JMm7kKqcwG75/HYTNehFTnTOKlCHcNG/lALOBUaF0Q8gccuP8w7mKsB/WY Kct7sG3Kom09vHpg14QML/4BqfBso3nMy2UpilmFqkd3iBZOc3OP93wbfoMdv+TY f3NuMC8GvjVj6w3y/ThVT5v9nW0hIOxnH0Z7/Z+StpKf66LEYrVK6wqrE+QOyPbt 7egm7xzufeMFYRG9D8yq1cdkgv91D+d0WZcGJ1WuhGmyGQIDAQABo1AwTjAdBgNV HQ4EFgQU92lSlWRQCgYvnDR+yKqbrJhXH8cwHwYDVR0jBBgwFoAU92lSlWRQCgYv nDR+yKqbrJhXH8cwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQ0FAAOCAQEAA0HF TipnY6COyJX9fPH9ZCW9+FitArf0liTJTOci2Wga6f7AWAvaqgEAYtOEwGmARTK8 i8MkAnf3rncvy/tegHIlklkmVHAnE8DaJIw+GwIQqg+CG+zW96M9ZicE2gP78I2d oMTKznk4POPzZOs5GnsFD50y49TY/gy7YEsmRhsyegnew9Ny45ZvAEsI1CD4QDZN nifCffGE5nNp7gcIlW5u66FvQ32deO9/Ag/83Qzj+MKvXtdkW+2PTG++g8qZnuZ6 51NjwKNY6DApQ5f7QN9WZHRs82s/SrWkMxv9HgIHMyQ6PxiRYZfaLdjTKgwv92P6 cDpPSjaUgpEJwiMvpQ== -----END CERTIFICATE-----

After saving the certifcate in ca.crt file, provide the path to the certificate in the programme used to send MQTT data.

MQTT

code for sending data using MQTT

Command to publish: Mosquitto publish

mosquitto_pub -d -h mqtt.favoriot.com -p 1883 -u your-device-access-token -P your-device-access-token  -t your-device-access-token/hello -m {data}

Command to publish : Mosquito publish secure version

mosquitto_pub -d -h mqtt.favoriot.com -p 8883 --cafile path_to_ca.crt_file -u your-device-access-token -P your-device-access-token  -t your-device-access-token/hello -m {data} --insecure

data format example:
"{\"device_developer_id\":\"deviceDefault@{user_id}\",\"data\":{\"humidity\":\"10\",\"Temperature\":\"10\"}}"

Command to subscribe: Mosquitto subscribe 

mosquitto_sub -d -h mqtt.favoriot.com -p 1883 -u your-device-access-token -P your-device-access-token  -t your-device-access-token/hello

Command to subscribe : Mosquito subscribe secure version

mosquitto_sub -d -h mqtt.favoriot.com -p 8883 --cafile path_to_ca.crt_file -u your-device-access-token -P your-device-access-token -t your-device-access-token/hello --insecure
var mqtt = require('mqtt')
var api = ''; // replace with your apikey 
var url = 'mqtt://mqtt.favoriot.com' ;


var options = {
  port: 1883,
  clientId: 'mqttjs_' + Math.random().toString(16).substr(2, 8),
  username: api,
  password: api,
};

// Create a client connection
var client = mqtt.connect(url, options);

// or var client = mqtt.connect({ port: 1883, host: '192.168.1.100', keepalive: 10000});

var data = {
       "device_developer_id": "deviceDefault@favoriot", // replace with your device developer id
       "data": {"temperature":"30", "humidity":"40"}
           };

client.on('connect', function () {

client.subscribe(api+"/v2/streams/status");  // listen stream response
client.publish(api+'/v2/streams', JSON.stringify(data)); // publish to favoriot iot platform

})

client.on('message', function (topic, message) {
  // message is Buffer 
  console.log(message.toString());
  client.end();
})
The code is only available in javascript and command line (bash)
The code is only available in javascript and command line (bash)

This section explains on how to use MQTT protocol to connect to FAVORIOT platform.

About MQTT

MQTT is an OASIS standard messaging protocol for the Internet of Things (IoT). It is designed as an extremely lightweight publish/subscribe messaging transport that is ideal for connecting remote devices with a small code footprint and minimal network bandwidth. At the moment Favoriot platform mqtt broker is compatible with MQTT 3.1 and 3.1.1 version

JSON Data

FAVORIOT platform accepts JSON data from a MQTT device. The format is in the following format if using mosquitto_pub command from CLI:

"{\"device_developer_id\":\"deviceDefault@mqtttest7\",\"data\":{\"humidity\":\"10\"}}"

MQTT QoS supported by Favoriot platform

MQTT Websocket

MQTT websocket allows browser to receive messages directly from a server as new messages arrives. Favoriot platform has enabled this feature that allows data to be stored, and the same time delivered to the MQTT client that subscribe to the same topic (a bi-directional communication). This is an important feature for the following use cases. • Display live data from a device • Receive alert and notifications • Communicate effectively with a mobile phone application *The data will be delivered "as-it-is" basis.

The Communication Architecture

the data stream

Configuration

Send / Publish data

Use the following configuration to setup your device to send / publish data.

Host : mqtt.favoriot.com

Standard Ports: 1883 and 8883 (for secure connection using TLS/SSL)

Websocket Port : 3000

Use your Device Access Token as username and password to connect to the platform. (How to access your device access token)

ClientID (for some MQTT clients): Any name

Publish : {your-device-access-token}/v2/streams

Example : {your-device-access-token}/v2/streams

Receive / Subscribe

Use to the following configuration to receive / subscribe

Subscribe : {your-device-access-token}/v2/streams/status

Example : {your-device-access-token}/v2/streams/status

In order to establish secure MQTT(S) connection to the Favoriot platform can use the same method in Security section

Whenever new data arrives at the Favoriot MQTT websocket, the same data will then be pushed to the subscribers. If you are having issues connecting your device to our platform, please contact us at **support@favoriot.com**.

CoAP

Code for sending data using CoAP

    The code is only available in javascript and python

const coap = require('coap') 
req = coap.request('coap://coap.favoriot.com/v2/streams')

var payload = {
                method:'POST',
                apikey:'Your API key here',
                parameters:{'device_developer_id':'deviceDefault@developer_id',
                            //example: 'device_developer_id':'arduino1@myaccount'
                            'data':{
                                    'temperature':'20',
                            }
                }
}

req.write(JSON.stringify(payload));

req.on('response', function(res) {
    res.pipe(process.stdout)
})

req.end()

    The code is only available in javascript and python

import json
import socket
from coapthon.client.helperclient import HelperClient
#from coapthon.resources.resource import Resource

url = 'coap.favoriot.com'
port = 5683
path = "/v2/streams"

host = socket.gethostbyname(url) #used DNS Lookup to get coap.favoriot.com server IP

payload = {
            'method':'POST',
            'apikey':'Your API key here',
            'parameters':{
                        'device_developer_id':'deviceDefault@developer_id', #example: arduino1@myaccount          
                        'data':{
                            'temperature':'20',
                            'humidity':'100',
                            'moisture':'100'
                        }
            }
}

BufferedData = json.dumps(payload) #convert json object format to string format

client = HelperClient(server=(host,port))
response = client.post(path,BufferedData)
print response.payload
client.stop()

This section explains on how to use CoAP protocol to connect to FAVORIOT platform.

About CoAP

Constrained Application Protocol (CoAP) is a simple protocol with low overhead specifically designed for constrained devices (such as microcontrollers) and constrained networks in Internet of Things (IoT). This protocol is used in M2M data exchange such as building automation and smart energy.

Configuration

Below is the configuration to connect your device with Favoriot platform using CoAP protocol

Host : ‘coap.favoriot.com’

Path : /v2/streams

apikey : <your api key>

device_developer_id : ‘deviceDefault@developer_id’

method : ‘POST’

JSON Data

FAVORIOT platform accepts JSON data from a devices using CoAP protocol. The following is the data format:

var payload = {
  method:'POST',
  apikey:'your device access token',
    parameters:{'device_developer_id':'deviceDefault@developer_id',
    'data':{
    'temperature':'20',
     }
  }
}

Replace 'your device access token' refer here How to access your device access token

Remarks: Please use dns lookup in the code to get the IP address for coap.favoriot.com when sending data.

If you are having issues connecting your device to our platform, please contact us at **support@favoriot.com**.

RESPONSES

Code Description
200 Success
424 Failed

WEBSOCKET

code for sending data using WebSocket

  The code is only available in  python and javascript
import asyncio
import socketio

sio = socketio.AsyncClient()

# connect event
@sio.event
async def connect():
    print('connection established')

# emit/broadcast request to event/namespace
@sio.event
async def emit_message():
    await sio.emit('v2/streams',{
          'request': "listen",
          'apikey':"your api key"
    })

    await sio.emit('v2/streams',{
          'request': "pull",
          'apikey':"your api key",
          'parameters': {
              'max': 2
           }
    })

    await sio.emit('v2/streams',{
        'request': 'push',
        'apikey':"your api key",
        'parameters':{'device_developer_id':'deviceDefault@developer_id','data':{'temperature':'20'}}
    })

    await sio.emit('v2/streams',{
        'request': 'delete',
        'apikey':"your api key",
        'parameters': {'stream_developer_id':'df777d9c-4b07-41a6-a0ab-0952797abbea@deviceDefault@developer_id'}
    })


# listen to event/namespace response 
@sio.on('v2/streams')
def listen_event(data):
    print(data)

# check connection status
@sio.event
async def disconnect():
    print('disconnected from server')

async def main():

    await sio.connect('wss://io.favoriot.com')
    await emit_message()
    await sio.wait()

if __name__ == '__main__':
     asyncio.run(main())
  const io = require('socket.io-client');
  const socket = io("wss://io.favoriot.com");

  socket.on("connect"() =>{
      // emitting event
      socket.emit("v2/streams",{
        request: 'listen',
        apikey:"your api key"
      });

      socket.emit("v2/streams",{
        request: 'push',
        apikey:"your api key",
        parameters:{'device_developer_id':'deviceDefault@developer_id','data':{'temperature':'20'}}
      });

      socket.emit("v2/streams",{
        request: 'pull',
        apikey:"your api key",
        parameters: {'device_developer_id':'deviceDefault@developer_id','max': 100}
      });

      socket.emit("v2/streams",{
        request: 'delete',
        apikey:"your api key",
        parameters: {'stream_developer_id':'df777d9c-4b07-41a6-a0ab-0952797abbea@deviceDefault@developer_id'}
      });
  });

  //listening event
  socket.on('v2/streams',(data) => {
    console.log(data);
});
   The code is only available in  python and javascript

This section explains on how to use WebSocket protocol to connect to FAVORIOT platform.

About WebSocket

WebSocket is an advanced technology that makes it possible to open a two-way interactive communication session between the user's browser and a server. Now you can send messages to a server and receive event-driven responses without having to poll the server for a reply

Configuration

Below is the configuration to do connection with Favoriot platform using WebSocket protocol

Host : ‘io.favoriot.com’

Port : 443 (secure connection using TLS/SSL)

Namespace/Event : v2/streams

request : ‘push’ or ‘pull’ or ‘delete’ or ‘listen’

apikey: your apikey here

'request' descriptions

Request Description
listen listen to data stream update that sending from device
push send data stream to platform
pull retrieve data stream from platform
delete delete the data stream in platform

*_Remarks: use namespace ‘v2/stream’ as event for emitting and listening activity. By default do some request to make sure your websocket client registered to websocket server. Once successfully get response from server, the websocket client will receive latest update of the data stream without do another request.

Listen/Receive update stream (listen)

Send stream (push)

Example Parameters:

Parameter Type Required Description
device_developer_id string true device developer ID
data JSON true list of sensor parameters and values

Retrieve stream (pull)

Example Parameters:

Parameter Type Required Description
device_developer_id string false Device developer ID
created_at string false filter the list of results by field created_at (timestamp)
created_from_to string false Allow to specify a range of streams creation (e.g. [ 2016-09-03T01:39:39.473Z TO NOW] )
max integer false define the number of results to be returned
order string false sorting the results by creation date either ascending or descending (asc or desc)
offset number false list the streams at given offset

Send stream (delete)

Example Parameters:

Parameter Type Required Description
stream_developer_id string true stream developer ID

RPC

About RPC

Remote Procedure Calls (RPC) feature allows to send command to devices and receive results of commands execution that broadcast by favoriot platform. The typical use cases of RPC calls is all sorts of remote control: reboot, turn the engine on/off, change state of the gpio/actuators, change configuration parameters, etc.

RPC via RestAPI

Use the following configuration to set up RPC via RestAPI

Connection

Host : https://apiv2.favoriot.com

Path : /v2/rpc

Port : 443 (TLS/SSL connection)

Method: GET

Headers:{'Content-Type:'application/json','apikey':'Your apikey here'}

Receive command

QUERY PARAMETERS

Parameter In Type Required Description
device_developer_id query String true Device developer ID
timeout query String false value of the processing timeout in milliseconds

Note: timeoutparameter is the duration for client to retrieve the RPC command that execute from favoriot platform.The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds).

RPC via MQTT

Use the following configuration to set up RPC via MQTT

Connection

Host : mqtt.favoriot.com

Standard Ports: 1883 and 8883 (for secure connection using TLS/SSL)

Websocket Port : 3000

ClientID (for some MQTT clients): Any name

Receive / Subscribe command

Subscribe : {your-device-access-token}/v2/rpc

Example : {your-device-access-token}/v2/rpc

RPC via WEBSOCKET

Use the following configuration to set up RPC via WebSocket

Connection

Host : wss://io.favoriot.com

Port : 443 (TLS/SSL connection)

Listen Event

Namespace/Event : v2/rpc

Following is the data format to send request for listening the event:

var payload = {
  request:'listen',
  apikey:'your apikey here'
}

RPC via COAP

Use the following configuration to set up RPC via COAP

Connection

Host : coap://coap.favoriot.com

Path : /v2/rpc

Standard Ports: 5683

Receive command

Following is the data format to get command:

var payload = {
  method:'GET',
  apikey:'your apikey or accesstoken',
  parameters:{
    'device_developer_id':'deviceDefault@developer_id',
    'timeout':'10000'
  }
}

Request Payload

Payload Type Required Description
method string true Method to query using 'GET'
apikey string true Use for authentication. Other option user can use (device accesstoken)
parameters JSON true Configurations:
1.device_developer_id: Device developer ID
2.timeout: value of the processing timeout in milliseconds

Note: timeoutparameter is the duration for client to retrieve the RPC command that execute from favoriot platform. The default value is 10000 (10 seconds). The minimum value is 5000 (5 seconds).

RESPONSES

Code Description
404 Not Found
408 Timeout

Note:When the command is available it will return custom command that set in control widget or rpc rules.

EDGE GATEWAY

This section explains on how to integrate any IoT Gateway to connect to our Edge Gateway feature using HTTP or MQTT communications.

About Edge Gateway

Favoriot Edge Gateway is a service that connects IoT gateways directly to the Favoriot Platform. It bridges the "edge" (local devices) and the Favoriot Platform, enabling data from local devices to be processed, managed, and stored on the platform. Additionally, it allows for the selection of specific parameters in the payload to be stored, providing greater control over transmitted data.


The Communication Architecture

Video: [Tutorial] - Favoriot Platform Edge Gateway

Step 1: Create edge gateway


How to create Edge Gateway

  1. Access Edge Gateway: In the left sidebar menu, click on "Edge Gateway" to access the gateway settings page.
  2. Add New Gateway: On the Edge Gateway page, click on the "add" icon (with the plus symbol) to start creating a new gateway.
  3. Create Gateway Form: The "Create Gateway" modal form will open. Fill out the following sections:
    • Information: Enter details about the gateway, including:
      • Name: The name of the gateway (e.g., Indoor_Gateway).
      • Description: A brief description of the gateway's purpose.
    • Hardware: Provide hardware details:
      • Model Number: Specify the model (e.g., IoT-FV-100).
      • Serial Number: Enter the serial number (e.g., SN-12345-67890).
      • Firmware Version Number: Enter the firmware version (e.g., 1.0.0).
      • Network Protocol: Enter the communication protocol use from Sensor to IoT Gateway (e.g., LoRa).
      • Photo: Optionally, upload a photo for the gateway.
      • Location: Use the map or manually input the latitude and longitude to set the gateway’s location.
    • State: Select the state of the gateway (e.g., Enabled) to allow data processing.
  4. Confirm: After filling in the required details, click "Confirm" to save the new gateway.

Step 2: Forward payload from IoT Gateway

Code samples

#========== RESTAPI (HTTPS) ==========
#!/bin/bash

# Favoriot API details
url="https://apiv2.favoriot.com/v2/gateway/streams/your_gateway_developer_id"  # Replace with your gateway developer ID
api_key="your_access_token"  # Replace with your access token

# JSON payload
payload='{
  "uid": "10001",
  "data": {
    "temperature": "30.51",
    "humidity": "45.31",
    "pressure": "100843.13"
  },
  "gateway_name": "Indoor_Gateway"
}'

# Send the HTTP POST request
response=$(curl -s -o /dev/null -w "%{http_code}" -X POST "$url" \
  -H "Content-Type: application/json" \
  -H "apikey: $api_key" \
  -d "$payload")

# Check response
if [ "$response" -eq 201 ]; then
  echo "Data sent successfully."
else
  echo "Failed to send data. HTTP response code: $response"
fi

#==========================
#========== MQTT ==========
#!/bin/bash

# MQTT details
broker="mqtt.favoriot.com"
port=1883  # Use 8883 for secure connection with TLS/SSL
topic="your_gateway_access_token/v2/gateway/streams"  # Replace with your gateway access token
access_token="your_access_token"  # Replace with your access token

# JSON payload
payload='{
  "uid": "10001",
  "data": {
    "temperature": "30.51",
    "humidity": "45.31",
    "pressure": "100843.13"
  },
  "gateway_name": "Indoor_Gateway"
}'

# Publish message using mosquitto_pub
mosquitto_pub -h "$broker" -p "$port" -t "$topic" -u "$access_token" -P "$access_token" -m "$payload"

# Check if the message was published successfully
if [ $? -eq 0 ]; then
  echo "Message published successfully."
else
  echo "Failed to publish message."
fi
#==========================
#========== RESTAPI (HTTPS) ==========
import requests
import json

# Favoriot HTTP API details
url = "https://apiv2.favoriot.com/v2/gateway/streams/your_gateway_developer_id"  # Replace with your gateway developer ID
headers = {
    'Content-Type': 'application/json',
    'apikey': 'your_apikey_or_access_token'  # Replace with your actual API key or access token
}

# JSON payload to be sent
payload = {
    "uid": "10001",
    "data": {
        "temperature": "30.51",
        "humidity": "45.31",
        "pressure": "100843.13"
    },
    "gateway_name": "Indoor_Gateway"
}

# Send HTTP POST request
response = requests.post(url, headers=headers, data=json.dumps(payload))

# Check response
if response.status_code == 201:
    print("Data sent successfully:", response.json())
else:
    print("Failed to send data:", response.status_code, response.text)

#==========================
#========== MQTT ==========
#pip install requests paho-mqtt
import paho.mqtt.client as mqtt
import json

# MQTT broker details
broker_url = "mqtt.favoriot.com"
broker_port = 1883  # Use 8883 for secure connection (TLS/SSL)
topic = "your_gateway_access_token/v2/gateway/streams"  # Replace with your gateway access token

# MQTT credentials
client_id = "your_client_id"  # Can be any unique name
username = "your_access_token"  # Use your access token for both username and password
password = "your_access_token"

# JSON payload to be published
payload = json.dumps({
    "uid": "10001",
    "data": {
        "temperature": "30.51",
        "humidity": "45.31",
        "pressure": "100843.13"
    },
    "gateway_name": "Indoor_Gateway"
})

# Define MQTT client
client = mqtt.Client(client_id)

# Set username and password
client.username_pw_set(username, password)

# Define connection and publishing callbacks
def on_connect(client, userdata, flags, rc):
    if rc == 0:
        print("Connected to Favoriot MQTT broker")
        # Publish the message upon successful connection
        client.publish(topic, payload, qos=1)
    else:
        print("Connection failed with code", rc)

def on_publish(client, userdata, mid):
    print("Message published:", payload)
    client.disconnect()  # Disconnect after publishing

def on_disconnect(client, userdata, rc):
    print("Disconnected from MQTT broker")

# Assign callbacks
client.on_connect = on_connect
client.on_publish = on_publish
client.on_disconnect = on_disconnect

# Connect to the broker and start the loop
client.connect(broker_url, broker_port, keepalive=60)
client.loop_forever()
#==========================
//========== RESTAPI (HTTPS) ==========
const https = require('https');

const data = JSON.stringify({
  // Add your JSON payload structure here
  uid: "10001",
  data: {
    temperature: "30.51",
    humidity: "45.31",
    pressure: "100843.13"
  },
  gateway_name: "Indoor_Gateway"
});

const options = {
  hostname: 'apiv2.favoriot.com',
  port: 443,
  path: '/v2/gateway/streams/your_gateway_developer_id', // Replace 'your_gateway_developer_id' with the actual ID
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'apikey': 'Your_apikey_or_accesstoken_here' // Replace with your actual API key or access token
  }
};

const req = https.request(options, (res) => {
  let response = '';
  console.log(`Status Code: ${res.statusCode}`);

  res.on('data', (chunk) => {
    response += chunk;
  });

  res.on('end', () => {
    console.log('Response:', response);
  });
});

req.on('error', (error) => {
  console.error('Error:', error);
});

// Write data to request body
req.write(data);
req.end();

//==========================
//========== MQTT ==========
const mqtt = require('mqtt');

// MQTT connection options
const options = {
  clientId: 'your_client_id',  // Replace with a unique client ID
  username: 'your_access_token',  // Replace with your access token as the username
  password: 'your_access_token',  // Replace with your access token as the password
  keepalive: 60,
  clean: true,
  reconnectPeriod: 1000,
  connectTimeout: 30 * 1000
};

// Choose one of the following URLs for connection:
const brokerUrl = 'mqtt://mqtt.favoriot.com:1883';    // For non-secure connection
// const brokerUrl = 'mqtts://mqtt.favoriot.com:8883'; // For secure connection (TLS/SSL)

const topic = 'your_gateway_access_token/v2/gateway/streams'; // Replace with your gateway access token
const client = mqtt.connect(brokerUrl, options);

// JSON payload to be published
const message = JSON.stringify({
  uid: "10001",
  data: {
    temperature: "30.51",
    humidity: "45.31",
    pressure: "100843.13"
  },
  gateway_name: "Indoor_Gateway"
});

// Connect to the MQTT broker
client.on('connect', () => {
  console.log('Connected to Favoriot MQTT broker');

  // Publish message to the specified topic
  client.publish(topic, message, { qos: 1 }, (error) => {
    if (error) {
      console.error('Publish Error:', error);
    } else {
      console.log('Message published:', message);
    }

    // Close the connection after publishing
    client.end();
  });
});

// Error handling
client.on('error', (error) => {
  console.error('Connection Error:', error);
});

//==========================

//========== RESTAPI (HTTPS) ==========
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;

public class FavoriotHttpExample {

    public static void main(String[] args) {
        try {
            // Favoriot API details
            String url = "https://apiv2.favoriot.com/v2/gateway/streams/your_gateway_developer_id"; // Replace with your gateway developer ID
            String apiKey = "your_access_token";  // Replace with your access token

            // JSON payload
            String payload = "{"
                    + "\"uid\": \"10001\","
                    + "\"data\": {"
                    + "\"temperature\": \"30.51\","
                    + "\"humidity\": \"45.31\","
                    + "\"pressure\": \"100843.13\""
                    + "},"
                    + "\"gateway_name\": \"Indoor_Gateway\""
                    + "}";

            // Create connection
            URL urlObj = new URL(url);
            HttpURLConnection conn = (HttpURLConnection) urlObj.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("Content-Type", "application/json");
            conn.setRequestProperty("apikey", apiKey);
            conn.setDoOutput(true);

            // Send request
            OutputStream os = conn.getOutputStream();
            os.write(payload.getBytes());
            os.flush();
            os.close();

            // Check response
            int responseCode = conn.getResponseCode();
            if (responseCode == HttpURLConnection.HTTP_OK) {
                System.out.println("Data sent successfully.");
            } else {
                System.out.println("Failed to send data. HTTP response code: " + responseCode);
            }

            conn.disconnect();

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
//==========================
//========== MQTT ==========
import org.eclipse.paho.client.mqttv3.IMqttDeliveryToken;
import org.eclipse.paho.client.mqttv3.MqttCallback;
import org.eclipse.paho.client.mqttv3.MqttClient;
import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
import org.eclipse.paho.client.mqttv3.MqttException;
import org.eclipse.paho.client.mqttv3.MqttMessage;

public class FavoriotMqttExample {

    public static void main(String[] args) {
        String broker = "tcp://mqtt.favoriot.com:1883";  // Use ssl://mqtt.favoriot.com:8883 for a secure connection
        String clientId = "your_client_id";  // Any unique client ID
        String accessToken = "your_access_token";  // Replace with your access token
        String topic = "your_gateway_access_token/v2/gateway/streams";  // Replace with your gateway access token

        // JSON payload
        String payload = "{"
                + "\"uid\": \"10001\","
                + "\"data\": {"
                + "\"temperature\": \"30.51\","
                + "\"humidity\": \"45.31\","
                + "\"pressure\": \"100843.13\""
                + "},"
                + "\"gateway_name\": \"Indoor_Gateway\""
                + "}";

        try {
            MqttClient client = new MqttClient(broker, clientId);
            MqttConnectOptions connOpts = new MqttConnectOptions();
            connOpts.setUserName(accessToken);
            connOpts.setPassword(accessToken.toCharArray());
            connOpts.setCleanSession(true);

            // Set callback for MQTT events
            client.setCallback(new MqttCallback() {
                @Override
                public void connectionLost(Throwable cause) {
                    System.out.println("Connection lost: " + cause.getMessage());
                }

                @Override
                public void messageArrived(String topic, MqttMessage message) {
                    System.out.println("Message arrived. Topic: " + topic + " Message: " + new String(message.getPayload()));
                }

                @Override
                public void deliveryComplete(IMqttDeliveryToken token) {
                    System.out.println("Delivery complete: " + token.getMessageId());
                }
            });

            // Connect to broker
            client.connect(connOpts);
            System.out.println("Connected to MQTT broker.");

            // Publish message
            MqttMessage message = new MqttMessage(payload.getBytes());
            message.setQos(1);
            client.publish(topic, message);
            System.out.println("Message published.");

            // Disconnect
            client.disconnect();
            System.out.println("Disconnected from MQTT broker.");

        } catch (MqttException me) {
            me.printStackTrace();
        }
    }
}

Use the settings as given below in your IoT Gateway to forward the data payload.

Configuration using HTTP(S)

Host : https://apiv2.favoriot.com

Path : v2/gateway/streams/{gateway_developer_id}

Port : 443 (TLS/SSL connection)

Method: POST

Headers:{'Content-Type:'application/json','apikey':'Your apikey or accesstoken here'}

Body: Any JSON payload structure

*Use the method in given in Security section for establish secure HTTP(S) connection to Favoriot platform

RESPONSES

Status Description
201 Gateway streams uploaded
401 Un-authorized user or apikey or accesstoken
403 Gateway is inactive
404 Gateway not found

Configuration using MQTT

Host : mqtt.favoriot.com

Standard Ports: 1883 and 8883 (for secure connection using TLS/SSL)

Websocket Port : 3000

ClientID (for some MQTT clients): Any name

Username : accesstoken

Password : accesstoken

Send / Publish command

Publish Topic : {your-gateway-access-token}/v2/gateway/streams

Message : Any JSON payload structure

Receive / Subscribe command

Subscribe Topic : {your-gateway-access-token}/v2/gateway/streams/status

*Use the method given in Security section for secure MQTT(S) connection to Favoriot platform

Remarks: Use the same selected gateway accesstoken as MQTT Client username & password and in the topic setup. Refer here to get the gateway access token

View Payload Uploaded

The payload forwarded from the IoT Gateway is not yet stored in the Favoriot Platform database until a mapping configuration is created. To view the uploaded payload, click the "Console" button.


Debug Console

Step 3: Add Edge Gateway Mapping Configuration

This mapping configuration is specifically designed to manipulate the received payload, allowing for key renaming and restructuring to match the data stream format structure for data storage in the Favoriot Platform. It also includes mapping the payload's unique ID to the corresponding device created on the Favoriot Platform.


How to Add Mapping Configuration

  1. View List: In the "Edge Gateway" section, locate the gateway device you want to configure (in this case, "Indoor_Gateway"). Click the "View List" button to see existing configurations for that gateway.

  2. Add Configuration: In the configurations section, click the "Add Configuration" button to create a new configuration for the selected gateway.

  3. Fill in Configuration Details: In the configuration form that appears:

    • Information: Enter a name for your configuration in the "Configuration Name" field.
    • Device Identifier: Specify the device identifier by entering the Device UID JSON path (e.g., payload.uid).
    • Device Mapping: Enter the actual Device UID value and select the corresponding device from the "Device" dropdown.
    • Parameter Value Mapping: Set a custom parameter name (e.g., "Temperature") and specify the JSON path for the parameter value (e.g., payload.data.temp).

After filling in the necessary fields, click the "Create" button to finalise the configuration.

Note: Always check the console debug to examine the structure of the JSON payload in order to set the UID and parameter JSON path values correctly

FEATURES

Dashboard

Visualise the data with a collection of widgets in a dashboard. Allows developers to publicise their dashboard for viewing purposes. A public url is generated (when activated), which then allows the developer to share the public url to other people.

The all new dashboard

Image: "Dashboards" page

Video: [HOW-TO] - Create Dashboard

Create a Dashboard

How to create a dashboard

Image: "Create Dashboard" popup window

  1. Click on the "Create Dashboard" button, in which a popup window should appear.
  2. Fill in the following inputs and click on the "Create" button to create the dashboard.
    • Dashboard Name (mandatory)
    • Dashboard Description (mandatory)
    • Dashboard Tags (optional) - filter list of dashboard based on tag name.
    • Dashboard Image (optional) - upload logo for white-labeling purpose. Image dimension: 200px (h) x 200px (w).
    • Select Image Position (if Dashboard Image uploaded) - Assign image position in the public dashboard's header. By default set to left.
  3. All of the created dashboards will be shown in the "Dashboards" page.

Enable Public Dashboard

Allows other people to access (view only) the dashboard by enabling the "Public" option and share the Public URL.

How to create a dashboard

Image: How To Enable Public Dashboard

  1. At the top right corner of the dashboard tile, click on the gear icon and a popup window will appear.
  2. Select dropdown list the "Public" to enable public access.
  3. Public URL will be generated and use that URL to share with others.
  4. Click the "Update" button to save the changes.
  5. Open the Public URL in a browser to view the Dashboard.

Disable Public Dashboard

  1. At the top right corner of the dashboard tile, click on the gear icon and a popup window will appear.
  2. Select dropdown list the "Private" to disable public access.
  3. Click the "Update" button to save the changes.

Edit Dashboard

Edit dashboard button

Image: Edit dashboard icon (right: Specific dashboard page)

  1. Click the gear icon located at the "Dashboards" page a popup window will appear.
  2. Once the editing is done, click on the "Update" button to save the changes.

Specific Dashboard

All of the created dashboards are shown in the "Dashboards" page. Click on the dashboard tile to view the contents of the selected dashboard.

Dashboard content

Image: Dashboard contents

Add Widgets

Graph/widget creation window

Image: "Add Widgets" popup window

  1. Click on the "+" icon button, in which a popup window should appear.
  2. Select the preferred widget type and configure the selected widget to the desired options.
  3. Once finished, click the "confirm" to add the configured widget to the dashboard.
  4. The added widget will appear in the dashboard content.

Related: How To Configure Widgets

Edit Widgets

Enter the editing mode to delete or change the created widget's configuration, position or size.

Edit buttons in editing mode

Image: Edit buttons in editing mode



Enter editing mode:

  1. Click on the Edit button (pencil icon) to start editing the widget(s) (editing mode entered).
  2. Once the page is in the editing mode, the Confirm button (check icon) and Cancel button (cross icon) will appear.
  3. All of the created widgets will have a header with the Edit button (spanner icon) and Delete button (bin icon) at the top right corner of it.

Exit editing mode:

  1. Click on the Confirm button (check icon) to save the changes or Cancel button (cross icon) to exit the editing mode without saving the changes.

Delete widget:

  1. In editing mode, click on the Bin icon at the top right corner of the widget's header.
  2. A popup window will appear, click on the "Confirm" button to delete the selected widget from the dashboard.

Change widget's configuration:

  1. In editing mode, click on the Spanner icon at the top right corner of the widget's header.
  2. A popup window with the selected widget's configuration will appear. The developer may change the widget's type here too.
  3. Once the editing is done, click on the "Confirm" button to save the changes.

Change widget's position:

  1. In editing mode, hover over the widget, click and hold the widget to move it to preferred position.
  2. Click on the Confirm button (check icon) to save the changes.

Change widget's size:

  1. In editing mode, hover over the widget's box border and the cursor will change to double arrow cursor.
  2. Click+hold+move the cursor to resize the widget.
  3. Click on the Confirm button (check icon) to save the changes.

Dashboard Widgets

Visualise your data with a variety of widget types.

Widget types

Image: Widget types

Video: [Walkthrough] - Dashboard Widgets

Graph: Line/Area/Bar

Assign data parameters to be plotted:

Assign data parameters

Image: Select device(s) to be plot

  1. All devices available will be listed.
  2. Check the selected device(s) one or more.

List of available parameters

Image: List of available parameters

  1. Select any of the parameter(s) to be added into the graph. Multiple parameters supported.
  1. To add another devices, make sure is has the same parameters (at least one) as the selected parameters from the primary device (available for historical plot only).

Select Date Range popup window

Image: "Select Date Range" popup window

  1. To plot a graph with the historical data instead of a real-time data, choose the "historical data" from options.
  2. Configure the following settings:
    • Data Count (mandatory) - Total number of data within the above date range to be plotted on the graph.
    • Date Time Range (mandatory) - Data within this date range will be use for plotting graph.

Show annotations :

Y-axis Annotation configuration

Image: Y-axis Annotation Configuration

  1. Click "new add" annotation button configuration window will appear.
  2. Configure the following settings (available for Y-axis only):
    • Label (mandatory)
    • Y Position (mandatory) - Y-axis value. If "Range?" enabled, it will be the starting point to highlight the annotation area. By default set to 0.
    • Y2 Position (mandatory) - The 2nd Y-axis value, which is the end point of the highlighted annotation area. By default set to 0.
    • Label Color (mandatory) - The "Text" color. By default set to #fff.
    • Background Color (mandatory) - The "Text" background color. By default set to #3d3d3d.
    • Annotation Fill Color(mandatory) - The "Annotation" background color. By default set to #b90083.
  3. To delete the added annotation(s), simply click on the remove button at the top right corner of the selected annotation box. To add another, repeat Step 2.

Line graph with Y-axis annotation

Image: Line Graph with Y-axis Annotation


Graph: Gauge

Gauge Types

Image: Gauge Types

Text

Widget to display a simple text. Useful as a text banner or to display textual information.

Text widget

Image: Text Widget

Card

Widget to display the latest data from a device (one parameter only).

Card widget

Image: Card Widget

Layout

Widget to display or label position device(s) on top an background/image.

Card widget

Image: Layout Widget

Clock

Widget to display digital date and time.

Clock widget

Image: Clock Widget


Button

Widget that acts as an interactive button that will publish the configured value(s) via MQTT when clicked.

Button widget

Image: Button Widget

Slider

Widget that acts as an interactive slider that will publish the configured value via MQTT when the knob is dragged within specified range.

Slider widget

Image: Slider Widget

Switch

Widget that acts as an interactive switch that will publish the configured values for "On" and "Off" via MQTT when clicked.

Switch widget

Image: Switch Widget

Device Status

Widget to display the connection status of the devices.

Device Connection widget

Image: Device Connection Widget


Map

Widget to display device's location configured during the creation of the device.

Map widget

Image: Map Widget

Analytic

Analyzing the data with a collection of widgets in a analytic dashboard. Allows developers to get more insight about the data. A public url is generated (when activated), which then allows the developer to share the public url to other people. Analytic features only available for developer account. To create analytic dashboard its similar how we manage Dashboard refer here How To Manage Dashboard

The all new dashboard

Image: "Analytic Dashboards" page

Video: [HOW-TO] - Create Analytic Dashboard

Analytic Widgets

Visualise your analyse data with a variety of widget types.

Widget types

Image: Analytic Widget types

Video: [Walkthrough] - Analytic Widgets

Rules

Quick explanation of feature focused rules provided by IOT Platform.

Duplicate Rule

Rule duplicate

Need a quick way to create a copy of a rule - do so by clicking on the 'Duplicate' button to create a copy of the rule being duplicated.

HTTP Post

Rule via http post

Trigger rule to send stream data to another server by making IOT Platform perform a POST request to another server location. Simply select the 'Then' rule to 'HTTP POST' and provide a server url/api route that allows for POST interactions and additionaly provide any header definitions required by the server to make a valid POST request.

The requested post data will be in such form pictured below:

HTTP Post Payload

RPC

Rule via rpc

Trigger an RPC, via a rule condition, that will send a user defined parameters and value to an MQTT subscribed topic of the assigned device set during the rule creation of RPC. Simply provide a parameter name and its value to which IOT Platform will send out to when rule condition has been matched.

Rules - Video Tutorials

Email

Video: [Walkthrough] - Rule Notification Email

Telegram

Video: [Walkthrough] - Rule Notification Telegram

SMS

Video: [Walkthrough] - Rule Notification SMS

HTTP POST

Video: [Walkthrough] - Rule HTTP Post

RPC

Video: [Walkthrough] - Rule RPC

Activity Logs

A page dedicated for the developers to view activities made in IOT Platform. Activities such as log into IOT Platform, POST data stream, creating graphs etc. are logged for viewing purposes.

Logs page

Interactions

Logs date range selection


Log view more information

Customers

Available to Developer account only

A feature that allows authorised external users to access sub-parts of the developer's projects, devices, data and dashboards based on the configured permission by the developer.

Structure

First of all, it is best to understand the structure of the Customers feature.

Customers structure

  1. Admin (Developer)
    • The person who will create the Customers.
  2. Organisations
    • The developer will assign a specific project in the Organisations level.
  3. Roles
    • The developer will assign the role's permission in the Roles level.
    • Streams:
      • Read: Users only able to view the data streams.
      • Read/Download: Users able to view and export the data streams.
    • Graphboards:
      • Read: Users only able to view the selected dashboard(s).
      • Read/Write: Users able to view and edit the dashboard.
  4. Users
    • The developer will create an account for each user(s) in the Users level.
    • The users can access to the project by logging in to the Favoriot IoT Platform.
    • Only permitted data will be displayed in their platform.

Customers Creation Process Flow

Customers flow

Permissions

This is where the developers are required to assign which parts of their projects are accessible to the users.

Permission


Note: - The client will received an email to indicate that the account has been created. the image below depict the similar email content that they will receive which includes their User Id and Password. To login, just head over to https://platform.favoriot.com/login and enter credentials as per normal.

Client email

Video: [Walkthrough] - Customers

TUTORIALS

This section provide video tutorials how to use Favoriot Platform and connecting various device from different platform. The code sample for each section is given on the right side of the page. select the respective language tab for your programming.

How to use Favoriot Platform

Video: [Walkthrough] - Favoriot Platform

Node Red Integration

Prerequisite:

  1. Device (Raspberry PI/Arduino) with sensor(s) connected
  2. Code that processes sensor data
  3. Node-RED (program)

  4. Internet connection

    This section will provide users to integrate their collected data-stream(s) (from sensors) to push to Node-RED (program), which will finally post those data-stream(s) into IOT Platform.

    The below diagram depicts how one may intergrate Node-RED into their projects:

    Diagram:

    Node-RED Intergration

    (Connecting device via Raspberry PI (with Node-RED installed) that send data to Node-RED (program) for furthur processing and finally send data to IOT Platform)

NOTE: - This tutorial below, are one of the ways that a developer can use Node-RED within their projects. It is not meant to be the only way, as they are many different methods of intergrating Node-RED into a project.

It is assumed that the developer reading this tutorial has some (basic) understanding on what is Node-RED, how it functions and how to use it. If not - head over to Node-RED first flow tutorial, before proceeding.

Node-RED with Raspberry PI using HTTP

  1. Ensure Raspberry PI is connected to a one/many sensors. Device is also connected to the internet and has Node-RED installed inside the device itself. (E.g. GUI/Command program)

  2. Open up Node-RED. Once open, take note of the Node-RED ip address and port number that it provides upon initialization of program.

    IP Address and PORT number

    Node-RED Server IP Address and PORT number

  1. Open Node-RED in a browser environment by inputting the ip address and port number inside the address bar.

  2. Once Node-RED has been opened in a browser environment, you will be presented with Node-RED's editor. Here developers can drag-n-drop various node(s) that transforms data that enters within this program.

    Node-RED in a Browser

  1. Insert an network node of 'http in' onto the editor. It will allow us to create an api route where data can go into. Once placed on the editor, double click on the 'http in' node and assign it a method of 'POST' and a url of 'data' value.

    HTTP IN Node

  1. Next drag over a 'common' node of type 'debug' to the editor and link it between the 'http in' node and the 'debug' node. It will allow us to see the incoming payload via http request.

    Debug Node

  1. Next drag over a 'http response' node, and set its 'statusCode' field to 200 and ensure it links between 'http in' and 'http response', allowing to respond back to device that made the 'POST' request.

    HTTP Response

  1. Once set, click the 'Deploy' red button to test out current flow configurations.

  2. Back in the Raspberry PI, with the code that has data captured from sensor, include a variable that holds Node-Red's server ip address and port number along with the newly created POST url route that was created previously in step 5.

    URL Node-RED

  1. Below the code, after capturing of data, make a POST request (via code library) (http request(s) library may differ from (programming) language to language).

    POST Code

  1. Once programmed, run the code. Head over to the Node-RED editor and open the debug panel to view the incoming payload sent from code/device to Node-RED. If all goes well, you should be able to see the incoming payload on the debug message window panel.

    Debug Window Panel

  1. Head back to the editor, drag and drop a 'function' node that will be used to set up a header object and request body.

The header object should contain the following property:

While the request body should contain the following property:

Ensure that you link the 'http-in' node to the 'function' node.

  1. Next step, drag over a 'http request' node and set its method to 'POST', the url value to 'https://apiv2.favoriot.com/v2/streams' and the return value to 'a parsed JSON object'. Ensure that the 'function' node is connected to the 'http request' node.

    Request to IOT Platform

  1. Lastly reassign the 'http response' link created in step 7 and to now have it linked between 'http request' node (request to IOT Platform) and 'http response'.

    Request to IOT Platform

  1. The final flow configuration should look similar to this. Feel free to add any node(s) in between the flow for maximum processing.

    Final Flow Configuration

  1. Click the 'Deploy' button and run the code on the device. If all goes well your data stream should be inserted and displayed at the stream page table within IOT Platform.

    Node Red Data Stream

Arduino

code to send data to FAVORIOT platform from Arduino

    The code is only available for java
    The code is only available for java
    The code is only available for java
/*
    This sketch sends streams to FAVORIOT Platform using Ethernet shield
*/
#include <SPI.h>
#include <Ethernet.h>

const int ON = 1;    // Constant to indicate that lights are on
const int OFF = 2;  // Constant to indicate that lights are off
const String APIKEY = "YOUR API KEY HERE"; // Replace with your FAVORIOT apikey
const String DEVICE = "YOUR DEVICE HERE"; // Replace with the id_developer of your device

// Enter a MAC address for your controller below.
// Newer Ethernet shields have a MAC address printed on a sticker on the shield
byte mac[] = {  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED };

// Your IP Address
IPAddress ip(192,168,0,16); // This is assigned to the arduino device (Please assign IP according to your network)

// api.favoriot.com address
char server[] = "apiv2.favoriot.com/v2"; 

EthernetClient client; // Initialize the library instance
int ledPin = 5;        // Led pin number
int LDRPin = 7;        // LDR sensor pin number
String lights = "OFF";       // Current status
String newLights = "OFF";    // New status

// The setup routine runs once when you press reset
void setup() {
  pinMode(ledPin, OUTPUT);        // Initialize the digital pin as an output
  Serial.begin(9600);             // Start serial port
  Serial.println(F("Starting"));
  Ethernet.begin(mac,ip);         // Start the Ethernet connection
  delay(2000);                    // Give the Ethernet shield a second to initialize
}

// The loop routine runs over and over again forever
void loop() {
  int val = analogRead(LDRPin);   // Read the value from the sensor
  Serial.println(val);
  if (val > 990) {  // This is the value limit between day or night with our LDR sensor. Maybe you need adjust this value.
    newLights = OFF;             // Now it's night. We have to turn on the LED
    digitalWrite(ledPin, HIGH);   // Turn the LED on (HIGH is the voltage level)
  }
  else {
    newLights = ON;               // Now it's day. We have to turn off the LED
    digitalWrite(ledPin, LOW);    // Turn the LED off by making the voltage LOW
  }
  if (lights != newLights) {        // Check if we have a change in status
    Serial.println(F("Send Stream"));
    lights = newLights;             // Status update and send stream
    sendStream();
  }
  delay(500);
  // If there's incoming data from the net connection, send it out the serial port
  // This is for debugging purposes only
  while (client.available()) {
    char c = client.read();
    Serial.print(c);
  }

  if (!client.connected()) {
      client.stop();
  }
}
// Send stream to FAVORIOT
void sendStream()
{
  String txt = "";          // Text to send
  if ( lights == "OFF" ) {   // Alarm OFF
     txt = "OFF";
  } else {                  // Alarm ON
     txt = "ON";
  }
  Serial.println(txt);      // For debugging purpose only

  if (client.connect(server, 80)) {   // If there's a successful connection
    Serial.println(F("connected"));
    // Build the data field
    String json = "{\"device_developer_id\":\""+DEVICE+"\",\"data\":{\"Light\":\""+txt+"\"}}";
    // Make a HTTP request
    client.println("POST /v2/streams HTTP/1.1");
    client.println("Host: apiv2.favoriot.com/");
    client.println(F("apikey: YOUR API KEY HERE"));
    client.println("Content-Type: application/json");
    client.print("Content-Length: ");
    int thisLength = json.length();
    client.println(thisLength);
    client.println("Connection: close");

    client.println();
    client.println(json);
  }
  else {
    // If you didn't get a connection to the server:
    Serial.println(F("connection failed"));
  }

}




/*
  FAVORIOT Arduino Code for Wi-Fi shield
 */

#include <SPI.h>
#include <WiFi.h>

char ssid[] = "YOUR WI-FI Network SSID"; //  your network SSID (name)
char pass[] = "WI-FI Password";    // your network password (use for WPA, or use as key for WEP)

const String DEVICE = "DEVICE NAME"; // Replace with the id_developer of your device
String txt = "OFF";          // Text to send

int status = WL_IDLE_STATUS;

char server[] = "apiv2.favoriot.com/v2";    //  address for FAVORIOT Platform

WiFiClient client;

void setup() {
  //Initialize serial and wait for port to open:
  Serial.begin(9600);
  while (!Serial) {
    ; // wait for serial port to connect. Needed for native USB port only
  }
  // check for the presence of the shield:
  // attempt to connect to Wifi network:
  while (status != WL_CONNECTED) {
    Serial.print("Attempting to connect to SSID: ");
    Serial.println(ssid);
    // Connect to WPA/WPA2 network. Change this line if using open or WEP network:
    status = WiFi.begin(ssid, pass);
    // wait 10 seconds for connection:
    delay(10000);
  }
  Serial.println("Connected to wifi");
}

void loop() {

  // Json Data to send to Platform
  String json = "{\"device_developer_id\":\"YOUR DEVICE HERE\",\"data\":{\"light\":\""+txt+"\"}}";
  Serial.println(json);
  if (client.connect(server, 80)) {
    // Make a HTTP request:
    client.println("POST /v2/streams HTTP/1.1");
    client.println("Host: apiv2.favoriot.com/");
    client.println(F("apikey: YOUR API KEY HERE"));
    client.println("Content-Type: application/json");
    client.println("cache-control: no-cache");
    client.print("Content-Length: ");
    int thisLength = json.length();
    client.println(thisLength);
    client.println("Connection: close");

    client.println();
    client.println(json);
  }
  // if there are incoming bytes available
  // from the server, read them and print them:
  while (client.available()) {
    char c = client.read();
    Serial.write(c);
  }
  // if the server's disconnected, stop the client:
  if (!client.connected()) {
    client.stop();
  }
  delay(10000);
}

This section provide tutorials on connecting various arduino device to FAVORIOT IoT. This easy tutorial helps you build a system for turning LED ON and OFF based in the light sensor reading (LDR sensor) and send an email alert. For this, a Arduino able to measure the light is used. In this tutorial you will learn how to:

Components used

Arduino is programmed to send a data stream to FAVORIOT depending on the intensity of light.

All the data streams sent by Arduino is stored in FAVORIOT platform.

In addition to storing data, the true power of FAVORIOT is to let you build Apps quickly with simple rule based on if-else logic. In this scenario we are going to build a Alert App that sends an email to you in case that Arduino detects the lights are ON or OFF.

The connections in Arduino are extremely simple. Refer to the diagram below.

arduino light sensor

If you are registered in FAVORIOT, you have a default device already created for you. Go to right platform on https://platform.favoriot.com/login and see the device panel to see the devices that are present. Basically you need the device_developer_id that might be something like defaultDevice@myusername. But if you want, you can create a new device and use it in this example.

Apikey

Now, go to your "account setting" which is available on the top right corner in the dropdown and check your Apikey. It's a big alphanumeric token like:
"98346673a6377ef1fde2357ebdcb0da582b150b00cabcd5a0d83045425407ab4".
You need this apikey to complete the example.

From Arduino you have to build a HTTP request and send the data.

HTTP request
 POST v2/streams HTTP/1.1
Host: apiv2.favoriot.com/
Accept: application/json
Content-Type: application/json
apikey: YOUR APIKEY HERE
Content-Length: YOUR CONTENT LENGTH HERE
Connection: close


Data

{ { "device_developer_id": "deviceDefault@FAVORIOT", "data": {"light":"ON"} } }

Alright then now your device must be sending streams when you turn on and turn off the lights.

It's time to see whether you can view the data on the platform and check if we have new streams. Login to your account on https://platform.favoriot.com/login and go to data stream tab.

Data stream on sidebar tab


You will see data like this in the data stream tab.

the data stream


Great! now as we are receiving data on our platform let's send email whenever new data comes. Go to the Rules tab below the data stream tab.

when inside the Rule tab click on Add New Rule button. A form will appear and fill in the details as described:

Field Details
Rule Name Short name for rule (.e.g: Light_rule)
Description Describe what the rule does (.e.g.: sends email when light turn on or off)
Device Name Select from the dropdown on which you want to create the rule
Data Field for device this is optional field and decribe to which data inside the device you are associating the rule.
Rule Describe the rule here (see more information below)
Then select what to do from dropdown (email or sms. More alert channel coming soon.)
To enter the email or sms here (based in your previous selection in previous step).
Message enter the short message you want to be attache with alert.

The rule should be described as follows:

(stream.Light === "ON") || (stream.Light === "OFF")

The syntax should be followed while describing the rule. stream. prefix (adding stream. is required) is followed the data field sent by device which is light in this case (the data sent by device is temperature then you will write stream.temperature). You can multiple rule using || (OR) && (AND) logical operators.

Now, whenever the data comes to the platform the rule will be triggered and and alert will be sent.

Congratulations! you have just created an IoT project from scratch. Now go ahead and let your imagination run wild. Show us what great things you can build.

If you are having trouble with connecting your device to our platform please contact us at **support@favoriot.com**.

Raspberry Pi

This section provide tutorials on connecting Raspberry Pi to FAVORIOT platform.

code for creating a data stream

    The code is only available for python
    The code is only available for python
    The code is only available for python
import requests
import json

url = "https://apiv2.favoriot.com/v2/streams"
payload = json.dumps({
  "device_developer_id": "deviceDefault@favoriot.iot",
  "data": {"temp":"14"}
})
headers = {
    "apikey": "YOUR API KEY HERE",
    "content-type": "application/json",
    "cache-control": "no-cache",
    }

response = requests.request("POST", url, headers=headers, data=payload)
parsed = json.loads(response.text)
print json.dumps(parsed, indent=4, sort_keys=True)

code for getting all data stream

import requests
import json

url = "https://apiv2.favoriot.com/v2/streams"
headers = {
    "apikey": "YOUR API KEY HERE",
    "content-type": "application/json",
    "cache-control": "no-cache"
    }
response = requests.request("GET", url, headers=headers)
parsed = json.loads(response.text)
print json.dumps(parsed, indent=4, sort_keys=True)

Raspbian comes preloaded with Python, the official programming language of the Raspberry Pi and IDLE 3, a Python Integrated Development Environment. We're going to show you now how to get started with Raspberry pi using python to connect to our FAVORIOT platform.

You can use Raspberry pi as IoT device by connecting sensors to it or it can be used as IoT Gateway.

Replace the device_developer_id in the payload with your device name. Follow the syntax as given inside the payload.

import request is used to enable set http request from python. You install this library by running
pip install request command in the terminal.

import json is used to format the json response received from FAVORIOT and prepare the json data to be sent to the FAVORIOT platform.

If you are having trouble with connecting your device to our platform please contact us at **support@favoriot.com**.

REDEEM

Received a voucher or referral code from Favoriot or other iot developers? If so, do redeem them, to gain beneficial discounts for initial purchases made via Favoriot IOT Platform.

How to Redeem

  1. Head over to the 'Subscription' page through the 'Subcribe Now'button, select plan related to the voucher.

    Redeem Old User 1

  2. Confirm order by clicking the the plan button.

  3. Key in the voucher code and click the 'apply' button.

  4. If voucher code is valid, the pricing of selected item will be altered based on the discount received from the voucher code.

    Discount Applied

  5. Proceed by clicking on the 'Make Payment' button to receive many discount benefits.

CONTACT US

If you are having trouble with connecting your device to our platform or you find a bug please contact us at **support@favoriot.com.

If you want your project to showcased on our website please contact us at support@favoriot.com**.

bash python javascript java