HTTP to XP Driver

This driver can run system macros based on http commands from an external browser or other program. It currently supports GET and POST commands.

The driver will also serve variable values to an external requestor using JSON notation for variable names and values.

Configuration Parameters:

License Key

Full functionality license key.

Enable Basic Authentication

Check this box to enable basic username/password authentication.

User Name

Basic authentication user name.

Password

Basic authentication password.

HTTP Output Communcation Settings

HTTP URL

The URL where you want to send GET and POST commands.

HTTP Port

The port for sending GET and POST commands. SSL port is usually 443 (HTTPS). Port 80 is for standard HTTP output.

Server Communication Settings

TCP Port Number

This is the TCP Port Number to listen on and use in GET and POST commands as defined below.

Alternate Connection Type

Select between "No Alternate Connection", "Serial Port", and "Global Cache". These are alternatives to the built in IP connection capability and provide some options on how to connect and operate or test this driver.

For these options, appropriate parameters are displayed when you select the desired type.

Macro Names

Configure each system macro that you want to provide to the external world. Name each macro something meaningful and then select that macro from the drop down list in the following field "Macro #". You can configure up to 50 macros this way.

Events

You can configure up to 50 driver events and invoke them as described below. In Integration Designer Apex (10.x) you can create a macro directly on the driver event. In ID 9.x you must create a system macro first and then assign that macro to a driver event.

Variables

You can configure up to 50 flags, integers and string variables to be served to an external requestor.

Commands

Send GET, Send POST

Sends GET or POST HTTP command with following parameters:

Command parameter is for additional command line command text such as /search.htm or /v1

Content Type parameter defines the type of data being sent. Options include text/plain, text/html, application/json, application/xml, application/x-form-url-encoded

Data Content parameter is the actual data (text) being sent. eg {"name":"Hallway Tstat", "temperature":"98.6"}

Trigger Event

Call this function to directly trigger a driver event. This is for testing purposes. Normally you would set it up to trigger the event using Driver Events that are triggered by your web browser or other Ethernet device.

GET and POST Commands and Variable Feedback

GET commands have the following URL syntax:

GET username:password@<xp-address>:<TCP-Port>/?macro=<macro number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<macro number> is the index of your system macro you want to run (1 - 50).

GET <xp-address>:<TCP-Port>/?mname=<macro name>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<macro name> is your system macro you want to execute. You configure this name in driver configuration.

GET <xp-address>:<TCP-Port>/?event=<event number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<event number> is the ID number of your driver event you want to trigger (1 - 50).

GET <xp-address>:<TCP-Port>/?vars

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

Returns ALL variables defined in configuration as JSON data.

e.g. {"1" : {"flag" : "true", "int" : "42", "string" : "System Ready"},

"2" : {"flag" : "false", "int" : "91", "string" : "null"} }

GET <xp-address>:<TCP-Port>/?var=<var number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<var number> is the index number of all three configured variable types (flag, int, string) you want to return (1 - 50).

Returns JSON with all three variables configured for that index.

e.g. {"index" : "4" , "val" : {"flag" : "true", "int" : "42", "string" : "System Ready"}

GET <xp-address>:<TCP-Port>/?flag=<var number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<var number> is the index number of the flag you want to return (1 - 50).

Returns JSON. e.g. {"flag" : "1", "value" : "true"}

GET <xp-address>:<TCP-Port>/?int=<var number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<var number> is the index number of the integer value you want to return (1 - 50).

Returns JSON. e.g. {"int" : "3", "value" : "42"}

GET <xp-address>:<TCP-Port>/?string=<var number>

where <xp-address> is the IP address of your processor (eg 192.168.1.200),

<TCP-Port> is the configured port number

<var number> is the index number of the flag you want to return (1 - 50).

Returns JSON. e.g. {"string" : "6", "value" : "System In Alarm"}

Browsers always use GET by default. So, from a browser, you would use this syntax to invoke a command:

http://<xp-address>:<TCP-Port>/?macro=<macro number>

or

http://<xp-address>:<TCP-Port>/?event=<event number>

POST commands require JSON data and do not have any extra URL commands.

POST <xp-address>:<TCP-Port>

JSON data is as follows:

{"macroID" : "<macro index number>"}

or

{"macroName" : "<macro name>"}

or

{"eventID" : "<event number>"}

where <event number> is the ID number of your driver event you want to trigger (1 - 5).