xPLHal xAP Support Info

[Tony Tofts]

Hi all,

Below is a summary of the additions to xPLHal to provide xap support.

Latest version is available from www.xplhal.com xplhal downloads page
The update download includes a new xpllib.dll

To turn xap support on/off use (add) the xap support flag in xplhal.xml
<control loadhub="Y" xapsupport="Y" />
^^^^^^^^^^^^^^

Note: if a xap hub is already present and running on the xplhal pc then xap
support will not be operational

Messages are scripted based on the source of the message, but not including
sub-instance
E.g. source=vendor.device.instance
Is scripted as xap_vendor_device_instance(xapmsg)
E.g. source=vendor.device.instance1.instance2:sub1.sub2
Is scripted as xap_vendor_device_instance1_instance2(xapmsg)

Functions available to support processing of xap messages are:

Note: Where a function supports a 'section' then
0 = header
1 = body 1
2 = body 2 etc

myvar=xap.bodycount(xapmsg)
This returns number of bodies in message, excludes header from count

Myvar=xap.getparam(xapmsg,section,param)
This returns the value of the given param name from the section

Myvar=xap.getparamcount(xapmsg,section)
This returns the number of name/value pairs in the section

Myvar=xap.getparamname(xapmsg,section,index)
This returns the name of the param by it's index in the section

Myvar=xap.getparamvalue(xapmsg,section,index)
This returns the value of the param by it's index in the section

Myvar=xap.getsection(xapmsg,section)
This returns the name of the section

To send a xap message use
Call xap.sendmsg(uid,class,source,target or "",bodies)
Xplhal builds the full header from the supplied parameters
Bodies parameter MUST include all delimeters etc such as } {

Regards
Tony