Web Services

GENERAL

Web service commands are supported for internal as well as external access.
The current Miniserver also supports HTTPS.

The structure of a web service command is as follows:

http://user:password@IPAddressMiniserver/command/control/value

Therefore, when using HTTP (Miniserver Gen.1), the access data should be omitted for the time being when entering a command in the address line.

Afterwards, the access data is requested via a window in the browser:

Some commands require a user with full access.

Then the command is executed and the result is displayed in the browser.
In the following example we get the current software version of the Miniserver:

Code “200” means the command was accepted and processed.

Structure in detail

• control: can be any input or output, real or virtual. Outputs can only be used for status requests.
• value: when ‘value’ is not available, the current control value is returned. The following values ??allowed: ‘A’, ‘On’, ‘off’, ‘Off’, ‘Impulse’, ‘Pulse’ or a decimal value (<1).
• Virtual digital inputs with 2 outputs (up-down, left-right, starting from version 1.5.4.16), the following values are allowed.

• ‘On’ = 1 and ‘Off’ = 0 for digital inputs and outputs.
• Analogue (0-10V) inputs operate in a range between 0 and 10.00. There is no formal limit (for example EIB temperatures of 21.5 or -5.2).
• A dot is used for the decimal output.

Example – Pulse Input

Before sending a pulse into the system, your Miniserver needs a Virtual Input that will accept the command.

Now once we have our Virtual Input added and saved into the Miniserver, the command will need to be sent. Below is an example of a 3rd party application* sending a pulse command into the Loxone Miniserver:

In this example we have the default credentials (username: admin, password: admin) and the virtual input in the command which has the name ‘Test Input’. By pressing the ‘Send’ button in the application, the string will use the IP address to find the Miniserver on the network, login and then process the command.

If the send command is accepted, the returned response in an XML format will be:

You will also see in Loxone Config the Virtual Input light up for a split second if ‘Live View’ is active: 

*In these examples, Postman is the 3rd party app being used to send the commands.

STATUS & CONTROL

QUERY: STATUS OF A CONTROL

Status requests via web service are only possible with inputs and outputs and are not possible with function blocks.

PUSH BUTTON

Example – Push Button

Before sending a command into the system, your Miniserver needs a Push Button function block that will accept the command.

Now once we have our Push Button added and saved into the Miniserver, the command will need to be sent. Below is an example of a 3rd party application* sending an ‘On’ command into the Loxone Miniserver:

In this example we have the default credentials (username: admin, password: admin) and the Push Button in the command which has the name ‘Push-Button’. By pressing the ‘Send’ button in the application, the string will use the IP address to find the Miniserver on the network, login and then process the command. We can change the last part of the command to be ‘On’ or ‘Off’, depending on different situations.

If the send command is accepted, the returned response in an XML format will be:

Code “200” means the command was accepted and processed.

You will also see in the Loxone Interface the Push Button will change state depending on which command is sent (on/off).

*In these examples, Postman is the 3rd party app being used to send the commands.

QUERY: STATUS CHANGES

CONFIGURATION AND STATISTICS

PLC COMMANDS

CONFIGURATION COMMANDS

SYSTEM COMMANDS

USE THE WEBINTERFACE IN AN IFRAME

To use the Miniserver’s webinterface in an iFrame, it must be enabled with the following web service, as iframes are not allowed by default to increase security.

http://miniserver/dev/sys/allowhttpiframe/1