Go Back   HomeSeer Message Board > 3rd Party Plug-Ins/Scripts > Plug-ins by Author > Click Here for List of Author Forums > MCS Plug-Ins and Scripts > xAP > xAP Library

xAP Library Library area for plug-in nodes. Use the discussion area to discuss these - posting here is only allowed by the moderator.

Closed Thread
Thread Tools Display Modes
Old July 2nd, 2005, 09:12 PM
Michael McSharry's Avatar
Michael McSharry Michael McSharry is offline
Join Date: Jul 2001
Location: North Bend, WA, USA
Posts: 13,768
xapmcsScript - Scripting xAP Node

xapmcsScript is an xAP ActiveX exe application node that provides for a quick scripting interface to xAP messages. One instance is used for each computer on the LAN that will use scripting to communicate xAP messages.

A scripting method is provided to send an xAP message and methods are provided to select xAP messages to be received for further script processing. ini file processing methods, and the hs-equivalent writelog, run and runex methods are also included as a convenience as these are often useful adjuncts to scripts.

Two objects are provided. One is the Application object and the other is the XapMessage object. The first is the primary scripting interface. The second contains methods and properties to deal directly with message content fields of an xap message.

The general flow of use is to first identify which, if any, xap messages are of interest to the script. This is done with the SelectXapMessage method. The selection filter allows
Target , Source, Class, and Section components of an xAP message to be used. Source and Target comply with the wildcard rules of xAP addressing. A null entry for a filter field will result in this field being ignored. Zero or more filters can be specified. Each script will have its own set of filter definitions.

xAP Message are sent using either the SendXapMessage or SendUDPMessage methods. SendXapMessage is the simplest method since the xap message format is constructed automatically. Most messages can be handled this way. SendUDPMessage expects and already-formed xap message. The XapMessage object provides facilities to simplify the contstruction of an xAP message. It also provides the methods to read individual fields of an xAP message.
Attached Files
File Type: zip xapmcsScript.zip (81.3 KB, 138 views)

Last edited by Michael McSharry; December 28th, 2006 at 01:35 AM.
Closed Thread


Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is On

Forum Jump

All times are GMT -4. The time now is 09:03 AM.

Copyright HomeSeer Technologies, LLC