• Light
  • Dark
  • Français
  • English
  • Spanish
  • Deutsch
  • Core 3.3
  • Core 4.0 (legacy)
  • Core 4.1
  • Core 4.2
  • Core 4.3
  • Core 4.4
  • Core 4.5

Interactions

Tools → Interactions

The interaction system in Jeedom allows you to perform actions from text or voice commands.

These commands can be obtained by :

The value of interactions lies in the simplified integration into other systems such as smartphones, tablets, other home automation boxes, etc.

Tip

You can open an interaction by doing :

  • Click on one of them.
  • Ctrl Clic or Clic Center to open it in a new browser tab.

You have a search engine to filter the display of interactions. The Escape key cancels the search. To the right of the search field, three buttons found in several places in Jeedom:

Once on the configuration of an interaction, you have a contextual menu with the Right Click on the tabs of the interaction. You can also use a Ctrl Click or Click Center to directly open another interaction in a new browser tab.

Interactions

At the top of the page, there are 3 buttons :

Tip

If you have an interaction that generates sentences for lights for example and you add a new light control module, you will either have to regenerate all the interactions, or go to the interaction in question and save it again to create the sentences of this new module.

Principe

The principle of creation is quite simple : we will define a generating model sentence which will allow Jeedom to create one or more hundreds of other sentences which will be possible combinations of the model.

We will define answers in the same way with a model (this allows Jeedom to have several answers for a single question).

We can also define a command to execute if for example the interaction is not linked to an action but information or if we wish to carry out a particular action after it (it is also possible to execute a scenario, to control several orders…).

Configuration

The configuration page consists of several tabs and buttons :

General tab

Filters tab

Actions tab

Use if you want to target one or more specific commands or pass specific parameters.

Exemples

Note

The screenshots may be different in view of developments.

Simple interaction

The simplest way to configure an interaction is to give it a rigid generator model, with no variation possible. This method will very precisely target a command or a scenario.

In the following example, we can see in the "Request" field the exact sentence to provide to trigger the interaction. Here, to turn on the living room ceiling light.

interact004

We can see, on this capture, the configuration to have an interaction linked to a specific action. This action is defined in the "Action" part of the page.

We can very well imagine doing the same with several actions to light several lamps in the living room as the following example :

interact005

In the 2 examples above, the model sentence is identical but the actions which result from it change according to what is configured in the “Action” part, we can therefore already with a simple interaction with a single sentence imagine actions combined between various commands and various scenarios (we can also trigger scenarios in the action part of interactions).

Tip

To add a scenario, create a new action, write "scenario" without an accent, press the tab key on your keyboard to bring up the scenario selector.

Multiple command interaction

Here we will see all the interest and all the power of interactions, with a model sentence we will be able to generate sentences for a whole group of commands.

We will resume what was done above, delete the actions that we had added, and instead of the fixed sentence, in "Request", we will use the tags #commande# and #equipement#. Jeedom will therefore replace these tags with the name of the commands and the name of the equipment (we can see the importance of having consistent command / equipment names).

interact006

So we can see here that Jeedom generated 152 sentences from our model. However, they are not very well built and we have a bit of everything.

To make order in all this, we will use the filters (right part of our configuration page). In this example, we want to generate sentences to turn on lights. We can therefore uncheck the type of info command (if I save, I only have 95 sentences left), then, in the subtypes, we can only keep checked “default” which corresponds to the action button ( so there are only 16 sentences left).

interact007

It's better, but we can make it even more natural. If I take the generated example “On entry”, it would be nice to be able to transform this sentence into “turn on the entry” or “turn on the entry”. To do this, Jeedom has, under the request field, a synonymous field which will allow us to name the name of the commands differently in our "generated" sentences, here it is "on", I even have "on2 "in modules that can control 2 outputs.

In synonyms, we will therefore indicate the name of the command and the synonym (s) to use :

interact008

We can see here a somewhat new syntax for synonyms. A command name can have several synonyms, here “on” has the synonym “turn on” and “turn on”. The syntax is therefore “Name of the command” = “synonym 1“, “synonym 2” (we can put as many synonym as we want). Then, to add synonyms for another command name, just add a vertical bar after the last synonym “|” after which you can again name the command which will have synonyms as for the first part, etc.

It's already better, but it still lacks for the command "on" "input" the "l" and for others the "la" or "le" or "a", etc. We could change the name of the equipment to add it, it would be a solution, otherwise we can use the variations in the request. This consists of listing a series of possible words at a location in the sentence, Jeedom will therefore generate sentences with these variations.

interact009

We now have slightly more correct sentences with sentences that are not correct, for our example “on” “entry”. so we find "Turn on entry", "Turn on an entry", "Turn on an entry", "Turn on the entry" etc. So we have all the possible variants with what we added between the “\ []” and this for each synonym, which quickly generates a lot of sentences (here 168).

In order to refine and not have improbable things like "turn on the TV", we can allow Jeedom to delete syntactically incorrect requests. It will therefore delete what is too far from the actual syntax of a sentence. In our case, we go from 168 sentences to 130 sentences.

interact010

It therefore becomes important to build your model sentences and synonyms well and to select the right filters so as not to generate too many unnecessary sentences. Personally, I find it interesting to have some inconsistencies of the style "an entry" because if at home, you have a foreign person who does not speak French correctly, the interactions will still work.

Customize responses

Until now, as a response to an interaction, we had a simple sentence that didn't say much except that something happened. The idea would be that Jeedom tells us what he did a little more precisely. This is where the response field comes in, where we will be able to customize the return according to the command executed.

To do this, we will again use the Jeedom Tag. For our lights, we can use a phrase of the style : I turned on #equipement# (see screenshot below).

interact011

You can also add any value from another command such as temperature, number of people, etc.

interact012

Binary conversion

Binary conversions apply to info type commands whose subtype is binary (returns 0 or 1 only). So you have to activate the right filters, as we can see on the screenshot a little lower (for the categories, we can check all of them, for the example I only kept light).

interact013

As we can see here, I have kept almost the same structure for the request (it is voluntary to focus on the specifics). Of course, I adapted the synonyms to have something coherent. However, for the answer, it is imperative to put only #valeur# which represents the 0 or 1 that Jeedom will replace with the following binary conversion.

Field Binary conversion must contain 2 answers : first the answer if the value of the command is 0, then a vertical bar “|” separation and finally the response if the command is worth 1. Here the answers are simply no and yes but we could put a little longer sentence.

Warning

Tags do not work in binary conversions.

Authorized users

The “Authorized users” field allows you to authorize only certain people to execute the command, you can put several profiles by separating them with a “|”.

Example : personne1|personne2

We can imagine that an alarm can be activated or deactivated by a child or a neighbor who would come to water the plants in your absence.

Regexp exclusion

It is possible to create Regexp exclusion, if a generated sentence matches this Regexp it will be deleted. The interest is to be able to remove false positives, ie a sentence generated by Jeedom which activates something which does not correspond to what we want or which would interfere with another interaction which would have a similar sentence.

We have 2 places to apply a Regexp :

For the "General exclusion regex for interactions" field, this rule will be applied to all interactions, which will be created or saved again later. If we want to apply it to all existing interactions, we must regenerate the interactions. Generally, it is used to erase incorrectly formed sentences found in most interactions generated.

For the "Regexp exclusion" field in the configuration page of each interaction, you can put a specific Regexp which will act only on said interaction. It therefore allows you to delete more precisely for an interaction. It can also make it possible to delete an interaction for a specific command for which one does not want to offer this possibility within the framework of a generation of multiple commands.

The following screenshot shows the interaction without the Regexp. In the list on the left, I filter the sentences to show you only the sentences that will be deleted. In reality there are 76 sentences generated with the configuration of the interaction.

interact014

As you can see on the following screenshot, I added a simple regexp which will search for the word "Julie" in the generated sentences and delete them. However, we can see in the list on the left that there are always sentences with the word "julie", in regular expressions, Julie is not equal to julie, this is called a case sensitivity or in good French a capital letter is different from a lowercase. As we can see in the following screenshot, there are only 71 sentences left, the 5 with a "Julie" have been deleted.

A regular expression is composed as follows :

If we translate this expression into a sentence, it would give “look for the word Julie which is preceded by anything and followed by anything”.

It's an extremely simple version of regular expressions but already very complicated to understand. It took me a while to understand how it works. As a slightly more complex example, a regexp to verify a URL :

/\^(https?:\ / \ /)?(\ [\ da-z \ .- ] +) \. (\ [az \. ] {2,6}) (\ [\ / \ w \ .- ] *)*\ /?\ $ /

Once you can write this, you understand the regular expressions.

interact015

To solve the problem of upper and lower case, we can add to our expression an option which will make it case-insensitive, or in other words, which considers a lowercase letter equal to a capital letter; to do this, we simply have to add at the end of our expression an “i”.

interact016

With the addition of the option "i" we see that there are only 55 sentences left and in the list on the left with the julie filter to find the sentences that contain this word, we see that there are some Much more.

As this is an extremely complex subject, I will not go into more detail here, there are enough tutorials on the net to help you, and don't forget that Google is your friend too because yes, it's my friend, it was he who taught me to understand Regexp and even to code. So if he helped me, he can also help you if you put good will in it.

Useful links :

Response composed of several pieces of information

It is also possible to put several info commands in a response, for example to have a situation summary.

interact021

In this example we see a simple sentence that will return an answer with 3 different temperatures, so here we can put a little whatever we want in order to have a set of information at once.

Is there anyone in the room ?

Basic version

interact017

This example specifically targets specific equipment which allows for a personalized response. So we could imagine replacing the answer of the example with “no there is no one in the room Julie|yes there is someone in the room Julie”

Evolution

interact018

Without the Regexp, we get here 11 sentences, but my interaction aims to generate sentences only to ask if there is someone in a room, so I do not need lamp status or other like outlets, which can be resolved with regexp filtering. To make it even more flexible, you can add synonyms, but in this case you should not forget to modify the regexp.

Know the temperature / humidity / brightness

Basic version

We could write the sentence in hard like for example "what is the temperature of the living room", but it would be necessary to make one for each sensor of temperature, brightness and humidity. With the Jeedom sentence generation system, we can therefore generate sentences for all the sensors of these 3 types of measurement with a single interaction.

Here a generic example which is used to know the temperature, humidity, brightness of the different rooms (object in the Jeedom sense).

interact019

Evolution

We can therefore add synonyms to the command name to have something more natural, add a regexp to filter the commands which have nothing to do with our interaction.

Adding a synonym, lets say to Jeedom that a command called "X" can also be called "Y" and therefore in our sentence if we have "turn on y", Jeedom knows that it is turn on x. This method is very convenient for renaming command names which, when displayed on the screen, are written in an unnatural way, vocally or in a written sentence like “ON””. A button written like this is completely logical but not in the context of a sentence.

We can also add a Regexp filter to remove some commands. Using the simple example, we see sentences "battery" or even "latency", which have nothing to do with our interaction temperature / humidity / brightness.

interact020

So we can see a regexp :

(batterie|latence|pression|vitesse|consommation)

This allows you to delete all commands that have one of these words in their sentence

Note

The regexp here is a simplified version for easy use. We can therefore either use traditional expressions or use simplified expressions as in this example.

Control a dimmer or a thermostat (slider)

Basic version

It is possible to control a lamp as a percentage (dimmer) or a thermostat with the interactions. Here is an example to control its dimmer on a lamp with interactions :

interact022

As we can see, there is here in the request the tag #consigne# (you can put what you want) which is included in the drive control to apply the desired value. To do this, we have 3 parts : * Request : in which we create a tag that will represent the value that will be sent to the interaction. * Reply : we reuse the tag for the response to be sure that Jeedom correctly understood the request. * Stock : we put an action on the lamp we want to drive and in the value we pass it our tag order.

Note

We can use any tag except those already used by Jeedom, there can be several to control for example several commands. Note also that all the tags are passed to the scenarios launched by the interaction (it is however necessary that the scenario is in “Execute in foreground”).

Evolution

We may want to control all cursor type commands with a single interaction. With the following example, we will therefore be able to control several drives with a single interaction and therefore generate a set of sentences to control them.

interact033

In this interaction, we have no command in the action part, we let Jeedom generate from tags the list of sentences. We can see the tag #slider#. It is imperative to use this tag for instructions in a multiple interaction command, it may not be the last word of the sentence. We can also see in the example that we can use in the response a tag that is not part of the request. The majority of the tags available in the scenarios are also available in the interactions and therefore can be used in a response.

Result of the interaction :

interact034

We can see that the tag #equipement# which is not used in the request is well completed in the response.

Control the color of an LED strip

It is possible to control a color command by the interactions by asking Jeedom for example to light a blue LED strip. This is the interaction to do :

interact023

So far nothing complicated, however, you must have configured the colors in Jeedom for it to work; go to the menu → Configuration (top right) then in the “Configuration of interactions” section” :

interact024

As we can see on the screenshot, there is no color configured, so you have to add colors with the "+" on the right. The name of the color, it is the name that you will pass to the interaction, then in the right part (column "HTML code"), by clicking on the black color we can choose a new color.

interact025

We can add as many as we want, we can put any name as any, so we could imagine assigning a color to the name of each member of the family.

Once configured, you say "Light the tree green", Jeedom will search in the request for a color and apply it to the order.

Use coupled with a scenario

Basic version

It is possible to couple an interaction to a scenario in order to carry out actions a little more complex than the execution of a simple action or a request for information.

interact026

This example therefore allows to launch the scenario which is linked in the action part, we can of course have several.

Programming an action with interactions

Interactions do a lot of things in particular. You can program an action dynamically. Example : “Turns on the heat at 22 for 2:50 p.m”. Nothing could be simpler, just use the tags #time# (if a specific time is defined) or #duration# (for in X time, example in 1 hour) :

interact23

Note

You will notice in the response the tag #value# this contains, in the case of a programmed interaction, the effective programming time

Nous utilisons des cookies pour vous garantir la meilleure expérience sur notre site web. Si vous continuez à utiliser ce site, nous supposerons que vous en êtes satisfait.