Universal Communicator User Manual

Transcription

1 Revision B NKK SWITCHES 7850 E. Gelding Drive Scottsdale, AZ BUYNKK ( ) FAX (480) <engineering@nkkswitches.com> All Rights Reserved Worldwide NKK Switches makes no warranty for the use of these products and assumes no responsibility for any errors, which may appear in this document, nor does it make a commitment to update the information contained herein. Smart Switch is trademark of NKK Switches. for B.doc Page 1 of 22

2 TABLE OF CONTENTS Table of Contents Purpose Applications Controller setup main window Single Picture Download window Switch Attributes window Batch Picture Download window Batch Attributes Download window Switch Data window Sending an image to controller (basic) Sending a manual command to controller (basic) Sending switch attributes to controller (basic) Sending a batch of images to controller (basic) Sending a batch of attributes to controller (basic)...22 for B.doc Page 2 of 22

3 1. Purpose This document is the user manual for 1.4. Both images and attributes can be downloaded. A PC computer with Widows XP, RS232 serial cable, and a comm port between 1 to16 set at is required Available image formats: LCD 36x24 1bit bitmaps. 254 bytes in size. LCD 64x32 1bit bitmaps. 318 bytes in size. OLED 64x48 switch. 24bit bitmap. 9,272 bytes in size. OLED 52x36 display. 64x48 24bit bitmap. 9,272 bytes in size. OLED rocker mono 96x64. 1bit bitmap. 830 bytes in size. 2. Applications Both the 64x32 and the 36x24 LCD s are best used to display simple text or icons representing the commands of the buttons with the colors representing status. The OLED 64x48 SmartSwitch or the OLED 52x36 display are best used for displaying slide shows of multiple images or a batch of images representing a video and adding attribute loops such as those shown below. Such image batches can be obtained through video editing programs such as QuickTime. The attributes and loops are explained in detail in the CL01 Intelligent Controller. The OLED rocker mono 96x64 is best for menus, scale settings or icons. for B.doc Page 3 of 22

4 Table 1, Two OLED 64x48 loops File Name DEC Address HEX Address SW1 SW2 EP1 T1V T2V ClownFish A ClownFish B ClownFish C ClownFish D ClownFish ClownFish ClownFish ClownFish Table 1 shows two loops. One starting at 007AH and ending at 0112H. The second one starts at 007BH and ends at 0113H. The loops run independently without interference between the two. For addresses 0112H and 0113H the 0000H in SW1 and SW2 columns tells the controller to go back to the starting address of the loop. 3. Controller setup 3.1. Controller shall be connected to computer via RS232 serial cable Logic Boards can be attached to Controller in several ways which depend on product. For all possible attachment ways J1 of Logic Board has to be attached to J1 of Controller with pin 1 matching to pin 1. Note: Attaching logic board to controller without matching pin 1 to pin 1 will cause damage Illustration 1 and 2 show two possible ways to attach Logic Boards to Controller Red line of ribbon cable shall be on pin 1 on each header. Illustration 1, Controller and logic board(s) for B.doc Page 4 of 22

5 Illustration 2, Controller and logic board without cable 4. main window Illustration 3, Main window interface This is main window of program Menu Items Single Pictures displays Single Picture Download window used for downloading a single image to controller Batch Pictures displays Batch Picture Download window used for downloading a batch of images to controller Switch Data displays Switch Data window used for inspecting the Switch Data in native format. for B.doc Page 5 of 22

6 Controller Feedback displays a Notepad with feedback from controller since program was started. Clears before first feedback About displays information about program Progress Reports Displays progress of downloading each image, progress of importing an image batch into program, elapsed time, unit time, and progress of downloading an image batch to controller Quit Button exits program. 5. Single Picture Download window Illustration 4, Single Picture Download window This window is used to download a single image, a group of attributes, or to download a command Full File Name select menu Selects image to send to controller Default image is Koala.bmp Import bmp option is used to import bmp files through a file retrieval dialog Displays full name and path of image file Determines information used and displayed depending on size of image file. for B.doc Page 6 of 22

7 5.2. Image Address text box Selects controller address for image to FFFF for OLED versions. 01 to FF for LCD versions Image display Displays short name of image file File Size display Displays file size in bytes of first image file Switch Type display Displays switch type Is dependent on image file size selected in Full File Name text box Picture box display Displays image selected in Full File Name text box Clear button Clears the Manual Command Input text box and Send to / Reply from Controller text box Manual Command Input text box User input of ASCII characters or HEX numbers to write commands for controller One character per nibble Send Manual Command button Sends all text from Manual Command Input text box to controller Spaces and carriage returns are ignored Download Text File button Sends Hex data from text file to controller File must start with RAW DATA for program to recognize it Data must be in Hex format Ignores spaces, line feed and carriage return characters Send to / Reply from Controller text box Check box enables display of transmitted image data. Default is set to disable for faster downloads. Manual command transmitted data are displayed Displays in Hex format Transmit in blue. Receive in black Edit Attributes button Displays Switch Attributes window On/Off image boxes Displays current colors selected for selected image Visible for LCD versions only Download Attributes button Downloads attributes to current address in Image Address text box Address Downloading display Displays current address that image is being downloaded to Comm Port select menu Selects comm port to send data to Available comm ports: 1, 2, Default is comm port 1. for B.doc Page 7 of 22

8 Note: When program is active currently selected comm port is open. Currently selected comm port will close when program is closed Comm Port Speed select menu Selects comm port speed Available speeds: 9600, and Comm State display Displays status of selected comm port Call button Sends command 01 to controller. Controller shall respond with a Query button Sends command to controller that responds with controller type, firmware version, and controller setting (switch type) Reset button Sends command 24 to controller. Controller shall reset Controller display Displays type of controller Firmware display Displays version of firmware on microchip Controller Setting display Displays controller setting (switch type). Note: Before downloading program compares Controller Setting to Switch Type display. If they are different a message box will appear to confirm download. Downloads can be continued or be canceled Controller check box Manually tells program that controller is present or not. Default checked L to R check box For OLED only. Image data is organized in left to right format for newer controllers or right to left format for older controllers. Default L to R Download Selected Image button Sends a command, address and selected bmp image data to selected address of controller Clear Current Address button Makes selected address all black Sends a command, address and blank data to selected address of controller Cancel Download button interrupts current download at end of image Close Form button Closes Single Picture Download window Does not end program. for B.doc Page 8 of 22

9 6. Switch Attributes window Illustration 5, Switch Attributes window for LCD 36x24 This window sets attributes for a single switch. Controls displayed vary depending on switch type selected. Note: For LCD 36x24 LED data will be sent with image data and not with other attributes Select a Color for On Cycle Each slider bar is one of three component colors; red, green, or blue. The mixed color is displayed to right of slider bars Select a Color for Off Cycle Each slider bar is one of three component colors; red, green, or blue. The mixed color is displayed to right of slider bars Image Address text box Selects controller address for image to FFFF for OLED versions. 01 to FF for LCD versions Pointer Module 1 text box (for 2 Switches only) Selects destination address when right button is pushed. Hex 00 to FF for LCD and 0000 to FFFF of OLED Pointer Module 2 text box (for 2 Switches only) Selects destination address when left button is pushed. Hex 00 to FF for LCD and 0000 to FFFF of OLED Pointer Timer 1 text box (for 2 Switches only) Selects destination address when timer 1 ends. Hex 00 to FF for LCD and 0000 to FFFF of OLED Pointer Timer 2 text box (for 2 Switches only) Selects destination address when timer 2 ends. Hex 00 to FF for LCD and 0000 to FFFF of OLED Timer 1 Value text box (for 2 Switches only) Selects millisecond length of timer 1. Hex 00 to FF. for B.doc Page 9 of 22

10 6.9. Timer 2 Value text box (for 2 Switches only) Selects millisecond length of timer 2. Hex 00 to FF Number of Switches select menu Chooses the number of switches the controller has; 2, 8, or 16 switches. The number of attributes downloaded will be adjusted by the number of switches selected. For 8 or 16 switches the text boxes are simply numbered Select button Preserves selected attributes for selected address and closes Switch Attributes window Cancel button Closes Switch Attributes window without preserving attribute information. 7. Batch Picture Download window Illustration 6, Batch Picture Download window This window is used to download a batch of images. for B.doc Page 10 of 22

11 7.1. Switch Type select menu Selects type of switch to be imported and downloaded Updates comm port speed to mach type of switch selected Import Batch button Opens a file dialog window from which user can select a file from a folder from which to import. Any file in a single folder can be selected. All files matching file size as determined by switch type will be imported from selected folder and displayed in Files and addresses list display Files are arranged in ASCII alphanumeric order Updates Batch Picture Download widow with information based on switch type and number of files Assigns an address for each image file imported Folder display Displays full name and path of image file First File display Displays first image file loaded File Size display Displays file size in bytes of first image file Edit Attributes button Displays Batch Attributes Download window Files and addresses list display Displays file titles and associated addresses for all files that were imported Files can be checked or unchecked to select them for download All button Checks all files None button Unchecks all files Invert button Checks all unchecked files. Unchecks all checked files Refresh button Refreshes Files and addresses list display and associated switch information when there are more than 100 files If there are more than 100 files imported Files and addresses list display and associated switch information are not updated until refresh button is pressed. Refresh button will turn red when a refresh is required Estimated Time Left, Elapsed, Unit displays the estimated time left, the estimated elapsed time, and estimated unit time per image. for B.doc Page 11 of 22

12 7.13. Offset Address text box Selects address in controller to send first image and offsets all other images Can take either hex address or decimal offset to FFFF for OLED. 01 to FF for LCD. Use +xxxxx for decimal offset for OLED. Use +xxx for decimal offset for LCD Max Offset display Displays maximum address that can be used for offsetting first image given number of image files loaded Offset button Updates files with selected start address or offset Reverse button Reverses address order. Highest to lowest and vice versa. Includes offset Start Address selection Selects address of first image to download. Includes offset and reverse order Stop Address selection Selects address of last image to download. Includes offset and reverse order and start address Start / Stop button Updates files by checking only files from selected start address through stop address. Removes all previous checked file arrangements Picture box display Displays image currently selected or downloading Address Downloading display Displays current address that image is being downloaded to Comm Port select menu Selects comm port to send data to Available comm ports: 1, 2, Comm Port Speed select menu Selects comm port speed Available speeds: 9600, 19200, and Comm State display Displays status of selected comm port Reset button Sends command 24 to controller. Controller shall reset Controller check box Manually tells program that controller is present or not. Default checked L to R check box For OLED only. Image data is organized in left to right format for newer controllers or right to left format for older controllers. Default L to R Send to / Reply from Controller text box Check box enables display of transmitted image data. Default is set to disable for faster downloads. Manual command transmitted data are displayed Displays in Hex format. for B.doc Page 12 of 22

13 Transmit in blue. Receive in black Clear button Clears the Send to / Reply from Controller text box Download Batch button Downloads checked files data to associated addresses to controller Will give visual feedback about state of download for each file Internal error checking captures controller s reply and looks for 6E errors then tracks failed files. user can reload failed files at end of download batch Download Selected Image button Downloads image data that is selected by user through Files and addresses list display Pause Download / Continue Download button Stops image data download at end of current image. Remembers current file that was being downloaded Continues image data download starting with file that was interrupted by pause button Cancel Download / Cancel Import button Cancels download batch or import batch at end of current image data download or file respectively Close Form button Closes Batch Picture Download window Does not end program. for B.doc Page 13 of 22

14 8. Batch Attributes Download window Illustration 7, Batch Attributes Download window This window is used to set attributes for batch of images. Note: For LCD 36x24 LED data will be sent with image data and not with other attributes Files, addresses and switch attributes display Displays image file name and address Displays switch attributes which can be edited by selecting the edit button Double clicking on the display allows selected image attributes to be edited using text boxes Number of Switches select menu Chooses the number of switches the controller has; 2, 8, or 16 switches. The number of attributes downloaded will be adjusted by the number of switches selected. For 8 or 16 switches the text boxes are simply numbered Only visible for LCD 36x24 LED or LCD 64x32 LED Edit Button Allows selected image attributes to be edited using text boxes Green Arrow sets value Red X cancels change Comm Port display Displays current comm port. for B.doc Page 14 of 22

15 8.5. Comm Port Speed display Displays comm port speed Comm State display Displays status of selected comm port Switch Type display Displays the type of switch Reset button Sends command 24 to controller. Controller shall reset Controller check box Manually tells program that controller is present or not. Default checked Send to / Reply from Controller text box Check box enables display of transmitted image data. Default is set to disable for faster downloads. Manual command transmitted data are displayed Displays in Hex format Transmit in blue. Receive in black Clear button Clears the Send to / Reply from Controller text box Address Downloading display Displays current address that image is being downloaded to Download Batch Attributes button Downloads attributes to controller Download Selected Image Attributes button Downloads image data to address from Files and addresses display Cancel Download button Cancels download Save Attributes button Saves attributes to predefined text file in current folder Close form button Requests to save attributes Exits back to Batch Picture Download window. for B.doc Page 15 of 22

16 9. Switch Data window Illustration 8, Switch Data window This window is used to observe the image data in the switches native format. It can load text files and other types of files that contain properly formatted image data Full File Name select menu Selects image to observe switch data Import bmp option is used to import bmp, text, and other files through a file retrieval dialog Displays full name and path of image file Determines information used and displayed depending on size and format of image file Image Address text box Selects controller address for image to FFFF for OLED versions. 01 to FF for LCD versions Image display. for B.doc Page 16 of 22

17 Displays short name of image file File Size display Displays file size in bytes of first image file Switch Type display Displays switch type Is dependent on image file size selected in Full File Name text box Picture box display Displays image selected in Full File Name text box Save Switch Data File button Saves switch data to a text file Download Switch Data button Sends a command, address and switch data to selected address of controller Cancel Download button interrupts current download at end of image Comm Port display Displays current comm port Comm Port Speed display Displays comm port speed Comm State display Displays status of selected comm port Address Downloading display Displays current address that image is being downloaded to Controller check box Manually tells program that controller is present or not. Default checked L to R check box For OLED only. Image data is organized in left to right format for newer controllers or right to left format for older controllers. Default L to R Send to / Reply from Controller text box Check box enables display of transmitted image data. Default is set to disable for faster downloads. Manual command transmitted data are displayed Displays in Hex format Transmit in blue. Receive in black Refresh button Re-retrieves switch data and displays it Clear button Clears the Send to / Reply from Controller text box Switch Data display Displays the switch data for the currently selected file. for B.doc Page 17 of 22

18 10. Sending an image to controller (basic) Illustration 9, Sending a single image for B.doc Page 18 of 22

19 11. Sending a manual command to controller (basic) Illustration 10, Sending a manual command for B.doc Page 19 of 22

20 12. Sending switch attributes to controller (basic) Note: For LCD 36x24 LED data will be sent with image data and not with other attributes. Illustration 11, Sending Switch Attributes for B.doc Page 20 of 22

21 13. Sending a batch of images to controller (basic) Illustration 12, Sending a Batch of Images for B.doc Page 21 of 22

22 14. Sending a batch of attributes to controller (basic) Note: For LCD 36x24 LED data will be sent with image data and not with other attributes. Illustration 13, Sending a Batch of Attributes for B.doc Page 22 of 22