/
index.txt
55 lines (38 loc) · 1.16 KB
/
index.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
========================
Butler technical details
========================
The butler component is based on RiveScript engine.
Startup
=======
On startup, the butler will check for installed **brain** packages in the Domogik package directory. Depending on the configured language, it will load the appropriate language related files.
Interacting with the butler
===========================
To interact with the butler, you just need to :
* publish your queries in an **interface.input** MQ message.
* subscribe for responses or notifications to an **interface.output** MQ message
interface.input
---------------
Example : ::
{
"text" : ... ,
"media" : ... ,
"location" : ... ,
"identity" : ... ,
"sex" : ... ,
"mood" : ... ,
"source" : ... ,
}
Only **text**, **media** and **source** (interface-name.hostname) are mandatory.
interface.output
----------------
Example : ::
{
"text" : ... ,
"media" : ... ,
"location" : ... ,
"identity" : ... ,
"sex" : ... ,
"mood" : ... ,
"reply_to" : ... ,
}
The **reply_to** filed is filled with the **source** value of an input message.