infini

How to create an application ?

Creating an application is too simple. Here we can have the necessary elements:

Package.json file

The first step is to make a "package.json" file. It should include, at least: application name, developer name, version number, package identifer, installation file name, main file name and requested rights (Notification , Scenarios ...)

{
"name": "appName",
"version": "1.0.0",
"author":"infini",
"packageId":"com.getinfini.example",
"install":"install.js",
"main":"example.js",
"notification":"warning"
}

Installation file

This file will runs automaticaly after downloading or by the user if he wants to manage your application. Your installation file will be correct, if you define certain number of elements.
To allow communication between your installer and our system, you must define an eventEmitter.

var eventEmitter=require('events').EventEmitter;
var event=new eventEmitter();

Graphical User Interface of your install will be done in HTML / CSS. So, you have to define a server with Express for example.

var express = require('express');
var router = express.Router();
var eventEmitter=require('events').EventEmitter;
var event=new eventEmitter();

router.get('/*', function (req, res, next) {
       res.write("Hello world");
       res.end();
});
module.exports = [router,event];

When your installer launches, the system will read your package.json and will ask the user whether accept the requested rights or not.

To recover this information and also the children that would have previously been installed, you should use "getConfiguration" and "configuration" to have the answer

event.emit("getConfiguration");
event.on("configuration",function(data){
       console.log(JSON.stringify(data));
});

The system will return a JSON file similar to this:

{
"name": "appName",
"version": "1.0.0",
"author":"infini",
"packageId":"com.getinfini.example",
"children":[],
"notification":"warning"
}

The next step is to create a child. The user must be associated with the child's creation. The best way is to allow the user, via your GUI, select the elements of the child.

To create a new child, use the emitter "newChild". You must define the number of elements. First, you should give a unique identifier to your child. You should also specify a url allowing the system to call your child. You have to specify the type of child too, ie what your child doing (example: manage light, manage temperature, do an on / off ...). Differents types of elements are available and they will be published later.
Example of "basic" child :

var data={
"id":"yourID",
"type":"theType",
"url":"/myURL"
}
event.emit("newChild",data);

Your child may be able to handle several things. Several cases:

- Your child can handle several different things
For example, a ceiling fan can do 2 things: ventilation and light. In this case, you must create an array of "type" with a different identifier for each element.

var data={
       "id": "ceilingFan1",
       "url": "/ceilingFan1",
       "type": [{
              "id": "fan",
              "type": "fan"
       }, {
              "id": "light",
              "type": "light"
       }]
}
event.emit("newChild",data);

- Your child can handle multiple items of the same type
For example, it can independently manage multiple connected bulbs. The procedure is same as before, the only difference is the possibilty to assign a name for each element to better differentiate them for scenarios. You can ask the user to choose a name which they want.

var data={
       "id": "connectedLight",
       "url": "/light",
       "type": [{
              "id": "light1",
              "type": "light",
              "name":"Light left"
       }, {
              "id": "light2",
              "type": "light",
              "name":"Light right"
       }]
}
event.emit("newChild",data);

The user should validate the creation of your child, assign a name and select a room.

When the child has been created, you will receive a message by using the listener "child".

Remove a child
If you want remove a child, please use "removeChild". You will have to give the identifier of your child.

event.emit("removeChild","yourID");

Once your installation has ended, you can emit an "endInstallation" to finish the installation.

Main file

This is your node.js app. As for the installer, it uses the same logic to your installation file. But, it's not possible to modify or create children.

Post Notifications
To send the notification, please use the emitter "newNotification". A notification must have several things:
- A title
- A subtitle
- A UUID
It may also optionally have:
- A color
- A type of emergency by default, the notification is considered "normal", but you can send "warning", "alert" and "alertMax" notifications according to what the user has authorized you.
- A format, by default, the notification is considered "normal" but you can also ask a question (with the ability to customize the text)

var data={"title":"Your Title", "subTitle":"Your Sub-Title", "uuid":"UUIDOfThisNotification"}
event.emit("newNotification",data);

Once the user has seen your notification, you will receive a message by listening to "notification". In the case of a "question" notification, you will also receive the user's response. The UUID is used to identify the notification.

Manage scenarios
If the user has authorized you, you can create scenarios. To do this, use the emitter "newScenario". A scenario must have a name (which you can define yourself or ask the user via your GUI) and a unique identifier.
There are two types of scenarios: weather they are directly operable by the user (example "alarm clock") or happens same as an event within your application (example: motion detection). The 2nd case is used By default. Add "userActivable" for the first case.
In this case and in order to be compatible with our application launcher, you must define an icon and / or text.

/*1st case :*/
var data={"title":"Alarm Clock", "uuid":"UUIDOfMyScenario1","userActivable":true,"userText":"06:00"};
event.emit("newScenario",data);
/*2nd case :*/
var data={"title":"Alarm Clock", "uuid":"UUIDOfMyScenario2"}
event.emit("newScenario",data);

In the first case, a scenario can be activated without being active. For example, the "wake-up" scenario can be activated by the user but it will only be active for the wake-up time.
To enable or disable a scenario, just emit :

event.emit("enableScenario",{"uuid":"UUIDOfMyScenario1", "enabled":true})

And to trigger a scenario make :

event.emit("triggerScenario",{"uuid":"UUIDOfMyScenario1"})

Manage data and orders
To ensure that the system works properly, you must notify the system if an action has taken place within your application (eg lighting the lights, opening the roller shutters, starting the music, etc.).
You must give the following things:
- the child's UUID
- the type
- the value
If you have declared several types, you must also give the Id of type

var data={"uuid":"UUIDOfChild","type":"light", "value":false }
event.emit("newEvent",data);

The objective of our platform is to offer a compatibility between the equipment and in particular the possibility of creating scenarios.
Your application must be able to receive orders in order to be compatible with the system.
You have to set up an "order listener". The system can send you an order by giving you the following elements:
- the child's UUID
- the type
- the value
If you have declared several types, it will also give you the Id of type.

Distribute your application

To distribute your application, the easiest way is to upload your app on the infini Market, our app store.
When opening the infini Market, you can submit your application, accompanied by a description, screenshot ...

By default, hubs can only download applications from infini Market. The "dev" mode is also used to install third-party applications. So, you can distribute your application by your own means. Only hubs in "dev" mode will be able to download your application in this case.