API2 - Revision history

Mark at 10:13, 11 November 2025

2025-11-11T10:13:34Z

Mark at 10:12, 11 November 2025

2025-11-11T10:12:06Z

Sova at 10:15, 11 July 2025

2025-07-11T10:15:08Z

Sova at 12:59, 23 June 2025

2025-06-23T12:59:02Z

Sova: changes for actual websocket api

2025-06-23T12:01:16Z

changes for actual websocket api

Show changes

Mark at 08:08, 23 June 2025

2025-06-23T08:08:29Z

Support at 13:16, 16 August 2023

2023-08-16T13:16:47Z

Support at 13:16, 16 August 2023

2023-08-16T13:16:18Z

Support at 13:15, 16 August 2023

2023-08-16T13:15:06Z

Support: Created page with " API2 works via WebSocket connection, so you can interact with your Larnitech server from a browser using extensions (such as WebSocket Test..."

2023-08-16T13:12:32Z

Created page with "<languages/> <translate>  API2 works via WebSocket connection, so you can interact with your Larnitech server from a browser using extensions (such as WebSocket Test..."

New page

<languages/>
<translate>

API2 works via WebSocket connection, so you can interact with your Larnitech server from a browser using extensions (such as WebSocket Test Client). 
To get started, you should: 
1. Establish a web socket connection. 
<syntaxhighlight lang="xml">
ws://IPADDR:PORT/api
</syntaxhighlight>
Where: IPADDR – ip address of your metaforsa or DE-MG; 
PORT – port for API2 (you can get it from LT_Setup => General => API => Websocket port (2041 by default); 
2. Authorize
<syntaxhighlight lang="json">
{
"request": "authorize",
"key": "XXXXXXXXXXXXXXX"
}
</syntaxhighlight>
Where XXXXXXXXXXXXXXX - key from LT_Setup => Security => Show API key 
3.After this you can send json requests:

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":"ENTER_API_KEY"}

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":"ENTER_API_KEY"}
response:
{
"requestType" : "deviceStatus",
"status" : {
"addr" : "310:1",
"state" : "middle",
"type" : "jalousie"
}
}

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

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

}

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

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>
</translate>

@@ Line 68: / Line 68: @@
 				"state":"undefined"
+			}
+		},
 		],
-	"found":2
+	"found":3
+}
@@ Line 130: / Line 157: @@
+	]
+}
 </syntaxhighlight>

@@ Line 4: / Line 4: @@
 API2 works via WebSocket connection, so you can interact with your Larnitech server from a browser using extensions (such as WebSocket Test Client).<br>
 To get started, you should:<br><br>
-. Establish a web socket connection.<br>
+. Establish a web socket connection.<br> Locally
 <syntaxhighlight lang="xml">
 ws://IPADDR:PORT/api
 </syntaxhighlight>
 Where: IPADDR – ip address of your metaforsa or DE-MG;<br>
-PORT – port for API2 (you can get it from LT_Setup =&gt; General =&gt; API =&gt; Websocket port (2041 by default);<br><br>
+PORT – port for API2 (you can get it from LT_Setup =&gt; General =&gt; API =&gt; Websocket port (2041 by default); <br>
 . Authorize
 <syntaxhighlight lang="json">

@@ Line 136: / Line 136: @@
 . Use request to get detailed info about element with "status":"detailed"
-<syntaxhighlight lang="xml" line>
+<syntaxhighlight lang="json" line>
 curl --header 'Content-Type: application/json' --data '{"request":"status-get", "API-KEY":"ENTER_API_KEY", "addr":"585:17", "status":"detailed"}' 'http://de-mg.local/API2/'
 </syntaxhighlight>
@@ Line 143: / Line 143: @@
 . Use request to set brightness for dimmer element
-<syntaxhighlight lang="xml" line>
+<syntaxhighlight lang="json" line>
 curl --header 'Content-Type: application/json' --data '{"request":"status-set","API-KEY":"ENTER_API_KEY", "addr":"585:17", "status":{"level":10}}' 'http://de-mg.local/API2/'
 </syntaxhighlight>
@@ Line 150: / Line 150: @@
 . Use request to set color-temp for dimmer element
-<syntaxhighlight lang="xml" line>
+<syntaxhighlight lang="json" line>
 curl --header 'Content-Type: application/json' --data '{"request":"status-set","API-KEY":"ENTER_API_KEY","addr":"585:17", "status":{"color-temp":100}}' 'http://de-mg.local/API2/'
 </syntaxhighlight>

@@ Line 136: / Line 136: @@
 . Use request to get detailed info about element with "status":"detailed"
-curl --header 'Content-Type: application/json' --data '{"request":"status-get", "API-KEY":"8010920395573775", "addr":"585:17", "status":"detailed"}' 'http://de-mg.local/API2/'
+<syntaxhighlight lang="xml" line>
 </translate>

@@ Line 43: / Line 43: @@
 <!--T:2-->
-<syntaxhighlight lang="xml" line>
+<syntaxhighlight lang="xml">
 request:
 {"request":"get-devices", "status":"detailed"}

@@ Line 22: / Line 22: @@
 Fields of JSON_REQUEST:
 <ul>
-  	<li>"requestType" - Type of request:
+  	<li>"request" - Type of request:
 <ul>
-  	<li>“getDevicesList” – request for getting the list of all devices;</li>
+  	<li>“getDevices” – 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>