Содержание

1 iRidium for Larnitech
2 Connecting
3 Setting on Larnitech side
4 Setting in iRidium studio
- 4.1 Commands and tags

iRidium for Larnitech

is a set of tools to create interfaces that control equipment by Larnitech

The documentation was updated on 02.6.2022

iRidium for Larnitech is a set of tools that allows to create an interface to control smart home or office made on the basis of equipment by German company - Larnitech.

Licensing of iRidium for Larnitech: more.

Connecting

Devices with iRidium connect to Larnitech devices by Ethernet (TCP) via:

DE-MG gateway
or METAFORSA MF-10.A controller

Setting on Larnitech side

1 Go to the web-interface of a gateway or a controller (LT Setup). Then go to Plugins tab.

2 If API plugin is not activated, activate it. Then click "Configure".

3 Save the settings. Then you set Key and Websocket port.

It is obligatory to activate a special API plugin for iRidium to exchange data with Larnitech gateway or controller.

Setting in iRidium studio

1 Create a panel project.

2 Add Larnitech Network driver to a project. Devices can also be imported using a scanner.

3 Set network connection:

Log Level: the level of logging;
Host: IP address of Larnitech gateway or controller
Port: Websocket port of Larnitech gateway or controller (8080 by default)
Password: an access key (Key)
Keep Alive: an interval to check TCP connection. In case there is no answer to the Keep Alive request, the driver state is obligatorily switched to "turned off".

4 Add a required number of Larnitech Devices to Larnitech network.

5 Set each device:

DeviceID: ID of a device
SubDeviceID: ID of a subdevice

6 Create a graphical interface to control Larnitech devices.

7 Assign commands and tags of Larnitech driver to graphical items.

Commands and tags

To control equipment it is required to set Commands and Feedbacks. To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback drag'n'drop a feedback channel on a graphic item and choose how to output or display a value.

Read more about work with graphic items in the "Types of graphic items" article.

Type of device	Parameter	Values	Write/ read	Note
CO2 Sensor	CO2 level	0 - 5000	Read	-
Lamp Script Light Scheme	SetState	0 = off 1 = on	Write	-
Lamp Script Light Scheme	State	0 = off 1 = on	Read	-
Valve	SetState	0 = close 1 = open	Write	-
Valve	State	0 = closed 1 = opened	Read	-
Jalousie Gate	SetState	0 = close 1 = open 2 = stop	Write	-
Jalousie Gate	State	0 = closed 1 = opened 2 = closing 3 = opening 4 = middle 5 = unknown	Read	-
Door Switch	State	0 = closed 1 = opened	Read	-
Switch	State	0 = keystroke 1 = holding the key 2 = releasing the key	Read	The status will be sent upon the occurrence of an event if client subscribed to events
Intercom	State	0 = no call 1 = answer 2 = call	Read	-
Humidity Sensor Illumination Sensor Motion Sensor Temperature Sensor	State	from -128.00 to +128.00	Read	-
Leak Sensor	SetState	0 = reset	Write	-
Leak Sensor	State	0 = no leakage 1 = leakage 2 = set up to ignore 3 = leakage when ignoring 4 = malfunction	Read	-
Dimmer Lamp	SetState	0 = off 1 = on	Write	-
	Brightness	0-100	Write	-
	State	0 = off 1 = on	Read	-
	Brightness	0-99	Read	-
RGB Lamp	SetState	0 = off 1 = on	Write	-
	Brightness	0-100		-
	Red	0-250		-
	Green	0-249		-
	Blue	0-248		-
	State	0 = off 1 = on	Read	-
	Brightness	0-99		-
	Red	0-249		-
	Green	0-248		-
	Blue	0-247		-
Valve Heating	SetState	0 = off 1 = on	Write	Take effect only in manual mode
	Temperature	0-99		-
	Mode	16 = always off 17 = manual mode 18 = previous mode (heating)		"Previous mode" is used to go back to the heating mode from the manual and "always off" modes
	State	0 = off 1 = on	Read	-
	Mode	0-15 = number of automation from logic 16 = always off 17 = manual mode		-
	Meas Temp	от -128.00 до +128.00		-
	Setpoint Temp	от 0.00 до +128.00		-
Conditioner	SetState	0 = off 1 = on	Write	-
	Temperature	16-32		Depending on the model of the air conditioner (see "t_min", "t_delta" in "getDevicesList" response)
	Mode	0 = fan 1 = heat 2 = cool 3 = dry 4 = auto		-
	Fan	0 = auto 1 = low 2 = middle 3 = high		-
	Vane hor	0-6		-
	Vane ver	0-5		-
	State	0 = off 1 = on	Read	-
	Temperature	16-32		-
	Mode	0 = fan 1 = heat 2 = cool 3 = dry 4 = auto		-
	Fan	0 = auto 1 = low 2 = middle 3 = high		-
	Vane hor	0-6		-
	Vane ver	0-5		-
Speaker	SetState	0 = stop 1 = pause 2 = play 3 = next 4 = prev	Write	-
	Volume	0-100		-
	Mute	0 = off 1 = on		-
	State	0 = stop 1 = playing 2 = pause 3 = error	Read	-
	Volume	0-100		-
	Mute	0 = off 1 = on		-
	Balance	0-100		-
	Priority	0-250		-
	Track Length	1-... (in milliseconds)		-
	Track Position	1-... (in milliseconds)		-