Difference between revisions of "ISY-99i/ISY-26 INSTEON:Using the Event Viewer"

From Universal Devices, Inc. Wiki
Jump to: navigation, search
m (Updated for 2.6.5+.)
(Added Level 2 codes.)
Line 1: Line 1:
 +
[[image:event_viewer_screenshot.png|upright|right|Event Viewer Window]]
 
With beta release 2.6.4 beta of firmware version 2.7 for ISY-26 and ISY-99i Series, an '''Event Viewer''' has been added to the '''Tools''' menu.  In firmware 2.6.5 and later, the '''Event Viewer''' has been moved to the '''Diagnostics''' sub-menu of the '''Tools''' menu, and the '''Always on Top''' checkbox has been removed as it is no longer required.  The '''Event Viewer''' provides a real-time display of traffic occurring on the INSTEON network, which may be saved to a log file.
 
With beta release 2.6.4 beta of firmware version 2.7 for ISY-26 and ISY-99i Series, an '''Event Viewer''' has been added to the '''Tools''' menu.  In firmware 2.6.5 and later, the '''Event Viewer''' has been moved to the '''Diagnostics''' sub-menu of the '''Tools''' menu, and the '''Always on Top''' checkbox has been removed as it is no longer required.  The '''Event Viewer''' provides a real-time display of traffic occurring on the INSTEON network, which may be saved to a log file.
  
[[image:event_viewer_screenshot.png|upright|right|Event Viewer Window]]
 
 
To open the '''Event Viewer''', open the '''Tools''' menu (and in 2.6.5 and later firmware open the '''Diagnostics''' sub-menu), and choose '''Event Viewer''':
 
To open the '''Event Viewer''', open the '''Tools''' menu (and in 2.6.5 and later firmware open the '''Diagnostics''' sub-menu), and choose '''Event Viewer''':
  
Each event is presented on one line in the '''Event Viewer''' window. Each event line displays the following columns:  the '''date''', the '''time''', a colon, a bracketed column containing the device's '''INSTEON address''' or the term '''X10''', the '''action''' code, and a '''parameter''' value.
+
The '''Event Viewer''' window may be sized, and (in firmware 2.6.4) may be set to be ''Always On Top''.  At the bottom of the window are buttons to ''Clear'' the window, ''Close'' the window, and ''Save Log To ...'' a file.  The ''Change Level: 1'' button allows setting the '''display level''' to 0, 1 or 2.  The default (when the window is opened) is 1.
  
{| style="background:#f4f4f4;" cellpadding="0" cellspacing="0" align="right"
+
{| style="background:#f4f4f4;" cellpadding="0" cellspacing="0" align="center"
 +
|+ Display Levels
 +
|- valign="top"
 +
| style="background:transparent" |   ||  0 ||    || No progress information. || style="background:transparent" |  
 +
|- valign="top"
 +
| style="background:transparent" |   ||  1 ||    || Normal events. || style="background:transparent" |  
 +
|- valign="top"
 +
| style="background:transparent" |   ||  2 ||    || Normal events and scheduler/trigger firing events.
 +
| style="background:transparent" |  
 +
|}
 +
 
 +
 
 +
The '''display level''' corresponds to the '''Debug''' level in the '''ISY Shell'''.  The '''Event Viewer''' window displays the same information as is found in the Java Console, but without the necessity of telneting to ISY and using the '''DBG''' command in order to set the '''Debug''' level.
 +
 
 +
With '''Level 1''', each event is presented on one line in the '''Event Viewer''' window.  Each event line displays the following columns:  the '''date''', the '''time''', a colon, a bracketed column containing the device's '''INSTEON address''' or the term '''X10''', the '''action''' code, and a '''parameter''' value.
 +
 
 +
For X-10 devices, the '''action''' code may be the device's X-10 address, or the X-10 command.  A complete X-10 command sequence consists of two parts:  the House/Unit code of the device being addressed, followed by the House/Command code of the command.  Since each of these two parts is actually a separate command, each is displayed as an individual event.  Some X-10 commands, such as '''All Off''', don't require a separate House/Unit code, and are therefore a single event.  The number in parenthesis is the actual X-10 command code.  A complete list of X-10 command codes may be found on the [[ISY-99i/ISY-26 INSTEON:Program Commands#X-10 Commands|Program Commands]] page.
 +
 
 +
For INSTEON devices, the '''action''' code may be one of:
 +
{| style="background:#f4f4f4;" cellpadding="0" cellspacing="4" align="center"
 
|+ INSTEON Action Codes
 
|+ INSTEON Action Codes
 
|- valign="top"
 
|- valign="top"
Line 27: Line 46:
 
| style="background:transparent" |   ||  ST ||    || Status || style="background:transparent" |  
 
| style="background:transparent" |   ||  ST ||    || Status || style="background:transparent" |  
 
|}
 
|}
For INSTEON devices, the '''action''' code may be one of:
+
 
  
 
For the '''On-Level''' and '''Ramp-Rate''' commands, the '''parameter''' is the ''on-level'' or ''ramp-rate'' being set, respectively.  For the '''Begin Manual Change''' command, the '''parameter''' is '1' for a ''Fade Up'', and '0' for a ''Fade Down''.  The '''parameter''' for the '''Status''' command, is the value returned by that command; usually the current ''on-level''.
 
For the '''On-Level''' and '''Ramp-Rate''' commands, the '''parameter''' is the ''on-level'' or ''ramp-rate'' being set, respectively.  For the '''Begin Manual Change''' command, the '''parameter''' is '1' for a ''Fade Up'', and '0' for a ''Fade Down''.  The '''parameter''' for the '''Status''' command, is the value returned by that command; usually the current ''on-level''.
  
For X-10 devices, the '''action''' code may be the device's X-10 address, or the X-10 command.  A complete X-10 command sequence consists of two parts:  the House/Unit code of the device being addressed, followed by the House/Command code of the command.  Since each of these two parts is actually a separate command, each is displayed as an individual event.  Some X-10 commands, such as '''All Off''', don't require a separate House/Unit code, and are therefore a single event.  The number in parenthesis is the actual X-10 command code.  A complete list of X-10 command codes may be found on the [[ISY-99i/ISY-26 INSTEON:Program Commands#X-10 Commands|Program Commands]] page.
+
With '''Level 2''', in addition to the information displayed by '''Level 1''', the '''Event Viewer''' displays more detailed informational lines, the most important of which are:
 
+
{| style="background:#f4f4f4;" cellpadding="0" cellspacing="4" align="center"
The '''Event Viewer''' window may be sized, and may be set to be ''Always On Top''.  At the bottom of the window are buttons to ''Clear'' the window, ''Close'' the window, and ''Save Log To ...'' a file.
+
|+ INSTEON Level 2 Codes
 
+
{| style="background:#f4f4f4;" cellpadding="0" cellspacing="0" align="right"
+
|+ Display Levels
+
 
|- valign="top"
 
|- valign="top"
| style="background:transparent" |   ||  0 ||    || No progress information. || style="background:transparent" |  
+
| style="background:transparent" |   ||  INST-ACK ||    || The PLM responded to a command sent by ISY (usually an echo).  i2 ACKs are longer (23 bytes). || style="background:transparent" |  
 
|- valign="top"
 
|- valign="top"
| style="background:transparent" |   ||  1 ||    || Normal events. || style="background:transparent" |  
+
| style="background:transparent" |   ||  INST-SRX ||    || The receiving device has either responded to a command from ISY or is sending an event.  This is the standard length message (i1). || style="background:transparent" |  
 
|- valign="top"
 
|- valign="top"
| style="background:transparent" |   ||  2 ||    || Normal events and scheduler/trigger firing events.
+
| style="background:transparent" |   ||  INST-ERX ||    || Like INST-SRX, but extended length and returned by i2 devices. || style="background:transparent" |  
| style="background:transparent" |  
+
 
|}
 
|}
The ''Change Level: 1'' button allows setting the '''display level''' to 0, 1 or 2.  The default (when the window is opened) is 1.
 
  
The '''display level''' corresponds to the '''Debug''' level in the '''ISY Shell'''.  The '''Event Viewer''' window displays the same information as is found in the Java Console, but without the necessity of telneting to ISY and using the '''DBG''' command in order to set the '''Debug''' level.
 
  
 +
In general, things work like this:
 +
{| style="background:#f4f4f4;" cellpadding="4" cellspacing="4" align="center"
 +
|+ INSTEON Communications
 +
|- valign="top"
 +
| style="background:transparent" |   ||  Sending a request from ISY (i1) ||    || ---->Send Request---->Receive INST-ACK-(Wait for Response)---->Receive INST-SRX.  Timeout means that either INST-ACK or ISNT-SRX did not come within allotted time (4 seconds). || style="background:transparent" |  
 +
|- valign="top"
 +
| style="background:transparent" |   ||  Sending a request from ISY (i2) ||    || ---->Send Request---->Receive INST-ACK-(Wait for Response)---->Receive INST-SRX---->Receive INST-ERX. || style="background:transparent" |  
 +
|- valign="top"
 +
| style="background:transparent" |   ||  Receiving events from devices ||    || ---->Receive INST-SRX || style="background:transparent" |  
 +
|}
  
  

Revision as of 01:27, 27 December 2008

Event Viewer Window

With beta release 2.6.4 beta of firmware version 2.7 for ISY-26 and ISY-99i Series, an Event Viewer has been added to the Tools menu. In firmware 2.6.5 and later, the Event Viewer has been moved to the Diagnostics sub-menu of the Tools menu, and the Always on Top checkbox has been removed as it is no longer required. The Event Viewer provides a real-time display of traffic occurring on the INSTEON network, which may be saved to a log file.

To open the Event Viewer, open the Tools menu (and in 2.6.5 and later firmware open the Diagnostics sub-menu), and choose Event Viewer:

The Event Viewer window may be sized, and (in firmware 2.6.4) may be set to be Always On Top. At the bottom of the window are buttons to Clear the window, Close the window, and Save Log To ... a file. The Change Level: 1 button allows setting the display level to 0, 1 or 2. The default (when the window is opened) is 1.

Display Levels
   0    No progress information.  
   1    Normal events.  
   2    Normal events and scheduler/trigger firing events.  


The display level corresponds to the Debug level in the ISY Shell. The Event Viewer window displays the same information as is found in the Java Console, but without the necessity of telneting to ISY and using the DBG command in order to set the Debug level.

With Level 1, each event is presented on one line in the Event Viewer window. Each event line displays the following columns: the date, the time, a colon, a bracketed column containing the device's INSTEON address or the term X10, the action code, and a parameter value.

For X-10 devices, the action code may be the device's X-10 address, or the X-10 command. A complete X-10 command sequence consists of two parts: the House/Unit code of the device being addressed, followed by the House/Command code of the command. Since each of these two parts is actually a separate command, each is displayed as an individual event. Some X-10 commands, such as All Off, don't require a separate House/Unit code, and are therefore a single event. The number in parenthesis is the actual X-10 command code. A complete list of X-10 command codes may be found on the Program Commands page.

For INSTEON devices, the action code may be one of:

INSTEON Action Codes
   DON    Device On  
   DOF    Device Off  
   DFON    Device Fast On  
   DFOF    Device Fast Off  
   BMAN    Begin Manual Change   
   SMAN    Stop Manual Change  
   OL    On-Level  
   RR    Ramp-Rate  
   ST    Status  


For the On-Level and Ramp-Rate commands, the parameter is the on-level or ramp-rate being set, respectively. For the Begin Manual Change command, the parameter is '1' for a Fade Up, and '0' for a Fade Down. The parameter for the Status command, is the value returned by that command; usually the current on-level.

With Level 2, in addition to the information displayed by Level 1, the Event Viewer displays more detailed informational lines, the most important of which are:

INSTEON Level 2 Codes
   INST-ACK    The PLM responded to a command sent by ISY (usually an echo). i2 ACKs are longer (23 bytes).  
   INST-SRX    The receiving device has either responded to a command from ISY or is sending an event. This is the standard length message (i1).  
   INST-ERX    Like INST-SRX, but extended length and returned by i2 devices.  


In general, things work like this:

INSTEON Communications
   Sending a request from ISY (i1)    ---->Send Request---->Receive INST-ACK-(Wait for Response)---->Receive INST-SRX. Timeout means that either INST-ACK or ISNT-SRX did not come within allotted time (4 seconds).  
   Sending a request from ISY (i2)    ---->Send Request---->Receive INST-ACK-(Wait for Response)---->Receive INST-SRX---->Receive INST-ERX.  
   Receiving events from devices    ---->Receive INST-SRX  




ISY-26 INSTEON / ISY-99i Series INSTEON : How-To Guide