Web Services

GENERAL

• Web service commands support both internal and 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

For security reasons, when using HTTP (Miniserver Gen.1), it is recommended to omit the access credentials when entering a command in the address bar. Instead, the browser will prompt you for login details in a separate window.

Some commands require a user with full access.

Once the command is executed, the result is displayed in the browser.
For example, the following command retrieves the current software version of the Miniserver:

If the command is successful, the response will include the status code “200”, indicating that the request 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 are allowed for digital values:
    • “Ein“, “On“, “Aus“, “Off“, “1“, “0“, “Impuls” or “Pulse“.
• Virtual digital inputs with 2 outputs (up-down, left-right, starting from version 1.5.4.16), the following values are allowed.

• • The following values are allowed for analog inputs:
    • (0-10V) inputs operate within a range of 0 to 10.00.
    • There is no formal limit (e.g., temperatures of 21.5 or -5.2 are valid).
    • A dot (.) is used as the decimal separator.
  • The following values are allowed for text inputs:
    • The Miniserver operates using UTF-8, so any character supported by UTF-8 should work correctly.

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

Miniserver Configuration, Statistics & Commands

The following commands provide system control, PLC operations, network statistics, and configuration options for the Miniserver.

1. PLC Commands (Programmable Logic Controller)

These commands allow you to monitor and control the PLC system.

2. Configuration Commands

These commands allow you to retrieve or modify Miniserver settings.

3. System Monitoring Commands

These commands provide information about system performance and statistics.

4. Date & Time Management

Manage system date and time settings.

5. Task Monitoring

Retrieve status and properties of system tasks.

6. System Control & File Management

These commands allow rebooting the Miniserver and managing system files.

7. System Logs & Statistics

Retrieve logs and system data.

8. External Web Service Execution

Send web service requests to external devices.

Commands for Devices

Extensions

The following commands apply to Extensions.
To execute them, a user with full access rights is required.

Tree and Air Devices

The following commands apply to specific Air or Tree devices.
To execute them, a user with full access rights is required.

Using the Miniserver Web Interface in an iFrame

By default, the Miniserver does not allow embedding in an iFrame for security reasons. To enable this functionality, you must explicitly allow it using the following web service command:

http://<miniserver-ip>/dev/sys/allowhttpiframe/1