mcsXap HS1 and HS2 Plugin

[Michael McSharry]

In process snapshot for xAP plugin to Homeseer. Works under HS1 and HS2.

Change Log
---------------
PR 1 1.2.0 Added BSC Sourced from HS
PR 2 1.2.0 Added acceptance of non-BSC schema
PR 3 1.2.0 Provided browser message view filtering
PR 4 1.2.0 Added backup time source support
PR 5 1.2.1 HSEvent Line 380 error
PR 6 1.3.3 Added extended Homeseer.Command schema
PR 7 1.3.4 Log errors related to TriggerUI (object not availalbe)
PR 8 1.3.5 Recompile to assure current posted configuration
PR 9 1.3.23 HS Sourced BSC devices cannot be commanded via xAP
PR10 1.3.51 Event.String message always generated
PR11 1.3.52 HSEvent line 350 error
PR12 1.3.80 Use database rather than ini to hold message filters
PR13 1.3.84 Extended trial to 6/30/2006
PR14 1.3.87 Recompile to assure line number reference
PR15 1.3.87 Include text as controllable from HS to xAP message
PR16 1.3.91 Commas appear in DC and name, devices scrambled in HS
PR17 1.3.92 BSC Commands send on string changes for non "text" devices
PR18 1.3.93 Error info added to SendBSCDB error output
PR19 1.3.96 BSC messages accepted as Raw messages when BSC Receive not checked
PR20 1.3.99 LCD Text output not generated when DeviceSting changes
PR21 1.3.100 Add debug to HS2 device recreation
PR22 1.3.105 Add more debug for device recreation
PR23 1.3.108 Raw devices being processed as if received as BSC
PR24 1.3.109 Do not change DeviceValue on BSC unless Text/Level received
PR25 1.3.109 Remove hard-coded debug
PR26 1.3.110 Additional Debug for SetBSCData that set HS's device status
PR27 1.3.112 Add check for bogus pi_trigger propery in HS Event
PR28 1.3.115 Print event name to log on ill-formed event triggers
PR29 1.3.116 Show trigger properties in log when ill-formed
PR30 1.3.118 Ignore xAP header fields after source field that are not target
PR30 1.3.119 Removed 6/30/2006 timestamp so no license is needed
PR31 1.3.120 Added debug to identify message recognition/device mapping
PR32 1.3.124 Add Hex encoding for xapBSC Text to allow non-printable characters
PR33 1.3.125 Wildcard ID on output from HS rather than using explicit ID's
PR34 1.3.126 Overflow on SetRawData when receiving CID
PR35 1.3.139 Add DIM UI for devices reporting with level key
PR36 1.3.141 Convert bsc level inputs to percentages when not enumerations
PR37 1.3.141 Put bsc text into DeviceString with displaytext is not present
PR38 1.3.142 Only do bsc level conversions to % for IOType=Ouptut devices
PR39 1.3.145 Change bsc output.state.1 to output.state
PR40 1.3.145 Correct hex encoding for text with non-printable characters
PR41 1.3.146 Set Last Change Time on any BSC key change
PR42 1.3.150 Message triggers dont trigger for PUID and key values
PR43 1.3.153 Add setting for number of IR Zones
PR44 1.3.155 Redesign event collection processing
PR45 1.3.156 Add tts.speak recognition to speak via HS
PR46 1.3.159 Change initialization interlocks
PR47 1.4.2 Add Style Sheet Option
PR48 1.4.2 Fix Browser Link Button checkbox not sticking
PR49 1.4.3 Add option for HS2-generated headers
PR81 1.5.1 Fix UID in subaddress for BSC sent by HS
PR82 1.5.1 Add X10 Receive Request option to use HS X10 interface
PR83 1.5.2 Debug added to HS output for xAP message delivery
PR84 1.5.3 Allow all devices to be sent xAPBSC if not using xAP X10 interface
PR86 1.5.4 Removed RegisterLink use to avoid startup warning
PR87 1.6.0 Incorporate functionality of .NET through PR86 to support Hybrid
PR88 1.6.1 Reference mcsXap.mdb to Homeseer location
PR89 1.6.1 Remove Homeseer.IO schema support
PR90 1.6.1 Enable X10 and IR capabilities that were unintentionally removed
PR91 1.6.1 Explicitly save 0 or 1 for checkbox selections in .ini vs null and 1
PR88 1.6.2 AddBSCSend line 160 when alternte BSC naming convention used
PR89 1.6.2 Leave message source in case as received
PR90 1.6.3 DeviceValues not updated based upon Text or Level values
PR91 1.6.4 xAPSendMessage scripting method not in hybrid
PR92 1.6.6 xapbsc.cmd not handled properly
PR93 1.6.6 xapbsc status for X10 devices updates
PR94 1.6.7 IncludeContent Line 20 error
PR101 1.7.1 xAP Message trigger feedback is skewed
PR102 1.7.1 xAP Message triggers do not take effect until xAP Plugin Save
-----------------------------------------------
.NET

PR50 2.2.0.0 Add Browser Button links for external applications
PR51 2.2.0.0 Add Winsock Debug option
PR52 2.2.0.0 Enable HS2 button links
PR53 2.2.0.1 Form updates not accepted if launched from HS2 link button
PR54 2.2.0.1 Implement PR45 for .NET version
PR55 2.2.0.2 Add Event Triggers for message timeouts
PR56 2.2.0.3 Remove options for button link and Time backup
PR57 2.2.0.3 Change Interface name back to mcsXap from MCSXAP
PR58 2.2.0.4 Add Save button at bottom of page
PR59 2.2.0.4 Move Sort buttons to column header of message list
PR60 2.2.0.4 Reset xAP when socket error is raised
PR61 2.2.0.4 Remove attempt to backup database during shutdown
PR62 2.2.0.5 xAP Event based output stopped when PR57 implemented
PR63 2.2.0.6 Allow address or address:subaddress for message timeout trigger
PR64 2.2.0.7 Allow all non-x10 devices to be send using xapBSC
PR65 2.2.0.8 Use X10 Transmit checkbox for handling X10 devices as xap-x10 or BSC
PR66 2.2.0.9 Change file message output to use trace rather than direct file system
PR67 2.2.0.9 Monitor sending of Heartbeat with hs.Writelog output
PR68 2.2.0.9 Fix case sensitivity to xapbsc.query
PR69 2.2.0.10 Add Timer to protect for send queue stalling when send errors occur
PR70 2.2.0.11 Protect from send complete interrupts when no data is sent
PR71 2.2.0.12 Provide option for generic/shorter subaddress for HS sourced BSC
PR72 2.2.0.12 Query BSC and provide BSC.info on startup
PR73 2.2.0.12 Make heartbeat UID 4 digits
PR74 2.2.0.13 Allow user to select subaddress segments for HS-sourced BSC
PR75 2.2.0.14 Subaddress segment selections not sticking
PR76 2.2.0.15 User same name capitalization for bsc.info and bsc.event
PR77 2.2.0.15 Add "D"elete checkbox to permanently delete message
PR78 2.2.0.16 Set DeviceValue for Relay & Switches 0/1 for OFF/ON Status
PR79 2.2.0.17 Accept/Reject sort buttons do not work
PR80 2.2.0.18 Add scripting methods to debug message deafness
PR82 2.2.1.0 Add X10 Receive Request option to use HS X10 interface
PR85 2.2.1.1 Move message send queue up from Winsock to Application projects
PR86 2.2.1.2 PR78 also set relay/switch devicestring unintentionally
PR87 2.2.1.3 Update based upon bringing ocx & dll to same functionality as hybrid
PR88 2.2.1.4 AddBSCSend line 160 when alternte BSC naming convention used
PR89 2.2.1.4 Leave message source in case as received
PR92 2.2.1.6 xapbsc.cmd not handled properly
PR93 2.2.1.6 xapbsc status for X10 devices updates
PR94 2.3.0.1 Reimplement .NET socket for latency and deafness
PR95 2.3.0.1 UpdateDatabase SQL syntax error
PR96 2.3.0.2 Only update HS Device Status when Status changes
PR97 2.3.1.0 Add Sort and Filter by xAP Address/Subaddress segments
PR98 2.3.1.2 Decode PC.Status schema from Speedfan
PR99 2.3.1.3 xAP Message Trigger event feedback not showing on HS event page
PR100 2.3.1.6 Limit DeviceString length sent from HS
PR101 2.3.1.7 xAP Message trigger feedback is skewed
PR102 2.3.1.7 xAP Message triggers do not take effect until xAP Plugin Save
PR103 2.3.1.8 Replace * and : and > with _ in xAP address derived from HS devices
PR104 2.3.1.9 Database date format not compatible for international users

PR105 3.0.0.5 Overhaul of socket handling to address eventual deafness
PR106 3.0.0.8 Special handling for C Bus Lighting Homeseer Device type
PR107 3.0.0.10 Accept heartbeat message with variable key sequence
PR108 3.0.0.11 Fix xAP timeout to trigger when messages not received
PR109 3.0.0.12 Remove case sensitivity in BSC key trigger
PR110 3.0.0.13 Add additional error output on IncludeContent function
PR111 3.0.0.14 xAPBSC.Cmd for HS device not handled
PR112 3.0.0.15 Don't include DisplayText of greater than 800 characters
PR113 3.0.0.16 Fix sending messages with DeviceString null (broke in .15)
PR114 3.0.0.17 SetBSC Data line 0 error with very large number input
PR115 3.0.0.18 Trigger collection rebuilt when items missing
PR116 3.0.0.19 Deliver value-only (dim) change requests to X10/IO interface
PR117 3.0.0.19 Put debug output in file rather than hs log

Select only one of the following. With the hybrid version the hspi_mcsXap.ocx in the \bin folder needs to be registered with regsvr32.exe. For HS1, download hybrid and unzip only hspi_mcsXap.ocx into Homseer root folder.

Current Version

mcsXap (Net) http://mcsSprinklers.com/mcsxap.zip

Previous Versions

mcsXap (Net) http://mcsSprinklers.com/mcsxapnet2319.zip

mcsXap (Hybrid) http://mcsSprinklers.com/mcsxaphybrid171.zip

[Guest]

Will the plug-in work with Insteon devices?

Thanks
Ron T.

[Michael McSharry]

It works with all homeseer devices. It does not manage the insteon interface, x10 interface, zwave interface, etc. Onec a device exists in hs then it is globally visible on the lan to anything that is xap knowledgeable

[Guest]

It works with all homeseer devices. It does not manage the insteon interface, x10 interface, zwave interface, etc. Onec a device exists in hs then it is globally visible on the lan to anything that is xap knowledgeable

Thanks Michael

I look forward to using it in a custom xAP .NET client application.

[Uncle Michael]

Michael,
Sorry, another question. I think my .net version of your xAP plug-in has "gone deaf", but when I downloaded the hybrid version the package seems to be incomplete. Is there another zip file I should have as well? Should I start with the standard version from the mcsSolutions web site?

[Uncle Michael]

I'm just getting back to this. I think I have everything in place, but I'm getting an error when I try to register the ocx file. What am I doing wrong?

[Michael McSharry]

confirm that the file is in \bin. There is a tool tht I think is called Dependency Walker that eill tell you what other files some file is dependent upon. Use google to find it.

[Uncle Michael]

Thanks Michael,
I did confirm the the file is in the Bin folder.
Dependency walker is cool! It says that two files could not be found: DWMAPI.dll and EFSADU.dll
Where do I go from here?

[Michael McSharry]

I did a quick google on the first of these and it appears to be related to the ie7 install. There is lots about it out there so the solution should be available.

[Uncle Michael]

Michael,
I also looked up info on these. What I found was more confusing than helpful. In particular, the Microsoft Forum Network discussion strongly implied that if Dependency Walker calls out this pair as missing for an XP installation without file encrypting enabled that it is a false lead. ("...dwmapi.dll is a Vista-only dll, and efsadu.dll is only installed if you've enabled the Encrypting File System on one of your drives.") That's why I haven't just downloaded and installed them. I'm suspicious there is another problem. Do you know any reason your osx file should need these two dlls?

[Michael McSharry]

I do my development on Vista so that may be the reason. I have XP on my laptop, but I could not get a reference to HS object which mcsXap normally uses. I changed the HS classes to type object and compiled. It is attached. Give it a try to see how far you get.

[Uncle Michael]

Michael,
Thank you for the new osx file. Unfortunately, it gives me the same error message when I try to register it.
Depends calls out the same two dlls as missing as well.

[Michael McSharry]

I would like to help, but I do not know what else I can do. You are the first to report this problem.

[bdickhaus]

I am successfully running the hybrid plug-in on XP SP2, but I have not installed IE7. It could be that IE7 and/or XP SP3 are causing this.

Bill

[Uncle Michael]

This is probably not worth much extra effort for my needs. I was considering using mcsSprinkler stand alone version on another PC and tying it into HS with Xap. Having Sprinkler talk to HS is not really critical, just a nice to have. So I'll probably just forego it for now. Thanks for trying.