Leopard II manual Table of Contents
|
|  Yüklə 3.21 Mb.
|
4.6C-Max Utilities The C-Max utilities are used for a variety of functions such as learning infrared codes, debugging (monitoring) variables and timers, editing ASCII strings, etc. Taking the time to learn their capabilities will allow you to save a lot of time when testing a new program or just monitoring activity when working on your home automation equipment. The main utilities menu is accessed by clicking (from the main editor screen) on Comms Attach to Controller. You will see the Controller Access screen (fig. 39): Fig. 39
The controller access screen is laid out as follows: The activity status window occupies the left part of the screen. Any activity you perform such as downloading a program, modifying a parameter, etc. will be listed here. New activity messages will always appear at the top, pushing down any previous messages. If the window gets full, a scroll bar will appear to it’s right, allowing you to view previous messages. The Errors check box will cause only error messages to appear instead of all activity, useful when debugging particular problems. On the right, you have the expansion module status window. For each expansion module that you have, you will see its module type (eg. SECU16, SLAVE, etc.) and the firmware version of that module. Following that are the ON/OFF status indication of the 16 possible I/O points of that module, and finally the Data for that module. Note that not all columns apply to all module types. For example, the I/O points only apply to the SECU16, SECU16I and RLY8XA modules. Similarly, the Data value is only valid for Bobcat modules. Along the bottom, you have the Rx and Tx indicator “lights” showing serial activity between C-Max and the controller. Next is the Firmware and Application version numbers. The firmware version is dependent upon the manufacturing date of the controller and other factors. This value will not change. The application version number tells you the version of the current executive version. The executive version refers to the part of the code in the controller that interprets the commands you use in your C-Max program, and new versions of C-Max often include a new matching executive as well. See the chapter on Reloading the executive to learn more about this important component of your controller’s software. Below the firmware and application versions is your computer’s date and time. For certain operations like loading a program or touch screen file, this line turns into a progress bar. To the right of these are two more information lines: The top line shows what the serial link to the controller is being used for at any given moment. The bottom line shows the sunrise and sunset times for the PC’s current date, for the defined geographical location. The geographical location is entered as longitude and latitude in the Comms setup screen during the C-Max installation process (see section 1 of this manual). Along the top, you have the pull down menus used to access each type of utility. We will now examine each one of these utilities in detail. 4.6.1Infra-RedThe infra-red (IR) utilities are used to learn, transmit, and otherwise manage IR codes in your controller. The Leopard II can learn up to 1024 IR codes. Clicking on Infra-Red reveals a pull down menu with several choices: 4.6.1.1Learn Infra-Red CommandLearning Infra-Red Command is used to “teach” a new IR command to your controller. Selecting this function opens a small window (fig. 40):    Fig. 40 Fig. 41 Fig. 42 To learn a new IR command, enter the Ir Number where you want to store the new code, and the Ir Frequency that you want to associate with this code. The IR frequency is used by the controller when it needs to “play back” the IR code to the device that this code normally controls. The frequency is the carrier frequency that the controlled device (TV, audio component, etc.) looks for in an attempt to reject IR noise or interference. Having the correct frequency is important for reliable recognition of IR codes being sent from your controller to the controlled device. If you don’t know the specific frequency for the brand of device that you have, use 38 or 40 kHz as a starting point, as these frequencies are quite commonly used. With the code number and frequency entered, click on Learn Ir. You will see a small window (fig 41) prompting you to send the desired IR code to be learned. Point your IR device (TV remote, etc.) to the IR receiver of your Leopard II (the small square just below the bottom-center of the screen) and press the button you want to learn for a fraction of a second. The small red window should disappear and you will be back to the window in fig. 40. The Leopard II’s screen backlight will turn on when it receives an IR code. Choosing the right IR code numbers is important: You can use IR codes in two ways with your Leopard II: They may be learned to be reproduced later by the Leopard II, for the purpose of controlling equipment under C-Max program control. IR codes can also be recognized by the Leopard II itself as input events, like button presses, etc. This gives you one more way to interact with your controller and have it respond to the IR codes to control devices in your home; be it X10, expansion modules, etc. If you plan on learning certain IR codes for the purpose of having the Leopard II recognize them as input commands later, store these in the lower numbered IR code locations. This is because whenever the controller receives an IR command, it must search through its list of learned IR codes to look for a match, which takes time and resources. To keep the search time reasonable, there is a controller parameter (parameter #20) which allows you to specify the maximum code location number to try before giving up looking for a match. By default this parameter is set to 80. If you need to recognize more then 80 codes, then adjust parameter 20 to the appropriate higher value. Conversely, if you do not need to match that many codes, then set parameter 20 to a lower number to speed up the processing of unrecognized codes. Note: Do not use code location #0 if the code will need to be recognized by the Leopard II. Make sure you track which code is stored in which location. Using meaningful names for each IR code in the System Map should make this quite easy. If the same code is learned in two different locations, the one in the lower numbered location will be the one matched first when that code is received. Once a code is learned, you can test it immediately if you wish by clicking on Transmit Ir (provided that an IR emitter has been set up previously). The learned code will be sent to the IR emitter immediately. You can erase a learned code using the Clear Ir Location button. 4.6.1.2Transmit Infra-Red CommandTransmit Infra-Red Command is used when you only want to transmit an already learned IR command. The window that will appear (fig. 42) allows you to enter the code number that you want to transmit, then click on Transmit Ir. You can also erase a code location by using the Clear Ir Location button. 4.6.1.3Transmit Remote Infra-Red CommandTransmit Remote Infra-Red Command is like the previous command except that you can use it to transmit an IR code using either a SECU16IR module or a slave controller (fig 43). If you are transmitting an IR code with a slave controller, note that the code number specified will be the one stored in that controller’s memory, not the code stored in the master.
To transmit a remote IR command, enter the module number (Adnet address) and the zone number, as well as the IR code number. The zone number is only used with the SECU16IR expansion module. This module has 16 addressable outputs that can be selected by the zone number. 4.6.1.4Download Infra-Red File to ControllerDownload Infra-Red File to Controller is used to send learned IR commands that are stored in a disk file to your controller. If you have a file containing IR codes (“.lir” file extension) that comes from another controller or a from a previous save, this is how you load them in. Clicking on this menu choice will open a file browsing menu, allowing you to locate the IR codes file that you want and download its contents into the controller. 4.6.1.5Upload Infra-Red File from ControllerUpload Infra-Red File from Controller does the opposite operation, allowing you to store your learned IR codes to a disk file. This is useful for backing up all the IR codes that you learned manually, and can be used to load into another controller or even sent to another user as a disk file. Once again, a file browsing window will appear, allowing you to select a name and location for your IR codes file (the file will have a “.lir” extension). 4.6.2X10The X10 pull down menu has the following three choices: 4.6.2.1Send X10.This utility allows you to send raw X10 commands, similar to the Transmit Single X10 command in C-Max. Selecting this command will open a window (fig 44):  Fig. 44
4.6.2.2Monitor X10This menu selection will open an X10 status and activity window (fig 45):  Fig 45
The table will be updated whenever an ON or OFF command for an X10 address is received, and also by any Status ON or Status OFF transmission for an X10 address, in response to a Status REQUEST, whether that command is sent by the Leopard II or any other X10 device. The right side of the window shows X10 events as they happen. Any new messages will be added to the top of the screen and push previous messages down. A scroll bar will appear on the right side of the window if the screen gets full. X10 commands will be shown in their raw form. You can choose to see commands either by their numeric value only (eg. An A/ON command will appear as “A/19”) or you can check the Use Names box to see the actual command name instead (e.g. “A/ON”). Use the Clear Log button to clear the window of all messages. 4.6.2.3Send Leviton X10.This third X10 utility allows you to both send Leviton X10 “group” commands and also set up (configure) your switches in groups. Selecting this utility will open a new window (fig 46): Leviton modules, (16xxx and “Green Line” HC series) support group commands. These modules can be set to learn a group command. Every module in that group will brighten or dim to a preset level when a command is issued. Every module in the group must have the same house code. If you want each module in a group to be at different light levels, then each module must have a unique key code. Sixty-four unique groups can be created. Each module can belong to 4 different groups. For example one light module can be in groups M1, M3, M7, and M9, while another module can be in groups M1, M25, M33, and M60. When a group M1 command is issued, both modules will respond. When an M3, M7 or M9 group command is issued, only the first module will respond. When a group command M25, M33 or M60 is issued, only the second module will respond.  Fig. 46
4.6.2.3.1To learn a group command:1) Click the radio button to the left of the House Code you want to train with your left mouse button. 2) Click the radio button to the left of Key Code to select the Leviton module you want to add to the group. 3) Select the Group Number by either typing in the group number to the right of Group Number or click the Up and Down arrows to the right of the edit box until the desired group number is displayed. 4) Move the scroll bar on the lower right corner until the desired light level is displayed. You can either click the arrows to the Left (Dim) or Right (Bright) with your left mouse button, or directly drag the slider left (Dim) or right (Bright) until the desired brightness level is displayed. 5) Click Set Light Level with your left mouse button. The Leviton module will respond to that light level. 6) Click Include in Group at Current Level with your left mouse button. The Leviton module is now part of that learned group. Repeat steps 1-6 until each Leviton module has learned its group(s). 4.6.2.3.2Setting a Group to Their Learned Levels1) Click the radio button to the left of the House Code you want to address with your left mouse button. 2) Select the Group Number by either typing in the group number to the right of Group Number or click the Up and Down arrows to the right of the edit box until the desired group number is displayed. 3) Click Entire Group to Learned Level with your left mouse button. Every light in that learned group will respond to their learned levels. In a C-Max program, you can use the THEN Transmit X10 Group (Leviton) command to accomplish the same task under program control. 4.6.2.3.3Turning Off an Entire Group1) Click the radio button to the left of the House Code you want to address with your left mouse button. 2) Select the Group Number by either typing in the group number to the right of Group Number or click the Up and Down arrows to the right of the edit box until the desired group number is displayed. 3) Click Entire Group OFF with your left mouse button. Every Leviton module in the selected groups will turn off. In a C-Max program, you can use the THEN Transmit X10 Group (Leviton) command to accomplish the same task under program control. 4.6.2.3.4Removing a Leviton Module From a Group1) Click the radio button to the left of the House Code you want to train with your left mouse button. 2) Click the radio button to the left of Key Code to select the Leviton module you want to remove from the group. 3) Select the Group Number by either typing in the group number to the right of Group Number or click the Up and Down arrows to the right of the edit box until the desired group number is displayed. 4) Click Remove from Group with your left mouse button. That module will no longer respond to that group command, but can be set to another group if desired. 4.6.3Program FileThis utility has a single menu choice: Download Program in Editor to Controller. Selecting this utility will immediately download the program currently in the program editor to you controller. The Date and Time field of the controller access screen will turn into a progress bar (horizontal bar graph) to show the progress of the operation. Note that you can also download a program into the controller by using the Download Project procedure described under Projects in this manual section. 4.6.4Controller UtilityThese utilities are used to access and update certain types of data in your controller, as well as provide tools that can be helpful in program testing or debugging. 4.6.4.1Set Controller Clock to PC ClockAs the name implies, the controller’s internal real time clock will be set to the same time and date as those of the PC. This is how you set the time in the Leopard II. Make sure the PC’s date and time are set to the values you want in the controller before doing this! 4.6.4.2Get Controller Clock.This command will read the current value of the controller’s internal real time clock (date and time) and display the values in the activity status window. The PC’s clock will not be affected by this command. This is useful if you just want to see what the time and date in the controller are currently set at. 4.6.4.3Reload Controller Executive.Use this command to manually initiate a new download of the controller executive. The executive is the computer code that your Leopard II uses to interpret the C-Max programs that you create and download to it. The C-Max program editor produces a compressed version of your program, which is then downloaded into the controller. The controller then runs it’s own command interpreter to execute the commands in your program. Any new commands offered in a newer version of C-Max needs to have the equivalent new commands added to the internal interpreter so that it will know how to execute them. Reloading the executive thus equates to loading the new command interpreter into your controller. Whenever you open the controller access window, C-Max compares the executive version currently in the controller against the one in the C-Max installation directory (the disk file is named “Flash512.bin”). If you install a new version of C-Max on your PC and it includes a new executive version, you will immediately see a window indicating that the current executive is not at the latest level as soon as you open the controller access window, and you will be asked if you want to update it now. You should normally answer Yes to this question and your executive will be automatically updated. This means that manually reloading the executive with the Reload Controller Executive command is rarely needed, but can be useful in certain situations such as: - If you accidentally program a routine that continuously sends data to the serial port (ie: Transmit ASCII Message commands) and C-Max can no longer attach to the controller because of this. If this happens, you can regain control with the following procedure: Have C-Max running and ready to attach to the controller, then power the controller off for a few seconds and then back on again. As soon as the power is back on, go into the controller access screen and immediately run the Reload Controller Executive utility. This works because there is a time delay lasting a few seconds between the time the serial port can be accessed and the program actually starts running. Reloading the executive always “kills” a loaded program, so you can make the necessary corrections in your program code and then download it again. - Sometimes a new executive version is released to correct a very minor bug and the version number is left unchanged. This means that the automatic detection of the available new version will not happen. Use this command to manually do the executive reload. 4.6.4.4Controller Memory Dump.This is a diagnostic command used by ADI. There is no functionality in this command for the controller user. 4.6.4.5Retrieve Controller Parameters.This command will read the configuration parameters from the controller and present them in an editable list (fig. 47). See the list of parameters in section 5 of this manual to learn the purpose of each parameter. Do not modify the parameters unless you’re certain of what you’re doing, because entering inappropriate values can cause certain features or expansion modules to appear to give erratic results or cease working altogether.  Fig. 47
4.6.4.6Auto Address Modules.This utility is used to configure the Adnet addresses of expansion modules. Read the “Auto Addressing” application note in section 5 of this manual to learn the complete procedure. Warning: Do not click on this menu choice unless you really intend to address new modules, because this utility will erase all the addresses of currently connected modules! If you do this, you will need to readdress all of them before they can be used again. 4.6.4.7Debug Timers and Variables.Selecting this menu choice will open a continuously updating window (fig. 48) showing the current value of all the timers and variables in the controller. This is one of the most often used utilities because it is handy to be able to see the immediate progression or changes of timers and variables in a running program. You can literally visualize changes as they happen, with no more then about one second of delay.   Fig. 48 Fig. 49 You can also modify the value of a timer or variable on the fly. To do that, click on the timer or variable that you want to change and a small editing window will appear (fig. 49). Enter the new value you want, then click OK.
4.6.5Module UtilityThe module utilities give you direct access to certain module functions. There are 4 utilities: 4.6.5.1Retrieve Module Parameters.Clicking on this selection will open a new window (fig. 50) and will initiate a read of all the parameters for all expansion modules. If your system has many modules, this can take a minute or more to complete.  Fig. 50
 Fig. 51 Retrieving module parameters can also be useful as a programming or debugging tool. For example, you have an analog sensor connected to a SECU16 input and you want to see the analog values for various inputs states: put the sensor in one of the input conditions and retrieve the parameters to see the resulting analog value for the sensor. Then modify the sensor’s input conditions and retrieve the parameters again to see the change in analog value. This can be used to establish the range of analog values or simply to test the sensor’s operation. 4.6.5.2Set/Clear RelayUse this utility to manually set or clear an output relay (SECU16 and RLY8XA modules only). Selecting this utility will open the following window (fig. 52):  Fig. 52
4.6.5.3Speak Easy.The Speak Easy utility allows you to record the messages and play them back. The menu selection will open a small utility window (fig 53):  Fig. 53
The detailed procedure for recording messages and playing them back are given in the Speak Easy manual, but here is a summary of the steps involved: 4.6.5.3.1 Recording a Message:· Select the module number of the Speak Easy and the message number to record then click the RECORD button. · The Power LED on the Speak Easy will begin to blink green. · Press and hold the Auto Address/Record button on the Speak Easy. · The Power LED on the Speak Easy will turn to solid green and start recording. · Release the Auto Address/Record button to stop recording. The Power LED will start blinking red. · The Speak Easy will automatically stop recording if the maximum message length is reached. 4.6.5.3.2 Playing a Message:· Access the Speak Easy Module Utility as described in the Recording a message section · Select the module number of the Speak Easy and the message number to play then click the PLAY button. · The message will begin to play and the Power LED will turn solid orange. · When the message is finished the Power LED will return to blinking red. 4.6.5.4ASCII BobcatThis utility allows you to trigger the transmission of an ASCII message from a serial Bobcat. This menu choice open up a window (fig 54) in which you can specify the module # of the serial Bobcat and the message number that you want to send.  Fig 54
The master controller is also capable of transmitting ASCII messages, but that utility is not provided here. This is because the controller access utilities need the controller’s serial port to operate. Transmitting an ASCII message through this same port would conflict with the controller access commands and cause communications error messages. 4.6.5.5Serial MessagesThis pull down menu has two choices, allowing the entering and editing of pager messages and ASCII messages. 4.6.5.5.1Pager Messages.This menu choice is used to enter and edit the alphanumeric pager messages that the controller can be programmed to send (using the THEN Send Page C-Max command). Note that the ADICON modem is needed to use the paging feature. Selecting this menu opens the following window (fig 55):  Fig. 55
4.6.5.5.2ASCII Messages.Use this menu choice to enter and edit ASCII messages that you want to use with either your controller or a serial Bobcat. These messages can be transmitted under program control using the THEN Transmit ASCII Message C-Max command. This selection opens the following window (fig 56):  Fig. 56
Click on the line that you want to edit and enter your text. To enter non-printable ASCII characters, enter a caret (^) followed by the 3 digit decimal value for the character. For example, a carriage return would be entered as “^013” (without the quotes). Always enter the three digits for an ASCII value, using leading zeros if needed. You can enter leading and trailing spaces if you wish, they will be saved as such, although they will not be easily visible in the editor. Such spaces can be useful when you plan on transmitting “long” ASCII messages by sending several strings in succession. The ASCII messages also support embedded formatted variables. The formatting string always begins with a “%” sign and can have several formatting options. See the variable formatting application note in section 5 of this manual to learn how to use the different formatting options. Embedded variables are supported by all ADI controllers and by serial Bobcats with firmware version 6 and above. Once you have finished editing the ASCII messages, they can be downloaded to the controller or serial Bobcat by selecting the appropriate module # in the list box at the bottom of the screen and then clicking on Send To. You can also load and save ASCII messages as disk files on your PC by clicking on the File pull down menu:
|
