# Patent

## Title
Automation control system having digital logging

## Abstract

A convergence and automation system includes (a) an internet-protocol based network, (b) hardware implemented with a web service for devices (WSD) protocol, wherein the hardware includes a plurality of devices connected to the network, each device being configured to perform at least one service, and a server connected to network and configured to control the devices for converging and automating the services thereof; and (c) software implemented with the WSD protocol and configured to establish communication among the sever and the devices and perform a logging function to record events and errors taking places in the convergence and automation system.

## Background
CROSS REFERENCE TO RELATED APPLICATION
This application claims priority to and the benefit of: Provisional Patent Application No. 60/782,734 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING A CONFIGURATION TOOL AND TWO-WAY ETHERNET COMMUNICATION FOR WEB SERVICE MESSAGING, DISCOVERY, DESCRIPTIONS, AND EVENTING THAT IS CONTROLLABLE WITH A TOUCH-SCREEN DISPLAY, to Seale MOORER et al.; Provisional Patent Application No. 60/782,596 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING DIGITAL MEDIA STREAMING, to Seale MOORER et al.; Provisional Patent Application No. 60/782,598 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING DIGITAL LOGGING, to Seale MOORER et al.; Provisional Patent Application No. 60/782,635 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING A CONTROL PANEL, to Seale MOORER et al.; Provisional Patent Application No. 60/782,599 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING A CONFIGURATION TOOL, to Seale MOORER et al.; Provisional Patent Application No. 60/782,600 filed on Mar. 16, 2006, entitled AUTOMATION CONTROL SYSTEM HAVING DEVICE SCRIPTING, to Seale MOORER et al.; Provisional Patent Application No. 60/782,634 filed on Mar. 16, 2006, entitled DEVICE AUTOMATION USING NETWORKED DEVICE CONTROL HAVING A WEB SERVICES FOR DEVICE STACK, to Seale MOORER et al.; Provisional Patent Application No. 60/782,595 filed on Mar. 16, 2006, entitled WIRELESS DIGITAL AMPLIFIER CONFIGURED FOR WALL MOUNTING, SHELF MOUNTING, AND THE LIKE, to Seale MOORER et al.; Provisional Patent Application No. 60/785,275 filed on Mar. 24, 2006, entitled AUTOMATION SYSTEM, to Seale MOORER et al.; Provisional Patent Application No. 60/793,257 filed on Apr. 20, 2006, entitled TOUCH SCREEN FOR USE WITH AUTOMATION SYSTEMS, to Seale MOORER et al.; Provisional Patent Application No. 60/747,726 filed on May 19, 2006, entitled COOLING DEVICE FOR A TOUCH SCREEN AND THE LIKE, to Seale MOORER et al.; Provisional Patent Application No. 60/746,287 filed on May 3, 2006, entitled HOME AUTOMATION SYSTEM AND THE LIKE, to Seale MOORER et al.; Provisional Patent Application No. 60/786,119 filed on Mar. 27, 2006, entitled HOME AUTOMATION PROGRAM CODE FOR SET TOP BOX OR SIMILAR CIRCUIT, to Steve CASHMAN; and Provisional Patent Application No. 60/857,774 filed Nov. 9, 2006, entitled PORTABLE MULTI-FUNCTIONAL MEDIA DEVICE, to Seale MOORER et al., all of which are hereby expressly incorporated by reference for all purposes as if fully set forth herein. Further, this application is related to the following U.S. Patent Applications: U.S. patent application Ser. No. (11/686,826), entitled NETWORK BASED DIGITAL ACCESS POINT DEVICE, filed Mar. 15, 2007, to Seale Moorer, et al., having U.S. Pat. No. (11/686,836), entitled INTERNET PROTOCOL BASED MEDIA STREAMING SOLUTION, filed Mar. 15, 2007, to Seale Moorer, et al., having U.S. patent application Ser. No. (11/686,896), entitled AUTOMATION CONTROL SYSTEM HAVING A CONFIGURATION TOOL AND TWO-WAY ETHERNET COMMUNICATION FOR WEB SERVICE MESSAGING, DISCOVERY, DESCRIPTION, AND EVENTING THAT IS CONTROLLABLE WITH A TOUCH-SCREEN DISPLAY, filed Mar. 15, 2007, to Seale Moorer, et al., having U.S. patent application Ser. No. (11/686,893), entitled USER CONTROL INTERFACE FOR CONVERGENCE AND AUTOMATION SYSTEM, filed Mar. 15, 2007, to Seale Moorer, et al., having U.S. patent application Ser. No. (11/686,846), entitled DEVICE AUTOMATION USING NETWORKED DEVICE CONTROL HAVING A WEB SERVICES FOR DEVICES STACK, filed Mar. 15, 2007, to Seale Moorer, et al., having U.S. patent application Ser. No. (11/686,875), entitled AUTOMATION CONTROL SYSTEM HAVING A CONFIGURATION TOOL, filed Mar. 15, 2007, to Seale Moorer, et al., and U.S. patent application Ser. No. (11/686,889), entitled AUTOMATION CONTROL SYSTEM HAVING DEVICE SCRIPTING, filed Mar. 15, 2007, to Seale Moorer, et al., having Attorney Docket No.: 2047672-5023US; which are all hereby expressly incorporated by reference for all purposes as if fully set forth herein.


BACKGROUND OF THE INVENTION
1. Field of the Invention
The invention is directed to monitoring an automation and convergence system, and more particularly to monitoring the automation and convergence system using a logging function.
2. Related Art
Household, academic facility and/or business spaces now more commonly have more than one audio or video device such as CD/DVD player, portable MP3 player, tuner, preamp, power amp, speakers, VCR, DVR, computers running media players or connected to some other source of audio or video (e.g., Internet radio, satellite radio and the like), etc. Typically, a CD/DVD player from one company comes with its own remote control and an amplifier by an entirely different company comes with its own remote control. The same space may have a PC with its keyboard and mouse, and yet another company's portable MP3 player with its own control switches. While each audio device is doing precisely what it was designed to do, each operates completely independent from the others with the possible exception of the portable MP3 player that may be connected to a PC for synchronization. As a result, a user ends up going from one keypad to another or juggling a series of remote controls in order to control the devices.
Since these audio/video and similar devices are not designed to communicate with each other or their communication is very limited, access to these audio/video devices is limited by their physical locations. For example, it is difficult to play an MP3 file saved in a PC hard disk drive in one room or area (a child's bedroom) on speakers located in another room or area (an entertainment room). Thus, in order for a user to enjoy music of his or her choice whenever and wherever he or she wants, each room needs to be equipped with all the necessary audio/video equipment and digital audio/video content.
Also, the audio/video devices are not designed to communicate with other home devices (e.g., TV, lighting, security system, etc.). Thus, it is difficult, if not impossible, to converge the devices for common control for certain occasions. For example, in order to watch a movie, the user must turn on a TV, a DVD player and an audio amplifier by using three different remote controls. Then the user must set the TV to receive a video signal from the DVD player, set the audio amplifier to receive an audio signal from the DVD player and use another control unit to adjust the lighting of the room. Even when a user utilizes a universal remote, as is known in the art, the result is a plurality of devices that are separately operated and are operated separately from a single universal remote. These devices do not converge as described above. Moreover, the devices lack any ability to monitor or log their actions so as to better ascertain the performance and troubleshoot the devices.
Accordingly, there is a need for a solution to the aforementioned need to monitor the accessibility, connectability, controlability and convergence issues.
SUMMARY OF THE INVENTION
The invention meets the foregoing needs using an automation specific IP based automation protocol, which results in a significant increase in discovery and communications between devices and other advantages apparent from the discussion herein.
Accordingly, in one aspect of the invention, a convergence and automation system includes an internet-protocol based network, hardware implemented with a web service for devices (WSD) protocol, the hardware includes a plurality of devices connected to the network, each device being configured to perform at least one service, and a server connected to network and configured to control the devices to converge and automate the services thereof, and the hardware configured to establish communication among the server and the devices and perform a logging function to record events and errors taking place in the convergence and automation system.
The hardware may include at least one client connected to the network and configured to control at least a portion of the services of the plurality devices. Each of the plurality of devices may be selected from the group consisting of an audio device, video device, intercom device, lighting control device, security device and HVAC device. The at least one client may be selected from the group consisting of a television, personal computer, personal data assistant and remote controller. The logging function may include generating messages describing the events and errors taking place in the convergence and automation system. Each of the messages may include a time stamp component, message type component, process component, and description of event component. The messages may include trace messages describing the events, and error messages describing the errors. The trace messages may include service-related messages that include a recording of the events related to the services performed by the devices, discovery messages that include a recording of the events related to introduction and acknowledgement of new services in the software, messaging messages that include a recording of the events related to communication among the devices, and subscription management messages that include a recording of the events related to subscription history of the services among the devices. The error messages may include configuration error messages that include a recording of the errors related to settings or triggering of the devices, network error messages that include a recording of the errors related to failure to communicate between the hardware and software, missing system file messages that include a recording of the errors related to missing necessary files, and scripting/scheduling error messages that include a recording of the errors related to errors in scripts or scheduling of the scripts. The logging function may include filtering, sorting and searching the messages. The logging function may include printing a report of the messages.
Accordingly, in another aspect of the invention, an article includes a machine readable medium having embodied thereon a program, the program being executable by a machine to perform a logging function to record events and errors taking place in a convergence and automation system, the convergence and automation system including an internet-protocol based network, hardware implemented with a web service for devices (WSD) protocol and software implemented with the WSD protocol and configured to establish communication in the hardware and perform the logging function to record the events and errors.
The hardware may include a plurality of devices connected to the network, each device being configured to perform at least one service, and a server connected to network and configured to control the devices for converging and automating the services thereof. The software may be configured to establish communication among the server and the devices. The logging function may include generating messages describing the events and error taking places in the convergence and automation system. The messages may include a time stamp component, message type component, process component, and description of event component. The messages may include trace messages describing the events, and error messages describing the errors. The trace messages may include service-related messages that include a recording of the events related to the services performed by the devices, discovery messages that include a recording of the events related to introduction and acknowledgement of new services in of the software, messaging messages that include a recording of the events related to communication among the devices, and subscription management messages that include a recording of the events related to subscription history of the services among the devices. The error messages may include configuration error messages recording the errors related to settings or triggering of the devices, network error messages recording the errors related to failure to communicate between the hardware and software, missing system file messages recording the errors related to missing necessary files, and scripting/scheduling error messages recording the errors related to errors in scripts or scheduling of the scripts. The logging function may include filtering, sorting and searching the messages.
Additional features, advantages, and embodiments of the invention may be set forth or apparent from consideration of the following detailed description, drawings, and claims. Moreover, it is to be understood that both the foregoing summary of the invention and the following detailed description are exemplary and intended to provide further explanation without limiting the scope of the invention as claimed.



BRIEF DESCRIPTION OF THE DRAWINGS
The accompanying drawings, which are included to provide a further understanding of the invention, are incorporated in and constitute a part of this specification, illustrate embodiments of the invention and together with the detailed description serve to explain the principles of the invention. No attempt is made to show structural details of the invention in more detail than may be necessary for a fundamental understanding of the invention and the various ways in which it may be practiced. In the drawings:
FIG. 1 shows an overview of a convergence and automation system (CAS) constructed according to the principles of the invention;
FIG. 2 shows a screen capture image of a log viewer, constructed according to the principles of the invention;
FIG. 3 shows a screen capture image of the log viewer of FIG. 2 being configured for filtering messages;
FIG. 4(a) shows a screen capture images of the log viewer of FIG. 2 being used to display all messages;
FIG. 4(b) shows a screen capture image of the log viewer of FIG. 2 being used to display only trace messages;
FIG. 4(c) shows a screen capture image of the log viewer of FIG. 2 being used to display only error messages;
FIG. 5 shows a screen capture image of the log viewer of FIG. 2 being used to sort messages;
FIG. 6(a) shows a screen capture image of the log viewer of FIG. 2 being used to search messages;
FIG. 6(b) shows a screen capture image of the log viewer of FIG. 2 being used to clear the selected messages;
FIG. 6(c) shows a screen capture image of the log viewer of FIG. 2 being used to display an expanded stack trace for an error massage;
FIG. 6(d) shows a screen capture image of a dialog box showing additional information about the error when a user selects “Show Expanded Errors” in FIG. 6(c);
FIG. 7(a) shows a screen capture image of a print preview window constructed according to the principles of the invention;
FIG. 7(b) shows a screen capture image of a page setup window constructed according to the principles of the invention;
FIG. 7(c) shows a screen capture image of the print preview window of FIG. 7(a) with a word-wrapping function enabled;
FIG. 8(a) shows an exemplary trace message having four core components constructed according to the principles of the invention;
FIG. 8(b) shows an exemplary error message having four core components constructed according to the principles of the invention;
FIG. 9 shows a portion of a service provider logging file constructed according to the principles of the invention;
FIG. 10 shows a table listing common trace messages alphabetically by the first letter of the message text constructed according to the principles of the invention;
FIG. 11(a) shows a table listing networking error messages alphabetically by the first letter of the message text constructed according to the principles of the invention;
FIG. 11(b) shows a table listing configuration error messages alphabetically by the first letter of the message text constructed according to the principles of the invention;
FIG. 11(c) shows a table listing script/schedule error messages alphabetically by the first letter of the message text constructed according to the principles of the invention; and
FIG. 11(d) shows a table listing missing system file error messages alphabetically by the first letter of the message text constructed according to the principles of the invention.



DETAILED DESCRIPTION OF THE INVENTION
The embodiments of the invention and the various features and advantageous details thereof are explained more fully with reference to the non-limiting embodiments and examples that are described and/or illustrated in the accompanying drawings and detailed in the following description. It should be noted that the features illustrated in the drawings are not necessarily drawn to scale, and features of one embodiment may be employed with other embodiments as the skilled artisan would recognize, even if not explicitly stated herein. Descriptions of well-known components and processing techniques may be omitted so as to not unnecessarily obscure the embodiments of the invention. The examples used herein are intended merely to facilitate an understanding of ways in which the invention may be practiced and to further enable those of skill in the art to practice the embodiments of the invention. Accordingly, the examples and embodiments herein should not be construed as limiting the scope of the invention, which is defined solely by the appended claims and applicable law. Moreover, it is noted that like reference numerals represent similar parts throughout the several views of the drawings.
FIG. 1 shows an overview of a convergence and automation system (CAS) for use with a portable remote control, communications and media consumption device constructed according to the principles of the invention. The CAS solution may be a combination of hardware and software. The hardware may include a server 10 connected to a network 12 (e.g. IP based wired or wireless network such as an Ethernet network) and may possibly be connected to the internet 14, devices 102 (e.g. audio 20, video 22, intercom 24, lighting 26, security system 28, HVAC 39, and the like) and clients 104 (e.g. TV 30, personal computer (PC) 32, personal digital assistance (PDA) 34, controller 36 such as a control panel, game controller (i.e. XBoxTM, not shown) and the like). Moreover, the clients 104 may include a remote control 39 or a portable device 106 for remote control, communications and media consumption, which may be configured to function as both the client and device. The server 10 may be any type of computer, such as a PC connected to the network 12. The clients 104 such as clients 30, 32, 34, 36 provide a user with control over the devices 102 such as devices 20, 22, 24, 26, 28, 29.
The software (i.e. application) enables the hardware devices 102 and/or clients 104 to communicate with each other despite their different proprietary languages and communication protocols, and may provide the user with control over most or all the hardware from a single client. The application may utilize at least one portion of the hardware to send commands to the devices 102 and receive feedback from them. The application integrates centralized device control into a PC based media environment (e.g., Microsoft Windows XP Media CenterTM or Microsoft Windows VistaTM environment) that may store, organize and play digital media content. The user may use the remote control 39 or the portable device 106 to listen to music, watch and record television, enjoy family photographs and home movies, as well as adjust the lighting, secure the home, adjust the temperature, distribute music throughout the house, check surveillance cameras and the like. Moreover, the portable device 106 has further communication features as noted below.
The application may be implemented with Web Services. The Web Services  use standard Internet protocol (IP) and are based on standard XML-related technologies such as SOAP (Simple Object Access Protocol) for communications and WSDL (Web Services Device Language) to describe interfaces. The devices implemented with Web Service for Device (WSD) become black boxes on the network, providing services to any application, on any platform, written in any language. Moreover, the use of WSD allows for the capabilities of Universal Plug and Play (UPnP) that seamlessly connects and simply implementation as is known in the art.
The invention is directed to the logging functionality of the CAS to monitor the processes and interactions taking place within the CAS. The log files generated by the CAS application may be used by a user, installer, technical support staff and/or the like for monitoring, tracing and diagnostic CAS operations. The messages in the log files may contain text that indicates what the message is for and the systems or processes involved.
Logging may be initiated by setting the CAS to trace the logging, which may be a default setting for the CAS operation during the CAS configuration. System integrators may use the log files and the reference information to help troubleshoot a problem in the field successfully or be of assistance in solving a problem by relaying information from the log files to the CAS technical support staff.
The device/software modules, methods or implementations described herein are intended for operation with dedicated hardware implementations including, but not limited to, semiconductors, application specific integrated circuits, programmable logic arrays, and other hardware devices constructed to implement the software modules, methods or implementation functionality described below. Moreover, various embodiments of the invention described herein are intended for operation as software programs running on a computer processor such as PC running the WindowsTM operating system as is well known in the art. The functional and operational description of the various device/software modules, methods or implementations described herein may be used together, separately, or in various combinations thereof. The device/software modules, methods or implementations will now be described in detail.
CAS Log Viewer
The logging system used in CAS may generate standard text-based files that are automatically read from the moment the CAS is initiated at startup until the final execution of shutdown. Depending on the period of time they cover, log files may become quite large as they capture all activity of the application. The CAS Log Viewer is an application created to assist the users in filtering through the log messages to find those relevant to the issue he or she is trying to troubleshoot.
FIG. 2 shows an exemplary log viewer 40 constructed according to the principles of the invention. The log viewer 40 of the invention may be integrated with the control panel of a WindowsTM operating system or implemented as a utility program in a CAS program group. The log viewer 40 may be started by opening Windows ExplorerTM, navigating to the control panel or a CAS program folder on the local drive, and double-clicking the corresponding executable file or program (e.g., logviewer.exe). The user may navigate the log viewer 40 using a mouse, keyboard, input device, or the like. As shown in FIG. 2, the log viewer 40 of the invention may include several elements such as a menu bar 42, search box 44, component pane 46 and/or log information pane 48 and the like.
To view a log, the user may select “File” and “Open” in the menu bar 42, and then browse to the log file. The log viewer 40 may allow the user to isolate messages pertaining to a specific system component. As shown in FIG. 3, to view only the messages for a specific component the user may click the box to the left of a component to place a check beside the component in the components pane 46 and then select “Apply.” Additional filtering functionality may include the ability select multiple components for viewing. For example, in FIG. 4(a), the user may select “Edit” and “Check All” to see all messages, or select “Edit” and “UnCheck All” to clear the selected messages. Also, the user may select “Filter” and “Select Trace” to show only ‘trace messages’ as shown in FIG. 4(b). Further, the user may select “Filter” and “Select Error” to show only ‘Error Messages’ as shown in FIG. 4(c).
The log messages in the log information pane 46 may be sorted by content headings such as time, type, component (alphabetical sort), message content (alphabetical sort) or the like, as shown in FIG. 5. To sort on one of these criteria, the user may simply select the heading 5 he or she wants, and then the messages may be sorted according to the selected heading. Selecting the same heading again may resort in reverse chronological or alphabetical order from the original sort.
In FIG. 6(a), the user may search for specific strings of text within messages, and matching results may be highlighted within the log information window 48. To conduct a search, the user may enter a term in the search box 44 and select “Find” 602 and select “Next” 604 to continue to move through matching results or select “Previous” 606 to backtrack through them. To clear the highlighted messages, the user may select “Edit” and “Clear Selected” as shown in FIG. 6(b). To select multiple, consecutive messages, the user may press the SHIFT key while clicking on the desired beginning and ending messages. To select multiple, nonconsecutive log messages, the user may press and hold the CTRL key while clicking on desired messages. The user may see an expanded stack trace for an error message by highlighting the error, right-clicking and selecting “Show Expanded Errors” as shown in FIG. 6(c). Then, an “Expanded Error Information” dialog box may appear with additional information about the error, as shown in FIG. 6(d), which may be printed as a report by selecting “File” and “Print” from the menu bar 42.
The user may print reports based on selected messages using the “File” and “Print” command from the menu bar 42. To preview a report, the user may select “File” and “Print Preview,” and a “Print Preview” window may appear as shown in FIG. 7(a). To change page setup for a report, the user may “File” and “Page Setup” from the menu bar 42, and then a “Page Setup” window may appear as shown in FIG. 7(b). To turn word wrapping on or off for a report, the user may select “Edit” and “WordWrap” from the menu bar 42. As shown in FIG. 7(c), word wrapping may break a line at a natural word break, rather than between characters within a word.
Interpretation of Log File Messages
Each message may be represented by a unique line of text in the log file. A message may be either a ‘Trace’ message (detailing an event) or an ‘Error’ message (detailing an error). Regardless of the type, there may be four core components to a message: Time Stamp, Message Type, Process issuing the message and a Description. The sample shown in FIG. 8(a) is a trace message that indicates that at 12:25, a Serial Port Controller created a controller for the COM17 port. As another example, a command sent to a specific thermostat and being successfully received by the thermostat may be represented in the following two messages:
3/14/2005 2:35:24 PM—Trace: (Aprilaire 2) Sending message: SN2 C8=ON
3/14/2005 2:35:24 PM—Trace: (Aprilaire 2) Message received: SN2 C8=ON
It may not be uncommon in the log that an anticipated “message received” line follows just after a “sending message” line. However, because there are so many systems that can be supported by the CAS and large numbers of messages may be transmitted almost simultaneously, there may be a variety of other logged messages from other devices occurring between the two. In fact, if something occurs that affects multiple areas of the software, the user may see hundreds of log messages with the exact same time stamp on them.
For the most part, the information and entries contained in the logs may be in the form of trace messages used to track the progress of transactions and interactions between the internal processes of the CAS. These trace messages may be sent and received by services and processes within the CAS in response to requests made by internal and external components. Because of the multitude of different systems the CAS supports, each with its own unique messaging needs, a comprehensive detail of all of the possible trace messages may be extensive and unwieldy. To address this issue, trace messages may contain intuitively labeled components. While the exact command being sent to or from a device may not be understandable, the user may be able to determine when the command was sent and if it was received, which may be the most relevant information to system installers.
Much of the information logged by the CAS may detail the interactions between different components of the software. Knowing the basic functions of these components and their relationship may assist the user in understanding the log. For each device 102 (e.g., lighting 26, HVAC 29, etc), there may be a corresponding ‘service’ in the CAS that facilitates control (a lighting service, HVAC service, etc). When the CAS is started, the necessary services are also started. Events such as “Starting service” or “Adding Hosted Service” may indicate that a service has been started. Other Service-related messages may include “Configuration is loaded,” “Controller is created,” “Controller is found,” “Starting Service,” “Adding Hosted Service,” “Sending Hello for service,” and the like.
Once started, a service may need to advertise its presence to the rest of the software. The other software components may be then aware that a new service (and thus, a new device) is now on the network. At the startup, advertisement may be done by issuing a ‘hello’ (i.e., “Sending Hello” for Service), and other components may indicate that they have heard this ‘hello’ (i.e., “Hello received”) in response, which is referred to as ‘discovery’ in the CAS. If the service is being started after initial startup has been completed, in lieu of a hello message, a ‘Probe’ may be sent. Other system components then may send ‘Probe Matches’ in response. Messages such as “Probe Received” and “Sending Probe Matches” may indicate that a service has been added and discovered successfully. Discovery related messages may include “Sending Hello,” “Hello Received,” “Probe Received,” “Sending Probe Matches,” and the like.
Messages that involve sending a command to a device and receiving a response may be found close together. Common trace messages involved in this process may include “Sending Message,” “Message Received,” “Received Non-conforming Message” (i.e., when a device returns more information than is required by the CAS), “Received Null Event” (i.e., when a device does not return messages in response to commands from the CAS), “Getting Script Template,” and the like.
A number of trace messages may refer to ‘Subscription Management.’ For example, when the user accesses device controls, for example, lighting controls, some components of the software then may automatically subscribe to events issued by the lighting service. When the user navigates off of the lighting controls page, the components may unsubscribe from the lighting service. If a service is stopped or shut down, all of its existing subscriptions may be cleared. These processes of subscription and unsubscription may be captured in the log. For troubleshooting purposes, subscription messages may indicate either successful communication between components and services, or that a service has been stopped or shut down and its subscriptions cleared. Common trace messages dealing with subscriptions may include “Sending Unsubscribe,” “Removing Subscription,” “Clearing subscriptions,” “Subscriptions cleared” and the like. The table shown in FIG. 10 lists the common trace messages alphabetically by the first letter of the message text.
The log file also may receive error messages that are generated when expected conditions are not met or unexpected conditions arise in the system. Error messages may also be generated when exceptions occur within the software as the result of a failed transaction or a missing or incorrect address or port. When errors occur, log entries may be generated that may be interpreted either by integrators or by technical staff in the course of troubleshooting the problem. An exemplary error message is shown in FIG. 8(b), which is similar to the trace message shown in FIG. 8(a). An error messages may be identified by the ‘message type’ category, which may includes “Error” as shown in FIG. 8(b). Error Messages may fall into several categories such as configuration errors, networking errors, missing system files, scripting/scheduling errors and the like.
The configuration errors may be related to the settings of a device or the trigger attempting to initiate control of the device. Log errors indicating a possible configuration problem may include “Could not create an instance of this type,” “Error occurred sending events,” “Error occurred sending message,” “Partition Name Invalid,” “Application setting has an invalid value,” “Zone Name Invalid,” “Network device not responding,” “Received restore for zone X which does not have partition mapping,” “Received alarm for zone X, which does not have partition mapping,” “Port Open Failure” and the like. The table shown in FIG. 11(b) lists the configuration error messages alphabetically by the first letter of the message text.
Some log errors may indicate a problem with the network such as a possible failure to communicate between the software and physical devices. Such problems may have a physical cause, for example, an unplugged or poorly fitted cable. The problem could also be an addressing issue such as a wrong serial port number for a device, or an incorrect IP Address. Log errors that indicate a possible networking problem may include “An error has occurred sending the probe message,” “Error occurred sending events,” “Error sending bye message,” “Error sending hello message” and the like. The table shown in FIG. 11(a) lists the network error messages alphabetically by the first letter of the message text.
Other error messages may indicate that a necessary DLL or system file is missing. In this case, the user may need to check the installation against the required file structures and/or the latest available CAS system files to ensure that all of the necessary system components are present. Log errors that indicate a possible missing system file may include “Type could not be loaded. Please check to make sure the file containing X is in the bin directory,” “The constructor for X has thrown an exception. Please check to make sure the file containing Y is in the bin directory,” “Could not create device” and the like. The table shown in FIG. 11(d) lists the missing system error messages alphabetically by the first letter of the message text.
An error in the script or scheduling of a script may trigger one of the following log errors: “Could not retrieve script templates,” “Could not load schedules as the config file is corrupt,” “Could not execute schedule,” “Could not save schedules to file,” “Could not compile script,” “Execution of script X received an error,” “Cannot perform action, script is in use” and the like. If the user sees one of these scripting/scheduling errors, he or she may need to check the script or schedule setup using either a CPA configuration tool or control panel. The table shown in FIG. 11(c) lists the script/schedule error messages alphabetically by the first letter of the message text.
An error condition is may not always accompanied by an error message. For example, problems such as faulty or unplugged communications cables may generate log trace messages that show timeout conditions because a command could not get through. The most common indicator of a non-responsive, non-error may be the ‘Null Event trace message.’
The logging system used in CAS may generate standard text-based files that are automatically read from the moment CAS is initiated at startup until the final execution of shutdown. These files may be viewed directly as text files. The logging system may place log files in the Logs directory under the Applications folder on the CAS server 10. To access these log files, one may need the CAS administrator permissions, Windows ExplorerTM, a text reader or editor. Altering information in the log files may have no effect on the system as the messages are evidence of events which have already occurred and are only a record of them. To view log files, the user may use a text editor such as Notepad to open the file and view the messages as in an exemplary log file shown in FIG. 9.
The methodologies described herein may be implemented by various means depending upon the application. For example, these methodologies may be implemented in hardware, firmware, software, or a combination thereof. For a hardware implementation, the processing units may be implemented within one or more application specific integrated circuits (ASICs), digital signal processors (DSPs), digital signal processing devices (DSPDs), programmable logic devices (PLDs), field programmable gate arrays (FPGAs), processors, controllers, micro-controllers, microprocessors, electronic devices, other electronic units designed to perform the functions described herein, or a combination thereof.
For a firmware and/or software implementation, the methodologies may be implemented with modules (e.g., procedures, functions, and so on) that perform the functions described herein. Any machine readable storage medium tangibly embodying instructions may be used in implementing the methodologies described herein. For example, software codes may be stored in a memory, for example the memory of client or device, and executed by a processor, for example a general-purpose processor. Memory may be implemented within the processor or external to the processor. As used herein the term “memory” refers to any type of long term, short term, volatile, nonvolatile, or other memory and is not to be limited to any particular type of memory or number of memories, or type of storage media upon which memory is stored.
While the invention has been described in terms of exemplary embodiments, those skilled in the art will recognize that the invention can be practiced with modifications in the spirit and scope of the appended claims. These examples given above are merely illustrative and are not meant to be an exhaustive list of all possible designs, embodiments, applications or modifications of the invention.

## Claims

1. A convergence and automation system, comprising:
an Internet-protocol (IP) based network; and
hardware implemented with a web service for devices (WSD) protocol, said hardware comprising:
a plurality of devices connected to the network, each device being configured to perform at least one service; and
a server connected to the network and configured to control the plurality of devices to converge and automate the at least one service;

said hardware being configured to establish communication among the server and the plurality of devices and perform a logging function to record an event and an error occurring in the convergence and automation system,
wherein said logging function comprises generating a message describing the event and error occurring in the convergence and automation system,
wherein said message comprises:
a trace message describing the event; and
an error message describing the error,

wherein said error message comprises:
a configuration error message comprising a record of an error related to a setting or a triggering of at least one of the plurality of devices;
a network error message comprising a record of an error related to a communicate failure between the hardware and the software;
a missing system file message comprising a record of an error related to a missing file; and
a scripting/scheduling error message comprising a record of an error related to a script or a scheduling of the script.

2. The convergence and automation system of claim 1, said hardware further comprising at least one client connected to the network and configured to control at least a portion of the at least one service.

3. The convergence and automation system of claim 2, wherein each of said plurality of devices is selected from the group comprising an audio device, a video device, an intercom device, a lighting control device, a security device and a heating ventilation air conditioning (HVAC) device.

4. The convergence and automation system of claim 2, wherein said at least one client is selected from the group comprising a television, a personal computer, a personal data assistant and a remote controller.

5. The convergence and automation system of claim 1, wherein said message comprises a time stamp component, a message type component, a process component, and a description of event component.

6. The convergence and automation system of claim 1, wherein the trace message comprises:
a service-related message comprising a record of an event related to said at least one service;
a discovery message comprising a record of an event related to introduction and acknowledgement of a new service in said software;
a messaging message comprising a record of an event related to communication among said plurality of devices; and
a subscription management message comprising a record of an event related to a subscription history of said at least one service.

7. The convergence and automation system of claim 1, said logging function further comprising filtering, sorting and searching said message.

8. The convergence and automation system of claim 7, wherein the logging function further comprises printing a report of said message.

9. A computer readable storage medium having a stored computer program embodying instructions, which, when executed by a computer, cause the computer to perform a logging function to record an event and an error occurring in a convergence and automation system, said convergence and automation system comprising an Internet-protocol (IP) based network and hardware implemented with a web service for devices (WSD) protocol, the computer readable storage medium comprising:
instructions for establishing communication in the hardware based on the WSD protocol; and
instructions for performing the logging function to record the event and the error, wherein said hardware comprises:
a plurality of devices connected to the network, each of the plurality of devices being configured to perform at least one service; and
a server connected to the network and configured to control the plurality of devices for converging and automating the at least one service,
wherein said instructions for establishing communication in the hardware comprise instructions for establishing communication among the server and the plurality of devices,
wherein said instructions for performing the logging function comprise instructions for generating a message describing the event and the error,
wherein said message comprises a time stamp component, a message type component, a process component, and a description of event component,
wherein said message comprises:
a trace message describing the event; and
an error message describing the error,

wherein said error message comprises:
a configuration error message recording an error related to a setting or a triggering of the plurality of devices;

a network error message recording an error related to a communicate failure between the hardware and software;
a missing system file message recording an error related to a missing file; and
a scripting/scheduling error message recording an error related to a script or a scheduling of the script.

10. The computer readable storage medium of claim 9, the trace message comprising:
a service-related message comprising a record of an event related to the at lest on service;
a discovery message comprising a record of an event related to introduction and acknowledgement of a new service in the software;
a messaging message comprising a record of an event related to communication among said plurality of devices; and
a subscription management message comprising a record of an event related to a subscription history of said at least one service.

11. The computer readable storage medium of claim 9, the logging function further comprising filtering and searching the message.