xPL K8055 Application Documentation

Application: xPL K8055

Build: V1.0.0.3

Build Date: 11/07/2007

Company: Rawalls

Contact: Tim Walls

Summary:

I have created this application to use with the xPL Protocol (http://www.xplproject.org.uk/). This application is to bridge the gap between the xPL Protocal and the Velleman K8055 USB I/O Device (http://www.velleman.be/ot/en/product/view/?id=351346).

Change log:

V1.0.0.3 11/07/2007

Fixed issue with XPL-TRIG messages having trailing characters.
Changed the “Digital Output” Current from “ENABLE/DISABLE” to “HIGH/LOW”.
Changed the “Digital Input” Current from “ENABLE/DISABLE” to “HIGH/LOW”.
Included MSWINSCK.OCX in setup package.

Minimum system requirements:

Windows 2000/XP

128Mb RAM

50 Mb Free Hard Drive Space

xPLHub (http://wiki.xplproject.org.uk/index.php/Core_Software)

xPLHAL (http://wiki.xplproject.org.uk/index.php/Core_Software)

Installation:

1. Start the setup.exe file included with the installation archive.

2. Run through the prompts to select the folder and start menu for the application.

3. click Finish to finish.

Usage:

The first time you run this application it will run in unconfigured mode. From here you will be required to launch your xPLHAL configuration software (e.g. xPLHAL Manager) and configure the options for this device. You will be required to set the instance name of the device and set any filters. You will also find the configuration option “CARDPORT”. Here you may select a port number from 0-3 depending on which port you have configured the K8055 Card to use. The application will create a file called config.ini after the first run which will save the source name of your device and the status of the digital and analogue outputs when you close the application.

Messaging:

The application uses two main xPL Schemas;

CONTROL.BASIC

(http://wiki.xplproject.org.uk/index.php/Schema_-_CONTROL.BASIC)

XPL-CMND Structure

CONTROL.BASIC

{

DEVICE=<sensor name>

TYPE=<sensor type>

CURRENT=<value>

DATA1=<data>

}

<sensor name> = 1-8 (Digital Outputs)

Select the digital output you wish to control between 1-8

<sensor name> = 1-2 (Analogue Outputs)

Select the analogue output you wish to control between 1-2

<sensor type> = output (Digital Output)

<sensor type> = slider (Analogue Output)

<value> = HIGH, LOW, TOGGLE, PULSE (Digital Output)

<value> = nn, +nn, -nn, nn% (Analogue Output)

<data> = (Value for Analogue Output only MAX Value 255)

Example:

Set Digital Output 4 to “ON”

CONTROL.BASIC

{

DEVICE=4

TYPE=output

CURRENT=high

}

Set Analogue Output 2 to “132”

CONTROL.BASIC

{

DEVICE=2

TYPE=slider

CURRENT=nn

DATA1=132

}

Set Analogue Output 1 to 37%

CONTROL.BASIC

{

DEVICE=1

TYPE=slider

CURRENT=nn%

DATA1=37

}

Decrement Analogue Output 1 by 65

CONTROL.BASIC

{

DEVICE=1

TYPE=slider

CURRENT=-nn

DATA1=65

}

Increment Analogue Output 1 by 234

CONTROL.BASIC

{

DEVICE=1

TYPE=slider

CURRENT=+nn

DATA1=234

}

SENSOR.BASIC

(http://wiki.xplproject.org.uk/index.php/Schema_-_SENSOR.BASIC)

XPL-TRIG Structure

sensor.basic

device=<sensor name>

type=<sensor type>

current=< value>

<sensor name> = 1-5 (Digital Inputs)

<sensor name> = 1-2 (Analogue Inputs)

<sensor type> = input (Digital Input)

<sensor type> = generic (Analogue Input)

<value> = HIGH, LOW (Digital Input)

<value> = (Analogue Input Value Between 1-255)

Example:

User Enabled Digital Input 4

SENSOR.BASIC

{

DEVICE=4

TYPE=input

CURRENT=high

}

User Set Analogue Input 2 to “132”

SENSOR.BASIC

{

DEVICE=2

TYPE=generic

CURRENT=132

}

XPL-CMND Structure

sensor.request

{

request=current

[device=<sensor name>]

[type=<sensor type>]

}

<sensor name> = 1-5 (Digital Inputs)

<sensor name> = 1-2 (Analogue Inputs)

<sensor type> = input (Digital Input)

<sensor type> = generic (Analogue Input)

XPL-STAT Structure

Same structure as the XPL-TRIG messages