Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The configuration is done using the following configuration files and definition tables:

xio.HTTP.ResourceDefinitions.dat

This definition table can be found within the studio in "HTTP"  -> "Resource definitions". It defines the encoding and the content that is expected at the web server. Each definition contains the following columns:

...

.

...

A detailed description

...

can be found

...

xio.HTTP.DatapointDefinitions.dat

Here the different data points that shall be represented as Server Items are defined. Each definition contains the following columns:

...

Name (string, mandatory): defines the name of the data point. In combination with path, it has to be unique.

...

within

...

Data type (enum, optional, default "STRING"): defines the type of the data point. Allowed values are: BOOL,STR,BYTE,CHAR,INT8,UINT8,INT16,UINT16,INT32,UINT32,INT64,UINT64,FLOAT,DOUBLE,DATE,TIME

...

Access mode (enum, optional, default "R"): defines the access rights of the data point. Allowed values are R (read-only), W (write-only), RW (read and writable).

...

Polling Url (string, optional, default ""): here the URL is specified with is used to retrieve the data point values. The server makes polling using HTTP GET requests to this URL. If empty, polling is not available.

...

Polling interval (ms) (number, optional, default "5000"): here the polling interval in milliseconds is specified.

...

Polling Resource (string, optional, default ""): here the resource that is used for polling is specified. It must match with the name that is used in the xio.HTTP.ResourceDefinitions.

...

Polling Parameters (string, optional, default ""): here a list of parameters that are used to replace the placeholders within the polling resource ({0}, {1}, ...) can be defined. The parameters have to be separated by comma ,

...

Update Url (string, optional, default ""): here the URL is specified with is used to update the data point values. The server makes HTTP PUT, POST or GET requests to this URL. If empty, updating the values is not possible.

...

Update Method (enum, optional, default "POST"): here the web update request method is specified. Allowed values are "POST" and "PUT".

...

Update Resource (string, optional, default ""): here the resource that is used for updating is specified. It must match with the name that is used in the xio.HTTP.ResourceDefinitions.

...

Update Parameters (string, optional, default ""): here a list of parameters that are used to replace the placeholders within the update resource ({0}, {1}, ...) can be defined. The parameters have to be separated by comma ,

...

Persistent (bool. optional, default "F"): if enabled, the last data point value is restored after server start up.

...

Historical (bool. optional, default "F") ( NETx BMS Server 2.0 only): if enabled, all data point changes are stored within the SQL database. 

...

Synchronize (bool. optional, default "T"): if enabled, the value is synchronized with the backup server if used.

xio.HTTP.cfg

In this configuration file, general settings can be defined. It contains the following settings:

...

the reference manual.

Integration steps

Anchor
Resource
Resource
One of the most important step is the definition of the HTTP resource that is expected by the server. The resource depends on the used encoding and on the direction of the data change (polling or update). 

...