The class LoxBerry::LoxoneTemplateBuilder is used to more easy generate Loxone Templates for Virtual UDP Inputs, Virtual HTTP Inputs and Virtual Outputs. On usage, you create a VI or VO object, and can add Commands to the VI/VO one by one.

This library automatically includes:

• use HTML::Entities;

use LoxBerry::LoxoneTemplateBuilder;
 
## Virtual HTTP Inputs ##
 
my $VIhttp = LoxBerry::LoxoneTemplateBuilder->VirtualInHttp(
    Title => "LoxBerry Healthcheck",
    Address => "http://loxberry:loxberry@loxberry/admin/system/healthcheck.cgi",
);
 
my $linenr = $VIhttp->VirtualInHttpCmd (
    Title => "timeepoch",
    Check => '"timeepoch":\v',
);
 
# Get the content of a specific line number (line 3)
my $vicmd = $VIhttp->VirtualInHttpCmd ( 3 );
 
# Delete a specific line
$VIhttp->delete($linenr);
 
# Get the created xml template
print $VIhttp->output;
 
## Virtual UDP Inputs ##
 
my $VIudp = LoxBerry::LoxoneTemplateBuilder->VirtualInUdp(
    Title => "LoxBerry Weather",
    Address => "",
    Port => "12345",
);
 
my $linenr = $VIudp->VirtualInUdpCmd (
    Title => "Temperature",
    Check => '"temperature":\v',
);
 
# Get the content of a specific line number (line 3)
my $vicmd = $VIhttp->VirtualInUdpCmd ( 3 );
 
# Get the created XML template
print $VIudp->output;
 
## Virtual Outputs ##
 
my $VO = LoxBerry::LoxoneTemplateBuilder->VirtualOut(
    Title => "Sonos",
    Address => "http://192.168.1.232:1400",
 
);
 
my $linenr = $VO->VirtualOutCmd(
    Title => "Play",
    CmdOnMethod => "post", 
    CmdOn => '/MediaRenderer/AVTransport/Control',
    CmdOnHTTP => 'SOAPACTION: "urn:schemas-upnp-org:service:AVTransport:1#Play"',
    CmdOnPost =>     '<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">'.
                    '<s:Body><u:Play xmlns:u="urn:schemas-upnp-org:service:AVTransport:1"><InstanceID>0</InstanceID><Speed>1</Speed></u:Play></s:Body></s:Envelope>',
);
 
print $VO->output;

The creation of the object classes VirtualInHttp, VirtualInUdp and VirtualOut return the pointer to the object.

For adding the commands, use the VirtualInHttpCmd, VirtualInUdpCmd or VirtualOutCmd accordingly to your class. The functions throw an exception, if you mix up class and *Cmd functions (e.g. creating an VI and add an VO Cmd).

The *Cmd functions return the index of the added command. You can use this index to later delete a line. Stored indexes stay consistent, also if you delete elements before.

The delete method deletes a line, using the provided index.

Using the *Cmd commands with a number as single parameter, returns the Cmd object of that line. 

The output returns the string of the created VirtualInHttp/VirtualInUdp/VirtualOut in the correct encoding and quotation.

See the tables below, what parameters and default values the classes provide. Omitting a parameter uses the default value.

LoxBerry::LoxoneTemplateBuilder->VirtualInHttp

VirtualInHttp->VirtualInHttpCmd

LoxBerry::LoxoneTemplateBuilder->VirtualInUdp

VirtualInUdp->VirtualInUdpCmd

LoxBerry::LoxoneTemplateBuilder->VirtualOut

VirtualOut->VirtualOutCmd

• Keep in mind, that \v, \i,… syntax is parsed by PHP. Examples:
  • If you use single quotes '\iHallo:\i\v' , PHP is directly print these strings.
  • If you use double quotes, you have to escape the backslash char by a backslash: "\\iHallo\\i\\v" .