API/ru - Revision history

Rusanov at 14:37, 16 January 2022

2022-01-16T14:37:12Z

Rusanov at 14:34, 16 January 2022

2022-01-16T14:34:49Z

Rusanov: Created page with "API"

2022-01-16T08:42:59Z

Created page with "API"

New page

<languages/>
API works through HTTP GET request, so you can work with your Larnitech server from browser, just sending requests from address string.
Request:
<syntaxhighlight lang="xml" line>
http://IPADDR:PORT/JSON_REQUEST
</syntaxhighlight>
Where:
IPADDR – ip address of your metaforsa or DE-MG;
PORT – port for API plugin (you can get it from LT Setup=>Plugins=>API=>Configure button);
JSON_REQUEST – request to server in json format.
Fields of JSON_REQUEST:
<ul>
<li>"requestType" - Type of request:
<ul>
<li>“getDevicesList” – request for getting the list of all devices;</li>
<li>“getDeviceStatus” – request for getting device status;</li>
<li>“setDeviceStatus” – request for setting device status;</li>
<li>“setDeviceStatusRaw” – request for setting device status (status in hex format);</li>
<li>“getAllDevicesStatus” – request for getting all devices status.</li>

</ul>
</li>
<li>“key” – key for API plugin (you can get it from LT Setup=>Plugins=>API=>Configure button).</li>
<li>“addr” – address of device.</li>
<li>“status” – status of device.</li>
</ul>
Examples of requests and responses:

<syntaxhighlight lang="json" line>
request:
{"requestType":"getDevicesList","key":"0000000000000000"}

response:
{
"requestType":"devicesList",
"devices": [
{
"type": "lamp",
"name": "Ceiling",
"addr":"401:1"
},

{
"type": "conditioner",
"name": "AC",
"addr":"158:200",
"t-min":"16",
"t-delta":"16"
}

]
}

request:
{"requestType":"getDeviceStatus","addr":"310:1","key":"0000000000000000"}
response:
{
"requestType" : "deviceStatus",
"status" : {
"addr" : "310:1",
"state" : "middle",
"type" : "jalousie"
}
}

request:
{"requestType":"setDeviceStatus","addr":"310:1","key":"0000000000000000","status":{"state": "on"}}

response:
{
"requestType":"setDeviceStatus",
"addr":"410:1",
"status":{
"state": "on"
}

}

request:
{"requestType":"getAllDevicesStatus","key":"0000000000000000"}

response:
{
"requestType":"allDevicesStatus",
"statuses": [
{
"addr":"401:1",
"state": "off",
},

{
"addr":"158:200",
"state": "on",
"temp":"25",
"mode":"cool",
"fan":"low",
"vane-ver":"1",
"vane-hor":"4"
}
]
}

request:
{"requestType":"setDeviceStatusRaw","addr":"310:1","key":"0","status":{"state":"ff00"}}

response:
{
"addr" : "310:1",
"key" : "0",
"requestType" : "setDeviceStatusRaw",
"status" : {
"state" : "ff00"
}
</syntaxhighlight>

@@ Line 1: / Line 1: @@
 <languages/>
 API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки.
 Запрос:
@@ Line 6: / Line 5: @@
 http://IPADDR:PORT/JSON_REQUEST
 </syntaxhighlight>
-Where:
+Где:
 IPADDR – IP адрес вашего модуля METAFORSA или DE-MG;
-PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).
+PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)).
 JSON_REQUEST – запрос к серверу в формате json.
 Поля запроса JSON_REQUEST:
@@ Line 22: / Line 21: @@
 </ul>
 </li>
-  	<li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).</li>
+  	<li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure)).</li>
   	<li>“addr” – адрес устройства.</li>
   	<li>“status” – статус устройства.</li>
 </ul>
 Примеры запросов и ответов:
 <syntaxhighlight lang="json" line>

@@ Line 1: / Line 1: @@
 <languages/>
-API works through HTTP GET request, so you can work with your Larnitech server from browser, just sending requests from address string.
+<div class="mw-translate-fuzzy">
-Request:
+API работает через HTTP-запрос GET, поэтому вы можете работать со своим сервером Larnitech из браузера, просто отправляя запросы из адресной строки.
 <syntaxhighlight lang="xml" line>
 http://IPADDR:PORT/JSON_REQUEST
 </syntaxhighlight>
 Where:
-IPADDR – ip address of your metaforsa or DE-MG;
+IPADDR – IP адрес вашего модуля METAFORSA или DE-MG;
-PORT – port for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button);
+PORT – порт для плагина API (вы можете найти его в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).
-JSON_REQUEST – request to server in json format.
+JSON_REQUEST – запрос к серверу в формате json.
-Fields of JSON_REQUEST:
+Поля запроса JSON_REQUEST:
 <ul>
-  	<li>"requestType" - Type of request:
+  	<li>"requestType" - тип запроса:
 <ul>
-  	<li>“getDevicesList” – request for getting the list of all devices;</li>
+  	<li>“getDevicesList” – запрос на получение списка всех устройств;</li>
-  	<li>“getDeviceStatus” – request for getting device status;</li>
+  	<li>“getDeviceStatus” – запрос на получение статуса устройства;</li>
-  	<li>“setDeviceStatus” – request for setting device status;</li>
+  	<li>“setDeviceStatus” – запрос на установку статуса устройства;</li>
-         <li>“setDeviceStatusRaw” – request for setting device status (status in hex format);</li>
+         <li>“setDeviceStatusRaw” – запрос на установку статуса устройства (статус в шестнадцатеричном формате);</li>
-  	<li>“getAllDevicesStatus” – request for getting all devices status.</li>
+  	<li>“getAllDevicesStatus” – запрос на получение статуса всех устройств.</li>
 </ul>
 </li>
-  	<li>“key” – key for API plugin (you can get it from LT Setup=&gt;Plugins=&gt;API=&gt;Configure button).</li>
+  	<li>“key” – ключ для плагина API (его можно получить в программе LT Setup. В разделе Плагины (Plugins) найдите плагин API и нажмите кнопку Настроить (Configure).</li>
-  	<li>“addr” – address of device.</li>
+  	<li>“addr” – адрес устройства.</li>
-  	<li>“status” – status of device.</li>
+  	<li>“status” – статус устройства.</li>
 </ul>
-Examples of requests and responses:
+Примеры запросов и ответов:
 <syntaxhighlight lang="json" line>