Home

Qlarity Foundry User`s Manual

1. v IP Address of Unit Enter the IP address assigned to the Qlarity based terminal or select it from the drop down list of recently used IP addresses Download to Multiple IP Addresses If you want to download a user application to multiple terminals on the network select this option Then click the Select IP addresses button that appears The Setup IP List dialog box appears QSI Qlarity Foundry Download Sofrware ro the Terminal Download a User Application Setup IP List 255 255 255 1 255 255 255 2 Cox 255 255 255 3 Cancel Clear List Delete Item 255 255 255 4 Add Enter an IP address in the text box at the bottom of the dialog box and click Add The address is added to the list In the same manner add each address to which you want to download Select an address in the list and click Delete Item to delete an address Click Clear List to remove all of the addresses from the list Click OK when you are done Recently Used IP Addresses Select a recently used IP address from the drop down list to insert it in the IP address of unit box 7 2 Download a User Application When you download a workspace to your Qlarity based terminal it is automatically compiled into binary file format BFF for use as a user application on the terminal The following sections describe how to prepare your Qlarity based terminal for downloading and how to download the user application 7 2 1 Prepare the Terminal f
2. To move an object to a different location in the Object Tree click and drag it to the desired position The icon for the object is dragged to the new location A horizontal placement line as shown in the illustration below appears as you drag the object to indicate the new position at which the object will be placed when you release the mouse but ton QSI Qlarity Foundry Basic Design Design a User Application E af EZBQhe _7 E ag EZBOFTe t_9 af EZBDFText_10 A box appears around a container object as you drag another object over it If you release the mouse button when the box appears the object you are dragging is placed in the container object EH a al EZRectangle_1 e SES VA 2 al EZBitmap 6 If you move a parent object a container object with children the children move with it You can place a container object inside another container object To change the Z order of an object within its family without moving it to a different parent right click the object either in the Object Tree or in the work area and select one of the fol lowing options from the shortcut menu Forward one Move the object forward one position in the Z order one position up the Object Tree Back one Move the object back one position in the Z order one position down the Object Tree Bring to front Move the object to the front of the Z order top of the list of children or top of the Object Tree Send to back
3. Tutorials Code View only Select this option to open the Object Documentation Help file and select a tutorial from the contents About Qlarity Foundry Select this option to identify the version of Qlarity Foundry BFF and the firmware that you are running The Qlarity Foundry toolbar contains icons for commonly used functions Click an icon to open the function Select Toolbar from the View menu to show or hide the toolbar The following sections describe the tools available on the toolbar in Layout View Code View and Simulation View 3 5 1 Layout View Toolbar B 4 iE TH L Ol zoom 100 Theme neon Click to start a new workspace Refer to section 4 1 for information Click to open an existing workspace Refer to section 4 2 for information Click to save the current workspace Refer to section 4 4 for information Click to compile the current workspace into the format required for a user application A workspace also must be compiled to properly display in Layout View Refer to section 4 5 for information on compiling a workspace Click to open the Download Application dialog box Refer to Chapter 7 Download Software to the Terminal for information Select an object in the work area then click to cut the object from the workspace The object remains in the Windows buffer until replaced by another cut or copy operation QSI Qlarity Foundry Getting Started a Zoom 100 Be 5
4. 0 00 e cece eens 81 6 3 8 3 Assignment and Parameters 0 0 0 e eee eee 81 6 3 8 4 Show Global Variables and Functions 00005 81 6 3 8 5 Show Object Properties and Methods 0 020000 82 6 3 8 6 Show for Built In Data Types 0 0 0 82 6 3 8 7 Fade AutoHelp Tips 0 cee eee I 82 GA Compile inns iy ii bise bee ete EN RM MESE 82 iii CowrtNTS 6 5 Simulation Vi Wi dut ane s tone S wee VENE VERE EUR Pp RT We 83 6 5 1 Communications Window Settings 0 0 cee eee eee eee 84 6 5 2 Keypad Settings hosce OD ROUX VR EPOR pe a ee ld 86 6 5 3 Serial Port Setup ose RR Rl ks hag beg ped eh ee te 87 CHAPTER 7 DOWNLOAD SOFTWARE TO THE TERMINAL esee hh 89 7 1 Configure Communications Port 0 0 ee eee ee 89 7 1 1 Serial Port Settings 42 eere eese p ees testae aree e 90 7 1 2 Ethernet Port Settings urna didas ER 90 7 2 Download a User Application 91 7 2 1 Prepare the Terminal for Downloading 0ooooocoocococcoco o o 91 7 2 2 Download the User Application 0 2 cece eee eee ee eee 91 T3 Downloada BRE File cui be pete ee esp ree 92 7 4 Upgrade the Firmware 0 0 eee cece eee eens 94 7 4 1 Determine Current Firmware Version 0 0 00 o 94 7 4 2 Prepare Terminal for Upgrade llle 95 7 4 3 Download New Firmware lees 95 TAA Induce Bootloader irain oe ia VC daft 96 4 5 Set Unit Dimme s
5. 7 3 Download a BFF File You can download a user application that is not currently loaded in Qlarity Foundry to the Qlarity based terminal but the file must be in binary file format BFF Save a file to BFF using the Generate BFF function on the File menu see section 4 6 Select Download Application from the File menu and the Download dialog box is displayed 92 QSI Qlarity Foundry Download Software ro the Terminal Download a BFF File 6 Download application to unit Download Serial Ethernet USB amm i App download size 103802 Port COMI vj Flash required 128 kBytes Baud rate 9600 JE Data Format ge v Download application LLILLLLIL O Send string over serial connection Download other BFF eni Upgrade firmware ar Induce Set unit time heated a Results ee Clear results box Close Window Open serial port whenever this screen is shown Click Download Other BFF and the following dialog box is displayed Select BFF file to download Look in hvac sample Ceibdffonts O bitmaps hvac sample C S Blibraries Cattfonts My Computer My Documents Desktop File name Cancel My Recent Files of type Qlarity application binary files bff All BFF files in the default folder are listed change folders if necessary Click the file that you want to download and click Open A progress
6. The Event Builder dialog box contains the action table that lists all actions assigned to the selected event and the action configuration that contains options to set up each action fw Event Builder ReleaseBtn click event DAR Description 1 Et Set KeyboardScreen s height property equal to HighScoreKeypad s binborder property Action Table Action Configuration P Set to this Value roperty to Set Object KeyboardScreen v Use the value of this object property j as C Property height v Object HighScoreKeypad x Cancel rege ls E Eatin Code View stylemapzz t O Use this explicit value _ Descriptions ions a Set an object property Use this action to set an object property or a global variable You can either set it to a specific value or copy the value of another property or variable Action Table The action table lists all actions configured for the selected event Each action is on a separate line in the table To modify an existing action click the action in the table To add a new action click the last line in the table labeled Click to add action and select the action from the drop down list Then modify or set up the selected action in the action configuration area Action Configuration After you select an action in the action table applicable options are displayed in the action configuration area to set up the action Click OK to accept the event as curr
7. The category directive is only valid when used for a doc prop directive category name gt may be any string that defines a category title This will add category name to the Properties window when an instance of the specified type is selected and the property will appear in that category All properties that share the same category name gt appear in the same category in the Properties window doc prop englishCaption Hcategory Language Data Defines the caption of this object when the English language is selected B 12 Default Items When defining objects you may specify one default property and one default function To edit the default function of an object double click the object in Layout View or the Object Tree and the editor of your choice either Code View or the Event Builder is opened To edit an object s property in the Properties window select the object in Layout View and press lt Enter gt If the default property is of a data type that offers a Select button _J in the Proper ties window click to edit the property in the custom editor for the property default item item type lt item name gt QSI Qlarity Foundry 179 Defininq Border Styles AuroDoc specification lt item type gt is either func or prop lt item name gt is the name of a method or property in the current object template The default item directive is only valid as following a doc obj direc tive doc object buttonv2
8. Workspace Z Order QSI Qlarity Foundry A BASIC like scripting language that is used to write user applications for the Qlarity based terminal Bitmap images fonts audio files and binary data files available for use in an application A root level container that uses the global properties and methods as its properties and meth ods The root container is best viewed as an abstraction It gives you a place to attach all other objects An object that is not attached to a container object is attached to the root container by default The root container is not a true object and cannot be disabled Its area cannot be mod ified The root container is a launching point for newly generated messages This means global message handlers have the highest priority for receiving new messages A user created program that controls the Qlarity based terminal A user application interacts with the terminal s system software firmware to define and control the terminal s display touch screen speaker and input output actions An object method that is implicitly called when the object property of the same name is assigned a value Although the name validation implies that the function is used to validate the value before it is assigned to the property the validation method may be used for any purpose This is a powerful feature of Qlarity because it allows object behavior to be controlled solely by manipulating the object properties A file create
9. endfunc Who do we attach to dim parent as objref init parent default func parent newval as objref parent newval Attach me parent Recalcil v gt Line 21 Col 53 Edit the code and click OK when you are finished to save the changes The Edit Library Entry window has a File menu and an Edit menu with the standard save edit and find options The File menu also contains the following option Save changes to library as hidden code This option gives the developer the option of hiding the source code in the library Once the source code is hidden 1t cannot be viewed or edited WARNING wes Make a copy of the source code before using the Save changes to library as hidden code option Once saved to the library it can no longer be viewed or edited by anyone QSI Qlarity Foundry 59 Edir Libraries Templates Resources and Libraries 5 3 3 2 Rename Entry Click an entry in the list to select it then click Rename Entry to change the name of the selected entry A dialog box is displayed for you to type the new name Click OK to apply the change and close the dialog box 5 3 3 3 Remove Entry Click an entry in the list to select it then click Remove Entry to remove the selected entry from the library A message is displayed warning you that this will permanently remove the entry from the library Click Yes to remove the entry 5 3 3 4 Set Entry Version Click an entry in the list to select it the
10. 109 Design a User Application Basic Design In Qlarity Foundry all objects are displayed in the work area by default whether they are enabled or disabled However you can select the View Only Enabled Objects option on the Tools menu to hide disabled objects 8 3 Design a User Application This section provides instructions for adding and working with object instances in a workspace to create a user application For information on adding opening and saving a workspace refer to Chapter 4 Workspaces 8 3 1 Add an Object Instance You can add object instances to your workspace from the Object Palette or from the Object Tree shortcut menu as explained in the following sections 8 3 1 1 Add an Object From the Object Palette The Object Palette contains a tab for each library in the workspace as well as an All tab and an Other tab Each tab has icons for all of the object templates in the library Click a tab to select an object from the specified library The All tab contains icons for all objects available to the workspace from all of the libraries in the workspace The background color of each icon identifies the library in which the object can be found The Other tab contains objects from various small libraries Refer to section 3 11 for more information on the Object Palette Do the following to add an object instance from the palette l 2 Click the icon of the object you want to add Move the mouse pointe
11. OK enclosed in square brackets Icons on toolbars are represented graphically Click on the toolbar When instructed to type a character or a word it is shown in the Courier typeface e setup Directory paths file names and file name extensions are indicated by italics eventbuilder qly Syntax commands and examples are shown in the Courier typeface dim count as integer CONTENTS QSI Qlarity Foundry CHAPTER 1 INTRODUCTION 5 15 25x hor Cs I RESI EU RC ER eS CES 1 LA Howto Use This Manual cvs esse et ee embed D Fare tone 1 L2 Description gt 233 2524 a o REA LUE a ao dla a 1 CHAPTER 2 INSTALLATION ad e RES i eR PE RE Pen NM IS oe 3 2 1 System Requirements o oooooococoor e eraa 3 2 2 Install Qlarity Foundry o ooooooooorcoonco I II 3 CHAPTER 3 GETTING STARTED 300 A UR ARRA ERR deve NN UE Rane e RA RR RUE E RUE 7 3 1 Start Olarity Foundry i eene rae RE d esee dede 7 3 1 1 Hardware Configuration Assistant lees 7 3 2 Open a Workspace sustraer leed 8 3 3 Man Window esre mili ede ee y er ve entis 10 34 MenuOptions ui recrues a ERRARE eo 11 3 E File Menuc z oe RS Mo RUE E tnl teet ds 12 3 42 Edit Menu A e 13 34 3 View Menu ur es erg ed 14 3 4 4 Tools MednU ooooocoooco e re 15 34 5 Help Menu xe A RUPES CP SIRE S adus gs 17 3 5 Toolbar ua db eg wane tae Ud oues Mi ra ies a e qeu oe E 18 3 5 1 Layout View Toolbar lseleeeeee eee 18 3 5 2 Code Vie
12. SJEJSISIS Y e 3 3 N eh ala of Finer v Compile Output Debug Output eady Y Layout View K 4 Code View Simulation View Compile Output Qu Errors dditional Ne BACK HOME NEXT Share objects you created and download objects others created N ww glarity com Ez x Object Palette EA ss E E BEEGP G NEIBBL BEES SES d BEBO GESERSES SENE ENGS OM P EH EB 3 P EJ SJ BREE BI loss m ELS tg 9 E ES DUI HE E RD E BE S fg ES E S E Ale Object Properties El t name WatchdogTimer gt General J v Main enabled true timeperiod 4 limeunits Qt seconds limertype tt periodic No Error Object Properties Object Events 275 320 All four windows are open by default If one is inadvertently closed you can open it from the View menu NOTE K In the illustration above and elsewhere in this chapter the objects in the Object Palette and Object Tree may differ from what you see in Qlarity Foundry Object names may also be differ ent This is the result of ongoing improvements to Olarity Foundry libraries 8 1 2 Simulate the Terminal Display QSI Qlarity Foundry Qlarity Foundry requires information about the display configuration of your Qlarity based terminal to simulate it accurately in the work area and in Simulation View The settings required for this include the following Display setup including landscape portrait and
13. To add advanced code constructs and to view and debug code in Qlarity Foundry libraries you need to enable the advanced code sections in Code View To display the Advanced Code and Libraries branches in the Object Tree and to make the sec tions available in the editor window click on the toolbar or select Settings from the Tools menu or press lt F12 gt click the Editor tab and select the Show advanced code sec tions in the Object Tree option 147 Validation Functions Advanced Design 10 1 1 Advanced Code The Advanced Code section is intended for advanced users that need more control over how Qlarity code is handled by Qlarity Foundry Code written in this area is treated as if it were written using a basic text editor rather than Qlarity Foundry Qlarity Foundry does not interact with any code authored in this section Normally Qlarity Foundry monitors the code that you type in Code View When you type an advanced code construct such as a declare or define statement Qlarity Foundry performs the action that you typed e g if you type in a define statement Qlarity Foundry removes the define statement and creates an object template In the Advanced Code section this monitoring is disabled and you can type in advanced code constructs without interference If you use the declare statement to create an object the object will be created and displayed in the Layout and Simulation Views but will not appear in the Object Tree no
14. While the terminal renders TrueType fonts fast enough that the difference in drawing speed is rarely noticeable you might consider using BDF fonts for display items that will change their text frequently such as items that are frequently polled from a remote device Copyright Many fonts are copyrighted Be sure to purchase or obtain permission to use a copyrighted font in your user applications Some Qlarity based terminals have an audio decoder option that enables them to play wave form audio files If your terminal supports an audio decoder you can add audio files in the wav format to your workspace You can play the audio files using the PlaySound API func tion Binary resources are files that you want to add to your user application unchanged For exam ple you could use a binary resource in your application if you wanted the Qlarity based termi nal to communicate with an embedded device with no PC connection You could for example add a configuration or firmware file to the application as a binary resource file and then use the GetBinaryResource API function to download the file from the Qlarity based ter minal to the embedded device when the application is running Edit Libraries QSI Qlarity Foundry Object libraries are provided by QSI and other sources to assist you in designing user appli cations Each library contains several predefined Qlarity objects This enables you to add object instances to your workspaces w
15. af LevelBanner c B amp af SideBar ms amp af ContrastDarker ms amp af ContrastLighter sf BorderLineRight sf BorderLineBottom sf BordeiLineL eft of BorderLineT op R af LevelDesigner gi Internal To add a new object instance to a workspace you can right click Globals and select New Object Instance from the shortcut menu or use the icons on the Object Palette QSI Qlarity Foundry Getting Started Layout and Code Views If any global code has been written for the workspace you can click Globals and see the prop erties associated with the global code Global properties apply to the entire workspace 3 7 2 Internal The internal branch of the object tree contains objects that are automatically created by Qlarity Foundry as it manages other objects such as the SoftKeyBar object Normally you will not edit or modify these objects directly 3 7 3 Object Templates A Qlarity program consists primarily of objects An object template contains the programming code that defines the object and how it behaves Once object templates are created any num ber of object instances based on the template can be added to a workspace Each object instance in a workspace must be associated with a template You will create object templates only if you are an advanced user Most users create object instances from predefined templates in libraries NOTE K Object templates in libraries are not li
16. and APIs in the workspace Documentation is included for all libraries provided with Qlarity Foundry Advanced users can add documentation for object templates they create refer to section 10 5 3 Adding Object Template Documentation for information To use Object Documentation in the Qlarity Documentation index double click the item for which you want to view Help You can also type a keyword in the text box to search for an item then double click the item in the keyword list Show Qlarity Language Help Ctrl F1 Select this option or press lt Ctrl gt lt F1 gt to view the Programmer s Reference Help file The Programmer s Reference provides information on the Qlarity programming language and mes sage handling system detailed information on the syntax to write programs in the Qlarity lan guage descriptions of system messages a Qlarity API Application Programming Interface function reference and other information on programming in the Qlarity language 17 Toolban 3 5 Toolbar 18 Getting Started Show Qlarity Foundry Help Shift F1 Select this option or press lt Shift gt lt F1 gt to view the Qlarity Foundry Help file The Help file provides the information in this Qlarity Foundry manual so that you can access it online while you are working in Qlarity Foundry Sample Workspaces Code View only Select this option to open the Object Documentation Help file and select a sample workspace from the contents
17. box Select the object you want to copy from the drop down list Refer to the Pro grammer s Reference Manual for more information on extending templates In the Template Name box type a name for the new template Each template in the workspace must have a unique name A template name has no size limitation but must start with a letter A name cannot contain spaces but may use the underline character _ The percent 46 pound and dollar sign symbols can be used at the end of the name The last box is labeled either Object Type or Based on depending on the option you selected QSI Qlarity Foundry Templates Resources and Libraries Add Edit Templates In the Object Type box select the type of object you are creating from the drop down list as follows An object that contains other objects e g a form It can be ntainer Con defined as part or all of the terminal screen A display element e g text object bitmap object line Area object object etc An object that serves a function not related to the display Non drawable object mae ae J e g key definition communications etc For more information on object types refer to Chapter 8 Basic Design and to Appendix A Glossary of Software Terms In the Based on box select the library object on which the new object template is to be based The programming code from the library object will be cop
18. 1 endfunc 5 Repeat steps 3 and 4 for as many functions as desired 6 Press or select Compile from the File menu to compile the workspace Any errors in the new source code are identified by messages in the Messages and Errors window If no errors are present the compiled workspace is returned to Layout View 9 5 3 Add a Global Message Handler to a Workspace Message handlers are functions that are called by the system in response to a message gener ated by an event Examples of such events are a touch screen press or the receipt of characters through a serial port There are two methods for adding message handlers in the Global Code space as follows QSI Qlarity Foundry 141 Global Code Intermediate Design Use the Message Handlers drop down list at the top of the Code View window easiest method Enter the message handler directly into the Global Code section in the Code View window 9 5 3 1 Add a Global Message Handler From a List Do the following to add a global message handler from the Message Handlers drop down list 1 Click the Code View tab 2 Click Globals in the Object Tree to open the Global Code section Any current global source code is displayed in the editor window 3 Ifyou want the message handler inserted at a cursor location select Insert at Cursor then click in the editor at the location where you want the handler inserted If you do not select this option the handler will
19. 3 2 Move Resize and Reorder Objects 112 NOTE To select an object to move resize or reorder click on it The selected object is outlined with a colored box You can only select one object at a time You cannot move or resize a locked object Press Tab to move forward from object to object in Z order Press lt Shift gt lt Tab gt to move backwards 3 When you press Tab the Properties window changes to match the newly selected object 8 3 2 1 Move an Object To move an object do one of the following Use the mouse Click in the center of the object hold down the mouse button and drag the object to a different position You can hold down the Shift key while moving an object to limit its movement to horizontal vertical or a 45 angle Use the Properties window Enter a new x and or y position integer in the Properties win dow 8 3 2 2 Resize an Object To resize an object do one of the following Use the mouse If the object has resize grips sizing handles you can click and drag any grip to resize the object Click and drag a corner grip to maintain the height width propor tions while resizing Resize Grips lt Buttoni Use the Properties window Change the height and or width integer in the Properties win dow 8 3 2 3 Change the Order of Objects You can change the Z order of an object or the parent child relationship simply by changing the object s position in the Object Tree
20. 3 Change the Order of Objects 112 8 3 2 4 Align Size Space Objects 0 0 eee eee eee eee 113 8 3 3 Change an Object s Properties 0 0 eee eee eee 115 iv QSI Qlarity Foundry CowrtNTS 8 3 3 1 Select Color c o di Dp 117 8 4 Event Builder ocio lel tirida d Todea a X MR 119 8 4 1 Overview of Event Builder Steps 0 0 0 eee eee eee 119 8 4 2 Event Builder Dialog Box lleleeeeeee eA 120 8 4 3 Select and Configure Actions oooooooooccncooo o 122 844 3 1 Select Acti nS i see ung PA RM LY ROM EIOS Man Mte 122 8 4 3 2 Configure Actions liess 123 8 4 4 Load Event Builder Sample Workspace 0 000000 02 eae 126 844 1 Tank Demo 5 522 entrer p pb pe NE e dira 127 8442 Toggle Demo i55 vive i 127 8 4 4 3 Keypad Demon ai a i e r T aa ren 128 8 4 5 Qlarity Code and Event Builder 0 0 cece eee 128 8 4 6 Troubleshooting o crcs ee crides iee I 128 8 5 Communication Objects 0 oa E i e es 129 8 5 1 Serial Objects 22 lor aa e a v 129 8 32 Bthernet Objects lap ee Rr re e 129 85 3 Receive Data sole RUE br ERU ERE ERR re 131 8 6 Test the User Application seeeeeeeeeee e 131 8 7 Save and Compile a Workspace 0 0 eee cece eA 132 8 7 1 Save a Workspace osc ed Seen a ea ea 132 8 7 2 Compile a Workspace 132 8 8 Download a User Application 132 CHAPTER 9 INTERMEDIATE DESIGN 455 ok hes A is AE FER EA RR Rus 133 9 T V
21. Basic glib loaded sys2 10 Basic exexceptiondisplay lib loaded sys1 00 ExExceptionDisplay libraries exangletext lib loaded v1 00 Ex ngleT ext libraries exradiocheck lib loaded v1 00 ExRadioCheck1 common lib loaded sys1 52 common progobjs lib loaded sys1 52 progobjs Edit Library Remove library Create new library Add existing library Advanced Close Entries Templates ie i Y AngleTexty2 nimatedlmage SA Anil ClockDisplayW2 S AnimatedlmageV2 ClockSet 2 ColorPickerv2 directionpady2 DisplayFadeV2 DisplaySetting 2 ellipsev2 emptyimage GroupBox Source Source Source Source Source Source Source Source Source Bitmap Source lt isplaySettingv2 lipsey2 JGroupBoxVv2 2 IconButtonv2 PAddressEntry V2 EF ColorPickerw2 DirectionPadV2 L4 DisplayFadeV2 Click Add Library to add a new library to the workspace Click Remove Library to remove the selected library For additional information on libraries refer to section 5 3 8 1 5 1 Libraries Provided with Qlarity Foundry QSI Qlarity Foundry Qlarity Foundry includes libraries of object templates that allow you to create interactive complex user applications without entering any programming code After you add one or more of these libraries to a workspace you can change the object properties to customize the object instances in your user application Two of the libraries provided with Qlarity Foundry that are used a
22. Libraries Edit Libraries Edit Library Path c backup glaritisamples samples hvac sample libraries exradiocheck lib Name EAS i Icon Foreground Icon Background O Version 1 00 Warning Any changes you make to libraries may affect other projects Additionally any changes will take effect immedediately and cannot be undone Entry Name Entry Type Version ExCheckBoxBDF Source 1 00 ExCheckBoxTTF Source 1 00 ExRadioButtonBDF Source 1 00 ExRadioButtonT TF Source 1 00 Add New Entry 5 3 4 3 System Libraries Not Explicitly Included in This Workspace A system library is one that resides in the same directory as the QlarityFoundry exe executable file Some system library template code may rely on templates in other libraries This is com mon when extending templates If the other libraries are not available to the Qlarity compiler compile time errors will occur The drop down list at this field contains options to indicate how to include system libraries that are not specified in the workspace Do not include If you select this option other system libraries are not included If code in one library relies on code in another library that is not included in the Qlarity workspace the compiler will generate errors Include as reference If you select this option a reference to all system libraries in your workspace is included A library that is included as a reference is available to the Qlarity compiler but wi
23. Move the object to the back of the Z order bottom of the list of children or bottom of the Object Tree 8 3 2 4 Align Size Space Objects NOTE I QSI Qlarity Foundry This option provides several tools for aligning sizing and spacing a group of objects in the workspace Before selecting a tool select the group of objects you want to manipulate using one of the following methods Click and drag to create a selection box that encompasses all of the objects you want to select To cancel the box click outside it e Press and hold Ctrl or lt Shift gt and select objects either by clicking on them in the work space or by clicking on their names in the Object Tree When aligning or spacing objects all selected objects must share the same object parent i e must be in the same terminal screen When sizing objects all selected objects must have a width or height property 113 Design a User Application Basic Design With the group of objects selected either right click one of the selected objects in the work area or pull down the Tools menu and select Align Size Space Objects If you are aligning or sizing the objects they will be aligned or sized with the actively selected object in the group To make an object active do one of the following Right click the object to select Align Size Space Objects from its right click menu Press and hold lt Ctrl gt while you click the object in the workspace or the Object
24. Popup help background Popup help border Help accent color You can specify that keywords strings symbols comments or errors appear in colors differ ent from normal text to assist in finding and identifying them within the code QSI Qlarity Foundry Olariry Foundry Preferences Ediron 6 3 2 6 3 3 6 3 4 6 3 5 6 3 6 QSI Qlarity Foundry Font Click an item to display its color in the Sample Text box Double click an item or click Set Color to change the color A color selector dialog box appears Click a color in the basic col ors section to select it To create a custom color drag the color selector in the rainbow palette to a color and then drag the slider up or down to adjust the saturation and lightness of the color or enter the HSL or RGB of a color Click OK to change the item to the selected color Automatic Color Click an item then click Automatic Color to set the color to the automatic color Reset All Colors to Default Click Reset All Colors to Default to set the color of every item to the Qlarity Foundry default From the Font drop down list select a font for the text in Code View A sample of the font is shown in the Sample Text box From the Point Size drop down list select a point size for the selected font The Sample Text reflects the selected point size Tab Spacing Enter the number of characters or use the selection arrows to select the number to be indented when y
25. The new library file is created and added to the Qlarity Foundry folder Use the Edit Library function to add entries object templates and resources to the library see section 5 3 3 5 Add New Entry for information You can also add new object templates to a library using the Send Template to Library option in Add Edit Templates see section 5 1 5 for information 5 4 Edit Named Colors You can use named colors and themes to simplify the process of assigning fill and line colors to objects Rather than manually selecting a color from a palette for each property of an object you can assign one named color to one or more properties of an object and to any num 64 QSI Qlarity Foundry Templates Resources and Libraries Edit Named Colors 5 4 1 Themes QSI Qlarity Foundry ber of objects in the workspace This improves color matching and helps to control the range of colors used For example you can assign a named color to several objects and then change the color of all those objects at the same time by simply changing the color of the named color You can also assign colors to properties without using named colors if you choose Qlarity Foundry includes several predefined named colors with each new workspace e g Clr_ScreenBackground and Clr_ScreenForeground Clr_ButtonBackground and Clr_ButtonForeground and so on You can create as many additional named colors as needed for a workspace e g Clr StartEndB
26. The size of the three arrays xCoords yCoords and cursors determines the number of resize grips that will be drawn All three arrays should be sized to the same value The boilerplate code sizes these arrays to 8 so 8 resize grips will be drawn for the object The code then locates the grips on the perimeter of the object at locations calculated from the posi tion and size properties Qlarity Foundry draws lines to connect each resize grip The closed parameter determines whether a line connecting the first and last grips will be drawn Ordinarily this is desirable However certain objects such as the Line and PolyLine objects in the QSI Common object library do not enclose a space on the screen and the last line is not desirable A value of TRUE causes this line to be drawn This property also determines whether clicking inside the object will select it in Layout View The code for the MSG_TOOL_MOVEHANDLE handler is as follows This function is called in response to a user moving a gt resize grip within Qlarity Foundry handleNum is the index into gt the arrays that were returned by the handler for gt MSG TOOL GETHANDLES You should return true from this function func ToolMoveHandle handleNum as reference to integer dx as integer dy as integer handles MSG TOOL MOVEHANDLE dim newX newY newWidth newHeight tmp as integer newX xPos 162 QSI Qlarity Foundry Advanced Design Create a New Object T
27. Window The Qlarity Foundry main window is shown below F Olarity Foundry 2 60 Now Workspace Globals Ele Edt Yew Took Heb ar PRA HL do n d EDE iud OL Gh zoom 100 di Theme neon T B Toolbar Object Tree AN X Basic Y DataProc Y Extra Y other V Ik 2 C4 E3 Gd EB E C3 A y A E gi ES EN sH O gf ExcepliorDisplay 3 PETTITT af KeyTranslator gt af Keypediellings A E al ScieonSaver o intend Object Tree NL LEER CERANG S O s M0 1542 o 9 83 eG H omms B 20 BS UN E D D gt EEXUO ES B 8S EEA E d a a er ds O Work Area bed Palette delaull tone default default toneetroc default Properties window Layout View Code View Simulation View View Tabs Compite Output Bro Errors B Messages and Errors window Compile Output Debug Output Object Properties Object Events Status Bar No Error 53 73 Ready Menu Bar The menu bar contains the File Edit View Tools and Help menus Refer to section 3 4 for a brief description of the menu options You can access all Qlarity Foundry options from the menus Toolbar The toolbar contains tools that provide quick links to commonly used Qlarity Foundry func tions The tools available change depending on the selected view mode Layout View or Code View Refer to section 3 5 for a description of each tool on the toolbar 10 QSI Qlarity Foundry Getting Started Menu O
28. a new screen saver from the Screen Saver drop down box When you are done click Finish to proceed The default workspace name is New Work space until you save it with a new file name The Object Palette includes tools to create all of the objects contained in the supported libraries You can add or remove resources and libraries after the workspace is created using the options on the Edit menu Refer to section 5 2 Edit Resources and section 5 3 Edit Libraries 39 Open a Workspace Workspaces 4 2 Open a Workspace To open a workspace click on the toolbar or select Open Workspace from the File menu The following dialog box is displayed Select workspace to open C3 samples Communications evs cg Demo eventbuilder demo games hvac sample Bother D basic_keyboard qly 23 basic_serial_communication qly 2 dns_ethernet_client qly 2 ftp_client_interface qly O listbox_alarms aly Dpassword _protected_screen qly Qlaritylnvaders 2j DataProc File name Files of type Qlarity files qly Cancel Workspace files have a qly extension All workspace files in the default folder are listed change folders if necessary Click a file to select it and its name is displayed in the File name field Click Open to open the workspace You can also double click a file name to open it If you select a workspace that is open in another instance of Qlarity Fou
29. and open a new workspace Revert Workspace Select this option to discard any changes made to the workspace and restore it to the last saved state Save Workspace Use this option to save the current workspace Refer to section 4 4 for information Save Workspace As Select this option to save a copy of the current workspace to a different file name The Save As dialog box is displayed Enter the new file name the extension is added automatically and click Save Collect for Output Use this option to transfer a workspace to another computer See section 4 4 3 for information Compile Layout and Code View only Use this option to compile the current workspace into the format required for a user applica tion A workspace must also be compiled to properly display in Layout View Refer to section 4 5 for information on compiling a workspace Generate BFF File Layout and Code View only You can download a user application that is not currently loaded in Qlarity Foundry to the Qlarity based terminal but the file must be in binary file format BFF Use this option to save a file to BFF Refer to section 4 6 for information Download Application Layout and Code View only Select this option to download files to the Qlarity based terminal You can download the cur rently loaded workspace any BFF file or a firmware upgrade Refer to Chapter 7 Download Software to the Terminal for information Recent Files After you have cre
30. assignment and parameters will always display constant values for user defined data types You can also configure AutoHelp for assignment and parameters to display addi tional items if desired Global Variables and Functions Select this option if you want AutoHelp to add appropriate global variables and functions with return values to the lists displayed 81 Compile Olariry Foundry Preferences 6 3 8 5 Show Object Properties and Methods Select this option if you want AutoHelp to add object properties and methods to its lists This option may make the completion list quite large 6 3 8 6 Show for Built In Data Types By default AutoHelp does not show completion results for built in data types such as integer and float Select this option if you want AutoHelp to show the completion results for built in data types 6 3 8 7 Fade AutoHelp Tips 6 4 Compile 82 Only available in Windows 2000 and Windows XP Select this option if you want the Auto Help display window to fade out as the mouse pointer approaches it This allows you to view the code under the AutoHelp window without closing AutoHelp Before you download a workspace to the Qlarity based terminal it must be compiled into the format required for a user application Compiling is also required to update modifications made in Code View before they can be seen in Layout View Click the Compile tab to set up the options for compiling Qlarity Foundry Preferences Ter
31. bin fosa 2 591a bin 48 Falose 2 600 bin VER ipiam 3 3 070_2 600 bin LD 54 xz0_2 5908 bin 33x70 2 591a bin My Documents xo OR Desktop 4 File name My Recent Files of type Qlarity firmware binary files bin 4 Select the firmware software file to be downloaded and click Open A progress graph tracks the download Messages in the Results box indicate whether the download was successful 96 QSI Qlarity Foundry Download Software ro the Terminal 7 4 5 Upgrade the Firmware When finished the new firmware version is shown in the Results box 6 Download application to unit Serial Ethemet USB Download App download size 103802 Flash required 128 kBytes Port COMI SEES Baud rate 9800 Data Format Bel m Download application Send string over serial connection Download other BFF s Induce Set unit time mer Upgrade firmware Results Ap de NOTICE received request from kemel to enter bootloader Entering OSI Bootloader V1 014 Bootloader entered USI Bootloader V1 U14 Built Jan 20 2003 at 17 22 15 Neceived new kernel 200626 bytes pde M Clear results box Close Window pen serial port whenever this screen is shown Set Unit Time Use the Set Unit Time function to set the real time clock on the Qlarity based terminal as fol lows 1 The terminal must be in download or develop mode If necessary set up the Qlar ity based
32. bitmap or font enter the location of the resource file Click Browse to find the file if necessary Click OK to continue If the library entry is a source object template a message is dis played explaining that Qlarity Foundry will insert a blank entry in the library To enter the pro gramming code for the object template select the new entry and click Edit Entry You can also add new object templates that you have already created with the Send Template to Library option in Add Edit Templates see section 5 1 5 for information 5 34 Advanced Click Advanced to display the advanced options for editing the standard and core libraries Advanced Library Options Edit standard natives lib Edit core core glib qhide System libraries that are not explicitly included in this workspace 1 Include as reference recommended v 5 3 4 1 Edit Standard natives lib QSI Qlarity Foundry In addition to native API functions as described in the Programmer s Reference Manual the standard Natives library natives lib contains several utility functions written in the Qlarity language To make these functions available type the following in the Globals section of your workspace library standard source lt entryname gt 61 Edir Libraries Templates Resources and Libraries entryname is the name of the library that contains the additional API functions you want to use To determine the entry i
33. cannot modify the settings in this tab in Simulation View Base Terminal To change the type of Qlarity based terminal you want to program select the new terminal type from the drop down list The type of terminal selected determines the legend you will see around the display in Layout View The display Dimensions setting changes to match that of the selected terminal 6 1 1 Display Setup Dimensions From the drop down list select the display dimensions in pixels of your model of Qlar ity based terminal Refer to your Qlarity based terminal specifications for this information Orientation A terminal may be mounted in landscape longest dimension is horizontal or portrait longest dimension is vertical mode Select one of the following options from the drop down list Por trait Landscape Portrait Il or Landscape ll The Portrait Il and Landscape Il options can be used by advanced programmers in conjunc tion with the GetSystemSetting API to modify the behavior of workspace objects in Simula tion View based on the display orientation of the target terminal Most users should select Landscape or Portrait Display Type Select one of the following options from the drop down list to indicate the type of display on your terminal Color Color TFT Color Enhanced TFT Grayscale Transflective or Gray scale Transmissive The Color TFT and Color Enhanced TFT options can be used by advanced programmers in conjunction with t
34. columns are defined a string column called Item Title which is 200 pixels wide an integer column titled Minimum Value in which values between 0 and 100 are accepted for entry the column will have a default width based on the column title and the default value for the inte gers will be 100 and the final column Item Color will be of default width and its type is color There are no restrictions on what colors may be selected but the default color is 3 blue 178 QSI Qlarity Foundry AutoDoc specification Sample Code B 10 Sample Code You may specify sample Qlarity code for any item you are documenting Sample code lines begin with the right pointing double angle quotation mark character The easiest way to generate sample code is to author and test the sample code then select the code in Qlarity Foundry and select Mark selected code as sample from the Tools menu doc func Min param iteml The first item to be compared param item2 The second item to be compared Returns the minimum value of its two parameters func PrintMinimum gt Print The minimum value is str Min 9 9 7 5 endfunc The preceding example would print out i The minimum value is 7 5 i B 11 Property Categories When authoring your own objects you may wish to specify the category for the object s prop erties in the Properties window To do this use the category directive Hcategory category name
35. defined in the object template but each object instance may override some of the object template s methods Methods define the behavior of an object at runtime and typically either manipulate or depend on the values of the object s properties A function in an object instance that overrides or replaces the method defined in the object template Each object instance may override some of the template s methods The override function has the same name and parameters as the template method and the code in an over ride may call the template method if desired An object that has a purpose not directly related to the terminal display Examples of non drawable objects include communication event and keyboard objects The basic unit of a user application You define objects by type with each type representing a display element button or other function Properties and methods define what an object is and how it behaves Object types may take many forms and serve any number of purposes Object types fall into three categories container objects area objects and non drawable objects For the display it is the Z order or the order in which objects are layered For messaging it is the order in which objects are prioritized The top object in the object hierarchy receives the highest messaging and display priority i e it is on top of other objects However any enabled objects regardless of their position in the hierarchy may rece
36. display a grid over the work area to help you more accurately place and align objects Enter the space between grid lines in pixels between 2 and 25 Show Grid Select this option to make the work area grid visible Snap to Grid Select this option to force objects to snap to the nearest grid line when added or moved This is useful for more accurate placement and alignment of objects Preview while dragging only available in Windows 2000 and Windows XP This option controls the way objects appear while dragging them with the mouse to move them in Layout View If selected a pre view of the object in the new location is displayed If not selected an outline of the object is displayed Time the mouse must be held This setting determines how long in milliseconds the redraw function is delayed when drag ging an object For most systems the default should be optimum If you need to increase or decrease the time interval enter a new value Highlight object under the mouse If this option is enabled each object s outline is highlighted as you move the mouse pointer over it If disabled an object s outline only appears when you click it Show data types in properties window If this option is enabled the data type of each property integer color string boolean bdf font etc is shown in the Properties window Show pop up help for objects and properties If this option is enabled a Help pop up appears when you move t
37. from a drop down list Transparent true false You can edit property values by clicking the property you want to edit Many properties have a drop down list from which to choose a valid entry You may also type in a value Click amp to group or ungroup the properties by category Click to toggle between sorting the properties alphabetically or by the order defined by the object s author Click to show or hide the data type for each property You can close the Properties window by clicking the Close button Kl Normally however you will want to keep the Properties window open QSI Qlarity Foundry Getting Started Object Palette 3 11 Object Palette The Object Palette contains a tab for each library in the workspace as well as an All tab and an Other tab Each tab has icons for all of the object templates in the library Object Palette ax Click a tab to select an object from the specified library The All tab contains icons for all objects available to the workspace from all of the libraries in the workspace The background color of each icon identifies the library in which the object can be found The Other tab contains objects from various small libraries For more information on object libraries refer to section 5 3 Edit Libraries Move the mouse pointer over an icon to display the object s name and description Click to place the mouse pointer in select mode In this mode click an existing
38. function lt name gt doc override lt name gt only use this if the function is gt designed to be overridden This documents an object itself doc object lt name gt To enter a description of an item begin each line of the description with a tilde doc object buttonv2 The ButtonV2 object is a versatile object that responds to gt touchscreen input When you touch an instance of the ButtonV2 object the gt function called Click is called The tilde must be the first non whitespace character on the line otherwise it is treated as a comment When documenting a function you can add parameter documentation as follows doc func CalcFactoral param toCalc The function calculates the factoral of this parameter CalcFactoral calculates the factoral of its parameter The gt factoral of n written n is defined as n n 1 n 2 gt Ro 1 func CalcFactoral toCalc as integer returns integer endfunc QSI Qlarity Foundry Advanced Design Guidelines for Designing New Object Templates Note that param lines must be completed in one line You cannot use the line continuation character to extend them to more than one line 10 6 Guidelines for Designing New Object Templates This section contains advice and collected wisdom regarding the design of new Qlarity object templates Designing good object templates is the most complex task in Qlarity programming Once this skill is ma
39. grayscale color Keyboard or valid input devices type of key input used with your terminal 101 Prepare Olaniry Foundry for Application Desiqn Basic Design Touch key legend border around the edge of the touch screen for a QSI standard touch key legend enable if you are using a touch key legend disable if you are not Simulation setup volume in Simulation View and Communications window defaults The Communications window simulates the data received and sent via the communications port Click on the toolbar or select Settings from the View menu The Qlarity Foundry Prefer ences dialog box is displayed Qlarity Foundry Preferences Terminal Layout Editor Compile Simulation Hardware Configuration Assistant Input Keyboard Base Terminal QTERM G75 Y Keypad i v Display Setup TouchScreen Dimensions Communications d M Number of serial ports 2 mi Orientation Misc Landscape gt Manufacturer ID MID 65535 Display Type E Ethernet Audio Decoder C Battery C Wireless network C Printer Tabs are available to define your Qlarity based terminal display to define the layout of the Qlarity Foundry work area which includes the QSI standard touch key legend setting to set up compile defaults and to set up the Simulation display Refer to Chapter 6 Qlarity Foundry Preferences for more information 8 1 3 Drawing Aids 102 a Zoom 100 When arranging the graphical objects on
40. have a bff extension In Qlarity Foundry you use a workspace to define functions for the terminal at the Qlar ity based terminal you use a user application to perform the functions When a workspace is compiled into a user application the Olarity interpreter initializes the user application in Qlarity Foundry so you can see the results You can then download the user application to the Qlarity based terminal 8 2 2 Qlarity Objects 106 A user application is constructed of Qlarity programmed objects An object instance is an occurrence of an object in the user application An object template contains the programming code that defines an object When you create a basic design you will use objects from existing libraries several libraries are provided with Qlarity Foundry There are three types of objects as follows All three types of objects can be found in QSI libraries Non drawable object An object that serves a function not related to the display e g key definition communica tions etc Area object An object that can be represented visually on the terminal display An area object might be any of the following Bitmap an imported bitmap image Lines circles or rectangles may include custom borders and fill colors Text labels headings or a field where text may be typed or displayed Resources bitmaps and fonts are required for text and bitmap objects Container object An area object that contai
41. in the same workspace or in a different workspace In Code View select this option or press lt Ctrll gt lt V gt to place cut or copied code at the cursor position in the same or a different workspace or in a different Windows application Find Code View only Select this option to find code in the displayed object instance template or workspace Enter the characters or code you want to find and click Find Next To find only characters match ing the entered case upper or lower select Match Case To search through all object instances and templates in the workspace select Entire Workspace Replace Code View only Select this option to find code in the displayed object instance or template and replace it with specified code In the Find What field enter the characters or code you want to find In the Replace With field enter the code with which you want to replace it Click Find Next to find the code Then click Replace to replace it Or click Replace All to automatically find and replace all occurrences of the code To find only characters matching the entered case upper or lower select Match Case Undo Select this option to undo the last action performed QSI Qlarity Foundry 13 Menu Options Getting Started Redo Code View only Select this option to redo the most recent undone action This option is only available after you have selected Undo in Code View Go to Bookmark Code View only Select t
42. into the format required for a user application A workspace also must be compiled to properly display in Layout View Refer to section 4 5 for more information Click to open the Download Application dialog box Refer to Chapter 7 for information Select code then click to cut the selected code from the workspace The code remains in the Windows buffer until replaced by other cut or copied code Select code then click to copy the selected code The code remains in the Windows buffer until replaced by other cut or copy operation Click to place cut or copied code into a workspace or another Windows application at the cur sor position Click to undo the last action performed Click to redo the most recent undone action Click to go to the next bookmark in the displayed object Use the Toggle Bookmark tool to add bookmarks to an object s code Click to add or remove a bookmark in an object s code at the cursor location Bookmarks make it possible to find a location quickly which is useful in objects with several lines of code Click to open the Add Edit Templates dialog box to add or edit an object template Refer to section 5 1 Add Edit Templates and to Chapter 10 Advanced Design for information on creating templates Click to open the Edit Resources dialog box to add resources to or remove them from the workspace Refer to section 5 2 Edit Resources for information Click to open the Libraries dia
43. object to select it The pointer remains in select mode until you click a different icon Click to place the mouse pointer in scroll mode If the layout scale is larger than the work area use the scroll mode to view the parts of the workspace that are not visible Click 2 then click anywhere in the work area and hold the mouse button as you drag in the direction you want to view When the section you want to view is visible release the mouse button The pointer remains in scroll mode until you click a different icon or exit the work space You can close the Object Palette by clicking the Close button x or you can show or hide it by clicking Object Palette on the View menu 3 11 1 Add a New Object Instance Do the following to add a new object instance from the palette 1 Click the icon of the object instance you want to add QSI Qlarity Foundry 33 Move and Resize Windows Getting Started NOTE 2 Move the mouse pointer to the work area The pointer changes to a cross hair 3 Click and hold the mouse button and drag the mouse to draw a rectangle in the work area Then release the mouse button Some objects have a default starting size and shape so the size of the rectangle doesn t matter only its position in the work area The size of other objects such as a line or rectan gle is initially determined by the size of the rectangle you draw Ex To add more than one instance of the same type of object pres
44. objects If this option is enabled the workspace is compiled so that all text is drawn using the Unicode character set This option is primarily used when developing Qlarity applications that support non Latin based languages such as Chinese or Japanese To use the extended characters in the Unicode character set you must include one or more fonts in the workspace that contain the Unicode characters that you want to display There are many such BDF and TrueType fonts available on the Internet When Unicode support is enabled Qlarity Foundry treats the charstr data type as a unistring rather than a string Since most objects value or caption properties are of type charstr string or byte array data must be converted to a charstr before they can be displayed in an object This includes all data received from a serial or Ethernet port as well as many API functions such as Str Also data in objects must be converted to strings before they can be transmitted out the serial port You may use the _StrToCharstr and _CharstrToStr functions to convert between string types For more information press F1 to view Object Documentation refer to section 3 4 5 Help Menu Start in Layout View If this option is enabled a workspace is compiled as soon as you load it If you typically work in Layout View you will want this feature enabled If you work more often in Code View or your workspace has errors that haven t been corrected yet you may
45. objects to specify the object s background and foreground colors Refer to section 5 4 for information Edit Named Borders Layout View only Select this option to define named borders You assign named borders to objects to specify border attributes Refer to section 5 5 for information 3 4 3 View Menu 14 Toolbar Select this option to show or hide the toolbar Refer to section 3 5 for information Status Bar Select this option to show or hide the status bar at the bottom of the main window QSI Qlarity Foundry Getting Started Menu Options Control Windows Select this option and a sub menu is displayed listing the windows and palettes that are avail able in the current view Select an option from the sub menu to display or hide the specified window or palette Refresh Layout View and Simulation View only Select this option to redraw the graphics on the screen in Layout View Layout View Select this option to switch to Layout View Code View Select this option to switch to Code View Simulation View Select this option to switch to Simulation View 3 4 4 Tools Menu NOTE I NOTE IE QSI Qlarity Foundry View Only Enabled Objects Layout View only Disabled objects are displayed in Layout View by default Select this option if you want to see only enabled objects in the work area Keep in mind that the enable disable option is different from the show hide option Dis abled objects are n
46. open a workspace 8 QSI Qlarity Foundry Getting Started QSI Qlarity Foundry Open a Workspace f Welcome to Qlarity Foundry Recent Files 25 25 lessaames glearoutsglearout al I C ABackup qglaritysamplesssamplessgamesVUlaritylnvaders G laritylnvaders qly C Backup qlaritysamples samples password_protected_screen qly C Backup qlaritysamples samples listbox_alarms qly C Backup qlaritysamples samples ftp_client_interface qly C Backup qlaritysamples samples dns_ethernet_client qly C Backup qlaritysamples samples basic_serial_communication gly C Backup qlaritysamples samples basic_keyboard qly C Backup qlaritysamples samples games touchball touchball qly Filter Recent I m TM Open Selected ar I ty pen Other File by QS Corporation Object Based Programming Start New Begin editing in Layout View Hardware Configuration Assistant Filter Recent If you have a long list of recent files you can filter them to make it easier to find a file Begin typing the name of the file and files beginning with the characters you typed are listed Open Selected Recently opened files if any are listed To open a recent file click the file name to select it then click Open Selected or double click the file name The workspace is opened in the main window Only one workspace at a time can be open in Qlarity Foundry Open Other File Click Open Other File and the Open dialog box appears
47. showing workspaces in the default folder Use the Windows tools to change folders if necessary Click a file to select it then click Open The workspace is opened in the main window see next page Start New To start a new workspace click Start New The New Qlarity Project dialog box appears Refer to section 4 1 Start a New Workspace for information Tutorials Click Tutorials to open a sample workspace and to start a tutorial to help you learn the basics of Qlarity Foundry The Object Documentation Help file is opened with the list of tutorials dis played Click the tutorial you want to work and the tutorial pdf file is opened in Adobe Acrobat Read through the tutorial and follow the instructions using the sample workspace Begin editing in Layout View If this option is enabled a workspace is automatically compiled and shown in the Layout View when it is opened If disabled the workspace is displayed in Code View and will need to be compiled before it can be displayed in Layout View You can also change this set ting using the Settings function Compile tab see section 6 4 Compile Main Window Gerrinq Started Hardware Configuration Assistant Click Hardware Configuration Assistant to access the Hardware Configuration Assistant which you use to specify the type of terminal you are programming and to configure it Refer to section 3 1 1 Hardware Configuration Assistant for information 3 3 Main
48. space by default Configure this object to communicate with the Modbus slave device You can then add other objects from the Modbus library such as gauges trend charts and register objects that can be used to read and set values for the PLC interface National Instruments LabVIEW platforms This option can be used to create a workspace designed to work with National Instrument s LabVIEW platforms such as FieldPoint CompactFieldPoint Compact Vision System and PXI Compact PCI QSI s VIs for LabVIEW 6 1 or higher is required See the tutorials section of Qlarity Foundry help for more information Create workspace like the last one created This option appears if you have previously created a workspace Select this option to create a workspace containing the same libraries and resources that were in the last workspace created Click the workspace type that you want to use and click Finish or Show Options depend ing on the workspace option you selected If you click Show Options the following dialog box is displayed 38 QSI Qlarity Foundry Workspaces Start a New Workspace NOTE I QSI Qlarity Foundry Select any additional items to add to the workspace Add additional items to your project Note Some objects require that at least Include a default BDF raster font one font or bitmap be included in the Include a default TrueT ype tm font workspace Creating such an object Include a default bitmap without includi
49. terminal for downloading using the terminal s Power On Setup utility Refer to the Olarity Based Terminal Hardware User s Manual for information on using Power On Setup NOTE I The time is set through the serial port connection If your terminal is connected to an Ethernet port you will need to change it to a serial port to perform this function 2 Click Set Unit Time bottom of the Serial tab The message Setting Time gt is displayed in the Results box If no further message is displayed the terminal s time has been set If an error occurs it is displayed in the Results box as shown below Results Terminal did not respond to set time Terminal did not respond to set time QSI Qlarity Foundry 97 Upgrade the Firmware Download Software to the Terminal Notes 98 QSI Qlarity Foundry CHAPTER 8 BASIC DESIGN You can use Qlarity Foundry to design a user application using library objects and or existing object templates This basic design requires no special programming skills This chapter provides instructions for using Qlarity Foundry to design a user application using only the objects and templates provided as well as information on the basic concepts of the Qlarity programming language All Qlarity Foundry users should review and become familiar with the information in this chapter If you want to learn more about using Qlarity Foundry and Qlarity programming you can then proceed to Ch
50. the named colors are shown Each theme uses the same named color labels only the colors assigned to them are different from theme to theme 65 66 NOTE p Edit Named Colors Templates Resources and Libraries Theme Click the drop down list and select a theme Its defined colors are shown next to the named color labels Save Current Border and Color Settings As Theme To save as a theme any changes you made to the named colors click Save current border and color settings as theme A prompt appears with the name of the currently selected theme If you do not want to change the colors in the theme displayed enter a new name to create a new theme Remember that the current named border definitions see section 5 5 Edit Named Borders are also saved as part of the theme If you change themes without saving the changes you made to the current theme the changes to the unsaved theme are not saved when you click OK 5 4 2 Named Colors NOTE NOTE p Named colors cannot be assigned to objects in libraries from Qlarity Foundry versions earlier than 2 1 To create or edit named colors begin by selecting a theme from the Theme drop down list Named colors are saved in themes The colors assigned to all named colors for the selected theme are displayed Both the named color label and the color currently assigned to the named color are shown gt Any change to a named color only applies to the currently selected theme
51. the terminal display proper alignment is important Qlarity Foundry provides the following tools to assist you with object layout To change the scale of the work area click the drop down arrow and select the scale from the drop down list Select this option to draw a line around all defined objects This is useful when you want to know the exact border location of each object or when one or more objects was accidently moved out of the work area Grid You can display a grid over the work area to help you more accurately place and align objects You can turn the grid off and on and change the spacing and color of the grid lines QSI Qlarity Foundry Basic Design Prepare Olaniry Foundry for Application Desiqn Snap to Grid If enabled this feature forces objects to snap to the nearest grid line when added or moved The top left corner of an object s rectangle snaps to the nearest horizontal and vertical grid lines when you release the mouse button To customize the grid and enable Snap to Grid click on the toolbar or select Settings from the View menu Click the Layout tab and edit the follow settings as needed refer to section 6 2 for more information Show Grid show hide grid Snap to Grid enable disable snap to grid Grid Spacing set the spacing of the grid lines Colors Grid set the color of the grid lines 8 1 4 Add Remove Resources Resources include all bitmap images fonts audio files and
52. the value of a property in another object The property to set is the action that results from the event r Property to Set m Set to this Value Object T ank gauge y Use the value of this object property Property value y Object Tank_slider y uon float C Use this explicit value H In the Property to Set section select the target object object to be changed when the event takes place such as moving a gauge from the Object drop down list From the Property drop down list select the target property property to be changed by the action In the Set to this Value section use one of the following options to set the value for the prop erty Use the value of this object property Select this option to use the value of a specified object and property Then select the source object from the Object drop down list and the source property from the Property drop down list In the example above the target and source properties both use the value property but any compatible property can be used For example if the target object is a label you might select the caption property Use this explicit value For some properties you may need to enter or select an explicit value For example if you want your own message displayed when a button is pressed enter the message in this text box A drop down list may appear with available values depending on the object se
53. to assign to the resource name 4 Click Open to accept the file and close the dialog box and the file is changed 5 2 5 Remove a Resource In the Edit Resources dialog box do the following to remove a resource from the workspace 1 From the list of resources select the resource or resources that you want to remove You can select multiple resources as described in the note above 2 Click Remove resource type e g Remove BDF Font The selected resource s is removed from the workspace 5 2 6 Bitmaps Qlarity Foundry supports bitmap images in the standard bmp format Use the following guide lines when creating bitmap images to be displayed on Qlarity based terminals Bitmap Size The size of a bitmap image is normally shown as the number of pixels in width by the number of pixels in height e g 25 x 10 The standard Qlarity based terminal display is 320 pixels in width by 240 pixels in height 320 x 240 Therefore you can easily determine what size to make your bitmap images so they will be in proportion to the size of your terminal Refer to your Qlarity based terminal specifications for its exact size Transparent Background You can specify that a color in a bitmap image become transparent in the workspace If you want the background of a bitmap image to be transparent in the workspace make the back ground a color that is not used in the bitmap then select the background color as the transpar ent color in the bi
54. to more than one group doc group extended drawing functions These functions draw to the display doc func DecoratedCircle group extended drawing functions documentation as appropriate doc func TransformAndDraw group extended drawing functions group transformation functions documentation as appropriate B 8 Hiding Documentation QSI Qlarity Foundry AutoDoc will generally not display documentation information on program elements that are not intended for general use This includes private methods and properties hidden variables validation functions and a few other unusual constructs Sometimes you may wish to use the undoc directive to suppress the documentation on other program elements such as global variables that are intended for internal use by a template undoc element type lt element name gt The undoc directive has the same syntax and supports the same lt element types gt as the doc directive You may also specify a documentation body for an item that uses the undoc direc 177 Property Flags AutoDoc specification tive While this body will never be displayed in the documentation it is a useful way to com ment your code B 9 Property Flags You may use the flags directive to specify special flags meta data for a property flags is only valid after a doc prop directive The documentation flags are used by a few select data types in the Properties window of Qlarity Foundry to con
55. v Data Format 9 4 Download application Download other BFF Send string over serial connectio s Induce Set unit time exp Results Engineering ethernet address detected Development mode Firmware version 1 510 c 1 016 BFF Built Mar 19 2003 at 13 38 12 Download application acre Clear results box Close Window pen serial port whenever this screen is shown 94 QSI Qlarity Foundry Download Sofrware ro the Terminal Upgrade the Firmware 7 4 2 Prepare Terminal for Upgrade To prepare the terminal to receive new firmware using a serial or Ethernet connection set the App Mode option to either Develop or Download Refer to the Qlarity Based Terminal Hardware User s Manual for Power On Setup instructions NOTE I Ifyou cannot access the Qlarity based terminal use the Induce Bootloader function refer to section 7 4 4 for information 7 4 3 Download New Firmware Do the following to download a new version of the Qlarity based firmware 1 Select Download Application from the File menu and the Download dialog box is dis played 2 Click Upgrade firmware to proceed and the following dialog box is displayed Select firmware file to download Look in O firmware loss 2 591a bin loss 2 600 bin oss 2 5903 bin losa 2 591a bin 48 Klose 2 600 bin My Computer recta a3 U z a bin Floro 2 600 bin 7o 2 590a bin 3 x70 2 591a bin EI x70_2 600 bin j G9 955_2 590a bin firm
56. Filename All resources used in a workspace are managed from this dialog box Select the tab for the resource type you want to manage You can add a new resource rename an existing resource change the file for an existing resource name or remove a resource from the workspace Refer to section 5 2 for information on editing resources 8 1 5 Add Remove Libraries A library is a file that contains predefined object templates that you can use to create user applications Library object templates are programmed to be flexible This means that you can modify them without additional programming to meet most requirements In basic design libraries are your primary source of new objects When you create a new workspace your selections in the New Qlarity Project dialog box determine which libraries are automatically added to the new workspace You can also add or remove libraries after you open the workspace NOTE I3 Object templates in libraries are not listed in the Object Tree under the Templates heading Only object templates created in the workspace are listed under this heading To add a library to or remove a library from a workspace click on the toolbar or select Edit Libraries on the Edit menu A dialog box similar to the following is displayed 104 QSI Qlarity Foundry Basic Design Prepare Olaniry Foundry for Application Design Libraries Filename Status Name loaded sys2 10 DataProc glib loaded sys2 10 DataProc
57. G TOOL ATTACH but possibly in other places gt as well func ToolAttached newParent as objref handles MSG TOOL ATTACHED Set our parent property to reflect who we are attached to and gt save parent newParent Tool Persist parent Save parent endfunc This function is called when the user created an instance of gt this template by selecting it from the object palette and gt dragging it in the layout view The handler for MSG INIT is not called automatically and if you gt want it called you should call it manually You should call Tool Persist on all the properties that you set gt up in this message handler func ToolDragCreate parentObj as objref handles MSG TOOL DRAGCREATE parent parentObj Tool Persist parent Call our MSG INIT handler Startup endfunc dendif First note that all of the tool handlers are enclosed inside a if TOOL Zendif block This excludes the tool handlers when the application is compiled for the Qlarity based terminal QSI Qlarity Foundry 159 Create a New Object Template Advanced Design 160 As noted in the comments the MSG_TOOL_ATTACH message is sent to an object when it has been dragged onto a new parent in the Object Tree An objref referencing the new parent is passed to the handler as a parameter In most cases the handler should merely call the Attach API function to request attachment to the new parent This is wha
58. GetException to retrieve information for the last thrown exception check the error type and respond appropri ately to each type of anticipated exception If the error type is not what was anticipated the exception should be rethrown using the Rethrow API function This gives higher level excep tion handling code the opportunity to handle the exception if desired Ordinarily GetException should be called only ONCE in an on error block In a global MSG_ERROR handler GetException is typically called repeatedly until all exceptions have been retrieved Details on the syntax of check error on error can be found in the Exception Handling section in the Qlarity Programmer s Reference Manual Create a New Object Template To create a new object template in your application do the following 1 Click on the toolbar or select Add Edit Templates from the Edit menu and the Add Edit Templates dialog box is displayed You can also right click anywhere in the Templates branch of the Object Tree and click Add Edit Templates on the shortcut menu ED Add Edit Templates Template Base Template New Template 2 Click New Template and the following dialog box is displayed QSI Qlarity Foundry Advanced Design Create a New Object Template 10 11 New Template Wizard Create a template ready to operate in Olarity Foundry Create a completely blank template O Copy the code of an existi
59. Hdefaultitem func Click Hdefaultitem prop value documentation as appropriate B 13 Defining Border Styles You can use the stylemap directive to specify a new border style element for an object Hstylemap style name style assignment gt lt style assignment gt lt style assignment gt Where lt style name gt is a valid Qlarity identifier name that names the style Each lt style assign ment gt defines the style for a specific theme If the user selects a theme in which the specified style is not defined and you do not specify a style assignment for that theme Qlarity Foundry uses the first specified lt style assignment gt lt style assignment gt has the following syntax lt theme name gt lt value gt lt theme name gt represents the name of a theme such as standard or grayscale_light lt value gt is a border style value stylemap Bdr ButtonBorder standard 0x00052025 classic 0x1c022001 Hstylemap Bdr LabelBorder standard 331783 classic 0 stylemap directives are standalone directives and not part of any other doc directive These directives may not be broken over multiple lines B 14 Defining Named Colors You can use the colormap directive to specify a new named color element for an object colormap color name color assignment gt color assignment gt color assignment gt Where color name is a valid Qlarity identifier name that names the color Ea
60. I Qlarity Foundry CHAPTER 10 ADVANCED DESIGN The ability to completely design custom objects for a user application is the crowning feature of the Qlarity programming language This chapter provides information to help users design their own objects using Qlarity Advanced users are not bound by the selection of objects available in QSI libraries As an advanced user you can design objects that best represent the data and user interface elements for a particular application For example if the Qlarity based terminal is replacing an existing control panel you can create objects that mimic the look and feel of the user interface ele ments on the old panel The variety of objects you can create with Qlarity is virtually unlim ited This chapter introduces the Qlarity concepts that are crucial for object design including the following Validation Functions The Qlarity API Library Exception Handling It also includes information on the following Create a New Object Template Guidelines for Designing New Object Templates Before proceeding you should be familiar with the concepts presented in Chapter 8 Basic Design and Chapter 9 Intermediate Design and have some practice with Qlarity design at those levels In addition you should review the Qlarity Programmer s Reference Manual as it covers basic information needed for programming in Qlarity 10 1 Advanced Code Sections QSI Qlarity Foundry
61. If you are making changes to more than one theme make sure you click Save current border and color set tings as theme before you change themes When you have finished editing or creating named colors click OK to save the changes and exit or click Cancel to discard the changes and exit 5 4 2 1 Change Named Color NOTE p To change the color assigned to a named color click the named color to select it then click a color in one of the color palettes The new color is assigned to the named color Click Save current border and color settings as theme to save the new color in the theme When you change the color assigned to a named color it is changed for all objects and proper ties to which the named color is assigned 5 4 2 2 Create New Named Color Click New named color to create a new named color You are prompted to enter a label A label has no size limitations but must start with a letter or underline character _ A label can not contain spaces but may contain the underline character The percent 46 pound and dollar sign symbols can be used at the end of the label Enter a label for the new named color and click OK The new named color is added to the list with a default color of white To QSI Qlarity Foundry Templates Resources and Libraries Edit Named Borders change the color click a color in one of the color palettes The color selected will be the color in every theme unless you change it
62. J Bg Aes FBS Be Theme neon QSI Qlarity Foundry Toolbar Select an object in the work area then click to make a copy of the object The object remains in the Windows buffer until replaced by another cut or copy operation Click to place a cut or copied object in a new location in the same workspace or in a different workspace Click to undo the last action performed The Undo buffer is cleared after the workspace is compiled Click to open the Add Edit Templates dialog box to add or edit an object template Refer to section 5 1 Add Edit Templates and to Chapter 10 Advanced Design for information on creating templates Click to open the Qlarity Resources dialog box to add resources to or remove them from the workspace Refer to section 5 2 Edit Resources for information Click to open the Libraries dialog box to add libraries to or remove libraries from the work space Refer to section 5 3 for information Click to turn on off the snap to grid function If enabled this feature forces objects to snap to the nearest grid line when added or moved The top left corner of an object s rectangle snaps to the nearest horizontal and vertical grid lines when you release the mouse button Click to show or hide the grid You can display a grid over the work area to help you more accurately place and align objects For information on changing the spacing or color of the grid refer to sectio
63. LabelBorder etc You can create as many additional named borders as needed for a workspace The designs for named borders along with the colors for named colors see section 5 4 are set up in themes see section 5 5 1 You can create your own themes and named borders and you can edit the predefined themes and named borders To create or edit named borders and themes for a workspace select Edit Named Borders from the Edit menu The following dialog box is displayed QSI Qlarity Foundry 67 Edir Named Borders Border Designer T Bdr_BumpBorder Bdr_ButtonBorder Bdr_CheckBoxBorder Bdr_Composite0bject Bdr_CompositeSunken Bdr InnerButton 5 Bdr InnerLabel E Bdr LabelBorder and Bdr None Bdr_Scrollbar la Bdr_SignalB ars General Effects Border width 2 E 3D Bevel Raised O Sunken Fade Effect Rounded Corners Use rounded comers Comer radius 5 Double Border C Use a double border Preview Options Changing preview options has no effect on the actual border Object fill color Background color C Inverse Pressed Templates Resources and Libraries New named border Reset border to default Theme neon v Save curent border and color settings as theme Fill preview Bdr Softkey 5 5 1 Themes The colors and border definitions assigned to named colors and named borders are grouped together in themes See section 5 4 Edit Named Colors for inform
64. M01 005 00 Rev 3 QLARITY FOUNDRYo USER GUIDE REVISION 2 61 QSI CORPORATION 2212 South West Temple 50 Salt Lake City Utah 84115 2648 USA Phone 801 466 8770 Fax 801 466 8792 Email info O qsicorp com Web www qsicorp com Copyright O 2009 QSI Corporation Printed in the USA All rights reserved No part of this publication may be reproduced in any form or by any means without prior written permission from QSI Corporation QTERM G70 G70 QTERM G75 G75 QTERM G55 G55 QTERM Z60 Z60 and QTERM are trademarks and Qlarity and Qlarity Foundry are registered trademarks of QSI Corporation Microsoft Windows Windows NT Windows 2000 Windows XP and their respective logos are registered trademarks of Microsoft Corporation in the United States and other countries TrueType is a registered trademark of Apple Computer Inc Manual Updated 13 October 2009 FCC COMPLIANCE STATEMENT This device complies with part 15 of the FCC Rules Operation is subject to the following two conditions 1 This device may not cause harmful interference and 2 this device must accept any interference received including inter ference that may cause undesired operation This equipment has been tested and found to comply with the limits for a Class A digital device pursuant to part 15 of the FCC Rules These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment This e
65. QSI Qlarity Foundry 23 24 Objecr Tree Getting Started Each object instance listed in the Object Tree has an icon that shows the type of object label button 3D event timer form line etc The objects are listed in Z order see Appendix A Glossary of Software Terms but you can move an object up or down the list using drag and drop The Object Tree also contains icons that can be used to show hide or lock unlock an object instance as follows Click to show eye open or hide eye closed the object instance in the work area This is use ful if you have objects stacked You can hide an object if you want to see an object that is behind it This icon indicates objects that have no display representation and are never displayed gener ally serial or Ethernet objects Click to lock lock closed or unlock lock open an object instance When an object is locked it cannot be changed or moved with the mouse 3 7 Globals In Layout View default view you see only the Globals branch of the Object Tree Under the Globals branch all object instances defined for the workspace are listed ce EE A af ExecptionDisplay E E af sim Bt f KeyboardScreen E Start Sy af InstructionsBtn Sy af StartGameBtn y af HiahScoreTransL bl Y S af HighScoreVertLbl B af SimTimer A Sy ad LastLevel A Saf LastScore FA Shaf GameTitle FA amp 9 StatBG ape InstructionsScreen Y af OpenDesigner 5 a nou B
66. Qlarity objects publish events to signal when an action has taken place such as the user pressing the touch screen data arriving on the serial port and so on Qlarity objects provide this notification in the form of functions that may be overridden in object instances to provide specific object behavior QSI Qlarity Foundry Intermediate Design Handling Events With Olaniry Code For example many button like objects such as the ButtonV2 or IconButtonV2 objects pub lish a function called Click By default this function does nothing but each instance of this object can include an override of the Click function to take some action in response to a press event on the object A typical response might include sending some characters to a communi cations port switching to a different screen or modifying the contents of another object In this manner an object s response to events is programmed using the Qlarity programming language Once you are familiar with the basics of Qlarity programming it is easy to program complex event handling into objects without the need to manage numerous event properties 9 4 1 Override an Object Method To override an object method in your application do the following 1 Add the object that will be used to handle the event e g ButtonV2 TimerV2 2 Select the object in the workspace in Layout View or in the Object Tree and select Code View 3 From the Events Overrides drop down list above
67. Sec O in es edet 97 CHAPTER 8 BASIC DESIGN as ree n x Ree ee Rte a xe e a RU CN Ei ure 99 8 1 Prepare Qlarity Foundry for Application Design ooooocococoocooo ooo 100 8 1 4 Basic Design Layout 0 0 ie o a ea eens 100 8 1 2 Simulate the Terminal Display 0 0 0 cece eee ee eee 101 8 1 3 Drawing Ards csse Aine Puce as nee eRe e AUR Re tps ease 102 8 1 4 Add Remove Resources 0 0 0 cece eee eee eee eee eee 103 8 1 5 Add Remove Libraries 0 0 eee nents 104 8 1 5 1 Libraries Provided with Qlarity Foundry 0 105 8 2 Understanding Qlarity for Basic Design 0 cece eee eee 106 8 2 1 Workspaces and User Applications 0 0 0 c eee eee eee 106 8 2 2 Olarity Objects oec hee ee out ae etse b eas 106 8 2 3 Parent Child Relationships leen 107 82 4 Z OTUer iiobis e bei ese de dea erts hM a a NU Et ge 109 8 2 5 Events and Messaging llle 109 8 2 6 Enabled Disabled ObjectS oooooooococoococcncooo 109 8 3 Design a User Application seseeeeeeee nee nes 110 8 3 1 Add an Object Instance leseeeeee eee 110 8 3 1 1 Add an Object From the Object Palette 110 8 3 1 2 Add an Object From the Shortcut Menu 0 111 8 3 2 Move Resize and Reorder Objects llle eee 112 8 3 2 1 Move an Object csset eR Rr eke e es Meee 112 8 3 2 2 Resize an Object sous eda etse eee dapes deed 112 8 3 2
68. Tool Persist yPos Tool Persist width Tool Persist height endfunc When the user drags a resize grip in Layout View the object being resized receives a MSG TOOL MOVEHANDLE message from Qlarity Foundry The grip being manipulated and the change in position are passed to the handler as parameters The handler typically deter mines which grip is being dragged calculates its new size and position updates its properties requests a redraw and persists the values with Tool Persist This is what the boilerplate code does There is also some validation code to prevent the object from being sized to a height or width of 0 The handleNum parameter is passed to the handler as a reference which allows the handler to change the currently selected grip if desired Notice that the boilerplate code reassigns han dleNum when the object is dragged inside out i e a grip at the bottom is dragged above the top of the object or a grip on the right edge of the object is dragged past its left edge Finally the container area object boilerplate code for the MSG TOOL DRAGCREATE han dler is as follows The following function is called when the user created an gt instance of this template by selecting it from the object gt palette and dragging it in the layout view The handler for MSG INIT is not called automatically and if you want it called you should call it manually You should call Tool Persist on all the propert
69. Tree The active object is indicated by solid resize grips and by bold highlighting in the Object Tree The following options are available on the Align Size Space Objects menu Align left Aligns the left most resize grip of each selected object with the left most resize grip of the active object Align center horizontal Aligns the horizontal center of each selected object with the center of the active object Align right Aligns the right most resize grip of each selected object with the right most resize grip of the active object Align top Aligns the top most resize grip of each selected object with the top most resize grip of the active object Align center vertical Aligns the vertical center of each selected object with the center of the active object Align bottom Aligns the bottom most resize grip of each selected object with the bottom most resize grip of the active object Make same width Changes the width of each selected object to the width of the active object All objects must have a width property Make same height Changes the height of all selected objects to the height of the active object All objects must have a height property 114 QSI Qlarity Foundry Basic Design Design a User Application Space evenly horizontally Finds the left most and right most objects among the selected objects and positions the remaining selected objects evenly between them This option works best when all objects ar
70. affect user appli cations read the next section 8 2 5 Events and Messaging Qlarity is an event driven programming language An event is any type of input such as the following A keyboard key press or release A touch screen press or release Achange in a value increment or decrement A timer action Data received through the serial port When an event occurs a Qlarity user application responds with all appropriate and specified actions The system generates a message indicating that the event has occurred and what it is The ter minal s message handling system determines which object or objects get the message and in what order the messages are processed The message is first passed to the root container which passes the message to each of its chil dren beginning with the front most object highest Z order When the message is passed to a container object this object first handles the message then passes it to each of its children beginning with the front most object in the container The terminal processes the message to completion 8 2 6 Enabled Disabled Objects QSI Qlarity Foundry An object instance can be enabled or disabled On the Qlarity based terminal only enabled objects are displayed Disabled objects still reside in the user application but they cannot receive or send most messages nor are they displayed on the terminal If a container object is disabled it cannot pass messages to its children
71. ample workspace and view examples of the objects events and actions that can be set up using Event Builder To open the sample workspace click Open and go to the folder Qlarity Foundry Sam ples Eventbuilder demo Select the file eventbuilder qly 126 QSI Qlarity Foundry Basic Design Event Builder An image of the workspace is shown below Event Builder Sample Demo Tank Demo Taggle Demo Keypad Demo Status Enable Keypad 100 0 The functions in the sample application are described in the following sections 8 4 4 1 Tank Demo The Tank Demo controls the level of liquid in a tank with a slider When the position of the slider in the Tank_Slider object changes it triggers the following actions Transmits its current value out the serial port to a controller that adds liquid to or drains liq uid from a tank to achieve the required level Changes the text label above the slider to the current value of the slider Sets the fill level of the gauge In a real life situation the controller to which you transmit the value would start the process to fill or drain the tank and send a value back to the gauge to update it However in the sample simulation the value is sent to the gauge directly Plays a musical note when the slider is moved 8 4 4 2 Toggle Demo QSI Qlarity Foundry The Toggle Demo toggles a spinner on and off When on a spinner object is displayed that allows a user to increase decrease
72. an init enabled true unc enabled newval as boolean enabled newval enable me enabled endfunc dim parent as objref func parent newval as objref parent newval attach me parent endfunc current temperature values dim ctemp 4 as float init ctemp 71 71 71 71 func ctemp newval as float ctemp newval updatecurtemp endfunc func ctemp newval as float index as integer ctemp index newval 3 9 Simulation View Simulation View is used to simulate with some limitations the operation of a user application after it is downloaded to the Qlarity based terminal Both touch screen and keyboard actions are simulated On a simulated touch screen for example you can activate a button by clicking 1t with the mouse When you click it the programmed action occurs 26 QSI Qlarity Foundry Getting Started Simulation View Security Vi Security E y E Lighting view HVAC View E Lighting ma W 0 g Posse or ML Security v Lighting View NOTE I To effectively simulate a Olarity based terminal you need to define the terminal s hardware in Qlarity Foundry including whether you use a touch screen or keyboard Use the Settings option to define the terminal s hardware and to set the simulation s volume and display func tions Refer to Chapter 6 Olarity Foundry Preferences QSI Qlarity Foundry 27 Simulation View Gerrinq Started 3 9 1 Serial I O Su
73. an event e g Tank slider 2 Inthe Properties window click the Events tab All events associated with the object are shown For example the Tank slider object in eventbuilder qly has one event Change 3 Click E next to the event to open the Event Builder dialog box The action table lists all actions that have been configured for the event Acion Description o Serial Transmit Transmit Sends tank level out COM1 to your controller out COMT 2 Set Property Set Slider label s caption property to Str T ank slider value E Set Property Set Tank gauge s value property to T ank slider value Play note 43 for 12 ms q The last line of the action table always contains a drop down list that you use to add a new action to the event 4 Click anywhere on the line to open the drop down list and select an action The action and its description are added to the table If you want to add a new action in the middle of the table or remove an action from the table right click in the action line A shortcut menu is displayed with options to insert or remove actions 5 Refer to the next section for information on each type of action and how to configure them 122 QSI Qlarity Foundry Basic Design Event Builder 8 4 3 2 Configure Actions The action drop down list contains the following actions Show Screen Enable Disable Object Set Property Serial Transmit Play Note Set Contrast Set Bac
74. apter 9 Intermediate Design and Chapter 10 Advanced Design This chapter provides the following information Prepare Qlarity Foundry for Application Design Basic Design Layout e Simulate the Terminal Display Drawing Aids Zoom Grid Snap etc Add Remove Resources Add Remove Libraries Understanding Qlarity for Basic Design e Workspaces and User Applications Qlarity Objects Parent Child Relationships Z Order Events and Messaging Enabled Disabled Objects Design a User Application Add an Object Instance Move Resize and Reorder Objects Change an Object s Properties QSI Qlarity Foundry 99 Prepare Olaniry Foundry for Application Desiqn Basic Design Event Builder Overview of Event Builder Steps Event Builder Dialog Box Select and Configure Actions Load Event Builder Sample Workspace Qlarity Code and Event Builder Troubleshooting Communication Objects Serial Objects Ethernet Objects Receive Data Test the User Application Save and Compile a Workspace Download a User Application 8 1 Prepare Qlarity Foundry for Application Design This section provides information on how to set up Qlarity Foundry before you design a user application Begin by opening Qlarity Foundry and starting a new workspace Refer to Chapter 3 Getting Started for information 8 1 1 Basic Design Layout 100 You work only in Layout View to create a basic design You shou
75. ary dataproc qlib and the Extra library extra glib These include drawing navigation keyboard and data commu nication and protocol objects required in all workspaces The standard workspace also includes default resources including some BDF fonts a TrueType font a default bitmap and some extra fonts You can add other resources using the Qlarity Foundry functions 37 SranT A New Workspace Workspaces Multilingual workspace This option includes multilingual libraries You can create a workspace that can support up to eight languages The current language can be changed on demand When you compile a multi lingual workspace you must enable Unicode support see section 6 4 Compile Galil Motion Controller This option includes the Common library and the Galil library that contains objects for com municating with Galil Motion Controllers A Galil communications object is included in the workspace by default Configure this object to communicate with the controller Serial TCP IP and UDP IP communications modes are supported You can then add other objects from the Galil library such as trend charts motion path charts and polling windows that can read values from and execute commands on the controller Modbus serial RTU mode and Open Modbus TCP This option includes the Common library and the Modbus library that contains objects with Modbus communications protocol A Modbus communications object is included in the work
76. at to send data to a user application Object name gt lt property name gt lt value gt Do not include the angle brackets lt Object name gt The name of the targeted object instance lt property name gt The name of the targeted property must be entered exactly as it appears in the Properties win dow value The value that you want to insert in the targeted property You can also request that an object s property value be sent back to the external device from a Qlarity based terminal by sending the object name and property as follows object name property name Do not include the angle brackets Object name The name of the targeted object instance property name The name of the targeted property must be entered exactly as it appears in the Properties win dow The value of the property followed by a semicolon is sent back out the terminal s port to the device making the query NOTE e You cannot request property values for the following properties color bitmap ttfont and bdffont 8 6 Test the User Application You can test most of your application s functionality in Simulation View before you download it to the terminal If the application uses serial communication you may want to configure QSI Qlarity Foundry 131 Save and Compile a Workspace Basic Design Simulation View to use your PC s serial port s to simulate serial communication refer to section 6 5 3 Serial P
77. ata types you may assign descriptions to each enumeration or start type item item lt item name gt lt item description gt This assigns lt item name gt the specified lt item description gt The item directive must be com pletely specified on a single line It may not be split into multiple lines doc type ledcmd Used by the QSI Qlarity Foundry AutoDoc specification Grouping Items link func SetLED API to determine the state to put the LED in item LED ON Turn on the specified LED item LED OFF Turn off the specified LED item LED TOGGLE Toggle the state of the specified LED enumerate ledcmd as LED ON 1 LED OFF 2 LED TOGGLE 3 Like the param directive you may also embed link and importdoc directives in the item directive See section B 5 Function Parameters for an example B 7 Grouping Items Occasionally you may document several related items such as a suite of related functions or objects If you want the user to see which items are related and be able to easily navigate from one item to another use groups Start by documenting the group itself using the doc group group name gt directive and add any descriptive body Next add the group directive to each related item in the group dgroup group name gt Where group name gt is the same name used in the doc group directive There may be any number of documentation elements in a group and a single documentation element may belong
78. ated and saved Qlarity files you can use this option as a shortcut to open a file that was recently opened Click Recent Files and a list of previously opened files is dis played Click the file that you want to open 12 QSI Qlarity Foundry Getting Started Menu Options Exit Select this option to exit Qlarity Foundry 3 4 2 Edit Menu The options in the Edit menu change depending on whether you are in Layout View or Code View The Edit menu is not available in Simulation View Select All Code View only Select this option to select all code in the Code View window Cut In Layout View select an object in the work area then select this option or press lt Ctrl gt lt X gt to cut the object from the workspace In Code View select code then select this option or press lt Ctrl gt lt X gt to cut the selected code from the workspace The object or code remains on the Windows clipboard until replaced by another cut or copy operation Copy In Layout View select an object in the work area then select this option or press lt Ctrl gt lt C gt to make a copy of the object In Code View select code then select this option or press lt Ctrl gt lt C gt to copy the selected code The object or code remains on the Windows clipboard until replaced by another cut or copy operation Paste In Layout View select this option or press lt Ctrl gt lt V gt to place a cut or copied object in a new location
79. ation Select Do not simulate if you do not want Qlar ity Foundry to access the network in Simulation View If your PC has 2 or more IP addresses assigned to it those addresses will also appear in the drop down list and you can select the IP address to use when simulating TCP and UDP com munication Play Sound at Breakpoint If this option is enabled a sound is played each time the source level debugger reaches a breakpoint in the code Refer to section 3 9 4 for more information Click Select to display an Open dialog box and select the waveform file you want to use 6 5 1 Communications Window Settings Click Communications Window Settings to set up communication preferences for the Communications window in Simulation View 84 QSI Qlarity Foundry Olaniry Foundry Preferences Simulation View Communications Settings C Display as Hexidecimal Wrap line on newline characters Favor wrapping lines on word breaks C Show only transmitted data Add a tab for each opened network channel On network channel open switch to its tab Non printable character Space character s Newline and carrage return 8192 Maximum buffer size The default settings are generally adequate for most users but you can change any of the fol lowing settings Display as hexadecimal If this option is enabled while in Simulation View data transmitted by the Qlarity based ter minal appears in the Communications window in hex format ra
80. ation on named colors Several predefined themes are set up in Qlarity Foundry You can change the colors or border definitions in a predefined theme or you can save the changes as a new theme Generally a theme represents a color scheme such as a theme with all grayscale colors a theme with shades of blue or a theme with neon colors To view the borders in a theme select the theme from the Theme drop down list The borders assigned to the named borders are shown Each theme uses the same named border labels only the border types assigned to them are different from theme to theme Theme Click the drop down list and select a theme Its defined borders are shown next to the named border labels Save Current Border and Color Settings As Theme To save as a theme any changes you made to the named borders click Save current border and color settings as theme A prompt appears with the name of the currently selected theme If you do not want to change the border designs in the theme displayed enter a new name to create a new theme Remember that the current named colors see section 5 4 Edit Named Colors are also saved as part of the theme NOTE IG Ifyou change themes without saving the changes you made to the current theme the changes to the unsaved theme are not saved when you click OK 68 QSI Qlarity Foundry Templates Resources and Libraries Edit Named Borders 5 5 2 Named Borders NOTE I NOTE IE NOTE I Name
81. ave either one or two serial ports 6 1 4 Miscellaneous Manufacturer ID MID If you purchased a custom MID code for your Qlarity based terminal enter it in the text box Your Qlarity based terminal will emulate a terminal with the MID code If you did not pur chase a custom MID code leave this value at the default 6 2 Layout Click the Layout tab to define the layout of the Qlarity Foundry work area to simulate your ter minal display Qlarity Foundry Preferences Terminal Layout Editor Compile Simulation v ier legend around v Highlight object under the mouse isplay Grid Grid Spacing 19 4 C Show Grid tom C Snap to Grid Layout View colors double click to set Dut of disolay 00000 Dragging Objects Display Border Selected Object Hot object Time the mouse must be Object outlines held still before a resize Grid takes effect zo Bes IET Allow locked objects to be moved within the Object Tree C Show data types in properties window v Show popup help for objects amp properties Tab location Bottom v v Preview while dragging QSI Qlarity Foundry 75 Layout 76 Olariry Foundry Preferences Show legend around display With touch screen displays you can add a border around the display for a stick on touch key legend If you are using a touch key legend select this option If you are not using a touch key legend leave the checkbox empty Grid Spacing You can
82. be added to the bottom of the Global Code section 4 Click the drop down arrow at the Message Handlers box and select the message from the list The message handler code is inserted in the editor If the message handler is for a registered message such as the MSG_TIMETICK or MSG COMM RECEIVE message make sure you add code elsewhere e g the MSG INIT message handler to register to receive it 5 A blank line is inserted in the message handler function Enter the user code at this loca tion 6 Click or select Compile from the File menu to compile the workspace Any errors in the new source code are identified by messages in the Messages and Errors window If no errors are present the compiled workspace is returned to Layout View NOTE K You can include only one message handler with each message type added to the Global Code section 9 5 3 2 Add a Global Message Handler in the Global Code Section Use the following method to enter a global message handler directly in the Globals section in the Code View window Click the Code View tab 2 Click Globals in the Object Tree to open the Global Code section Any current global source code is displayed in the editor window 142 QSI Qlarity Foundry Global Code Intermediate Design 3 On a blank line in the editor window outside of any other function declare a new func tion by typing the func keyword followed by the name of the function a left parenthe sis
83. binary data files available in a workspace and eventually in the user application You must add resources to a workspace before you can use them in object instances Use the Edit Resources option to add resources to your workspace or to change or remove the resources used Because resources become part of the user application when it is compiled you should delete any unnecessary resources NOTE amp When you create a new workspace you have the option to add default bitmap images and fonts to your workspace Some objects may require at least one bitmap BDF font or TT font resource before the object will function properly When you have finished creating a work space however you may want to remove any unused default bitmaps and fonts before you download the user application to the Qlarity based terminal to conserve the terminal s flash and RAM memory Click on the toolbar or select Edit Resources from the Edit menu and the Edit Resources dialog box is displayed QSI Qlarity Foundry 103 Prepare Olaniry Foundry for Application Desiqn Basic Design Edit Resources Bitmaps BDF Fonts TrueType Fonts Audio Binary Bitmap name Sys Filename Alarm bitmaps alarm bmp all bitmaps all bmp bottomLeft bitmaps bottomleft bmp bottomright bitmaps bottomright bmp lightoff bitmaps lightoff bmp lighton bitmaps lighton bmp Temp bitmaps temp bmp topleft bitmaps topleft bmp topright bitmaps topright bmp Resource data Preview
84. ccordingly Requiring each object to implement its own Layout View behavior allows you to extend the functionality of Qlarity Foundry in unique and powerful ways This power and flexibility comes at the price of some complexity in writing handlers for the tool messages Fortunately the boilerplate code is sufficient for most objects This section describes the implementation of the tool handlers in the new template boilerplate code The tool messages are explained in detail in Tool Messages in the Qlarity Program mer s Reference Manual Since a non drawable object is not visible on the display in Layout View its handler methods for tool messages are small and straightforward The code for the handlers is as follows 158 QSI Qlarity Foundry Advanced Design Create a New Object Template Hif TOOL This function is called by Qlarity Foundry when you change the gt attachment of an object i e in response to dragging it around gt the object tree Note the purpose of this function is to allow you to attach to gt another container you should not change your parent property gt or call Tool Persist until you receive a MSG TOOL ATTACHED A MSG TOOL ATTACHED will be sent in response to an Attach API gt function call func ToolAttach attachTo as objref handles MSG TOOL ATTACH Attach me attachTo endfunc This function is called in response to calling Attach primarily gt in a handler for MS
85. cessing The handler that caused the exception is aborted but the current message continues to propagate to other objects until it has been pro cessed to completion At this point if there are any exceptions in the system exception stack the system software generates a MSG ERROR message which is processed immediately i e before any other pending messages are processed MSG ERROR is a special message that can only be pro cessed by handlers in the Global Code space This allows applications to provide a last chance global error handler routine that receives all unhandled exceptions The MSG ERROR handler has no parameters so the exceptions must still be retrieved by calls to GetException Retrieving an exception by calling GetException removes the exception from the system exception stack Therefore calling GetException terminates an exception unless it is rethrown by calling the Rethrow API function If the exception has not been handled i e removed from the system exception stack after MSG ERROR is processed or if there is no global MSG ERROR handler the exception is either discarded for exception levels of EXLEV IGNORABLE or lower or the exception location and description are transmitted from the primary serial port for exceptions of EXLEV SYSTEM or higher 151 Create a New Object Template Advanced Design 10 5 152 NOTE gt The typical check error block or global MSG_ERROR handler calls
86. ch color assignment defines the color for a specific theme If the user selects a theme in which the specified color is not defined and the directive does not specify a color assignment for that theme Olarity Foundry uses the first specified color assignment color assignment has the following syntax theme name gt lt value gt 180 QSI Qlarity Foundry AutoDoc specification Defining Named Colors QSI Qlarity Foundry lt theme name gt represents the name of a theme such as standard or grayscale_light lt value gt is a numeric color value colormap Clr LabelBackground standard 38 classic 183 colormap Clr LabelForeground standard 255 classic 0 colormap directives are standalone directives and not part of any other doc directive These directives may not be broken over multiple lines 181 Defining Named Colors AutoDoc specification Notes 182 QSI Qlarity Foundry
87. character Maximum buffer size Enter the maximum amount of data in bytes to be held in the Communications window buffer When this number of bytes is reached data will be removed from the top of the buffer as new data appears at the bottom Click Default to enter the default buffer size 6 5 2 Keypad Settings 86 This option only applies to applications that use an external keypad not a keyboard Click Keypad Settings to configure the keypad simulation Keypad Settings Keypad C Key Click C Key Repeat Repeat Delay 52 Repeat Rate Automatic Shift Key Automatic Power Key Key Click Select this option to turn the audible key click on in Simulation View If selected you will hear a tone or beep when you click a key on the simulated keypad Key Repeat Select this option to turn the key repeat feature on If selected a key entry repeats when you click and hold down the mouse button on a key on the simulated keypad Repeat Delay If you selected Key Repeat enter the delay time in milliseconds that you want between when a key is pressed and when it begins to repeat automatically Repeat Rate If you selected Key Repeat enter the time in milliseconds that you want between each repeat when a key begins to repeat automatically Automatic Shift Key When this option is enabled clicking the Shift key on the simulated keypad does not register a key press it puts the keypad into the shifted state If t
88. character receive or a system time tick Events generate messages that allow the user application to react to the event in a defined way Code and data that exists independently of objects in an application Collections of predefined object templates and or resources available in Qlarity Foundry Some libraries are provided by QSI however advanced users may create their own libraries Delivers information about an event to the user application User defined functions and object methods are called when the message they handle is generated System that handles event processing for the Qlarity based terminal When an event occurs the system software and or hardware drivers generate a message indicating that the event has occurred The message is passed through the message handling system in the Olarity based system software which reviews the object hierarchy and determines which object gets the message and in what order the message will be processed 169 Methods Method Override Non Drawable Object Object Object Hierarchy Object Instance Object Template 170 Properties Glossary of Sofrware Terms In order to process a message an object must be enabled which also causes area and container objects with a defined area to be drawn on the screen Disabled objects do not process most messages Functions contained in an object comprising much of the code portion of the object The meth ods for each type of object are
89. d msg timetick 0 94 af Gomelille enable board false 9 amp gSubG Starc enabled false o Q IretuctionsScteen Po TS true endfunc r CEN ore init checksize 7 10 SER soda af HiCout 9 Denda A af Demoniorice De af Loeb a e ReleateBin Be afl SucideBtn A of Scorelbl A af Score bli A Qbivedbi A af Romainlre A af Remonibl A 99 af Lovollbi A 9 of Tite 7 af Sound O af ContrantDatker Bs af ContractLighter J of BordetLineFight gt a desiciones ORSU X Code View S Simulation View 0 gf BordeiLineLelt e af BodelLineTop Compile Output ax BBB O if Bond O gf LeweDesigner Goto Erten ag Temetates Bal Boad torre anto e A LeveDeongn LANE Y Compe Output Debug Output Ready No Error Line 1 Cob 1 9 2 Understanding Qlarity for Intermediate Design Before you can effectively design a user application at the intermediate level you need to understand some basic Qlarity concepts which are explained in the following sections 134 QSI Qlarity Foundry Intermediate Design Olariry Code for Objects 9 2 1 Qlarity Programming Language Qlarity syntax is based on the BASIC programming language with extensions added to handle creation and manipulation of objects This chapter provides examples of programming code written in the Qlarity language For additional examples and information refer to the Qlarity Programmer s Reference Manual 9 2 2 Objects and Templates A Qlarity ap
90. d a container object e g tab screen etc to your work area and then place new objects inside the container the objects automatically become children of the parent container object If an object is not placed inside a container object it is linked to the root container by default When you collapse the Object Tree you can quickly identify all objects in the root container In the following illustration the first two objects EZBackButton_1 and EZBackButton 2 are area objects that have been placed in the root container The next to EZScreen 3 EZScreen 1 and EZScreen 2 indicate that they are container objects with other objects in them parents with children QSI Qlarity Foundry 107 Understanding Olaniry fon Basic Design Basic Design 108 exe El A af ExecptionDisplay E E af sim 20 amp y KeyboardS creen So a Start Sy ad InstructionsBtn S af StartGameBtn EP S af HighScoreTransLbl S af HighScoreVertLbl BB af SimTimer A Saf LastLevel A Shaf LastScore A af GameTitle FA Sh 0 Stat E 553 InstructionsScreen Y 2 af OpenDesigner ab 9 ad input B af LevelBanner aE amp af SideBar 2 f ContrastDarker m amp af ContrastLighter 2 of BorderLineRight amp sf BorderLineBottom of BordeiLineL eft sf BorderLineTop 2 af Board 2 af LevelDesigner gi Internal Click next to a parent container object to see its children as shown below ela EEE A 9 af ExecptionDisp
91. d borders cannot be assigned to objects in libraries from Qlarity Foundry versions ear lier than 2 1 To create or edit named borders begin by selecting a theme from the Theme drop down list The attributes of named borders are saved in themes All named border attributes for the selected theme are displayed Both the named border label and the border attributes currently assigned to the named border are shown To change the attributes for a named border click the named border to select it then select from the General Effects Rounded Corners and Double Borders options see the fol lowing sections for details to modify the border The new attributes are shown in the small image next to the label as well as in the preview box When you change the border design for a named border it is changed for all objects and prop erties to which the named border is assigned Any change to a named border only applies to the currently selected theme If you are making changes to more than one theme make sure you click Save current border and color set tings as theme before you change themes When you have finished editing or creating named borders click OK to save the changes and exit or click Cancel to discard the changes and exit 5 5 2 1 General Effects QSI Qlarity Foundry Border Width In the Border width box enter or click the arrow buttons to select the width of the border in number of pixels 3D Bevel If yo
92. d in Qlarity Foundry that contains Qlarity programming code and data for a user application You use Qlarity Foundry to compile the workspace file into a user application and to download the user application to the Qlarity based terminal You can create any number of workspaces The order in which objects are layered The order of objects in the Object Tree indicates the Z ordering of objects from front to back The Z ordering may also be manipulated at runtime using the Z order primitive API functions Also see Object Hierarchy 171 Glossary of Sofrware Terms Notes 172 QSI Qlarity Foundry APPENDIX B AUTODOC SPECIFICATION AutoDoc is Qlarity meta data that automatically documents source code in a workspace and Qlarity libraries All of the libraries provided with Qlarity Foundry have been documented using the AutoDoc feature This appendix contains the complete specification on how to write AutoDoc meta data If you choose not to add AutoDoc meta data your templates properties and methods will still appear in the object documentation and be available for the AutoHelp feature in Qlarity Foundry but they will not contain helpful descriptions B 1 Documentation Declaration QSI Qlarity Foundry To begin documenting a program element use the following syntax doc element type element name gt Where element type is one of unc prop obj override type group and element name is the name of the element
93. d to set up options for the code editor Code View and to enable or disable warnings and other defaults for compiling Click on the toolbar or select Settings from the Tools menu and the Qlarity Foundry Preferences dialog box is displayed Qlarity Foundry Preferences Terminal Layout Editor Hardware Configuration Assistant Input Keyboard Keypad TouchScreen Communications Compile Simulation Base Terminal OTERM G75 v Display Setup Dimensions 540 x 480 v Orientation MES Number of serial ports 2 ig Manufacturer ID MID 65535 Landscape Display Type Color v Audio Decoder C Battery C Printer Ethernet C Wireless network Tabs are available to define your Qlarity based terminal display to define the layout of the Qlarity Foundry work area to set up the code editor and to set up compile defaults as described in the following sections The options in the Terminal tab are for advanced users or for those setting up a custom hard ware configuration Generally you should use the Hardware Configuration Assistant to set up your terminal Hardware Configuration Assistant Click Hardware Configuration Assistant to set up a common terminal configuration Refer to section 3 1 1 for information You can also open the Hardware Configuration Assistant from the Welcome to Qlarity Foundry dialog box when you open a workspace T3 Terminal 74 NOTE Olariry Foundry Preferences You
94. ded corners to round the corners of the border Then enter or click the arrow buttons to select the radius of the corners in number of pixels The greater the number of pix els the more rounded the corner 5 5 2 3 Double Border Select Use a double border to create a double border Then enter or click the arrow buttons to select the width of each border in pixels 1 3 5 5 2 4 Preview The options in the Preview section including Object Fill Color and Background Color allow you to experiment with color combinations but have no effect on the colors in the work space All object background and fill colors in the workspace are determined by the color or named color assigned to the objects or properties 5 5 2 5 Create New Named Border Click New named border to create a new named border You are prompted to enter a label A label has no size limitations but must start with a letter or underline character _ A label cannot contain spaces but may contain the underline character The percent pound and dollar sign symbols can be used at the end of the label Enter the a label for the new named border and click OK The new named border is added to the list with default attributes To change the border change the General Effects Rounded Corners and Dou ble Borders options The border attributes selected will be the same in every theme unless you change them for a selected theme and click Save current b
95. der are listed change folders if necessary 2 Select the resource file or files that you want to add NOTE I 7o select multiple files that appear consecutively in a list press and hold lt Shift gt then click the first and last file in the group you want to select To select multiple non consecutive files press and hold lt Ctrl gt then click each file that you want to select 3 Click Open The resource is added to the list of resources When you add a resource it is given the name of the file by default The resource name is the name that appears in the Properties window for you to select the resource for an object instance For information on changing the name refer to section 5 2 3 5 2 2 Preview Resources When you select a resource in the list a preview of the resource is displayed in the Preview box as shown below if appropriate If you selected an audio resource click the button in the Preview box to listen to the sound Edit Resources Bitmaps BDF Fonts TrueType Fonts Audio Binary Bitmap name Sys Filename Alarm bitmaps alarm bmp all bitmaps all bmp bottomL eft bitmaps bottomleft bmp bottomright bitmaps bottomright bmp lightoff bitmaps lightoff bmp Highton a A ad Temp bitmaps temp bmp topleft bitmaps topleft bmp topright bitmaps topright bmp Resource data Preview Filename bitmaps lighton bmp A Rename lighton 52 QSI Qlarity Foundry Templates Reso
96. described for the Global Code space see section 9 5 4 When you are finished editing the template click or select Compile from the File menu to compile the workspace Any errors in the new source code are identified by mes sages in the Messages and Errors window If no errors are present the compiled work space is returned to Layout View Notice that the Object Palette contains a new icon representing the new template By default the new template s icon is the same as the icon for the library template that served as the basis for the new template except that the background color is different Icons for local templates in a workspace appear before library template icons 5 To edit the icon or change the name click E on the toolbar or select Add Edit Tem plates from the Edit menu Click the template name in the Add Edit Templates dialog box then click Edit Icon Refer to section 5 1 2 Edit a Template Icon for more infor mation Where to Go From Here This chapter introduced the basics of programming applications using Code View and the Qlarity programming language As your familiarity with Qlarity increases your ability to pro gram complex tasks and customize your application will grow To strengthen your background in Qlarity you should read the Qlarity Programmer s Reference Manual Next proceed to Chapter 10 Advanced Design in this manual to help you get started pro ducing your own object templates QS
97. e and the following dialog box is displayed QSI Qlarity Foundry 45 Add Edir Templares 2 46 Templates Resources and Libraries New Template Wizard Create a template ready to operate in Olarity Foundry Create a completely blank template O Copy the code of an existing template in a library O Extend inherit a template from an existing template in a library Template name Dbject type Area Object b Select one of the following options to start the new template Create a template ready to operate in Qlarity Foundry Use this option to create a new object template by starting with the programming code for a basic object that will function in Qlarity Foundry and display on the screen Additional programming is required to define the object s function appearance and so on Create a completely blank template Use this option to start with a blank unprogrammed object template Copy the code of an existing template in a library Use this option to copy an object template from an existing library object When you select this option a Based on box replaces the Object type box Select the object you want to copy from the drop down list Extend inherit a template from an existing template in a library Use this option to create a new object template based on the programming code from an existing library object When you select this option a Based on box replaces the Object type
98. e of the function is displayed in the code otherwise performs a single step Step Out Of lt Shift gt lt F11 gt Select to execute the rest of the current function and return to the calling function Stops on the first executable line outside of the function call If there is another breakpoint in the current function execution stops there Pause Execution lt Ctrl gt lt Break gt Select to stop execution at the next executable line of Qlarity code If no Qlarity code is exe cuting i e the application is idle execution does not pause until after it has been started by an event such as a screen touch or time tick QSI Qlarity Foundry 29 Simulation View Getting Started 3 9 5 Call Stack Window The Call Stack window displays the line number and the object of the current function as well as that of all its callers Select Call Stack from the View menu to display the window This window only displays information when execution has paused or stopped at a breakpoint By default the call stack is not displayed 3 9 6 Watch Window The Watch window allows you to monitor the value of any workspace variables To display the Watch window select Watch Window from the View menu or press lt Ctrl gt 9 Watch Window Type the name of the desired variables in the Name column When execution has paused or stopped at a breakpoint the variables values are shown If execution is not within the scope of th
99. e the same width Space evenly vertically Finds the top most and bottom most objects among the selected objects and positions the remaining selected objects evenly between them This option works best when all objects are the same height 8 3 3 Change an Object s Properties QSI Qlarity Foundry Each object has properties that help define the object instance Click an object in the work area or click an object name in the Object Tree to display the Properties window If the Prop erties window is not displayed pull down the View menu and click Properties Window The default properties for an object instance are defined in the object template from which the object instance was added You can change any of the default properties for an object instance to create a unique object that meets your requirements Properties that are common to almost all objects include Object name Enable disabled status Parent specification A wide range of additional properties vary depending on the type of object For example some typical properties for area objects include e Size height and width e Alignment xalign and yalign Color for borders fill foreground background font etc Font for a text area object Position in display xpos and ypos where both positions start at the top left corner of the parent object The xpos value increases right ypos increases down For specific inf
100. e code You can also select Goto Next Message from the Edit menu to select the next error message and view its location in Code View 4 6 Generate a BFF File QSI Qlarity Foundry Use this function to save a Qlarity workspace file to binary file format BFF which is the application format required by the terminal When you use the Download Application option to download the current workspace to the Qlarity based terminal Qlarity Foundry automatically compiles the workspace into a BFF file however the BFF file is not saved To save a workspace s BFF file so that you can download it at any time without loading the workspace in Qlarity Foundry do the following 1 Load the workspace that you want to save to a BFF file 2 Select Generate filename bff from the File menu where filename is the name of the current workspace The following dialog box is displayed Create Compiled Binary BFF file Save in samples Communications e yews Demo eventbuilder demo games hvac sample other My Computer My Documents Ls Desktop My Recent Documents Cancel File name Ei Save as type larity application binary files bff gt My Network 3 Inthe File name field type a name for the BFF file or accept the default file name you do not have to type the extension The workspace file name with a bff extension in place of the qly extension is used as the defaul
101. e desired new screen as follows curscreen enabled false newscreen enabled true where curscreen and newscreen are the names of the screen objects to be manipulated Since the override method is a complete Qlarity function local variables can be declared and code including conditional statements if else looping for next do while etc and any other legal Qlarity code can be added to the function Complete details on the Qlarity programming language are found in the Qlarity Programmer s Reference Manual NOTE K Since Qlarity is an event driven program you should return from functions in a timely manner Writing code that does not return will cause the system to hang 6 Click Compile button or select Compile from the File menu to compile the work space If there are compile errors in your code messages are displayed in the Messages and Errors window An example of such a message is shown below Compile Output nx Merror OpenDesigner line 17 Parse error Unrecognized use of name Compile Output Debug Output The message includes a description of the error including the object and line number where the error occurred Double clicking the error message in the Messages and Errors window takes you to the location of the error in Code View NOTE K J there are no errors found during the compile the workspace is automatically returned to Layout View 9 5 Global Code In addition to method override
102. e events using Event Builder and then study the program code generated If you modify an event in Code View and later open the event in Event Builder your changes are reflected 8 4 6 Troubleshooting If you make a mistake while configuring an action an error message is displayed in red in the Description column of the action table Action 1 Set Property Missing source property EY Ses TO 2 Click to add action If any error messages are shown you will be unable to click OK to save and exit the dialog box In some cases Qlarity Foundry may not detect the error until you click OK In those cases Event Builder remains open for you to correct the error After you correct the error click OK again If there are no more errors Event Builder closes and the event is configured If you cannot or do not want to correct the error click Cancel Event Builder closes and any changes you made are not saved Advanced users may click Edit in Code View to edit the object template code to correct any errors Errors must be corrected in Code View before you can exit or switch back to Lay out View 128 QSI Qlarity Foundry Basic Design Communication Objects 8 5 Communication Objects The DataProc library dataproc glib provided with Qlarity Foundry contains object templates that are programmed to send data to a computer or other compatible device through a serial or Ethernet port Once a communication object or obj
103. e exception level for exceptions thrown by the application via the Throw API func tion EXLEV MIN This level represents the minimum severity for an exception The exception type is an error code that describes the cause of the error Each exception type is accompanied by a short text description of the problem The error code provides a convenient means for Qlarity exception handlers to determine what error occurred while the description provides a readable summary of the exception The location string indicates the Qlarity func tion or system software facility that was executing when the error occurred This is useful for debugging the application The error codes and descriptions are listed in the Exception List of the Qlarity Program mer s Reference Manual Exception handling code is supported in the Qlarity programming language by check error on error blocks When an exception occurs the Qlarity execution engine determines QSI Qlarity Foundry Advanced Design QSI Qlarity Foundry Exception Handling if the offending code is inside a check error block If so execution immediately jumps to the first statement in the on error block If the offending code is not in a check error block the Qlarity execution engine checks the function that called the current Qlarity function for an enclosing check error block This process iterates until either an enclosing check error block is found or the m
104. e object is selected sets the property in all selected objects to the new value Properties are the data in an object instance They are grouped into categories to help you find and edit a defined property Properties are normally grouped into the following categories Main Contains properties that you must set to use the object These might include enabling the status of the object or the object s current value Border and Color Contains properties that set the appearance of the object 31 Properties Window Getting Started 32 General Contains properties that are required by the object but are rarely set in the Properties window These might include the position and size of the object Text Settings Contains properties that set the less common text attributes in an object such as the inset of the text from the edge of the object or the justification of the text within the object Misc Contains properties that do not fit into any of the above categories Some objects may contain other categories that are specific to the object Examples of properties include Instance name required Enabled disabled switch Parent object to which the instance is attached often a form xy coordinates x and y positions on the terminal display Color including color of background text border etc selected from drop down lists or the Select Color palette Font selected from a drop down list Bitmap image selected
105. e ssn 21 ts ERR Piers 148 10 1 2 Libraries Rumor PR Oi EUER eie 148 10 2 Validation Functions lsseeeeeeee III 148 10 3 The Qlarity API Library iro ciani a E a RR 149 10 4 Exception Handling sseeeeeee III 150 10 5 Create a New Object Template ooooooococococrccr eee 152 10 5 1 New Template Boilerplate Code 0 0 0 cee eee eee 154 10 5 1 1 Non Drawable Objects sss 156 10 531 2 Area Objects oio dete ae a Ad 156 10 5 1 3 Container Objects 158 10 5 2 Getting New Object Templates to Work in Qlarity Foundry 158 10 5 3 Adding Object Template Documentation eese 165 10 6 Guidelines for Designing New Object Templates ooo o ooooo ooo 167 10 7 Where to Go From Here ssseseeee II 168 APPENDIX A GLOSSARY OF SOFTWARE TERMS 0 cece cece ee cece hh hr r rr nnn 169 APPENDIX B AUTODOG SPECIFICATION 553 e ee Rer bua Sines SSS e 173 B 1 Documentation Declaration 00 0 cece eee ae 173 B 2 Documentation Body 2 0 0 0 eee nee s 174 B 3 Linking Items o dt e das ete dd bec Ae Ak eek 174 B 4 Importing Items vores eii iea hee ee RR DER HR oe ee E E 175 B 5 Function Parameters sse neesta sien cect ete n 176 B 6 Data Type Elements 0 0 0 eee eee ene nes 176 B7 Grouping Items soi be ek bee a ee Ae be aa ee ir 177 B 8 Hiding Documentation 0 eee es 177 BO Property Flags tone ted tss bead e re me Pudet sa Gaby sea
106. e that you want to change It is highlighted in blue QSI Qlarity Foundry 49 Edir Resources Templates Resources and Libraries 2 Click the radio button for the object template type to which you want to change the tem plate as follows An object that contains other objects e g a form It can be Container f d defined as part or all of the terminal screen A display element e g text object bitmap object line Area object object etc An object that serves a function not related to the display Non drawable object E ee e g key definition communications etc For more information on object types refer to Chapter 8 Basic Design and to Appendix A Glossary of Software Terms 5 1 7 Extend a Template A template may extend another base template A template that extends another template inherits the base template s properties and methods In the Add Edit Templates dialog box do the following to extend a template 1 Click the template that you want to modify It is highlighted in blue 2 From the Extends template drop down list select the base template that you want the selected template to extend If you do not want the template to extend another template select none from the drop down list Refer to the Programmer s Reference Manual for detailed information on extending object templates 5 2 Edit Resources 50 NOTE p Resources include a
107. e variable no value is displayed Click sa to show or hide the data type for each variable Click to treat arrays of bytes unibytes and characters as strings in the Watch window Click a to view numeric integral values in the Watch window in hexadecimal format rather than decimal format 30 QSI Qlarity Foundry Getting Started Properties Window 3 10 Properties Window NOTE I QSI Qlarity Foundry The Properties window displays the properties of the selected object instance An example of a keypad object is shown below Object Properties default 256 115 14 34 false note_usedefault note_usedefault clickonpress false separators false marqueepos qkp topdetached popupstyle _gkp_nopopup passwordmode false shifted false hasenter true hascancel true marqueeinset 0 Click an object in the work area or click its object name in the Object Tree to display its prop erties If the Properties window is not displayed pull down the View menu and click Proper ties Window If more than one object is selected only those properties that are common to all selected objects are shown in the Properties window If the same value is assigned to a property for all selected objects that value is displayed If the selected objects have different values for the same property lt multiple values gt appears in grayed text In either case setting a value in the Properties window when more than on
108. ects Property Initializations Method Overrides Handling Events With Qlarity Code Override an Object Method Global Code Add a Global Variable to a Workspace Add a Global Function to a Workspace Add a Global Message Handler to a Workspace Create a New Object Template 133 Viewing the Code Intermediate Design 9 1 Viewing the Code To view and change the Qlarity code for an object select the object in Layout View or in the Object Tree and then click the Code View tab at the bottom of the work area see section 3 8 Layout and Code Views In the illustration on the next page the global code for an exam ple workspace is shown The Messages and Errors window at the bottom shows any compiling errors that occurred during the last compile 19 Qlarity Foundry 2 60 glearout qly OpenDesigner dl fen le Elo Eck Yew Tools Heb dur PT IES NN ARAS bject Tree gt Events Ovenides v v Show only event lunctions E nit parent default E Cidah init xpos zx 2 init ypos 34 se reno init width 35 Edo D Kotestscemn A mA O BH 9 af HonScoekeypad L pio tuns onStateChange af Initruchion Btn enabled false e af StatGameBin if isChecked then af HohScoreTransL b levelbesigner enabled true aeo af HighScoreVentbi DesignVindow enabled true af SimTimer LevelTimer enabled false A gf Lastevel levelBanner enabled false X amp af LovScere unregistermeghandier boar
109. ects is set up you can use Event Builder section 8 4 to set up an event to send data out the port No programming is required 8 5 1 Serial Objects To use the serial port to send data add a Serial Protocol V2 object to the workspace The optional second serial port can also be used by adding a second Serial Protocol V2 object Following are the properties of a Serial Protocol V2 object Name Type a name for the new object type over the default name Each object in the workspace must have a unique name An object name has no size limitation but must start with a letter A name cannot contain spaces but may use the underline character _ The percent pound and dollar sign symbols can be used at the end of the name enabled If the object is to be enabled select true from the drop down list To disable the object select false parent To make the object the child of a parent object select a container object from the drop down list and the object instance is automatically moved and linked to the selected object in the Object Tree To move an object to the root container select default comport From the drop down list select the communications port on the Qlarity based terminal from which the data will be sent If you have only one select COM1 senddata This property receives the data string that is to be sent through the serial port Data can be sent to this property from a serial object confi
110. eld Wizard for Qlarity eT Foundry 2 60 The InstallShield Wizard will install Qlarity Foundry 2 60 on your computer To continue click Next 3 Click Next and the License Agreement window is displayed InstallShield Wizard License Agreement Please read the following license agreement carefully InstallShield Press the PAGE DOWN key to see the rest of the agreement END USER LICENSE AGREEMENT FOR OSI CORPORATION SOFTWARE IMPORTANTIREAD CAREFULLY BY CLICKING THE ACCEPTANCE BUTTON OR INSTALLING THE SOFTWARE YOU ARE CONSENTING TO BE BOUND BY AND ARE BECOMING 4 PARTY TO THIS END USER LICENSE AGREEMENT THIS END USER LICENSE AGREEMENT EULA IS A LEGAL AGREEMENT BETWEEN YOU EITHER AN INDIVIDUAL OR A SINGLE ENTITY AND QS CORPORATION FOR THE GLARITY FOUNDRY SOFTWARE ACCOMPANYING THIS EULA WHICH INCLUDES COMPUTER SOFTWARE SAMPLE OBJECTS AND MAY INCLUDE Do you accept all the terms of the preceding License Agreement If you choose No the setup will close To install Glarity Foundry 2 60 you must accept this agreement lt Back No QSI Qlarity Foundry Installation Install Olaniry Foundry 4 Read the agreement and click Yes if you accept the terms The following window appears InstallShield Wizard Choose Destination Location Select folder where Setup will install files Setup will install Qlarity Foundry 2 60 in the following folder To install to this folder click Next To install to a diff
111. emplate newY yPos newWidth width newHeight height if handleNum 0 then newX xPos dx newWidth width dx newY yPos dy newHeight height dy elseif handleNum 1 then newY yPos dy newHeight height dy elseif handleNum 2 then newY yPos dy newHeight height dy newWidth width dx elseif handleNum then newWidth width dx elseif handleNum then newWidth width dx newHeight height dy elseif handleNum then newHeight height dy elseif handleNum then newX xPos dx newWidth width dx newHeight height dy else newX xPos dx newWidth width dx endif if newWidth lt 1 then newX newX newWidth 1 newWidth newWidth 2 tmp handleNum mod 4 if tmp 0 then handleNum handleNum 2 elseif tmp 2 then handleNum handleNum 2 else handleNum handleNum 4 mod 8 endif endif if newHeight lt 1 then newY newY newHeight 1 newHeight newHeight 2 tmp handleNum mod 4 if tmp 0 then handleNum handleNum 6 mod 8 QSI Qlarity Foundry 163 Create a New Object Template Advanced Design 164 elseif tmp 1 then handleNum handleNum 4 mod 8 else handleNum handleNum 2 mod 8 endif endif xPos newX yPos newY width newWidth height newHeight Relocate me xPos yPos Resize me width height Save any changes we just made Tool Persist xPos
112. ently configured If any configuration contains an error a message is displayed Edit in Code View Click Edit in Code View to view the event s actions as programming code If you understand the Qlarity programming language you may use Code View to work with programming code You generally only work in Code View if you are customizing actions or creating actions If you are learning Olarity programming it may also be helpful to view the code to understand how an event is programmed 121 Event Builder Basic Design Descriptions Code Preview Click Descriptions to display the Qlarity programming code for the actions in the Descrip tion column of the action table The button label changes to Code Preview Click Code Preview to switch back to a description of each action in the table 8 4 3 Select and Configure Actions A sample workspace eventbuilder qly containing events created using Event Builder is included with Qlarity Foundry For information on loading and using the sample workspace refer to section 8 4 4 Load Event Builder Sample Workspace The sample workspace is used in the images and examples in this section You may find it helpful to load the sample Workspace and use it to view examples of the actions described in this section 8 4 3 1 Select Actions To select actions for an object s events do the following 1 In the open workspace e g eventbuilder qly select the object for which you want to set up
113. er 10 5 1 1 Non Drawable Objects The boilerplate code for a non drawable object template includes the enabled and parent properties It also includes a handler method that handles the MSG_INIT message The code is as follows Perform basic initialization for the object The function will be called once when the terminal starts up This function may also be called within Qlarity Foundry whenever gt a property is set in the properties window func StartUp handles MSG INIT Enable me enabled Attach me parent endfunc The comments describe what the handler is and when it is called The method is called Star tUp takes no parameters and has no return value It is declared as a handler for the MSG INIT message The body of the method merely calls the Enable and Attach API functions passing the val ues of the enabled and parent properties This is necessary to properly initialize the objects by informing the system software about the state of the object at system startup All versions of the boilerplate code include a set of tool message handlers so that they can properly function in Qlarity Foundry These methods are described in detail in the next section Other properties and methods can be added to the boilerplate code to implement the desired behavior in the object 10 5 1 2 Area Objects The area object boilerplate code implements a simple rectangular drawable object It also pro v
114. erent folder click Browse and select another folder m Destination Folder CA AQSI Corporation Qlarity Foundry 2 605 old Inst eld lt Back Cancel 5 Accept the destination folder shown or click Browse to select a different folder or create a new folder in which to install Qlarity Foundry Click Next to continue The following window appears InstallShield Wizard Setup Type Choose the setup type that best suits your needs Click the type of Setup you prefer Description Install the features commonly required for Glarity Foundry 2 60 The application and help files will be installed as well as some sample programs and basic tutorials lt Back Cancel Click each type of system setup to read a description of the files that are installed Then select the type of setup that best suits your needs Complete Custom Minimal or Typi cal Click Next to continue If you selected Custom a dialog box appears for you to select the files and features you want to install QSI Qlarity Foundry Install Olaniry Foundry Installation The Setup Status window appears and displays the status of the installation as each file is installed in the specified destination folder InstallShield Wizard Setup Status Qlarity Foundry 2 60 Setup is performing the requested operations Copying new files nstallShield After all of the files are copied to your hard disk the foll
115. essage handler for the current message is reached Since the message handler was called by the system in response to an event the call cannot be traced further than this function For example suppose a Qlarity statement in function Foo causes an exception Foo is in turn called by a function named Bar Bar is a handler called by the system in response to a message When the exception occurs the Qlarity execution engine first checks the function Foof to see if the offending statement is enclosed within a check error block If it is execu tion jumps to the first statement in the on error block that follows the check error block If it is not enclosed in a check error block the Qlarity execution engine then checks the Bar function to determine if the call to Foo was enclosed in a check error block If it is execu tion jumps immediately from the offending statement in Foo to the first statement in the cor responding on error block in Bar If no enclosing block is found in Bar the system handles the exception as described below Unhandled exceptions are maintained in a LIFO last in first out stack by the system software If multiple unhandled exceptions are pending a call to GetException always returns the most recently thrown exception on the stack If no enclosing check error block is found an exception remains in the system exception stack until the current message completes pro
116. for a selected theme and click Save current border and color settings as theme 5 4 2 3 Delete Named Color To delete a named color that you created select it then click Delete named color A prompt is displayed to confirm that you want to delete it Click Yes to delete the named color You cannot delete the default named colors 5 4 2 4 Rename Named Color To rename a named color that you created select it then click Rename color A message is displayed to warn you that you should not rename a named color that has been assigned to objects If you do the workspace will not compile Click Yes to rename the named color After changing the name click OK to save the change You cannot rename the default named colors 5 4 2 5 Reset Color to Theme Default To restore the originally assigned color to a theme s default named color select the named color you want to restore and click Reset color to theme default 5 5 Edit Named Borders You can use named borders to assign borders to objects Rather than manually creating a border for each object you can assign one named border to any number of objects in the work space All objects assigned a named border will then have the same border characteristics When you change the characteristics of a named border it is changed for all objects using that named border Qlarity Foundry includes several predefined named borders with each new workspace e g Bdr ButtonBorder Bdr_
117. functions in the current code section If you are editing a template that extends another template functions in the base template are also listed Existing functions appear in bold select one to move the cursor to the function If you select a function that only exists in a base template the function is added to the template you are currently editing and overrides the existing function in the template New Variable Click New Variable to add a new variable to the code section you are currently editing A dialog box appears to specify the variable name data type validation function and any docu mentation Refer to section 9 5 1 1 for more information on adding a new variable Insert at Cursor Select this option before selecting a new function or variable to place the item at the cursor location If not selected new functions and variables are added to the end of the current code section 3 6 2 Object Instance Code When editing Object Instance code the navigation bar contains the following components Events Overrides v Show only event functions Events Overrides Click the drop down arrow to display a list of events that can be handled Events that have already been implemented are shown in bold Select an item to either add an event handler or to position the cursor on an existing event handler Show Only Event Functions When this option is selected only those functions that are designated as event functions are shown in the E
118. g gn sd rg 40 4 4 Save a WOrkspa6e 2i baee ees etis e espe edi 41 44 1 Save Workspace ook ree REIR ER CIS Beda b 41 44 2 Save Workspace Asun eun ex eee Nee de tween ens 41 4 4 3 Coll ct for Output se eov SEIAR IRAN Rete LEER 42 4 5 Compile a Workspace eu li ce ese eer rm re 42 4 6 Generate a BEE File ins tiene Wiens deor E eoe Tg eerte bg eased 43 CHAPTER 5 TEMPLATES RESOURCES AND LIBRARIES 00 c secs cece ccs ccceceseceseees 45 51 Add Edit Templates arine rote tret erg dup see gs e bara tyes 45 5 1 1 Add a New Object Template llle 45 51 2 Edita Template TC REL RACES PLUR 47 5 1 3 Rename a Template o oo ooocccoccococcoco een es 48 5 1 4 Remove a Template o oooooccccoccoonccrcr e 48 5 1 5 Send Template to Library ie osai a a e i a AA eee 49 5 1 6 Change Template Type 1 0 0 2 eee e 49 23 17 Extenda Template ia ii Ei vie 50 2532 Edit Resources s oie eR REG WEE ed ees 50 23 2 1 Add a Resource aoo necs br E 51 5 2 2 Preview Resources osonro ciuci eee i o ereta eah e kee 52 23 2 3 Renaime a Resource ose tl a Wi ke eee aE 53 5 2 4 Change a Resource Files oris srs mersa o pa mann i Sana aa a a E a a 53 ZO Remove a Resource 124 ous eb eb AE Pa athe ded eee 54 25 2 0 Bitmaps iss yes us er RAG hve d ette Rea e eae Mae ight daa 54 IZA OA te MA CE A on sae A 54 5 2 8 ALO S e is eee p P EUR EH ti uae Nc hides aos is 55 23 2 0 IBIBAEy dit depre sagst sages elegi Nato esee deed 55 5 3 Ed
119. g your object templates in a library they can easily be distributed to other locations or com puters by copying the library file e g libraryname lib NOTE 513 You should not save your new object templates to OSI libraries OSI libraries are regularly updated and the new libraries replace the existing ones so your templates would be overwrit ten Instead you should create a new library in which to store your own object design work Refer to section 5 3 Edit Libraries for more information In the Add Edit Templates dialog box do the following to add an object template to a library 1 Click the template that you want to add to a library It is highlighted in blue 2 Click Send Template to Library The following dialog box is displayed Send to Library Select library Basic Entry name Diamond Leave template in workspace when done 3 Inthe Select Library box select the library to which you want the object template cop ied 4 The Entry Name box displays the name of the object template To assign it a different name within the library type a new name 5 If you want to leave the template in the current workspace after you copy it to the library select Leave template in workspace when done 6 Click OK to place the object template in the selected library 5 1 6 Change Template Type In the Add Edit Templates dialog box do the following to change the object type of a tem plate 1 Click the templat
120. ght bmp Resource data Preview Filename All resources used in a workspace are managed from this dialog box Click the tab for the resource type you want to manage then follow the procedures in the fol lowing sections as applicable to add a new resource rename an existing resource change the file for an existing resource name or remove a resource from the workspace Additional infor mation on each resource type is also provided in the following sections After you have finished adding editing or removing resources click OK to save your changes and exit the Edit Resources dialog box The workspace is compiled Resources that you added are available for use in the objects and resources that you removed are no longer available Save the workspace to save the new information to disk NOTE Ix The labels on the buttons used to edit resources change to match the resource tab you selected For example you click New bitmap to add a bitmap image New BDF font to add a BDF font and New audio resource to add an audio file The label on the Rename button changes to the name of the resource you selected to rename 5 2 1 Add a Resource In the Edit Resources dialog box do the following to add a new resource to the workspace QSI Qlarity Foundry 51 Edir Resources Templares Resources and Libraries 1 Click New resource type e g New BDF Font and an Open dialog box appears Resource files in the default fol
121. ght situations or in situations in which the light levels may vary dramatically You may also want to turn the backlight off to extend its life Create two buttons for each adjustment one for lighter backlight and one for darker backlight one to turn the backlight on and one to turn it off Each event e g button press changes the backlight as follows Backlight Lighter and Backlight Darker adjust the backlight one level brighter or darker with each event Backlight Off turns the backlight off Backlight On turns the backlight on to the level it was at before turning it off Custom Action This option allows you to program a custom action if an available Event Builder action does not meet your requirements Any action supported by the Qlarity programming language may be used Complex actions and events that require the full expressiveness of the Qlarity pro gramming language such as loops and if then else logic should be entered in Code View Insert a Blank Line This action is not available from the drop down list of actions It appears only if the selected event has been previously edited in Code View and blank lines were inserted in the event s code This action does nothing It is used to format the code generated by Event Builder 8 4 4 Load Event Builder Sample Workspace A sample workspace eventbuilder qly containing events created with Event Builder is included with Qlarity Foundry You may find it helpful to load the s
122. graph tracks the download and messages in the Results box indicate whether the download was successful QSI Qlarity Foundry 93 Upgrade the Firmware Download Software to the Terminal 7 4 Upgrade the Firmware Use the Upgrade Firmware function to download a new version of the terminal resident software firmware to the Qlarity based terminal Refer to section 7 4 1 below for information on identifying the version of your current ter minal firmware Refer to section 7 4 2 for information on preparing your terminal for downloading firmware Refer to section 7 4 3 for information on downloading the new firmware 7 4 1 Determine Current Firmware Version If you are not sure what version of firmware is on the Qlarity based terminal do the following to determine the current version of terminal firmware 1 Verify that the Olarity based terminal is connected to your computer 2 Put the Qlarity based terminal in Develop mode App Mode Develop Refer to the Qlarity Based Terminal Hardware User s Manual for instructions 3 Select Download Application from the File menu 4 Power the terminal on If it is already on power it off and back on The firmware version and date of issue are displayed in the Results box as shown in the figure below 6 Download application to unit Download Serial Ethemet USB App download size 103802 Pott COM1 Flash required 128 kBytes v Baud rate ggg m
123. gured in Event Builder see section 8 4 When the serial object s senddata property receives data it automatically sends the data followed by a semicolon out the port appendterminator This property determines whether a semicolon is appended to the end of all data sent out the serial port 8 5 2 Ethernet Objects To use the Ethernet port to send data add one or more Ethernet Protocol V2 objects If you want to send data to multiple addresses on a network you can create a separate Ethernet Proto QSI Qlarity Foundry 129 Communication Objecrs Basic Design col V2 object for each address or you can send to different addresses from a single Ethernet Protocol V2 object by changing the network address in the object instance as required Following are the properties of an Ethernet Protocol V2 object Name Type a name for the new object type over the default name Each object in the workspace must have a unique name An object name has no size limitation but must start with a letter A name cannot contain spaces but may use the underline character _ The percent pound and dollar sign symbols can be used at the end of the name enabled If the object is to be enabled select true from the drop down list To disable the object select false parent To make the object the child of a parent object select a container object from the drop down list and the object instance is automatically moved and li
124. he GetHardwareInfo API to modify the behavior of workspace objects in Simulation View based on the display type of the target terminal If you are not sure which type of color display you have select Color If you select Grayscale Transflective the default color theme is dark text and borders on a light background If you select Grayscale Transmissive the default color theme is light text and borders on a dark background Refer to section 5 4 1 Themes for information on select ing and modifying a color theme If you are not sure which type of grayscale display you have select Grayscale Transflective Audio Decoder If the terminal has the audio decoder option which allows it to play waveform audio files you can select this option to enable it Ethernet If the terminal has an Ethernet port and you will be using it for communication select this option to enable the port QSI Qlarity Foundry Olaniry Foundry Preferences Layout 6 1 2 Input Keyboard External Keypad TouchScreen Click the input mode or modes that are supported by your terminal and that you plan to use If you select External Keypad click Select to select an external keypad configuration cre ate a new configuration or modify an existing one to match the actual keypad that you are using with the terminal 6 1 3 Communications Number of serial ports Select the number of serial ports available on your Qlarity based terminal Most terminals h
125. he documentation from one item into another item This differs from linking in that the documentation is directly displayed as part of the item rather than indi rectly displayed via a hyperlink importdoc lt element type gt lt element name gt lt import what gt indent box i11 This imports the documentation from lt element type gt lt element name gt directly into the docu mentation for the current item lt element type gt of group is not supported The items after the optional sign control exactly how the import is handled lt import what gt is one of the following items none No import will occur all The specified item will be imported in its entirety decl Only the declaration line for the specified item will be imported itemlist Only valid for type lt element types gt Imports a simple list of enumeration or start type items for the specified data type itemdesc Only valid for type lt element types gt Imports the list of enumeration or start type items for the specified data type as well as those items descriptions The items and descriptions are dis played in a table format In addition to lt import what gt importing items also supports the following non exclusive for mat commands indent The imported text tables will be indented from the left margin box The imported text tables will be displayed in a box fill The imported text tables will be dis
126. he handler These properly ini tialize the location and size of the object on the display Since the area object is drawable a MSG_DRAW handler is required to do the actual drawing The boilerplate version of this method is as follows Display the object This function will be called whenever necessary to show the object func Draw handles MSG DRAW SetFGColor RGB WHITE SetBGColor RGB GRAY DrawBox xPos yPos xPos width 1 yPos height 1 DrawLine xPos yPos xPos width 1 yPos height 1 DrawLine xPos yPos height 1 xPos width 1 yPos endfunc A statement is defined as a single line of code In order for the compiler to distinguish between statements each statement must be separated by a newline character If a statement must be split into multiple lines type gt at the end of the line to tell the compiler to look for the rest of the statement on the next line This function sets the foreground color to white and the background color to gray It then draws a box using the object s properties to determine the location and size The two calls to DrawLine draw an X inside the box This code is easily modified to provide the desired drawing behavior 157 Create a New Object Template Advanced Design 10 5 1 3 Container Objects The boilerplate code for a container template is very similar to the code for an area object tem plate The MSG_DRAW handler is slightly different as fo
127. he mouse pointer over icons in the Object Palette and when you click on properties in the Properties window The text for the pop up Help is based on the Object Documentation file which you can view by pressing lt F1 gt Tab Location From the drop down list select your preferred location in the window for the Layout View and Code View tabs QSI Qlarity Foundry Olariry Foundry Preferences Ediror 6 3 Editor QSI Qlarity Foundry Layout View Colors The components that appear in the work area layout are listed Click a component to display an example in the Sample box of the color in which it appears in the work area Double click an item to change the color A color selector dialog box appears Click a color in the basic col ors section to select it To create a custom color drag the color selector in the rainbow palette to a color and then drag the slider up or down to adjust the saturation and lightness of the color or enter the HSL or RGB of a color Click OK to change the component to the selected color The work area components include the following Out of Display The area that the legend covers not shown if Show Legend Around Display is enabled Display Border The line separating the border and the work area not shown if Show Legend Around Dis play is enabled Selected Object An object that you click The selected color outlines the object to show that it is selected Hot Object The object unde
128. here is a shift LED on the simulated key QSI Qlarity Foundry Olaniry Foundry Preferences Simulation View pad the LED state is automatically toggled Subsequent key presses are processed as shifted When this option is disabled clicking the Shift key is processed as a key press just like any other key Automatic Power Key When this option is enabled clicking the Power key on the simulated keypad does not register a key press While pressing this key on a real terminal would put the terminal in sleep mode clicking the simulated key has no effect other than to toggle the power LED if present When this option is disabled clicking the Power key is processed as a key press just like any other key 6 5 3 Serial Port Setup QSI Qlarity Foundry You can set up Simulation View to send and receive application data through a serial port or ports on your computer Use the serial port setup to set up the computer s ports to simulate the serial ports on the Qlarity based terminal The terminal s available serial ports are listed For information on entering the number of serial ports on your terminal see section 6 1 3 To specify the PC port that you want to use for the simulation and to set up the port s configuration select the terminal port from the list and click Modify Serial Port Settings or double click the port The following dialog box is dis played Simulation Port Settings Setup terminal serial port com2 for simula
129. his option to go to the next bookmark in the displayed object s code Use Set Book mark to add or remove bookmarks in an object s code Set Bookmark Code View only Select this option to add or remove a bookmark in an object s code at the cursor location Bookmarks make it possible to find a location quickly which is useful in objects with several lines of code Go to Next Message Code View only If there are messages in the Messages and Errors window select this option to select the next message or the first one if none is selected and position the cursor on the line that generated the message This applies to messages due to compile errors compile warnings or runtime messages generated by the Tool_Trace API and runtime exceptions Add Edit Templates Select this option to open the Add Edit Templates dialog box to add or edit an object template Refer to section 5 1 Add Edit Templates and to Chapter 10 Advanced Design for infor mation on creating templates Edit Resources Use this option to open the Qlarity Resources dialog box to add resources to or remove them from the workspace Refer to section 5 2 Edit Resources for information Edit Libraries Use this option to open the Libraries dialog box to add libraries to or remove libraries from the workspace Refer to section 5 3 for information Edit Named Colors Layout View only Select this option to define named colors You assign named colors to
130. ications and BFF files and upgrade new firmware O Appendix A Glossary of Software Terms A list of Qlarity terms and their definitions You should read and understand these terms before you attempt to perform the functions described in Chapter 9 and Chapter 10 Olarity pronounced clarity the programming language used to program the Qlarity based terminal is a powerful BASIC like language that utilizes the full potential of the Qlarity based terminal Qlarity Foundry is a Windows based design tool that uses Qlarity to help you design user applications for the Qlarity based terminal Description InTROdUCTION Qlarity uses objects as the building blocks for all user applications An object can take many forms including text labels and fields bitmaps lines forms key definitions clocks counters and so on Libraries which are supplied with Qlarity Foundry contain predefined objects for which the programming is already done To adapt a library object to a user application you typically only need to enter properties e g name location color bitmap etc If custom programming is required Qlarity Foundry contains the tools you need to modify library objects or create your own objects Qlarity Foundry provides all the tools you need to work with user applications including those used to do the following Create a user application basic to advanced levels Modify a user application Compile and d
131. ides the enabled and parent properties as well as the xPos yPos width and height properties to represent the position and size of the object on the display The code for xPos is representative of the code for all the new properties as shown below The horizontal position of the object dim xPos as integer init xPos 0 func xPos newval as integer xPos newVal Relocate me xPos yPos endfunc QSI Qlarity Foundry Advanced Design NOTE I QSI Qlarity Foundry Create a New Object Template xPos is an integer with a default value of 0 The validation method assigns the new value to the property as previously described then calls the Relocate API function to inform the sys tem software that the object has moved to a new location on the display This generates a MSG_DRAW message for the appropriate regions of the display The MSG_INIT handler in the area object boilerplate code is similar to its counterpart in the non drawable code as follows Perform basic initialization for the object The function will be called once when the terminal starts up This function may also be called within Qlarity Foundry whenever gt a property is set in the properties window func StartUp handles MSG INIT Relocate me xPos yPos Resize me width height Enable me enabled Attach me parent endfunc Notice that calls to Relocate and Resize have been added to t
132. ied evel Ovas Advanced Code E E s Basic E i1 Layout View amp Code View Simulation View ox Comple Output Om tros Comple Output Debug Output No Error Lire 1 Col 1 154 QSI Qlarity Foundry Advanced Design QSI Qlarity Foundry Create a New Object Template The illustration above shows a portion of an example of the boilerplate code provided by QSI as an optional starting point when creating a new object template The boilerplate code included in a new template depends on the type of object being created i e non drawable area object or container The purpose of the boilerplate code is to provide a set of properties and methods found in a typical object of the selected type It also provides fully functional tool methods The source code is well documented and serves as an example of a working Qlarity object Each property is defined as follows descriptive comment describe the property dim statement create the property init statement assign a default value validation method provide functionality for property changes For example the enabled property is common to all objects and appears in the boilerplate code for any type of template The code that defines the property is as follows Whether the object is displayed on the terminal dim enabled as boolean init enabled true func enabled newval as boolean enabled newval Enable me enabled endfunc The comment de
133. ied to the new object template 5 Click OK to create the new template 5 1 2 Edit a Template Icon Each template is identified in the Object Tree by an icon To customize the icon for a template click the template name in the Add Edit Templates dialog box then click Edit Icon The fol lowing dialog box is displayed Edit Template Icon Le 2 y Left Button im mi mj Right Button mis af Filicon ml Copy icon E The icon form is graphically represented as a grid Each square in the grid is an individual pixel On the grid draw the icon for the template using the following tools f you want to modify an existing icon to create a new one click the drop down arrow at the Copy icon box and select an icon from the list The selected icon is displayed QSI Qlarity Foundry AT 48 Add Edit Templates Templates Resources and Libraries If you would like to start with all pixels the same color i e white black or a shade of gray click the starting color next to the Fill Icon label By default click a pixel with the left mouse button to make the pixel black click with the right mouse button to make it white You can also specify colors other than black and white for each mouse button as follows Next to the Left Button label click the color that you want to apply when you click the left mouse button Next to the Right Button label click the color that you want to apply whe
134. ies that you set gt up in this message handler x1 yl are the coordinates that gt the user started his drag and x2 y2 are the coordinates that gt the mouse was released func ToolDragCreate parentObj as objref x1 as integer yl as integer x2 as integer y2 as integer handles MSG TOOL DRAGCREATE QSI Qlarity Foundry Advanced Design Create a New Object Template if x2 lt x1 then xPos x2 width x1 x2 1 else xPos xl width x2 x1 1 endif if y2 lt yl then yPos y2 height yl y2 1 else yPos yl height y2 yl 1 endif parent parentObj Save the properties that we just set Tool Persist parent Tool Persist xPos Tool Persist yPos Tool Persist width Tool Persist height Call our MSG INIT handler StartUp endfunc Since the location and size of an area object container is determined by the extent of the click and drag operation in Layout View this handler is necessarily more complex than the handler in the non drawable boilerplate code The x1 y1 and x2 y2 coordinates that are passed to the handler as parameters indicate the locations of the initial click and release respectively at the end of the drag The handler calculates the position and size properties of the object based on the values of x1 y1 and x2 y2 It also sets the parent persists the changed properties and calls the MSG INIT handler to complete the object i
135. iewing the Code ose DES Re eee ED CEP eR ara 134 9 2 Understanding Qlarity for Intermediate Design 0000000 134 9 2 1 Qlarity Programming Language leeeee ee 135 9 2 2 Objects and Templates leleee I 135 9 3 Qlarity Code for ObjectS ooooo oococonoononcr e 135 9 3 1 Property Initializations lseeeeeee III 135 0 3 2 Method Overrides ie ttr dl ena etae Ms 136 9 4 Handling Events With Qlarity Code 0 eee 136 9 4 1 Override an Object Method 2 0 0 eee eee eee 137 9 5 Global Code oh batte ce Danes Gaya tae atlases Nes ege e oe eaten e 138 9 5 1 Add a Global Variable to a Workspace 00 0 0 ee eee eee eee 139 9 5 1 1 Add a Global Variable Using New Varlable 139 9 5 1 2 Add a Global Variable in the Global Code Section 140 9 5 2 Add a Global Function to a Workspace ooocococcocococccoco eee 140 9 5 3 Add a Global Message Handler to a Workspace o ooooomomm o o 141 9 5 3 1 Add a Global Message Handler From a List 142 9 5 3 2 Add a Global Message Handler in the Global Code Section 142 9 6 Create a New Object Template 0 0 0 0 eh 144 9 7 Where to Go FromHere slelelelee e enna 146 CHAPTER 10 QSI Qlarity Foundry V vi CowrtNTS ADVANCED DESIGN 5 54 ds 16 wi die X e UII a eR e ie RI RE Sieve ER 147 10 1 Advanced Code Sections lllllee ee 147 10 1 1 Advanced Cod
136. indow Simulation View Keyboard Simulation View Keypad Simulation View Each window has its own title bar at the top To move a window click the title bar hold down the mouse button and drag the window to another location either in the main window or out side the main window As you drag it you will see an outline that indicates the position and size it will be When it is in the position you want release the mouse button If you release the mouse button close to a docked position in the main window the window snaps into place If you do not want the window to snap into a docked position hold down the Ctrl key as you drag it It then becomes a floating window that can be positioned anywhere on the screen To resize a window move the mouse pointer over any side or corner until the pointer changes to directional arrows Click and hold the mouse button and drag the side or corner of the win dow until it is the size you want then release the mouse button You can resize the main window using the same method To close a window click BJ To open a closed window select its name from the View menu 3 13 Where to Go From Here QSI Qlarity Foundry When you have finished reviewing Getting Started refer to Chapter 8 Basic Design to learn about the Qlarity design process and specifically to section 8 4 2 Event Builder Dialog Box for information on Qlarity Foundry s user friendly design tool for creating u
137. ired 128 kBytes Download application Send string over serial connection Download other BFF mit en Induce Set unit time Dose Results Port COMI Baud rate 9800 Data Format ge1 v v v Upgrade firmware iO Clear results box Close Window Open serial port whenever this screen is shown NOTE I Your communication settings in Qlarity Foundry must match those at the Qlarity based termi nal For information on referencing or changing the terminal s communication settings refer to the Olarity Based Terminal Hardware User s Manual QSI Qlarity Foundry 89 Confiqure Communications Port 90 7 1 1 7 1 2 Download Sofrware ro the Terminal Serial Port Settings Click the Serial tab to set up a serial port Serial Ethernet USB Port coM1 v Baud rate 9600 v Data Format ge1 v Send string over serial connection gt lt mit ce Induce Set unit time Pianos Port From the drop down list select the port used to communicate with the Qlarity based terminal e g Com1 Baud rate From the drop down list select the baud rate for the port e g 115200 Data Format From the drop down list select the data format for the port e g 8n1 Ethernet Port Settings Click the Ethernet tab to set up an Ethernet port Serial Ethemet USB Download via ethemet IP Address of unit 255 25 25 255 C Download to multiple IP addresses Recently used IP addresses
138. it Libraries onore e rr DENVVERS Dee RA EAE TRGA 55 5 3 1 Add Existing Library ooooooocoocococooororon e 56 5 3 2 Remove Library a ta exi AS REESE 57 13 3 Edit Libt ry es leere Dee ex REL ERIS 57 2 3 3 T Edit Entry ehem it DEP bv ees 58 2 9 3 2 Rename Edipo ia das 60 5 3 3 3 Remove EOI da Les 60 3 3 3 4 Set Entry Version oce ers c ex LES WR Va RU e 60 3 3 35 Add New Entry seeded ebbe heut a 60 5 344 Advanced i oi te EDU e D Re eo EM ren iof 61 5 3 4 1 Edit Standard natives lib llle 61 5 3 4 2 Edit Core core glib ghide 1 2 2 0 0 eee eee 62 QSI Qlarity Foundry CowrtNTS QSI Qlarity Foundry 5 3 4 3 System Libraries Not Explicitly Included in This Workspace 63 5 3 5 Create a New Library 0 cece eects 63 5 4 Edit Named Colors ae a a roa ro e e 64 SAL bhemes A RR Dex A e eid 65 42 Named Colors osse Ret ees ia e PNIS NAE a EAE 66 5 4 2 1 Change Named Color ooooooccooccoococonorocr o 66 5 4 2 2 Create New Named Color o o ooooooooooooooooooooo o 66 5 4 2 3 Delete Named Color o ooooooooooooo ooo 67 5 4 2 4 Rename Named Color 0 0 0 0000 ccc ee eens 67 5 4 2 5 Reset Color to Theme Default ooooooooooo o 67 2 5 Edit Named Borders 2e LR eek e vete ee RU ave Ves 67 5 9 E CTDhe mess orae du LER Da dac Dl dabo ced Ae 68 5 5 2 Named Borders AS A x P A ae PANES 69 925 251 General Electo et ee twv e RE oa ELE 69 5 55 22 Ro
139. ithout the need to program new object templates 55 Edir Libraries NOTE NOTE p p Templates Resources and Libraries When you add a library to a workspace the objects in the library are added to the Object Pal ette and to the drop down list in the Instance Properties dialog box right click anywhere in the Object Tree and click New Object Instance When you create a new workspace you have the option to add default libraries to the work space You can remove a default library or add new libraries to the workspace using the Edit Libraries option Object templates in libraries are not listed under Templates in the Object Tree Only object templates created in the workspace are listed under this heading However you can create a new object template based on an existing library object see section 5 1 Add Edit Tem plates To add a library to or remove a library from your workspace click le on the toolbar or select Edit Libraries from the Edit menu A dialog box similar to the following is displayed Libraries Filename Status Name DataProc glib loaded sys2 10 DataProc Basic glib loaded sys2 10 Basic exexceptiondisplay lib loaded sys1 00 ExExceptionDisplay libraries exangletext lib loaded v1 00 ExAngleT ext libraries exradiocheck lib loaded v1 00 ExRadioCheck1 common lib loaded sys1 52 common progobjs lib loaded sys1 52 progobjs Entries Templates AngleText 2 Source Y AngleText 2 Disp
140. ive or send messages You can manipulate the position of an object in the hierarchy with API functions Each con tainer including the root container maintains a list of objects attached to it its children The order of objects on this list indicates the Z ordering of objects from front to back The Z ordering may also be manipulated at runtime using the Z order primitive API functions An occurrence of an object in a user application An object instance is defined by the object template on which the object is based Each object maintains its own properties and may con tain code for method overrides The programming code that defines an object Each object instance in a user application is based on a template Object templates can be a part of a workspace or supplied through one or more libraries The template defines which properties and methods are included in the object Variables that are stored in an object and comprise the data portion of the object The proper ties for each type of object are defined in the object template but each object instance main tains its own properties In Qlarity Foundry object properties can be changed in the Properties window in Layout View without the need to modify the programming code Properties may also be changed at runtime to reflect the current state of the object QSI Qlarity Foundry Glossary of Sofrware Terms Qlarity Resources Root Container User Application Validation Method
141. klight Custom Action After you select an action options appear in the action configuration area of the Event Builder dialog box to configure the action Refer to the following sections for information on each action s configuration Show Screen This action selects a new object to show While this action is typically used for screens any object may be selected When this action is executed the currently displayed screen is hidden and the newly selected screen is shown If you want to an object or screen to pop up over the current screen you should use the Enable Disable Object action instead Show Screen Ev_enable_screen hd Click the drop down arrow and select the object from the list with which you want to replace the current object Enable Disable Object This action enables or disables the selected object When an object is disabled it is not shown on the terminal display and will not respond to most events In the following action example when the event occurs a spinner object is disabled To enable the spinner object a second event and action are required gt Enable Disable Object Object 3 pinner C Enable this object Disable this object C Toggle this object s enabled state QSI Qlarity Foundry 123 Event Builder NOTE 124 Basic Design Set Property This action sets the value of an object property or global variable You can use Set Property for example to change
142. l selected Display Select one of the following options from the drop down list to indicate the type of display on your terminal Color TFT or Color Enhanced TFT Orientation Select the orientation in which your terminal is mounted Portrait longest dimension is verti cal or Landscape longest dimension is horizontal Portrait Il and Landscape ll options are also available to match the settings on your terminal if applicable Serial Ports Select the number of serial communication ports on the terminal from the drop down list Only valid entries are listed PS 2 Keyboard If the terminal has a keyboard port and you will be using a keyboard select this option to enable the keyboard port Ethernet If the terminal has an Ethernet port and you will be using it for communication select this option to enable the port Audio Decoder If the terminal has the audio decoder option which allows it to play waveform audio files you can select this option to enable it Click OK to save the terminal configuration and close the window Click Cancel to exit the window without saving your changes 3 2 Open a Workspace A workspace is a file created in Qlarity Foundry that you will compile into a user application In Qlarity Foundry you use the workspace to define functions for the terminal at the Qlar ity based terminal you use the user application to perform the functions When Qlarity Foundry starts a dialog box appears so you can
143. lains how to set up and define your terminal settings for Qlarity Foundry and enter Qlarity Foundry preferences Download Software to the Terminal This chapter explains how to configure the terminal communications port download user applications and BFF files and upgrade new firmware Basic Design This chapter explains how to get started using Qlarity Foundry and covers user application design basics Intermediate Design This chapter provides instructions a step beyond design basics Advanced Design This chapter provides instructions for advanced user application design Appendix A Glossary of Software Terms This appendix provides definitions of the terms used in Qlar ity Foundry Appendix B AutoDoc specification This appendix contains the complete specification on how to write AutoDoc meta data to document the source code in a workspace and Qlarity libraries MANUAL CONVENTIONS Within Qlarity Foundry functions can be selected using a mouse a keyboard shortcut or an icon on a tool bar The following conventions are used to identify selections in this manual When instructed to press a specific key it is shown in a bold sans serif typeface and is enclosed in angle brackets Enters When instructed to press a key and hold it down while typing another key the keys are lt CTRL gt lt V gt shown together When instructed to click a button or icon it is shown in a bold sans serif typeface and is
144. larity Foundry Sample code is ignored by the compiler and appears grayed out in Qlarity Foundry Run Simulation View only Select this option to continue running the simulation after it has paused or stopped Single Step Simulation View only Select this option to execute the current line and stop on the next line Step Into Simulation View only Select this option to step into a function call If no function is on the current line this acts as a single step Step Out Of Simulation View only Select this option to step out of a function call This executes the rest of the current function and returns to the calling function It stops on the first executable line outside of the function call If there is another breakpoint in the current function execution stops there Pause Execution Simulation View only Select this option to stop execution at the next executable line of Qlarity code If no Qlarity code is executing i e the application is idle execution does not pause until after it has been started by an event such as a screen touch or time tick Clear All Breakpoints Simulation View only Select this option to remove all of the breakpoints that were set 3 4 5 Help Menu QSI Qlarity Foundry Show Object Documentation F1 Select this option or press F1 to view Object Documentation which is a Help file contain ing information on library and workspace object templates as well as functions variables
145. late In the Libraries dialog box click a library to select it then click Edit Library and the follow ing dialog box is displayed 57 Edir Libraries Templates Resources and Libraries Edit Library Path c backup qlaritysamples samples hvac sample libraries exradiocheck lib Name JE xRadioCheck Icon Foreground Icon Background L1 Version 1 00 Warning Any changes you make to libraries may affect other projects Additionally any changes will take effect immedediately and cannot be undone Entry Name Entry Type Version ExCheckBoxBDF Source 1 00 ExCheckBoxTTF Source 1 00 ExRadioButtonBDF Source 1 00 ExRadioButtonTTF Source 1 00 Add New Entry OK NOTE 13 Changes that you make to libraries take effect immediately and cannot be undone Remember that a library may be used in more than one workspace and changes made to the library affect every workspace in which it is loaded You can change the library name version or icon colors as well as change the entries in the library Name To change the library s name click in the Name text box and type over the existing entry The change is reflected in the Filename column in the Libraries dialog box Version To change the version number of the library click in the Version text box and type over the existing number The change is reflected in the Status column in the Libraries dialog box Icon Foreground Ico
146. lay w Y sim cB amp KeyboardScreen B Saf HighScoreKeypad A Saf HighScoreLbl 22d gt Start S af InstructionsBtn Sy al StartGameBtn Sal HighScoreTransLbl Y S af HighScoreVertLbl B gt af SimTimer A yall LastLevel A Shaf LastScore A Shaf GameTitle AS j StatBG Ed InstructionsScreen Y 2 af OpenDesigner a5 9 e input E db sf LevelBanner c B amp f SideBar rs amp af ContrastD arker Er amp af ContrastLighter sf BorderLineRight sf BorderLineBottom sf BorderLineLett sf BorderLineTop R af LevelDesigner gi Internal A parent object can also be a child a container object with children inside another container object HardwareNew and SoftwareNew in the illustration are examples of parent objects within other parent objects QSI Qlarity Foundry Basic Design 8 2 4 Z Order Understanding Olaniry fon Basic Design Z order is the order in which objects are layered The Z order determines how objects are dis played whether they are behind or in front of another object or objects and the order in which information is processed messaging In a Qlarity Foundry workspace the Object Tree lists objects in their Z order with those listed first receiving the highest display and messaging pri ority To change an object s Z order click and drag the object name to a different position in the Object Tree To learn more about how parent child relationships and Z order
147. laySetting 2 AnimatedlmageY2 Source i Ellipse V2 ClockDisplay 2 Source 6 Bor 2 ClockSet 2 Source 1 A aroupeop ColorPickerv2 Source directionpady2 Source DisplayFadeV2 Source DirectionPadv2 DisplaySettingv2 Source ae m ellipse 2 Source a DisplayFadeV2 emptyimage Bitmap GroupBox Source All libraries currently in the workspace are listed Click a library to display its entries and object templates at the bottom of the dialog box 5 3 1 Add Existing Library 56 Do the following to add a new library to the workspace 1 Click Add Existing Library and a dialog box appears that lists all the libraries included with Qlarity Foundry that have not been added to the workspace 2 Select one or more libraries from the list QSI Qlarity Foundry Templates Resources and Libraries Edit Libraries To select multiple libraries that appear consecutively in the list press and hold lt Shift gt then click the first and last library in the group you want to select To select multiple non consecutive libraries press and hold lt Ctrl gt then click each library that you want to select The objects in the selected library or libraries are displayed at the bottom of the dialog box Click OK to close the dialog box and the selected libraries are added to the workspace The objects in the new libraries are added to the Object Palette To add a library that is not listed click Add Other Library a
148. ld keep the following Qlarity Foundry windows open as you will use all of them Toolbar Properties window Object Palette Object Tree QSI Qlarity Foundry Basic Design Prepare Olaniry Foundry for Application Design File Edit View Tools Help BE uL ds i i 9 E X d LA B zoom 100 d Theme neon z ax E Globals fas ri WatchdaaT imer A af ExceptionDisplay amp Bl af TouchKillnfoLbl 2 af InfoLbl 2 af FullScreenColorLbl RE gt af FTPServer B af HideFullScreenColorLt 8 2 af QwertyKeypad 2 f TranslucentColorPicke Er af BacklightDownBtn 2 af BacklightUpBtn Ex af ContrastDownBin En af ContrastUpBtn e af EndGames x BU amp f HelpSideButtonsSer 320 amp af ObiectsScr SS e ObjectsTabCont ies af General Tab mes y ButtonsTab Ef f OutputT ab H 2 af TrendScale H Y of GaugeScale af Timer ad Label0bj wf GaugeLbl af Gauge af Tachometer af Tachometer 2 af TrendChatl E E E a Ge A A 4li A 6 A ime Input Tab af GraphicsSer Sy af TS_ThemeList y ad TranslucentSpn y afl AngleSpn y al TranslucentLbl y ad graphicsLine Sy af AngleTest b al SpinningRings S af pacityLbl y af NebulaPic S af AngleLbl y ad TranslucentColorBt af AngleTestChk y 05 Sy adl TranlucentChk y ad StillmageChk y af SpinRingsChk al GraphicsMainLbl 2 yf SelThemeLbl g DiagnosticsScr gt gt
149. lected Some objects may require additional configuration such as selecting a color If additional configuration is available for the selected object a 5 button appears next to the text box 3 Some object properties are not compatible If you select an incompatible value for the target property an error is generated when you click OK and close the Event Builder dialog box Serial Transmit This action transmits data out one of the terminal s serial ports r Transmit out Serial Port Select Serial Port COM1 y Message to Transmit Sends tank level out COM1 to a your controller zl Pause until transmission completed J QSI Qlarity Foundry Basic Design Event Builder From the Select Serial Port drop down list select the communications port on the Qlar ity based terminal from which the data will be sent If you have only one select COM1 For information on entering the number of serial ports on your terminal see section 6 1 3 In the Message to Transmit box enter the string to send out the serial port or a description of the value to be sent Enable Pause until transmission completed only if you want the termi nal to pause Generally you should leave this disabled as it may decrease performance on the terminal Play Note This action sounds a tone on the terminal s speaker m Play Note on Speaker Note ja y E Duration 2 c Select which note to play at the Note field Valid val
150. ll bitmap images fonts audio files and binary data files that are available in a workspace and eventually in the user application You must add resources to a workspace before you can use them in object instances Use the Edit Resources option to add resource files to your workspace or to change or remove the resources available Because resources become part of the user application when it is compiled you should delete any unnecessary resources When you create a new workspace you have the option to add default bitmap images and fonts to your workspace Some objects may require at least one bitmap BDF font or TT font resource before the object will function properly When you have finished creating a work space however you may want to remove any unused default bitmaps and fonts before you download the user application to the Olarity based terminal to conserve the terminal s flash and RAM memory QSI Qlarity Foundry Templates Resources and Libraries Edit Resources Click A on the toolbar or select Edit Resources from the Edit menu and the Edit Resources dialog box is displayed Edit Resources Bitmaps BDF Fonts TrueType Fonts Audio Binary Bitmap name Sys Filename Alarm bitmaps alarm bmp all bitmaps all bmp bottomLeft bitmaps bottomleft bmp bottomright bitmaps bottomright bmp lightoff bitmaps lightoff brp lighton bitmaps lighton bmp Temp bitmaps temp bmp topleft bitmaps topleft bmp topright bitmaps topri
151. ll not generate an error if the workspace is moved to a computer that does not have that library Include directly If you select this option all system libraries are included directly If the workspace is moved to a computer that does not have one of the system libraries compile time errors will occur NOTE I you select an option to include additional system libraries the library objects do not appear in the Object Palette 5 3 5 Create a New Library Do the following to create a new Qlarity Foundry library QSI Qlarity Foundry 63 Edit Named Colors Templates Resources and Libraries 1 Click Create New Library A dialog box similar to the one shown below is displayed Create new library PR Save in 3 Glarity Foundry gt 3 debugfiles O C AuteDoc hvac sample ca AuxSupport firmware 2 Basic glib 2 dataProc qlib 2 Extra lib 42 Galil mcV2 glib z Modbus 2 qlib a zt multilingual qlib 2 NIObjsV2 gib 2 Opto22 PAC glib s OrbComm glib My Computer My Documents 2 Desktop L My Recent Save as type Library files qlib v Cancel 2 Enter a file name for the new library e g mylib and click Save The extension ib is added automatically The following prompt is displayed Qlarity Foundry Enter a name for the library NewLib a 3 Enter a descriptive name for the library e g arch library or Johns library and click OK
152. llows Display the object This function will be called whenever necessary to show the object func Draw pass as boolean handles MSG DRAW if not pass then SetFGColor RGB WHITE SetBGColor RGB GRAY DrawBox xPos yPos xPos width 1 yPos height 1 DrawLine xPos yPos xPos width 1 yPos height 1 DrawLine xPos yPos height 1 xPos width 1 yPos endif endfunc Notice that the MSG_DRAW handler for a container takes a boolean parameter This is because a container receives two opportunities to handle a MSG_DRAW message once before the message is passed to its children and once after the children have finished handling the message The value that the handler receives in the pass parameter indicates whether or not the message has already been passed to the container s children see Draw Messages in the Qlarity Programmer s Reference Manual 10 5 2 Getting New Object Templates to Work in Qlarity Foundry Since Qlarity Foundry does not have knowledge of the implementation of a Qlarity object the object template must implement handlers for several tool messages to work properly in Qlarity Foundry These messages are generated by Olarity Foundry when the user interacts with the object in Layout View For example when an object is selected it should display a series of resize grips to allow the user to resize the object by dragging the mouse When the resize grips are dragged the object should respond a
153. llows instances to override the function to provide a desired response to the timer expiration The code for the method override is defined inside the object instance The override method must have the same name parameters and return type as the template method that is being overridden For example if the method in the template is named foo and it takes an integer and a float as parameters and returns a float then the override function must also be named foo and must also take an integer and a float as parameters in the same order as the template method and return a float In addition if the template method handles one or more messages the override must handle the same message s This may require you to examine the code in the template possibly in a library Otherwise the method is like any other Qlarity function and may contain whatever Qlarity code is desired The special function Default when placed inside an override method calls the overridden method in the template The same parameters that were passed to the override method should be passed in Default Refer to the Qlarity Programmer s Reference Manual for information on how functions are defined in Qlarity If you find that you are adding identical override functions to many instances of the same object consider modifying the object template to create a new template with the desired func tionality 9 4 Handling Events With Qlarity Code 136 Many
154. log box to add libraries to or remove libraries from the work space Refer to section 5 3 for information QSI Qlarity Foundry Gerrinq Started Navigation Bar Code View only Click to open the Qlarity Foundry Preferences dialog box to define the Qlarity based termi nal s configuration and to enter Qlarity Foundry preferences Qlarity Foundry attempts to sim ulate the terminal s display area input type and so on as closely as possible Refer to Chapter 6 Qlarity Foundry Preferences for information U DA Click to identify the version of Qlarity Foundry you are running 3 5 3 Simulation View Toolbar OCHO 0 p EEES Click to start a new workspace Refer to section 4 1 for information Click to open an existing workspace Refer to section 4 2 for information yo Jj Click to save the current workspace Refer to section 4 4 for information Click to identify the version of Qlarity Foundry you are running Click to set or remove a breakpoint while running a simulation Click to continue running the simulation after it has paused or stopped Click to execute the current line and stop on the next line Click to step into a function call If no function is on the current line this acts as a single step Click to step out of a function call This executes the rest of the current function and returns to the calling function It stops on the first executable line outside of the function call If there is anothe
155. map images available for use in the object instance A different image can be selected by clicking it 116 QSI Qlarity Foundry Basic Design NOTE I Design a User Application Name String ezimage_5 enabled boolean true parent objref default xpos integer 46 ypos integer 37 transparent boolean false transparentcolor color rgb magenta ezimage bitmap default zu blink boolean blinkrate integer checkbox2 gt clock event imageev cubedd eventsourceobj objref fan0 fani eventsourceprop string fan2 eventtargetobj objref fan3 a70_entry eventtargetprop string g70 enviro eventtargetvalue string eg uiton eventobj ezevent empty If 7 appears in a property field when you select the property a drop down list of property options is available Click to display the drop down list and then click the option you want to use If the property is a workspace resource bitmap image font sound or binary data a Select button E is displayed next to the drop down arrow If the resource you want is not in the drop down list click 7 to open the Qlarity Resources dialog box Select a resource and click OK to add it to the workspace and to the property s drop down list Select the resource from the drop down list to place it in the property Refer to section 5 2 Edit Resources for infor mation on the Qlarity Resources dialog box Refer to section 8 3 3 1 Select Color for infor mation on
156. mes available to the workspace will be listed If you previously created a theme selec tion drop down list and have not renamed the object when you select this option the previous theme selection object is replaced with a new one Rescale Application Code View only When migrating an application from a terminal with a 320x240 display to one with a 640x480 display select this option to automatically resize the objects in your workspace based on the new display settings A dialog box is displayed to specify the changes you want to make The Rescale Application feature should be used with care The changes cannot be undone so it is recommended that you save a backup copy of your workspace first Also rescaling an application is just the first step in migration You should examine each object in the workspace after the rescale has occurred to ensure that it scaled correctly Toggle Breakpoint Code View and Simulation View Select this option to set or remove a breakpoint in Code View or while running a simulation New Variable Code View only Select this option to insert a new variable or property in the code A dialog box is displayed to specify the attributes of the new variable or property QSI Qlarity Foundry Getting Started Menu Options Mark Selected Code as Sample Code View only Select this option to flag or unflag selected code lines as sample code Sample code is a form of comment used by the AutoDocumentation system in Q
157. minal Layout Editor Compile Simulation Enabled warnings Unicode support v Syntax error v Parse error v Internal compiler error v Undefined reference v Redefinition error v Illegal native usage v Unresolvable reference v Illegal value v Validation function error 171 Override function error Y Limit BDF Fonts to ASCII characters conserves terminal memory Enable Unicode support in the standard objects Start in Layout View C Extra exception tracking Enabled Warnings All possible warning messages that may appear when compiling a workspace are listed Click the checkbox to select each warning that you want displayed after a compile When you first start programming in Qlarity Foundry you probably want to display all warnings however if you are an advanced user you may find some of the less serious warnings to be unnecessary QSI Qlarity Foundry Olariry Foundry Preferences Simulation View NOTE gt An error message is displayed when an error occurs that prevents compiling Error messages cannot be disabled Limit BDF Fonts to ASCII Characters If this option is enabled only the ASCII characters in BDF fonts are displayed Unless you need to use characters beyond the standard ASCII character set you should enable this option to reduce the memory requirements for BDF fonts The Qlarity based terminal contains 256 ASCII characters Enable Unicode support in the standard
158. n 8 1 3 Drawing Aids Click to open the Qlarity Foundry Preferences dialog box to define the Qlarity based termi nal s configuration and to enter Qlarity Foundry preferences Qlarity Foundry attempts to sim ulate the terminal s display area input type and so on as closely as possible Refer to Chapter 6 Qlarity Foundry Preferences for information Click to identify the version of Qlarity Foundry you are running To change the zoom of the work area click the drop down arrow and select the percentage of zoom from the drop down list This function is also available in Simulation View Click to draw a line around all defined objects This is useful when you want to know the exact border location of each object or when one or more objects were accidently moved out of the work area To select a theme for the colors and borders of the objects in the workspace click the drop down arrow and select the theme you want to use from the list See section 5 4 and section 5 5 for information on themes 19 Toolban 20 Gerrinq Started 3 5 2 Code View Toolbar Cee bl Oe RR Bee X y D El A Hi Ln s A mel ls Ez 5 e E E E Click to start a new workspace Refer to section 4 1 for information Click to open an existing workspace Refer to section 4 2 for information Click to save the current workspace Refer to section 4 4 for information Click to compile the current workspace
159. n Background On the Object Palette icons for all objects in a library use a common color scheme Use these options to specify or change the foreground and or background color of the library s object icons Click Icon Foreground or Icon Background and a color palette is displayed A rectangle appears around the current foreground or background color Click a different color square to change the color then click OK 5 3 3 1 Edit Entry 58 Click an object template entry in the Entry Name list to select it then click Edit Entry to edit the programming code of the selected object This function is only available for source type entries QSI Qlarity Foundry Templates Resources and Libraries Edir Libraries The object template is displayed in a text editor similar to Code View as shown below fm Edit Library Entry ExCheckBoxBDF File Edit Copyright 2001 OSI Corporation Permission is granted to copy distribute and modify this code provided that this copyright statement is preserved eee eee ee a a a ee ee ee ee a ee ee a ee ee a ee ee ee ee a ee a a standard source Draw3DRect standard source TextMultilineBDF standard source Notes Standard source ToolMessages func OnPress return endfunc func OnStateChange return endfunc Whether the object is displayed on the terminal dim enabled as boolean init enabled true func enabled newval as boolean enabled newval Enable me enabled
160. n Functions and Array Element Validation Functions sections of the Olarity Programmer s Reference Manual for more detail Validation functions may also be associated with global variables These global validation functions should be included in the Global Code space NOTE K Ordinarily the validation function assigns the new value to the property using the strict assignment operator Itis important to use the strict assignment operator when assigning the new value to the property inside the validation function If the validation assignment oper ator is used the validation function recursively calls itself until the system software stack over flows Refer to the Validation Methods section in the Qlarity Programmer s Reference Manual for additional details on validation functions 10 3 The Qlarity API Library The Qlarity API Application Programming Interface is a library of functions built into the Olarity system software These functions allow Qlarity applications to interact with the Qlar ity based hardware to perform tasks such as drawing on the display or sending data to a com munications interface Other functions perform common tasks that would be tedious or difficult to implement using the Qlarity language Over 100 functions are available All func tions are documented in the Qlarity API Function Reference chapter of the Qlarity Program mer s Reference Manual QSI Qlarity Foundry 149 Exception Handling Ad
161. n click Set Entry Version to change the version num ber of the selected entry A dialog box is displayed for you to type the new number Click OK to apply the change and close the dialog box 5 3 3 5 Add New Entry A library contains two types of entries Source objects object templates Embedded resources e g bitmaps BDF fonts and TT fonts Only resources that are used in an object template e g a custom button tab etc need to be embedded in the library Libraries can also reference any resource that has been loaded into a workspace However by embedding the resource in the library you make certain that it is available when an object instance is created To add a new entry to a library click Add New Entry The following dialog box is displayed New Library Entry Entry name Entry type Source Entry Name Enter a name for the new entry A name has no size limitation but must start with a letter or underline character _ A name cannot contain spaces but may contain the underline character The percent pound and dollar sign symbols can be used at the end of the name Entry Type From the drop down list select the type of entry 60 QSI Qlarity Foundry Templates Resources and Libraries Edir Libraries Source object template Bitmap resource BDF font resource TT font resource Audio file Binary file Filename If the library entry is a resource e g
162. n which a function resides locate the function in the Object Doc umentation Help file Each utility function in the library begins with the underscore _ charac ter Click the Edit standard button to view the utility functions included in the Natives library Edit Library Path c backup glaritysamples samples hvac sample libraries exradiocheck lib Name ExRadioCheck1 Icon Background O Version 1 00 Entry Name ExCheckBoxBDF ExCheckBoxTTF ExRadioButtonBDF ExRadioButtonT TF Warning Any changes you make to libraries may affect other projects Additionally any changes will take effect immedediately and cannot be undone Entry Type Source Source Source Version 1 00 1 00 1 00 Edit Entry Rename Entry Remove Entry Set Entry Version Add New Entry Do not modify these functions as objects in various libraries also use them In addition any changes you make to Natives library functions are overwritten when you upgrade Qlarity Foundry Refer to section 5 3 3 Edit Library for information on editing functions 5 3 4 2 Edit Core core qlib qhide The Core library contains core object definitions that are used as a base for extension Many standard Qlarity objects extend templates in this library Objects in the Core library do not appear in the Object Palette Select this option to reference code in the Core library 62 QSI Qlarity Foundry Templates Resources and
163. n you click the right mouse button Click el El B to move or offset the graphic in the grid However any pixels with a color other than white are changed to white when they are moved from the display area For example if you change the default fill to black and click twice then click once a one pixel wide white border is added to the right side of the image Click twice and once to add a white top border Click to return the graphic to its original design Click to invert the color of each pixel in the icon 5 1 3 Rename a Template In the Add Edit Templates dialog box do the following to change an object template s name 1 4 Click the template name that you want to edit It is highlighted in blue Click Rename Template Type the new name over the old name Press lt Enter gt to save the new name or press Esc to revert to the old name 5 1 4 Remove a Template In the Add Edit Templates dialog box do the following to remove an object template from the workspace 1 Click the template that you want to remove It is highlighted in blue 2 Click Remove Template 3 A prompt is displayed to confirm that you want to remove the template Select Yes to remove the object template from the workspace QSI Qlarity Foundry Templates Resources and Libraries Add Edit Templates 5 1 5 Send Template to Library After you have created and customized an object template you can add it to a library By plac in
164. nction is the link between an object s properties and its behavior Almost every property should have a validation function so that the object can properly respond to property changes Become familiar with the API library All interaction with the Qlarity based hardware is achieved through API function calls You should be familiar with the functions available and their capabilities Provide default values for all properties This provides a predictable starting point for each newly created object instance QSI Qlarity Foundry 167 Where ro Go From Here Advanced Design 10 7 168 Provide simple to use override functions Many of the objects in the QSI libraries include simple override functions that are called from message handlers Most of these functions are empty by default but they provide a way for each object instance to determine how it will respond to a given event These override func tions often take no parameters and have no return value so they are easy to remember and use For example many button type objects have a Click function that is called from the handler for a touch screen press and release This function is empty by default but it provides an inter face for each object instance to customize its response to a press or release event Keep the MSG_DRAW handler small Drawing requires the most computations on the Qlarity based terminal The MSG_DRAW handler for an object should be as concise and efficient as pos
165. nd lt li Clr_ButtonForeground Cir_ButtonForeground lt M ci_FiiCotor E Clr_LabelBackground m Ch_ScreenBackground Clr_ScreenForeground E Cir_SoftkeybarB ackground A Cir_SoftkeybarButtonB g E Ch_SoftkeybarButtonFg 4 Edit named colors Preview z Ch_LabelForeground The list of named colors is also displayed in this dialog box The current color of the property is displayed beneath the palette If it is a named color the named color label is highlighted in the list If it is a color from the color palette it is selected in the color palette To edit a named color click Edit Named Colors Refer to section 5 4 for information on editing and creating named colors 118 QSI Qlarity Foundry Basic Design Event Builder Click either a named color or a color in the palette to assign a different color to the property If you want to match a color from another object in the workspace click 2 and an image of the workspace is displayed Click in the area of the workspace that has the color you want to match The color of the area you clicked is shown in the Sample box In addition the 4X box dis plays the area magnified four times Edit named colors Preview Ea Ch_ButtonForeground You can click a color in the 4X box to select it This is useful if you want to identify a color in a congested area of the display You can also click in the 4X box and drag the mouse to shift the displa
166. nd an Open dialog box appears Select the library or libraries that you want to add change the folder if neces sary and click Open The library is added to the workspace Click Close to save your changes and exit the dialog box The workspace is compiled and the objects in the new library are available for use in the workspace Save the workspace to save the information to disk 5 3 2 Remove Library Do the following to remove a library from the current workspace 1 All libraries that are loaded in the workspace are listed Click the library that you want to remove It is highlighted Click Remove Library and the library file is removed from the workspace Click Close to save your changes and exit the dialog box The workspace is compiled and the objects in the library are no longer available for use in the workspace 5 3 3 Edit Library NOTE I QSI Qlarity Foundry Library editing functions require an understanding of Qlarity programming Refer to Chapter 9 Intermediate Design and Chapter 10 Advanced Design for information on Qlarity pro gramming You should not edit QSI libraries QSI libraries are regularly updated and the new libraries replace the existing ones so any changes are overwritten You should edit only libraries that you created see section 5 3 5 Create a New Library You can modify an object template by importing it into your workspace see section 5 1 1 Add a New Object Temp
167. ndler is an objref referencing the parent object The handler updates its parent property and calls Tool Persist Note that the MSG INIT handler is called from the handler to complete the object initialization The tool message handlers for containers and area objects are identical In addition to the han dlers described above the boilerplate code for these object types includes handlers for the MSG TOOL MOVE MSG TOOL GETHANDLES and MSG TOOL MOVEHANDLE messages Also the MSG TOOL DRAGCREATE handler is larger and more complex than the handler for non drawables The MSG TOOL ATTACH and MSG TOOL ATTACHED handlers are identical to the han dlers in the non drawable code so they are omitted here The code for the MSG TOOL MOVE handler is as follows This function is called when the user drags an object instance gt with the mouse in Qlarity Foundry dx and dy are relative gt offsets from the current location of the object func ToolMove dx as integer dy as integer handles MSG TOOL MOVE xPos xPos dx yPos yPos dy Relocate me xPos yPos QSI Qlarity Foundry Advanced Design Create a New Object Template Save the changes we just made Tool Persist xPos Tool Persist yPos endfunc When the user drags an object in Layout View the object dragged receives MSG_TOOL_MOVE messages from Qlarity Foundry The change in position is passed to the handler in the dx and dy values The objec
168. ndry on the same com puter a warning appears indicating that the workspace is in use If you want to save the work space you will have to save it with a different name select Save Workspace As from the File menu to ensure that no data is overwritten 4 3 Close a Workspace Select Close Workspace from the File menu to close the current workspace and start a new workspace The following prompt appears Qlarity Foundry 2 J Save changes to New Workspace 3 Cow 3 Cem 40 QSI Qlarity Foundry Workspaces Save a Workspace Click Yes if you want to save the workspace that was loaded or click No if you do not want to save it A new unnamed project is started using the default resources from the previous workspace At this point you can start a new project or open a different project using the Open Workspace option 4 4 Save a Workspace The first time you save a new workspace the Save As dialog box appears so that you can enter a name for the workspace file see section 4 4 2 Then when you save the file it is saved to the file name you entered If you want to make a copy of the workspace or change the file name use Save Workspace As If you want to transfer a workspace to another computer use the Collect for Output function see section 4 4 3 below 4 4 1 Save Workspace To save a workspace click on the toolbar or select Save Workspace from the File menu If you have already named the w
169. ng a SEES locis causes an error For additional fonts an Y Include extra fonts bitmaps select Edit Resources from the Edit menu Include an error handling object Screen Saver Dancing Lines Select additional object libraries No library selected Basic qlib DataProc qlib Extra qlib Galil mcV2 glib i1708V1 alib MitsubishiFX glib ModbusV2 glib multilingual qlib hs Your project is now ready Select any addition options for your application then press Finish This dialog box allows you to add or remove resources Include a default font and bitmap Before some objects can be added to a workspace at least one font or bitmap image must already exist in the workspace if not an error occurs For this reason it is recommended that you include the default fonts and bitmaps Include extra fonts To include additional fonts in your workspace select this option Include an error handling object By default an error handling object ExceptionDisplay is added to your workspace that iden tifies and displays descriptions of any errors in your code It is recommended that you include this object in all of your workspaces Screen Saver The default screen saver displays a pattern of dancing lines for a period of time before it blanks the display By default the display switches to dancing lines after fifteen minutes and to a blank display after thirty minutes You can change the default by selecting
170. ng template in a library O Extend inherit a template from an existing template in a library Template name Object type Area Object x Select one of the following options to start the new template Create a template ready to operate in Qlarity Foundry Use this option to insert the new template boilerplate code into your workspace see section 10 5 1 New Template Boilerplate Code Create a completely blank template Use this option to start with a blank unprogrammed object template You will need to add all Qlarity code Type a name for the new template in the Template Name edit box Select the type of object non drawable area object or container from the Object Type list box Click OK The new template name appears in the Add Edit Templates dialog box Click Close to close the Add Edit Templates dialog box Select Code View The new template name appears under the Templates icon in the Object Tree Templates are not shown in the Object Tree in Layout View Click on the new template in the Object Tree If you created a template ready to operate in QF the boilerplate code appears in the edit window Variables declared inside a template become properties of the template object and func tions declared inside the template become the object s methods Add delete or modify properties and methods as desired When you are finished defining the template click or select Compile f
171. nitialization The boilerplate handlers should suffice for most objects and the code is easily modified to suit unusual circumstances Writing these handlers from scratch can be tedious and error prone For this reason using the boilerplate code as a basis for new object template designs is recom mended 10 5 3 Adding Object Template Documentation QSI Qlarity Foundry AutoDoc is a Qlarity Foundry feature that automatically documents the object templates included in a workspace All libraries provided with Qlarity Foundry as well as functions 165 Create a New Object Template Advanced Design 166 variables and APIs are already included in Object Documentation and the optional extra pop up Help see section 6 2 Layout Press F1 or select Object Documentation on the Help menu to open Object Documenta tion To add documentation on global variables global functions objects methods or properties that you create you must add the proper doc code to your code AutoDoc will then find the information you enter and add it to the Object Documentation To document a program item type the following in the same location as the item e g to doc ument an object property enter the documentation within the object This documents an object property OR global variable doc property lt name gt doc prop lt name gt This documents a global function or object method doc func lt name gt doc
172. nked to the selected object in the Object Tree To move an object to the root container select default senddata This property receives the data string that is to be sent through the Ethernet port Data can be sent to this property from an Ethernet object configured in Event Builder see section 8 4 When the Ethernet object s senddata property receives data it automatically sends the data followed by a semicolon out the port protocol Enter the protocol to be used to send the data e g UDP or TCP localport Enter the address for the UDP or TCP port on the Qlarity based For additional information refer to your Ethernet protocol or contact your network administrator foreignport Enter the address for the UDP or TCP port on the host For additional information refer to your Ethernet protocol or contact your network administrator ipaddr Enter the IP address of the device to which you are sending data appendterminator This property determines whether a semicolon is appended to the end of all data sent out the Ethernet port 130 QSI Qlarity Foundry Basic Design Tesr rhe User Application 8 5 3 Receive Data You can send data from an external device e g computer to a Qlarity based terminal via the port serial or Ethernet To do this you specify an object and its property to receive the data in a user application This changes the specified property value to the received data value Use the following form
173. ns other objects such as the Screen object in the common lib library A container object may occupy part of the terminal display or the full display area QSI Qlarity Foundry Basic Design Understanding Olaniry fon Basic Design You use container objects to define an association between objects and to indicate how they are displayed All objects in a container process information as a group Containers are often stacked and identified with tabs 8 2 3 Parent Child Relationships Qlarity allows you to group objects together How objects are grouped determines how infor mation is processed messaging and how the terminal screen redraws The complexity of your user application determines how much you need to group objects Grouped objects have a parent child relationship with the parent always a container object and the objects inside the container the children Each user application starts with a root container Though invisible it is the container in which you place all other objects The following illustration shows a root container with sev eral objects in it Root Container Container Object Container Object Object Object Object Object Object Object linked to Root Container In this illustration two container objects plus another object are linked to the root container In addition each container object has objects linked to it which are referred to as its children In Qlarity Foundry when you ad
174. nstall Location NSimFiles 28 QSI Qlarity Foundry Getting Started Simulation View 3 9 3 Simulation View Limitations Simulation View has the following limitations When using a keyboard the repeat delay rate is determined by the global setting in Windows This will only match your terminal s settings if you set it to match on your PC PrintScreen and Pause Break keys cannot be properly simulated SetSystemSetting and related API functions may not be fully simulated 3 9 4 Source Level Debugger A source level debugger is included in Qlarity Foundry This allows an application developer to look at the execution of the Qlarity code line by line in order to find programming errors If an error is expected in a specific place in the code a breakpoint can be set at that point and execution will stop when that point is reached during simulation Then variable values as well as the flow of execution can be examined to determine the problem The following options are available on the Simulation View Tools menu and toolbar to help debug an application n ToggleBreakpoint F9 Select to set or remove a breakpoint Run F5 Select to continue running the simulation after it has paused or stopped Single Step F8 Select to execute the current line and stop on the next line G Step Into lt F11 gt When you select this option if the current line contains a function call the first executable lin
175. or Downloading You may need to set up the Qlarity based terminal for downloading using the terminal s Power On Setup utility Refer to the Olarity Based Terminal Hardware User s Manual for informa tion on using Power On Setup 7 2 2 Download the User Application Do the following to download a user application to the terminal refer to the previous section for information on preparing the terminal for download 1 Select Download Application from the File menu and the Download dialog box is dis played QSI Qlarity Foundry 91 Download a BFF File Download Software ro the Terminal 6 Download application to unit Serial Ethemet USB pod App download size 103802 Port COM w Flash required 128 kBytes Baud rate 9600 i Data Format ge v Download application Send string over serial connection Download other BFF mm Upgrade firmware s Induce Set unit time seii Results ae Clear results box Close Window Open serial port whenever this screen is shown Click Download Application to proceed A progress graph tracks the download and the Results box displays messages indicating whether the download was successful If an error occurs verify that your communications settings are correct Power the terminal off and back on and once again place the terminal in the proper mode Repeat the down load process NOTE EG Click Clear Results Box to clear the messages in the Results box
176. order and color settings as theme 5 5 2 6 Delete Named Border To delete a named border that you created select it then click Delete named border A prompt is displayed to confirm that you want to delete it Click Yes to delete the named bor der You cannot delete the default named borders 70 QSI Qlarity Foundry Templates Resources and Libraries Edit Named Borders 5 5 2 7 Rename Named Border To rename a named border that you created select it then click Rename border A message is displayed to warn that you should not rename a named border that has been assigned to objects If you do the workspace will not compile Click Yes to rename the named border After changing the name click OK to save the change You cannot rename the default named borders 5 5 2 8 Reset Border to Default QSI Qlarity Foundry To restore the originally assigned attributes to a theme s default named border select the named border you want to reset and click Reset border to default 71 Edir Named Borders Templates Resources and Libraries Notes 72 QSI Qlarity Foundry CHAPTER 6 QLARITY FOUNDRY PREFERENCES 6 1 Terminal QSI Qlarity Foundry Use the Settings option to record the display configuration of your Qlarity based terminal and to enter Qlarity Foundry preferences Qlarity Foundry requires this information to simu late as accurately as possible the terminal display The Settings option is also use
177. orkspace the file is saved If it is a new workspace and you have not yet named it the Save As dialog box appears see section 4 4 2 4 4 2 Save Workspace As To save a workspace to a different name select Save Workspace As from the File menu The following dialog box is displayed Save workspace as Save in C3 samples a Communications CJ BIS samples demo i eventbuilder demo O EA games desc Gahvac sample other c Sbasic_keyboard aly CJ basic serial communication dly touchball 2 dns_ethernet_client qly 2 Ftp_client_interface qly O Diistbox_alarms qly Qlaritylnvaders DQ password protected_screen qly 23 DataProc File name Save as type Glarity files d E QSI Qlarity Foundry 41 Compile A Workspace Workspaces Select the folder in which you want to save the file In the File name field type the name that you want to give the workspace you do not have to type the extension Click Save to save the workspace The original file is retained The new file is a copy of the original file If you are renaming the file you will need to delete the original file 4 4 3 Collect for Output Use this option to collect all of the resources used in a workspace into one file You can then move the file to another computer and all resources will be available to open the workspace To transfer a workspace to another computer select Collect for Output from the File men
178. ormation about any QSI library object open Object Documentation lt F1 gt The following illustration shows an example of the Properties window for a button object 115 Design a User Application Basic Design Object Properties QwertyKeypad default 256 115 14 34 inactive false note_usedefault tone error note usedefault clickonpress false separators false marqueepos dkp topdetached popupstyle _gkp_nopopup passwordmode false shifted false hasenter true hascancel true marqueeinset 0 Note that the properties are grouped by category Click the name of a category to open or close the list of properties in the category Refer to section 3 10 for a description of each category The first column lists the name of each property Property names are defined in the object tem plate The middle column optionally displayed see section 6 2 Layout lists the data type of each property for information only The property settings which you can change are listed in the third column Click the property that you want to change Enter the new property setting in the third column You can enter new property settings by typing the new information type over the default set ting or by selecting from a drop down list or dialog box In the following illustration the property ezimage is selected This is the name of the bitmap image used in the object instance The drop down list shows all bit
179. ort Setup 8 7 Save and Compile a Workspace 8 7 1 Save a Workspace You should save your workspace often while you are working on it to prevent losing work in La the event of a computer lockup or power failure To save a workspace click on the tool bar or select Save Workspace from the File menu For more information on saving a work space refer to section 4 4 8 7 2 Compile a Workspace You should compile your workspace periodically while you are working on it to properly dis play the changes in Layout View Compiling is also required before you download a user application Click on the toolbar or select Compile Workspace from the File menu to compile the current workspace into the format required for a user application If the compile is successful the program displays the workspace in Layout View If any errors occur during the compile the program switches to Code View and the error messages are dis played in the Compile dialog box 8 8 Download a User Application Before you can download a user application to the Qlarity based terminal you need to config ure communications in Qlarity Foundry and at the terminal and prepare the terminal for down load For information on setting up communications refer to section 7 1 For information on preparing the terminal for downloading refer to section 7 2 1 For information on downloading a user application to the terminal refer to section 7 2 2 132 QSI Qlarit
180. ot displayed on the Qlarity based terminal hidden objects are displayed on the terminal unless they are disabled they are only hidden in Qlarity Foundry Refer to section 3 7 for information on the show hide option Stop Qlarity Interpreter When a workspace is compiled the Qlarity interpreter runs a portion of the user application in Qlarity Foundry Select this option to stop the user application from running For example if an object instance contains an infinite loop you will not be able to work in Layout View You can select this option to terminate the interpreter and switch to Code View so you can correct the problem The Olarity interpreter may detect the infinite loop when it tries to run the application and dis play a prompt for you to stop the application Settings Use this option to open the Qlarity Foundry Preferences dialog box to define the Qlarity based terminal s configuration and to enter Olarity Foundry preferences Qlarity Foundry attempts to simulate the terminal s display area input type and so on as closely as possible Refer to Chapter 6 Qlarity Foundry Preferences for information 15 Menu Options 16 NOTE p Getting Started Snap to Grid Layout View only Select this option to enable or disable the snap to grid function If enabled this feature forces objects to snap to the nearest grid point when added or moved The top left corner of an object s rectangle snaps to the nea
181. other function declare a new variable by typing the dim dimension keyword followed by the name of the variable the keyword as and then the type of the new variable For example the following code declares a new integer variable named count dim count as integer If desired also assign an initial value to the variable by adding a new line containing the keyword init the name of the new variable the operator and the initial value of the variable For example the following line initializes the new count variable to a value of 10 init count 10 Repeat steps 3 and 4 for as many variables as desired Click or select Compile from the File menu to compile the workspace Any errors in the new source code are identified by messages in the Messages and Errors window If no errors are present the compiled workspace is returned to Layout View 9 5 2 Adda Global Function to a Workspace 140 To add a global function to the workspace do the following 1 Select Globals in the Object Tree to access the Global Code space QSI Qlarity Foundry Intermediate Design Global Code 2 Select Code View The editor window displays any current global source code 3 Ona blank line in the editor window outside of any other function declare a new function by typing the func keyword followed by the name of the function a left parenthesis the parameters of the new function and a right parenthesis If the f
182. ou press Tab Show Advanced Code Sections in Object Tree Normally disabled Select this option to show the advanced code sections in Code View This adds an Advanced Code Libraries and Internals branch to the Object Tree and enables advanced users to work with advanced and library code For information on these functions refer to section 10 1 Fast Selection This option determines how text selected in Code View is displayed If you enable this option selected text is inverted If disabled text is blocked and highlighted Parenthesis Matching If you enable this option when the cursor in Code View is at a parenthesis or square bracket character both the character at the cursor and the matching parenthesis or square bracket are underlined If disabled parentheses and square brackets are not matched 79 Ediron Olariry Foundry Preferences 6 3 7 Edit Events in the Event Builder If you enable this option the default event editor is Event Builder see section 8 4 If disabled the default event editor is Code View In Layout View double click an object that supports events to launch the default event editor 6 3 8 AutoHelp Settings The AutoHelp feature assists you in writing Qlarity source code If specific settings are enabled while writing code in Code View pop up lists are displayed from which you can make selections Click AutoHelp Settings to set up or disable the AutoHelp options AutoHelp Settings F
183. owing window appears InstallShield Wizard Ol a rity InstallShield Wizard Complete Setup has finished installing Qlarity Foundry 2 60 on your computer 7 Click Finish Installation is complete 6 QSI Qlarity Foundry CHAPTER 3 GETTING STARTED 3 Start Qlarity Foundry To start Qlarity Foundry click Start then click Programs and select QSI Corporation Click Launch Qlarity Foundry to start the program 3 1 1 Hardware Configuration Assistant The first time you launch Qlarity Foundry the Hardware Configuration Assistant is displayed To display the Hardware Configuration Assistant thereafter click Hardware Configuration Assistant at the Welcome to Qlarity Foundry dialog box see section 3 2 Open a Work space Hardware Configuration Assistant Select Terminal Type QTERM G70 QTERM G75 i il OTERM Z60 QTERM G58 Sa QTERM G56 Display Color TFT Orientation Landscape Serial Ports 1 port PS 2 Keyboard O Ethemet Audio Decoder Use the Hardware Configuration Assistant to specify the type of terminal you are program ming and to describe its hardware configuration and orientation QSI Qlarity Foundry Open a Workspace Getting Started Select Terminal Type Select the type of terminal you will be programming from the list of terminal types or by click ing its image on the left The options available at the remaining fields are determined by the type of termina
184. ownload a user application to the Qlarity based terminal QSI Qlarity Foundry CHAPTER 2 INSTALLATION This chapter provides instructions for installing and setting up the Qlarity Foundry software 2 1 System Requirements Computer Requirements 500 MHz processor or faster 256 Mbytes of RAM 1 Gbyte recommended 70 Mbytes available hard disk space Operating System Requirements Microsoft Windows XP or later 2 2 Install Qlarity Foundry To install Qlarity Foundry take the following steps 1 Close any open Windows applications 2 Insert the Qlarity Foundry CD ROM into your CD ROM drive The Setup program should auto start If it does not auto start click Start and click Run The following window appears Run 3 xl pmm Type the name of a program folder document or Internet k resource and Windows will open it for you Open F setup exe h Cancel Browse Type e 1 setup in which e is the letter of your CD ROM drive The following message appears as the installer is configured QSI Qlarity Foundry 3 Install Olaniry Foundry Installation InstallShield Wizard which will quide you through the program setup process Please wait e Qlarity Foundry 2 60 Setup is preparing the InstallShield Wizard Configuring Windows Installer The InstallShield Wizard is loaded and the following window appears InstallShield Wizard Clarity ity Welcome to the InstallShi
185. p Group names may contain multiple words and are not restricted to the Qlarity naming rules B 2 Documentation Body A documentation declaration is usually followed by one or more documentation body ele ments A documentation body element must begin with the tilde character and must begin a line Documentation body elements may optionally contain HTML tags for formatting pur poses doc func VerifyState This function checks the state of persistent variables in the application and verifies that each contains a valid value lt BR gt lt BR gt This function lt B gt must lt b gt be called during a MSG INIT message B 3 Linking Items You can link related documentation items using the following syntax link lt element type gt lt element name gt lt alternate text gt This will insert a link to the documentation element specified by lt element type gt and lt element name gt The optional lt alternate text gt specifies the text that will appear in the documentation doc prop comPort Specifies the com port used for communication The value of this property will be passed to the link func Transmit API function doc prop resetNow Setting this property to true will cause the terminal to reset as if Hlink func SoftReset SoftReset RESET NORMAL had been called 174 QSI Qlarity Foundry AutoDoc specification Importing Items B 4 Importing Items QSI Qlarity Foundry You can import all or part of t
186. played in a box that is filled with a gradient fill 175 Function PARAMETERS AutoDoc specification Examples This function will return one of the following values importdoc type weekday itemlist indent box Please review the following valid protocols importdoc type netprotocol all B 5 Function Parameters When documenting functions you may use the param directive to describe the parameters of the function When the documentation is displayed the parameters are summarized in an easy to read table param directives are also used for the AutoHelp feature in Qlarity Foundry param lt parameter name gt lt parameter description gt This assigns lt parameter name gt the given lt parameter description gt The param directive must appear entirely on one line It may not be split into multiple lines doc func sqrt param real The value whose square root will be calculated Calculates the square root of the parameter lt b gt read lt b gt and returns that value func sqrt real as float returns float calculate the square root endfunc You may also use the link or importdoc directives in a param directive as follows param LEDCommand Determines the behavior of the LED One of the following values importdoc type ledcmd itemdesc param PixmapToProcess A pixmap to process This should be an array returned from the link func GetObjPixmap function B 6 Data Type Elements 176 When documenting d
187. plication consists primarily of objects An object template defines a new type of object with certain properties and behaviors Any number of object instances that are based on the object template may be added to an application Object templates typically reside in libraries where they can be used in many different applica tions However templates can also exist in a normal workspace When templates are part of a workspace they appear at the bottom of the Object Tree when Code View is selected A template defines the properties variables and methods functions for a certain type of object The properties and methods in a template completely define the behavior of object instances that are created from the template Properties may also be assigned default values in the template These values are used if the object instance does not assign an initial value to a property Details on creating templates are provided in Chapter 10 Advanced Design Each object instance may be customized by changing the values of the properties and by over riding methods defined in the template A method override is a function defined in the object instance that replaces the method of the same name defined in the template for the specific instance only If the functionality of the template method is desired it can still be called from inside the override method Customizing object instances by changing their initial properties requires no programming and i
188. pport Simulation View supports serial I O using the Communications window bottom left corner of the display Communications Window B 5x a Test was completed Coml Com2 Test was completed Serial data programmed to be transmitted through the terminal s Com1 or Com2 port appears in the lower portion of the Communications window You can also enter data in the upper por tion of the window and click Xmit to simulate data being sent to the terminal Click to access the Communications Settings dialog box see section 6 5 1 for informa tion Click to clear flush the contents of the window Click to copy the contents of the window 3 9 2 File System Support The full Qlarity file system is supported however it is not persistent between sessions of Qlar ity Foundry i e it is erased when you close Qlarity Foundry Simulation View s file system is limited to 64 kilobytes of data except as described in the next paragraph In Simulation View only a special folder exists in the root of the file system called sim including the colon Files saved to this folder and subfolders under this folder are written directly to your computer s hard drive and can be accessed outside of Qlarity Foundry Also files written in this folder are persistent between Qlarity Foundry sessions They are also exempt from the 64 kilobyte data limitation Files stored under sim can be accessed on your hard drive from Qlarity Foundry I
189. ptions Object Tree Object instances that have been added to the workspace are listed under Globals and object templates are listed under Templates in the Object Tree Some objects may be automatically added to a workspace when it is created including the following ScreenSaver blanks the screen after a period of inactivity ExceptionDisplay displays unhandled Qlarity Exceptions Work Area This is the area in Layout View in which you place object instances to add them to the work space The work area simulates the display of the Qlarity based terminal Object Palette The Object Palette contains an icon for each object template in the workspace and in any active libraries You click the icons to add new object instances Move the mouse pointer over an icon to display the object s name Refer to section 3 11 for more information Properties Window The Properties window is displayed by default Click an object instance in the Object Tree or work area and its properties are displayed Refer to section 3 10 for information View Tabs To set up the workspace you can work in either Layout View or Code View Layout View is a graphics mode used to lay out the terminal display Generally unless you are making changes to the programming code you will work in Layout View Code View is used to write or edit an object s programming code You will generally only work in Code View if you are customiz ing objects or creating yo
190. quipment generates uses and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual may cause harmful interference to radio communications Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at his own expense Any modification to this device including any changes to the recommended antenna configuration that are not expressly approved by QSI could void the user s authority to operate this device FOREWORD Qlarity Foundry is a Windows based design tool that uses the Qlarity programming language to help you design user applications for a Qlarity based terminal Chapter 1 Chapter 2 Chapter 3 Chapter 4 Chapter 5 Chapter 6 Chapter 7 Chapter 8 Chapter 9 Chapter 10 Introduction This chapter explains how to use this manual to get the most out of Olarity Foundry and describes Qlarity Foundry Installation This chapter covers the installation and setup of the Qlarity Foundry software Getting Started This chapter outlines Qlarity Foundry s features and functions Workspaces This chapter explains how to start open close save and use workspaces in Qlarity Foundry Templates Resources and Libraries This chapter explains how to add and edit templates advanced function edit resources and edit libraries Qlarity Foundry Preferences This chapter exp
191. r breakpoint in the current function execution stops there Click to stop execution at the next executable line of Qlarity code Click to remove all of the breakpoints that were set a To change the zoom of the work area click the drop down arrow and select the percentage of Zoom 100 y i ae re 2 zm ie 7 zoom from the drop down list This function is also available in Simulation View qe Smf fit ii E3 Ee 9 3 6 Navigation Bar Code View only The top of the Code View window contains a navigation bar to aid in code development The contents of the navigation bar may vary based on the section of code you are editing QSI Qlarity Foundry 21 Navigation Ban Code View only Getting Started 22 3 6 1 Global Template or Library Code When editing Global Template or Library code the navigation bar contains the following components Message Handlers v Existing functions v New Variable Insert at cursor Message Handlers Click the drop down arrow to display a list of valid message handlers in the current code sec tion Message handlers that have already been implemented are shown in bold Select a mes sage handler to either add it to the selected message or to move the cursor to the selected message handler if it has already been added Refer to section 9 5 3 for more information on message handlers Existing Functions or Existing and Inherited Functions Click the drop down arrow to display a list of all existing
192. r sign symbols can be used at the end of the name Refer to section 8 3 2 for information on moving resizing and changing the order of objects 8 3 1 2 Add an Object From the Shortcut Menu Do the following to add a new object instance from the Object Tree shortcut menu 1 Right click anywhere in the Object Tree to display the shortcut menu 2 Click New Object Instance The Instance Properties dialog box is opened All available objects are listed in the drop down list at the Type field as shown below Instance Properties Name Newlnstancel Type a LevelDesign 1 LevelTemplate Line Bl UnifiedLevel Vaus FE boardPrev brick 3 At the Name field type a name for the new object type over the default name Each object in the workspace must have a unique name An object name has no size limitation but must start with a letter A name cannot contain spaces but may use the underline char acter _ The percent 26 pound and dollar sign symbols can be used at the end of the name 4 Atthe Type field click the drop down list and select the type of object that you want to add After you select an object it is added to the work area at its default location and is listed in the Object Tree The newly added object remains selected and its properties are displayed You can edit the properties as required QSI Qlarity Foundry 111 Design a User Application Basic Design 8
193. r the mouse pointer if Highlight object under the mouse is selected The selected color outlines the object as the pointer moves over it Object Outlines The outlines around objects if Outline all objects on the toolbar is enabled Grid Grid lines appear in the selected color if Show Grid is enabled Allow Locked Objects to be Moved within Object Tree If an object is locked it cannot be moved in the work area If this function is enabled however a locked object can be moved in the Object Tree Click the Editor tab to set up options for Code View The code editor is displayed when Code View is selected and is used to enter and edit objects programming code TI Ediron 78 6 3 1 Colors Qlarity Foundry Preferences Terminal Layout Editor Colors Normal Text Keywords Strings Symbols Comments Documentation Errors L Selection Popup help background Mese te bondon Automatic color Olariry Foundry Preferences Compile Simulation Font ETCITENENEEEE V Tab Spacing 4 m picea as code sections in the C Fast Selection Parenthesis Matching C Edit events in the Event Builder Reset all colors to default AutoHelp settings You can specify a background color or different colors for different parts of the programming code as follows Background Normal text Keywords Strings e Symbols Comments Documentation Errors Selection
194. r to the work area The pointer changes to a cross hair Click and hold the mouse button and drag the mouse to draw a rectangle in the work area then release the mouse button Some objects have a default starting size and shape so the size of the rectangle doesn t matter only its position in the work area The size of other objects such as a line or rectan gle is initially determined by the size of the rectangle you draw If you are adding a non drawable object the location in the work area doesn t matter since the object is not part of the display You may want to use the shortcut menu to add a non drawable object in its default position see section 8 3 1 2 Add an Object From the Shortcut Menu for information NOTE K Toadd more than one instance of the same type of object press and hold the Shift key when you click the object icon The object type remains selected and you can just click and drag in the workspace to add objects until you release the Shift key 110 QSI Qlarity Foundry Basic Desiqn Design a User Application 4 After you add an object it remains selected and its properties are displayed Click the Name property and type a name for the new object type over the default name Each object in the workspace must have a unique name An object name has no size limitation but must start with a letter A name cannot contain spaces but may use the underline char acter _ The percent pound and dolla
195. r will it have resize grips 10 1 2 Libraries The Libraries section allows an advanced user to view and debug code in the included librar ies It is recommended that you do not edit QSI provided libraries By default library code entries are locked and may not be edited To unlock a library code entry click the lock icon next to the entry name To aid in debugging a workspace software breakpoints can be set in the library code 10 2 Validation Functions 148 Validation functions are special functions that are closely associated with object properties or global variables When a property is assigned a value using the validation assignment operator the associated validation function is implicitly called and passed the new value as a param eter This facility allows objects to appropriately respond to property changes Validation func tions are also called when certain API functions such as Val and SetObjPropO are used to assign a value to a property Validation functions are also useful for assuring that the new value is valid or within an appro priate range hence the term validation function To associate a validation function with a property the function must have the same name as the property In almost all cases it must take a single parameter of the same data type as the prop erty The name of this parameter can be any legal Qlarity variable name but it is good style to use acommon name for all your validation f
196. rest grid point when you release the mouse button View Grid Layout View only Select this option to show or hide the grid You can display a grid over the work area to help you more accurately place and align objects For information on changing the spacing or color of the grid refer to section 8 1 3 Drawing Aids Align Size Space Objects Layout View only This option provides several tools for aligning sizing and spacing objects in your workspace Select the object you want to manipulate then select the tool from the submenu Refer to section 8 3 2 4 Align Size Space Objects for more information Add Theme Selection Listbox Layout View only Select this option to create a listbox object that can be used to dynamically select color and border themes for all objects in the workspace See section 5 4 and section 5 5 for information on themes The current themes available to the workspace will be listed If you previously created a theme selection listbox and have not renamed the object when you select this option the previous theme selection object is replaced with a new one Add Theme Selection DropDownList Layout View only Select this option to create a drop down list object that can be used to dynamically select color and border themes for all objects in the workspace similar to a theme selection listbox but uses less display space See section 5 4 and section 5 5 for information on themes The cur rent the
197. rom the File menu to compile the workspace Any errors in the new source code are identified by mes sages in the Error Messages box If no errors are present the compiled workspace is returned to Layout View 153 QSI Qlarity Foundry Create a New Object Template Advanced Design Notice that the Object Palette contains a default icon representing the new template 12 To edit the icon or change the name click on the toolbar or select Add Edit Tem plates from the Edit menu Click the template name in the Add Edit Templates dialog box then click Edit Icon Refer to section 5 1 2 Edit a Template Icon for more infor mation 10 5 1 New Template Boilerplate Code The new template boilerplate code can be used as a foundation for building new objects Using the boilerplate code can greatly simplify the creation of new objects This section provides an overview of what the boilerplate code is and the functionality it provides The actual boiler plate code generated by Qlarity Foundry is continually being improved and may differ from the code described in this section The functionality however is mostly the same EER Qlarity Foundry 2 60 glearout gly TestTemplate Ele Edt yew Jools Hep al ad RP av x0 v abie Insert at cursor Object Tree Enwstng functions E Globais gi mema gi Template BS Board S boardPre brick k LevelDesign 1 Levelfempiste Line Too lMessages D Unif
198. s width 1 xCoords 3 xCoords 2 xCoords 4 xCoords 2 xCoords 5 xCoords 1 xCoords 6 xPos xCoords 7 xPos yCoords 0 yPos yCoords 1 yPos yCoords 2 yPos QSI Qlarity Foundry 161 Create a New Object Template Advanced Design yCoords 3 yPos height 2 1 yCoords 4 yPos height 1 yCoords 5 yCoords 4 yCoords 6 yCoords 4 yCoords 7 yCoords 3 cursors csrs closed true endfunc The MSG_TOOL_GETHANDLES message is sent to an object by Qlarity Foundry when the object is created All objects receive this message when a workspace is initialized Qlarity Foundry requests the locations of the resize grips sizing handles that are drawn on an object when it is selected The handler is passed references to three arrays xCoords yCoords and cursors and a boolean variable named closed The handler places values in these parameters to indicate the location and style of the resize grips The handler first creates and initializes an array of type GuiCursors This is an enumerated type whose values indicate the style of the corresponding resize grip The selected style deter mines what cursor is drawn when the mouse passes over the resize grip and the restrictions on drag movement for the resize grip See Tool Messages in the Qlarity Programmer s Refer ence Manual The xCoords and yCoords arrays receive the horizontal and vertical locations for each resize grip respectively
199. s an application can be customized by adding variables and functions to the Global Code space Global variables can be used to hold data not stored in objects Global functions can implement commonly performed routines that might be shared by many objects Also most messages can be handled by global message handlers if desired Message handlers are special functions that are called by the system software when the mes sage that the function handles is processed Refer to Chapter 10 Advanced Design for more information on messages 138 QSI Qlarity Foundry Intermediate Design Global Code Since global functions are not overrides there are few restrictions on the names parameters or return type for global functions 9 5 1 Adda Global Variable to a Workspace A global variable is a variable that is declared in the Global Code section outside of any object There are two methods for adding a global variable e Use the New Variable option in Code View easiest method Enter the variable directly into the Global Code section in the Code View window 9 5 1 1 Add a Global Variable Using New Variable Do the following to add a global variable using the New Variable option 1 Click the Code View tab 2 Click Globals in the Object Tree to open the Global Code section Any current global source code is displayed in the editor window 3 If you want the new variable inserted at a cursor location select Insert at Cursor
200. s and hold the Shift key when you click the object icon The object type remains selected and you can just click and drag in the workspace to add objects until you release the Shift key 4 After you add an object it remains selected and its properties are displayed You can then edit the properties as required including assigning the object a unique name To resize an object do one of the following Use the mouse If the object has resize grips sizing handles you can click and drag any handle to resize the object Resize sica Use the Properties window Change the height and or width integer in the Properties win dow Select from the drop down list or type in the new value To move an object do one of the following Click in the center of the object hold down the mouse button and drag the object to a differ ent position You can hold down the Shift key while moving an object to limit its move ment to horizontal vertical or a 45 angle Change the x and or y position integer in the Properties window Select from the drop down list or type in the new value 3 12 Move and Resize Windows 34 The following windows can be moved resized or undocked separated from the main win dow Object Tree Properties window Layout View Object Palette Layout View Messages and Errors QSI Qlarity Foundry Getting Started NOTE I NOTE I Where ro Go From Here Communications w
201. s discussed in Chapter 8 Conversely overriding methods does require some programming and is the main focus of this chapter 9 3 Qlarity Code for Objects The following sections describe the Qlarity code used to define an object and the method over rides in an object template 9 3 1 Property Initializations Code for a typical object includes several lines in the following format init lt propertyname gt lt value gt lt propertyname gt This is the name of one of the object s properties QSI Qlarity Foundry 135 Handling Events With Olaniry Code Intermediate Design lt value gt This assigns the initial value for the property in the application If a property is not shown it is assigned the default initial value from the object template Changing lt value gt in one of these statements is the same as changing the property value in the Properties window 9 3 2 Method Overrides NOTE is Most methods defined in an object template may be overridden in any instance created from the template Indeed many objects have methods that are intended only for override the default method in the template does nothing This allows an object to provide or publish a way to customize the behavior of the object without modifying the template For example a timer object might provide a function called Alarm which is called by the object each time a preset time period expires The function in the template does nothing but it a
202. scribes the purpose of the property The dim statement creates a boolean property named enabled The init statement assigns a default value of TRUE to the enabled property which means that if the property is not assigned an initial value in the object instance the value defaults to TRUE Finally the validation function see section 10 2 Validation Functions describes the behav ior of the object when the value of enabled is changed The validation function first does a strict assignment of the new value to the property then calls the Enable API function to inform the firmware that the enabled status of the object has changed Calling API functions to implement the effects of a property change is a very common activity in validation methods An example of another property found in all versions of the boilerplate code is the parent property as follows Who do we attach to dim parent as objref init parent default func parent newval as objref parent newval Attach me parent endfunc 155 Create a New Object Template 156 Advanced Design This code creates a property of type objref named parent Parent is given a default value of default which is the root container when assigned to objref variables The validation method assigns the new value to the property using the strict assignment operator then calls the Attach API function to attach the object to its new parent contain
203. selecting a color If you want an object instance to be the child of a parent object placed in a container object from the parent property drop down list select a container object and the object instance is automatically moved and attached to the selected object in the Object Tree To move an object to the root container click default in the drop down list 8 3 3 1 Select Color QSI Qlarity Foundry If a color can be selected for an object property e g borders fill foreground background font etc when you select the property two Select buttons are displayed and Click 2 to display a drop down list of available named colors in the workspace You can use named colors to simplify matching and coordinating colors to create a color scheme for the workspace Refer to section 5 4 for information on named colors 117 Design a User Application Basic Design bacolor checkbgcolor E ck butto checkfgcolor checkborderstyle C buttonbackgro cir buttonbackgro B cir buttonforegrou E cir labelbackground cir labelforeground E ch_screenbackgr ch_screenforegro E cli softkeybarbac ch_softkeybarbutt cir softkeybarbutt Click a named color to select it for the object property Click to display a Select Color palette from which to choose a color for the property Select Color Named Color Custom Color Clr ButtonBackground lll i lili itt EESAN HEHNHESS o Clr ButtonBackgrou
204. ser applications Refer to chapters 3 through 7 as required to answer specific questions about using Qlarity Foundry 35 Where ro Go From Here Getting Started Notes 36 QSI Qlarity Foundry CHAPTER 4 WORKSPACES 4 1 Start a New Workspace QSI Qlarity Foundry When you first start Qlarity Foundry the Welcome to Qlarity Foundry dialog box is dis played To start a new workspace from this dialog box click Start New To start a new workspace with Qlarity Foundry open click on the toolbar or select New Workspace from the File menu The following dialog box is displayed Select the type of workspace to create Choose the type of project to create Standard workspace Multilingual workspace Galil Motion Controller Modbus TM serial RTL mode and Open Modbus TM TCP National Instruments LabVIEW platforms Create workspace like the last one created Standard workspace Description Create a workspace using a set of objects that can be customized by using the Event Builder or writing functions in Qlarity programming code The upper box lists several types of workspaces you can create The difference between work space types is determined by the library or libraries included with the selection New options are being added regularly but at the time of this printing the following workspace types were supported Standard workspace This option includes the Basic library basic qlib Data Processing libr
205. sible Where convenient data needed for drawing should be pre calculated and stored in private properties for later use in the MSG_DRAW handler Use user messages to communicate between objects User messages provide an excellent way to communicate between objects because the sending object does not require any knowledge about the receiving object This feature allows Qlarity to be extended in a number of powerful ways Where to Go From Here The full power and potential of the Qlarity programming language is now at your disposal As your experience with Qlarity grows you will likely create objects that might be useful for oth ers QSI encourages Qlarity programmers to submit their object template designs to the Qlarity Web site www qlarity com where they can be shared with others Questions and feedback about the Qlarity programming language and the Qlarity based termi nal should be sent via e mail to support 2 qsicorp com You should also check the www qlar ity com Web site occasionally for software and documentation updates new library objects and support materials QSI Qlarity Foundry APPENDIX A GLOSSARY OF SOFTWARE TERMS API Function Area Object BFF File Format Container Object Enabled and Disabled Objects Event Globals Libraries Message Message Handling System QSI Qlarity Foundry A function that is called from the user application to interact with the Olarity based system software firm
206. sted in the Object Tree under the Templates heading Only object templates created in the workspace are listed under the Templates heading 3 8 Layout and Code Views Layout View is the default view mode You will generally use only Layout View unless you are customizing objects or creating your own objects using the Olarity programming language An example of the work area of a workspace in Layout View is shown below Current Temperature a Lighting View A Ca Layout View closely simulates how the workspace will appear after it has been compiled and downloaded to the Qlarity based terminal QSI Qlarity Foundry 25 Simulation View Getting Started If you understand the Qlarity programming language you may use Code View to work with an object s programming code Select an object instance and click the Code View tab to display the property initializations for the object instance Object instance code may also contain method overrides which change the behavior of an object instance from that specified in the object template The following example shows the code for a text object in the sample workspace in the Lay out View example above parent SetTemp xpos 42 ypos 210 width 236 height 20 value Currently set to transparent true fgcolor rgb white The following example shows the first portion of the programming code for the Temperature Update template dir enabled as boole
207. stered the full potential of Qlarity can be utilized in your application development Look at template code in the QSI libraries Each library contains the full source code for every object template in the library You are encouraged to study the code in these libraries to learn the techniques and conventions used in their design Often the easiest way to create a custom object is to modify a template that is sim ilar to the desired object Use the boilerplate code This code provides a complete working Qlarity object ready for customization Do not unnec essarily reinvent the wheel Use a consistent style This is important in any programming project QSI has developed a set of Qlarity program ming style conventions for objects that are designed in house This was also used in the boiler plate code The style guide is available on the Qlarity Web site www qlarity com Although you may wish to modify these guidelines or develop your own use of a consistent style will make your object designs easier to develop maintain and use Use consistent naming conventions for properties and methods This is actually part of a consistent style The QSI Qlarity style guide lists the recommended names for properties that are commonly used in objects Using these conventions aids the designer when the object is used in an application it also increases readability of the object template source code Use validation functions A validation fu
208. t 4 Click Save to generate the BFF file 43 Generate A BFF File Workspaces You can download the BFF file using the Download Other BFF option in the Download Application function File menu Refer to section 7 3 Download a BFF File for informa tion 44 QSI Qlarity Foundry CHAPTER 5 TEMPLATES RESOURCES AND LIBRARIES 5 1 Add Edit Templates Creating and designing object templates is an advanced function which is covered in depth in Chapter 10 Advanced Design This section provides an overview of the Add Edit Templates function Use Add Edit Templates to create a new object template The new template may be blank it may contain only boilerplate code or it may be based on a library object template New object templates are added to the Template branch of the Object Tree After adding a template you use Code View to add or edit your custom programming code You can also use the Add Edit Templates function to change the name of an existing template Click on the toolbar or select Add Edit Templates from the Edit menu and the Add Edit Templates dialog box is displayed You can also right click anywhere in the Templates branch of the Object Tree and click Add Edit Templates on the shortcut menu taa Add Edit Templates Template Base Template New Template 5 1 1 Add a New Object Template In the Add Edit Templates dialog box do the following to create a new object template 1 Click New Templat
209. t Builder Steps QSI Qlarity Foundry To design a user application using Event Builder you will generally take the following steps Decide what you want your Qlarity application to do 119 Event Builder Basic Design Determine which objects you need Some objects will be used for events others will per form the actions associated with the events Place all of the objects in the workspace Outline each event action association e g when a button is pressed an action or actions occur Use Event Builder to assign actions to each event 8 4 2 Event Builder Dialog Box In Layout View select an object in the workspace for which you want to set up an event The properties and events associated with the object are displayed in the Properties window Click the Events tab to see the events associated with the selected object Object Events ES CancelPressed EnterPressed ValueChanged 00d Object Properties Object Events A Click El next to an event to open the Event Builder dialog box to assign actions to the event fs Event Builder ReleaseBtn click event Action Description 1 Click to add action v Select what type of action you wish to add from the drop down list in the grid Once you have selected a general 0 action type you may customize what exactly occurs during that action Cancel Edit in Code View 120 QSI Qlarity Foundry Basic Design QSI Qlarity Foundry Event Builder
210. t the basic design level are Basic library basic qlib Data Processing library dataproc qlib These libraries include the following types of objects Container objects with tabs or buttons to switch from one screen to the next Basic library Area objects with event functionality all libraries Refer to section 8 4 Event Builder for information on configuring objects to respond to events Communication objects Data Processing library Refer to section 8 4 Event Builder and section 8 5 Communication Objects for information on using communication objects to send data to another device through the Qlarity based terminal s serial or Ethernet port The Qlarity Foundry libraries are continually being added to and improved You can obtain the latest libraries at QSI Corporation s Web site www qsicorp com qlarity Also on the Web site you will find descriptions of the objects included in the libraries 105 Understanding Olaniry fon Basic Design Basic Design 8 2 Understanding Olarity for Basic Design Before you can effectively design a user application you need to understand some basic Qlar ity concepts which are explained in the following sections 8 2 1 Workspaces and User Applications A workspace is a Windows based file created in Qlarity Foundry that is compiled into a user application Workspace files are stored as plain text and typically have a qly file name exten sion User application files
211. t the boilerplate code does If the object has restrictions on where it can be attached or what types of objects can serve as its parent code should be added to the handler to enforce the restrictions For example the Tabs object in the QSI Common object library can only attach to a Tab Container object The MSG_TOOL_ATTACH handler for the Tabs object enforces this restriction After a requested attach is complete the attached object receives a MSG_TOOL_ATTACHED message from Qlarity Foundry An objref referencing the new parent is passed to the handler as a parameter This provides an opportunity for the object to update its parent property after the attach has been completed successfully The new parent may be different from the parent that was passed to the Attach API function in the MSG TOOL ATTACH handler Also note that the boilerplate handler calls the Tool Persist API function after the parent property has been updated The Tool Persist function should be called after any property update in a tool message handler The last handler included in the non drawable boilerplate code is the MSG TOOL DRAGCREATE handler When an object instance is created by selecting the template on the Object Palette and dragging it into the Layout View display the object receives aMSG TOOL DRAGCREATE message from Qlarity Foundry This allows the object to ini tialize itself properly For a non drawable object the only parameter passed to the ha
212. t the level of help offered when referencing methods or properties of an object The following options are available None AutoHelp will not offer identifier completion assistance Standard AutoHelp will appear when it seems likely that you are referencing an object property or method In general this means after you type an object name and type in the dot operator High AutoHelp will attempt to appear any time the cursor is over an object property or method that is referenced via the dot operator 6 3 8 3 Assignment and Parameters 6 3 8 4 Show QSI Qlarity Foundry Use this option to set the level of help offered when editing the right hand side of an assign ment statement or entering parameters in a function call Some information is drawn from the last time the workspace was compiled Data types that have been added or changed since the last compile may not be available The following options are available None AutoHelp will not offer assignment and parameter completion assistance Standard AutoHelp will appear whenever it seems likely hat you are editing the right hand side of an assignment or a parameter to a function or method call and AutoHelp has information about the current context High AutoHelp will always attempt to appear when the cursor is in the context of the right hand side of an assignment or a parameter to a function or method call and AutoHelp has information about the current context AutoHelp for
213. t updates its xPos and yPos properties to the new location and calls the Relocate API to generate a MSG_DRAW that updates the screen if necessary Finally the handler persists the values of the updated properties with calls to Tool_Persist The code for the MSG_TOOL_GETHANDLES handler is as follows This function is called by Qlarity Foundry to obtain the gt coordinates of the resize grips The arrays xCoords yCoords gt and cursors all contain 0 elements initially This means that gt you should either call redim on those arrays and set their gt values or declare local arrays set the values of the local gt arrays and then assign xCoords yCoords and cursors to those gt local arrays Closed indicates whether the Foundry should gt connect the first and last grips to make a closed object gt xCoords yCoords and cursors should all contain the same number gt of elements when this function completes func ToolGetHandles xCoords as reference to integer yCoords as reference to integer cursors as reference to GuiCursors closed as reference to boolean handles MSG TOOL GETHANDLES dim csrs 8 as GuiCursors init csrs CSR UPLEFT CSR UPDOWN CSR UPRIGHT gt CSR LEFTRIGHT CSR DOWNRIGHT CSR UPDOWN CSR DOWNLEFT gt CSR LEFTRIGHT redim xCoords 8 redim yCoords 8 xCoords 0 xPos xCoords 1 xPos width 2 1 xCoords 2 xPo
214. ted cereos d 178 B 10 Sample Code e taco tad han een bh aes Rave Plate Ieee hade ede Late me dado 179 Bull Property Categories tt A er Nes 179 B 12 Default Items oce Ui exu ee eee eee eua ce iui a se 179 B 13 Defining Border Styles 2 0 0 eee cece 180 B 14 Defining Named Colors 0 0 0 0 eee eee eee 180 QSI Qlarity Foundry CHAPTER 1 INTRODUCTION 1 1 How to Use This Manual 1 2 Description QSI Qlarity Foundry For instructions on installing Qlarity Foundry see Chapter 2 Installation To get started using Olarity Foundry and to learn design basics review the following chapters O Chapter 3 Getting Started O Chapter 8 Basic Design To learn more about user application design refer to the following chapters O Chapter 9 Intermediate Design O Chapter 10 Advanced Design Use the following chapters to learn about specific Qlarity Foundry functions O Chapter 4 Workspaces How to start open close save and use workspaces in Qlarity Foundry O Chapter 5 Templates Resources and Libraries How to add and edit templates advanced function edit resources and edit libraries O Chapter 6 Qlarity Foundry Preferences How to set up and define your terminal settings for Qlarity Foundry and enter Qlarity Foundry preferences O Chapter 7 Download Software to the Terminal How to configure the terminal communications port download user appl
215. the Template name box type a name for the new template Each template in the work space must have a unique name A template name has no size limitation but must start with a letter or underline character _ A name cannot contain spaces but may contain the underline character or pound sign The percent 96 and dollar sign symbols can be used at the end of the name 6 Click OK to create the new template Many library templates depend on global code or other resources in the library Qlarity Foundry will add these items to your workspace and inform you of the additional changes in a dialog box When the dialog box appears click OK to proceed 7 The template list in the Add Edit Templates dialog should now include the new template Click Close to close the dialog box Now do the following to edit the new template to your specifications 1 Select Code View The new template is now listed under the Templates heading in the Object Tree 2 Select the new template in the Object Tree The source code for the template is displayed in the editor window QSI Qlarity Foundry 145 Where ro Go From Here Intermediate Design 9 7 146 3 Editthe template source code Variables declared inside a template become properties of the template object and functions declared inside the template become the object s meth ods Properties and methods can be added deleted or modified as desired You can add properties and methods just as
216. the code select the method you want to override Select Show only event functions if you want the drop down list to displays only meth ods that have been designated event methods If Show only event functions is not selected all possible override methods are listed Move the mouse pointer over a method in the list to display a description of the function 4 When you select a method from the list code similar to the following appears beneath all code for the object func click endfunc 5 Between the func statement and the endfunc statement add Qlarity code to implement the desired response to the event A typical event response might include code to set prop erties in this or another object The Qlarity code to do this is as follows lt objname gt lt propertyname gt lt value gt lt objname gt This is the name of the object whose property will be changed To assign values to its own properties the override function in an object can refer to itself using the me keyword as the lt objname gt lt propertyname gt This is the name of the property to change lt value gt This is the new value to assign to the property QSI Qlarity Foundry 137 Global Code Intermediate Design Another common activity is switching screens display pages or hiding one object and displaying another To switch screens the method typically disables the current screen object and enables the screen object for th
217. the parameters of the new function and a right parenthesis If the function returns a value the right parenthesis should be followed by the keyword returns and then the type of the returned value Indicate the end of the function with the endfunc keyword on its own line The parameters appear as new variable declarations see section 9 5 1 without the dim keyword Each parameter is separated from other parameters by a comma Since this is a message handler there are restrictions on the parameters and return type for this function The allowed parameters and return type depend on what message is being handled There are no restrictions on the name of the function except those imposed by Qlarity See the Qlarity Programmer s Reference Manual for more details Also a handles statement is needed on the line following the function declaration The statement begins with the keyword handles followed by the name of the message that is being handled by the function For example the following code declares a new message handler named timer that han dles MSG_TIMETICK As explained in the Qlarity Programmer s Reference Manual the handler takes no parameters and does not return a value func timer handles MSG TIMETICK endfunc Fill the body of the handler on lines between the handles statement and the endfunc statement with the Qlarity code to implement the desired function If the handler returns a
218. the value shown The Status toggle object the button uses the following events TurnOn triggers the following actions Changes the caption above the toggle button to reflect the current status of On Enables the spinner object TurnOff triggers the following actions Changes the caption above the toggle button to reflect the current status of Off Disables the spinner object 127 Event Builder Basic Design 8 4 4 3 Keypad Demo The Keypad Demo provides a keypad that can be used to enter numerical data to be sent to a controller The following objects have programmed events Enable button A press or click event enables the numeric keypad makes it viewable so it can be used for data input Numeric keypad The following two actions have been programmed to the keypad e When the Enter key is pressed any data entered the value is posted to the Keypad value text box located above the keypad e When the Enter key is pressed the value is sent out the serial port to a controller expect ing a value 8 4 5 Qlarity Code and Event Builder While Event Builder requires no programming experience it uses the Olarity programming language Events created with Event Builder generate Qlarity program code This means that it is possible to develop events in Event Builder and then add advanced functionality in Code View It is also useful if you are learning the Qlarity programming language to creat
219. then click in the editor at the location where you want the variable inserted If you do not select this option the variable will be added to the bottom of the Global Code section 4 Click New Variable This button is only available when the Globals section is selected The following dialog box is displayed New Variable Property Data Type Create validation function Initial Value optional default Properties Window category optional Documentation optional 5 In the Name text box enter a name for the variable QSI Qlarity Foundry 139 Global Code 9 Intermediate Design In the Data Type text box enter the variable s data type Select Create Validation Function if you want Qlarity Foundry to automatically create a validation function Optionally enter an initial value for the variable the Properties window category in which the variable should be placed i e General Main etc and any text that you want added to the variable s online documentation Click OK to add the global variable 9 5 1 2 Add a Global Variable in the Global Code Section Use the following method to enter the variable directly in the Globals section in the Code View window Click the Code View tab Click Globals in the Object Tree to open the Global Code section Any current global source code is displayed in the editor window On a blank line in the editor window separate from any
220. ther than text e g ABCD appears as 41 42 43 44 Wrap line on newline characters Enable this option if you want characters in the Communications window to wrap to the next line when a newline character is encountered Favor wrapping lines on word breaks If Wrap line on newline characters is enabled select this option to wrap to the next line after a word rather than between characters in a word whenever possible Show only transmitted data If this option is enabled the Communications window will display only data that is transmitted from the application program Disable this option to show both data transmitted both received by the application Add a tab for each opened network channel If this option is enabled each time a network channel is opened in Simulation View a new tab is created for the channel The tab displays the data that is sent and received on the channel On network channel open switch to its tab This option becomes available when you select the previous option If this option is enabled each time a network channel is opened the channel s tab is displayed QSI Qlarity Foundry 85 Simulation View Olariry Foundry Preferences Non printable character Space character Newline and carriage return Enter the character that you want to appear on the screen in Simulation View when a non printable space or newline carriage return character is encountered Click Default to enter the default
221. tion Baud Rate 9600 v Data Format 9 4 v v Flow Control None Simulateon PC Serial Port None Baud Rate From the drop down list select the initial baud rate of the PC port selected in Sim on PC Port Data Format From the drop down list select the data bits parity and stop bits of the PC port selected in Sim on PC Port Flow Control From the drop down list select the flow control of the PC port selected in Sim on PC Port Simulate on PC Port From the drop down list select the serial port on your PC that you want to use to transmit data in Simulation View If this option is set to lt None gt any serial send and receive requests by the application are ignored If you are setting up more than one port assign a different PC serial port to each terminal serial port 87 Simulation View Olaniry Foundry Preferences Notes 88 QSI Qlarity Foundry CHAPTER 7 DOWNLOAD SOFTWARE TO THE TERMINAL This chapter provides information to do the following Configure Communications Port Download a User Application Download a BFF File Upgrade the Firmware 7 1 Configure Communications Port To configure the communications port used to download user applications to your Qlar ity based terminal select Download Application from the File menu The following dialog box is displayed 5 Download application to unit Serial Ethemet USB ae App download size 103802 Flash requ
222. tmap object properties in Qlarity Foundry Bright magenta and bright green are often used as transparent background colors 5 2 7 Fonts Qlarity based terminals support BDF raster and TrueType fonts Use the following guide lines to help you determine which fonts to use in a workspace Scalable and Non scalable Fonts BDF raster fonts are non scalable which means that you need to load a separate font file for each point size e g Arial 8 Arial 14 Arial 20 etc TrueType TT fonts are scalable which means that a single font can typically be scaled to several different point sizes 54 QSI Qlarity Foundry Templates Resources and Libraries Edit Libraries 5 3 5 2 8 Audio 5 2 9 Binary Rotating a Font A TT font can be rotated to any angle A BDF font can only be displayed at the angle at which it was created Availability BDF fonts and TrueType fonts are readily available from several sources including many pub lic domain Internet sources TrueType fonts can be used on any Windows computer Terminal Memory Use A BDF font file is smaller than a TT font file If you are using only one or two sizes of a spe cific font Arial Times Roman etc you can save terminal memory using BDF fonts If you are using several point sizes for a specific font the TT font will likely use less memory than three or more BDF fonts Display Speed BDF fonts are displayed more quickly than TrueType fonts on Qlarity based terminals
223. trol how they are processed Hflags flag data flag data is interpreted by the Properties window based on the data type of the property flags directives must appear entirely on a single line The most common use of flags is to define the grid shown by the aggregate data type The aggregate data type uses a flags directive to define the grid that is shown when editing the property The aggregate data type s flags directive uses the following format flags dialog title gt lt dialog instructions column definition gt lt column definition column definitions Where lt column definition gt has the following format lt column name gt lt column data type gt lt min value gt lt max value column width gt lt default value gt In lt column definition gt most items are optional but if you omit an item or include an item later in the list you must include placeholder commas lt column data type gt may be one of string integer boolean byte unibyte float or color For example Provides a grid with a single column for string entry flags Enter List Type some strings List Item string Provides a grid with several columns flags Enter Data Enter the title min value and color for each display element Item Title string 200 Minimum Value integer 0 100 50 Item Color color 3 In the first example a single column is defined for string entry In the second example three
224. u The following dialog box is displayed Select where to output the workspace Save in IJ samples Cg Communications a cvs My Computer Demo eventbuilder demo Cg games CJ GA hvac sample My Documents Gather basic keyboard aly basic serial communication dly 4 2 dns_ethernet_client qly 2 ftp_client_interface qly QD listbox _alarms qly Z password _protected_screen qly Desktop 4 2 My Recent Documents amp File name D Cancel My Network Save as type Glarity files dy i In the File name field type the name that you want to give the output file you do not have to type the extension Click Save to save the file 4 5 Compile a Workspace Click on the toolbar or select Compile Workspace from the File menu to compile the current workspace into the format required for a user application Compiling is also required to update modifications made in Code View before they can be seen in Layout View However if you make changes in Code View and then switch to Layout View the program compiles auto matically 42 QSI Qlarity Foundry Workspaces Generate A BFF File If the compile is successful the program displays the application in Layout View If any errors occur during the compile the program switches to Code View and the error messages are dis played in the Compile dialog box Double click an error message to go to the location of the error in th
225. u want a beveled border as for a button select 3D Bevel The options to select a raised or sunken bevel appear You can see the effect of each option in the preview Border Color If you do not select a 3D bevel you can select a different color for the border Click Border Color and a Select Color palette appears from which to select the color If you want to match a color from another object in the workspace click beneath the color palette and an image of the workspace is displayed Click in the area of the workspace that has the color you want to match The color of the area you clicked is shown in the Sample box In addition the 4X box displays the area magnified four times Edit named colors Preview EN Clr_ButtonForeground 69 Edir Named Borders Templates Resources and Libraries You can click a color in the 4X box to select it This is useful if you want to identify a color in a congested area of the display You can also click in the 4X box and drag the mouse to shift the displayed area slightly Click OK to close the workspace image and the color you selected is shown in the Select Color palette Click OK at the Select Color palette to assign the selected color to the border Fade Effect If you have defined a wide border you can select Fade Effect to add a fading color effect to the border Refer to the preview for an illustration of the fade effect 5 5 2 2 Rounded Corners Select Use roun
226. ues range from 1 very low pitch to 86 very high pitch The standard beep when a button is pressed is 30 Selecting O generates no sound At the Duration field select the duration of the note in milliseconds The standard button beep lasts 100 ms Refer to the Qlarity Programmer s Reference Manual Playnote section for more information Set Contrast This action changes the level of contrast on the terminal screen when the event occurs Adjust Contrast Contrast Lighter C Contrast Darker For example you might use this action to provide a contrast adjustment in case the display becomes difficult to read Create two buttons one for lighter contrast and one for darker con trast Each event e g button press changes the contrast one step lighter or darker NOTE gt The contrast level set with this action is not permanent When the terminal is reset it reverts to the default contrast level If you want to save the contrast level use a DisplaySetting V2 object Terminals with TFT displays ignore this command as TFT displays do not support a contrast setting QSI Qlarity Foundry 125 Event Builder Basic Design Set Backlight This action brightens darkens turns off or turns on the display backlight r Adjust Backlight Backlight Lighter C Backlight Darker C Backlight On C Backlight Off For example you might use this action to provide a backlight adjustment if the terminal is used in low li
227. unction returns a variable the right parenthesis should be followed by the keyword returns then the type of the returned value The end of the new function is indicated by the endfunc keyword on its own line The parameters appear as new variable declarations see section 9 5 1 without the dim keyword Each parameter is separated from other parameters by a comma For example the following code declares a new function named average that takes two floats named first and second as parameters and returns a float func average first as float second as gt float returns float endfunc NOTE K A Statement is defined as a single line of code In order for the compiler to distinguish between statements each statement must be separated by a newline character If a statement must be split into multiple lines type gt at the end of the line to tell the compiler to look for the rest of the statement on the next line 4 Fill the body of the function between the func statement and the endfunc statement with the Olarity code to implement the desired function If the function returns a value be sure to include a return statement followed by an expression that yields the value being returned For more information see the Qlarity Programmer s Reference Manual In the example above the completed function is as follows func average first as float second as gt float returns float return first second 2
228. unctions see section 10 6 Guidelines for Designing New Object Templates Validation functions should not have a return value Apart from these restrictions the function is written and behaves as a normal function The valida tion function can be explicitly called from other Qlarity functions if desired For example when the graph level property of a bar graph object is changed you need to redraw the graph at the new level Also values outside the range of the gauge should be QSI Qlarity Foundry Advanced Design The Olaniry API Library clipped to a maximum or minimum value These can both be accomplished with a validation function for the graph level property Suppose that the property is an integer named sraphlevel The validation function might look like the following func graphlevel newval as integer clip to the max or min value if newval maxval then newval maxval elseif newval minval then newval minval endif Now assign newval to level Note the use of strict assignment op graphlevel newval Now request this object to redraw rerender me endfunc The Rerender function is a Qlarity API function see section 10 3 The Qlarity API Library that generates a MSG_DRAW message for the area of the object For array properties separate validation functions can be written for assignment of the entire array and assignment of individual elements of the array See the Array Validatio
229. unctions and Methods w Assignment and Parameters uses the M O results of the most recent compile to Identifier Completion Standard w determine possible values If you have 1 modified your source code since the last Assignment and Parameters Standard compile or if the last compile had errors it is Show global variables and functions eri Ihat the listed values may be Show object properties and methods Show for built in data types You may elect to fade AutoHelp bubbles as the mouse moves near obscured code to allow you to look at your source code as well as use the AutoHelp Fade AutoHelp tips NOTE 513 AutoHelp is designed only to be an aid in code development It may not be available in some circumstances and the information that it contains may be out of date or in an improper con text Using AutoHelp is no substitute for good programming practices 6 3 8 1 Functions and Methods Use this option to set the level of help offered when writing a function or method call The fol lowing options are available None AutoHelp will not automatically appear when writing function or method calls Standard AutoHelp will attempt to appear whenever it seems likely that you are going to edit a function or method call High AutoHelp will attempt to appear when you position the cursor in a function call 80 QSI Qlarity Foundry Olariry Foundry Preferences Ediror 6 3 8 2 Identifier Completion Use this option to se
230. unded Corners i2 Ll ILS ILS IR a ex ied aps 70 5323 Double Border eo oe e rer dre oe e 70 3 39 24 A e erem I EPA Un Rte ER 70 5 5 2 5 Create New Named Border ooooooooooooooomomoo o 70 5 5 2 6 Delete Named Border o oooooooooooo ooo 70 5 5 2 7 Rename Named Border o ooooooooooooooommooo 71 5 5 2 8 Reset Border to Default 71 CHAPTER 6 QLARITY FOUNDRY PREFERENCES ccc ccc c cece ccc cece ccs ese cee rss so 73 Gel Terminals a a toed X bt onte ttr cor d p Da 73 6 1 1 Display Setup cio ni RR eR EI EIER eia 74 61 2 Input ocn or pF ae ake ree ye bg e ae eee wet e eris dd 75 6 1 3 Communications sou WIEYGPW A Ye av EORR eU EU 75 6 1 4 Miscellaneous Rr IT a re c ET Re e t Re RR RR ERE 75 6 2 Lay bicapa 6 racha eg ces ee ote abet E ke RAUM More 75 6 3 EOL i seats da debes Poe eoi Dod ee dev ee bU s TT OSM ColOrS 5 ns reta eret ires lbs ot lea 78 6 3 2 Bontzc s d o E ot eto eU ee estes veo ed o abest vea e bs 79 6 3 3 Tab Spacing oss a Mec Rake t ce ge cons t eus 79 6 3 4 Show Advanced Code Sections in Object Tree oooooomomomo o 79 030 Fast deleita mtis tepida e E APO ta sai 79 6 3 6 Parenthesis Matching 0 0 eee e 79 6 3 7 Edit Events in the Event Builder ooooooooooomoomoo o o 80 6 3 8 AutoHelp Settings elle R9 Re e E eee 80 6 3 8 1 Functions and Methods 0 0 0 ccc cee eee eee 80 6 3 8 2 Identifier Completion
231. ur own objects Simulation View can be used after you have created a workspace to simulate the performance of the workspace objects on the Qlarity based termi nal Click the Layout View tab or Code View tab at the bottom of the work area default loca tion to change views Click the Simulation View tab to start the terminal simulation Refer to section 3 8 for more information on the Layout and Code Views Refer to section 3 9 for more information on Simulation View Messages and Errors Window The Messages and Errors window displays any errors or other messages generated when the workspace is compiled or during a debug operation These messages can help you identify and correct problems with the workspace Status Bar The status bar shows the status of the workspace and the coordinates at which the mouse pointer is positioned in the work area Also if you position the mouse pointer over an option on a menu or a tool on the toolbar the function of the option or tool is displayed in the status bar 3 4 Menu Options QSI Qlarity Foundry 11 Menu Options Getting Started The following sections describe the options available on each menu on the menu bar 3 4 1 File Menu New Workspace Use this option to start a new workspace Refer to section 4 1 for information Open Workspace Use this option to open an existing workspace Refer to section 4 2 for information Close Workspace Select this option to close the current workspace
232. urces and Libraries Edit Resources Edit Resources Bitmaps BDF Fonts TrueType Fonts Audio Binary TrueType font name Sys Filename Arial ttfonts arial ttf Resource data Preview Filename ttfonts arial ttf j 16 The Qi 18 The Quick i 20 The Quick 22 The Quic 5 2 5 Rename a Resource In the Edit Resources dialog box do the following to change the name of a resource This changes the name that appears in the Properties window for you to select the resource for an object instance it does not change the file name of the resource 1 From the list of resources select the resource that you want to rename and click Rename resource name e g Rename qterm_g70 A dialog box is displayed with the current name of the resource selected in the text box Qlarity Foundry Enter the new name for the resource mE 2 Type over the name with the new name or edit the name as desired 3 Click OK to rename the resource and close the dialog box The new name appears in the name column of the resource list 5 2 4 Change a Resource File In the Edit Resources dialog box do the following to change the file assigned to an existing resource name QSI Qlarity Foundry 53 Edir Resources Templates Resources and Libraries 1 From the list of resources select the resource for which you want to change the file 2 Click Browse and an Open dialog box appears 3 Select the file that you want
233. uttons BG and Clr StartEndButtons FG The colors of named colors along with named borders see section 5 5 are set up in themes see section 5 4 1 You can create your own themes and named colors and you can edit the predefined themes and named colors To create or edit named colors and themes for a workspace select Edit Named Colors from the Edit menu The following dialog box is displayed Edit Named Colors iE Select a named color from the list then click on a new color to assign to it Cir ButtonBackground Clr ButtonB ackground lt HH SERA let ned col HB ci_ButtonForeground EBEHES Tl oe Bname col Bore E BESSEN E Clr_LabelB ackground a yn mo _ Ch_ScreenBackground E Ch_ScreenForeground standard Y Ch_SoftkeybarB ackground Cir_SoftkeybarButtonB g El a Clr SoftkeybarButtonFg g HBHEHHEHESS BEE The colors and border definitions assigned to named colors and named borders are grouped together in themes See section 5 5 Edit Named Borders for information on named bor ders Several predefined themes are set up in Qlarity Foundry You can change the colors or border definitions in a predefined theme or you can save the changes as a new theme Generally a theme represents a color scheme such as a theme with all grayscale colors a theme with shades of blue or a theme with neon colors To view the colors in a theme select the theme from the Theme drop down list The colors assigned to
234. value be sure to include a return statement For more information see the Qlarity Pro grammer s Reference Manual For example the handler described above could check the value of a global variable named threshold and enable an object named cal screen if threshold is greater than 10 The complete function example follows func timer handles MSG TIMETICK if threshold 10 then cal screen enabled TRUE endif endfunc Repeat steps 3 and 4 for as many handlers as desired Do not add two handlers for the same message Click or select Compile from the File menu to compile the workspace Any errors in the new source code are identified by messages in the Messages and Errors window If no errors are present the compiled workspace is returned to Layout View 143 QSI Qlarity Foundry Create a New Object Template Intermediate Design 9 6 Create a New Object Template The method override mechanism provides a powerful way to customize an individual object s behavior and response to events However you may want to change the behavior of all instances of a particular object Adding an identical override to all objects from a particular template would be tedious and prone to error It is better to modify an existing object template to create a new object template NOTE IG Itis recommended that you do not directly modify the code in the OSI standard object librar ies OSI occasionally updates these libraries and
235. vanced Design 10 4 Exception Handling 150 When an abnormal condition arises while a Qlarity application is running the system software generates an exception An application may also throw an exception when it detects a problem The Qlarity exception handling system allows the exception handling code to be localized to a convenient location either within an object template or for the application as a whole This section describes the facilities that Qlarity provides for generating and handling exceptions An exception is generated in one of two ways the system software throws an exception if it detects a problem or the application can throw an exception for any reason The application exception is thrown with a call to the Throw API function Each exception carries certain information regarding what occurred and where This informa tion includes an exception level an indicator of severity an exception type a location where the exception occurred and a brief explanation of the error The exception level can assume the following values in order of decreasing severity EXLEV COMPILER This level indicates a serious error most likely caused by the Qlarity compiler EXLEV SYSTEM This level indicates a problem in the system software such as memory exhaustion a problem with the message queue and so on EXLEV IGNORABLE This level indicates an unexpected condition that is generally serious but not fatal EXLEV USER This is th
236. vents Overrides drop down list If this option is not selected all functions that are eligible to be overridden are listed QSI Qlarity Foundry Getting Started Object Tree 3 7 Object Tree The Object Tree contains five branches as follows Globals Internal Templates Advanced Code e Libraries The Globals branch is always visible the Templates Advanced Code and Libraries branches are only visible in Code View The Advanced Code and Libraries branches are disabled by default as they are intended only for advanced users refer to section 6 3 for information on enabling these The illustration below shows all branches of the Object Tree in Code View A of ExecptionDisplay w E af sim aE e KeyboardScreen ope Start S af InstructionsBtn wf StartGameBtn E amp sf HiahScoreTransL bl Yr E af HighScoreVertLbl B af SimTimer A af LastLevel A of LastScore FA 2 af GameTitle PAD G StatBG x B amp InstructionsScreen 2 af OpenDesigner 2 af input Gb af LevelBanner a B amp af SideBar ms amp af ContrastDarker m amp af ContrastLighter wj BorderLineRight E sf BorderLineBottom 8 sf BorderLineL eft gf BordeiLineTop 2 af Board 2 af LevelDesigner gi Intemal aa Templates Ball E Board zs boardPrev E brick as input k LevelDesign 1 LevelTemplate Vine Ww prize i simulate Ej UnifiedLevel DD Vaus Advanced Code Libraries c Mb Extra Y Basic
237. w Toolbar iva rm be RAM MOUSE EU 20 3 5 3 Simulation View Toolbar seeseeeeeee eh 21 3 6 Navigation Bar Code View only 0 0 0 ccc cee eh 21 3 6 1 Global Template or Library Code 0 cee eee eee 22 3 6 2 Object Instance Code onse ceu e Dog ey ee edere 22 3T Object Tree os UR DARE PP QI I RE EY OI S qu 23 3 1 1 Global S its fe eL LEV Che Eve ids 24 3 7 2 Internal ii EE ETE 25 3 7 3 Object Templates omo tio dr ste tta eb belge ke 25 35 8 Layout nd Code Views zie RO Er ER re ex se 25 3 9 Sinulation Vi Wisin Ne o pU Vp bee Reo aw ees 26 3 9 1 Serial VO Support oeste a ce Xe Eee a eges 28 3 9 2 File System Support lsleseseleeeee e 28 3 9 3 Simulation View Limitations leeeeeeee ee 29 3 9 4 Source Level Debugger lsllleeeee ee 29 3 9 5 Call Stack WindOW heoi o zoe DRUSI UP EI hier 30 3 0 6 Watch Window eea a Re re e e xen 30 3 10 Properties WIndOW 5 0 zonis PRU di EVI e UR He 31 3 11 Object Palette 5o sais e y e E 33 3 11 1 Add a New Object Instance lssseeeeeeee o 33 CowrtNTS 3 12 Move and Resize Windows seeeeeee teens 34 3 13 Where to Go From Here ssseseeleeeee eee een ae 35 CHAPTER 4 WORKSPACES e ei da EE VERB CERE QI ERE ERES QUE Eds 37 4 1 Start New Workspace 1 024 cna bep eere RR UT RI aem alan 37 4 2 Open a Workspace uta tene p LT sete ere 40 4 31 Close a Workspaces ice Ea ERR UG REPRE ENDO e
238. want to disable it 6 5 Simulation View QSI Qlarity Foundry Use the options in the Simulation View tab to adjust or mute the sound during terminal simula tion to set up communications for the Communications window in Simulation View to set up the computer s ports to simulate the serial ports on the Qlarity based terminal and to specify simulated keypad settings for applications that use an external keypad 83 Simulation View Olaniry Foundry Preferences Qlarity Foundry Preferences Terminal Layout Editor Compile Simulation Speaker Volume 7 Communications Window Settings C Mute Keypad Settings Breakpoint Sound Breakpoint at exception Ethernet simulation Default simulation v Serial Port Setup Terminal Port BaudRate Data Format Flow Control Simulate on PC Port com 9600 8E1 None lt none gt com2 39600 8E1 None lt none gt lt These settings are the initial communications settings that the com port s use in Simulation View Remember to specify the terminal hardware with the Terminal tab Speaker Volume Click and drag the slide button to adjust the volume in Simulation View Mute Enable this option to turn sound off in Simulation View Ethernet Simulation Select a network simulation choice from the drop down list If you select Default simulation your computer s network connection if available will be used in Simulation View to transmit and receive data requested by the applic
239. ware My Recent Files of type Glarity firmware binary files bin Cancel 3 Selectthe firmware upgrade file to be downloaded and click Open A progress graph tracks the download Messages in the Results box indicate whether the download was successful When finished the new firmware version is shown in the Results box QSI Qlarity Foundry 95 Upgrade the Firmware Download Software to the Terminal 7 4 4 Induce Bootloader If the firmware on your Qlarity based terminal has become corrupt and you cannot run the Power On Setup utility use the Induce Bootloader function to upgrade or reinstall the firm ware NOTE I fyour terminal is connected to an Ethernet port you will need to change it to a serial port to perform this function Do the following to download a new version of the Qlarity based terminal firmware 1 Select Download Application from the File menu 2 Click Induce Bootloader and an Inducing Bootloader message is displayed in the Results box After a time the following message is displayed Bootloader induction terminated Followed by the message NOTICE received command from host to enter bootloader Entering QSI Bootloader V1 014 3 Click Upgrade firmware to proceed and the following dialog box is displayed Select firmware file to download Look in firmware oce loss 2 590s bin O loss 2 591a bin firmware Kal g55 2 600 bin J aloe 2 590a
240. ware and hardware You use API functions to draw to the screen render text and bitmaps send characters to the serial and network ports enable disable objects manipu late object order in the hierarchy perform complex math and so on An object that directly interacts with the terminal display by drawing something on the display and or processing area based messages Examples of area objects include text objects bitmap objects and line objects Binary file format BFF required for a user application to run on a Qlarity based terminal When a workspace is compiled it is converted to a BFF format An object that contains other objects e g a form or screen On the Qlarity based display a container may represent a portion of the display or all of the display Whether or not a con tainer is displayed depends on its position in the object hierarchy and whether or not contain ers objects in front of the object are transparent Also the hierarchy determines the order for messaging An object may be enabled or disabled without deleting it from the user application An enabled object can process most messages Disabled objects are not drawn on the display and are not eligible to process messages In Qlarity Foundry an object can be enabled or disabled using its object properties but disabled objects continue to be displayed An occurrence that signals a change in the terminal state such as a touch screen press a key board press a serial
241. y Foundry CHAPTER 9 INTERMEDIATE DESIGN QSI Qlarity Foundry Chapter 8 Basic Design introduces some basic application design techniques using Qlarity Foundry It also provides information on Qlarity Foundry s Event Builder which can be used to add events to your applications with no programming While this is enough for many appli cations if you require very complex flexible or custom applications you will want to have some Qlarity programming skills To assist you with intermediate design and help you get started with Olarity Programming this chapter provides information on overriding object functions to change the object s behavior and discusses adding global code and creating new object templates based on templates that already exist in libraries By applying a small amount of programming you can add a great deal of flexibility and power to your applications Before proceeding you should be familiar with the concepts presented in Chapter 8 Basic Design Also this chapter includes many references to the Qlarity Programmer s Reference Manual The Programmer s Reference Manual will provide an invaluable resource to you as you learn intermediate Qlarity design and eventually advanced Qlarity design as explained in Chapter 10 This chapter covers the following information Viewing the Code Understanding Qlarity for Intermediate Design Olarity Programming Language Objects and Templates Qlarity Code for Obj
242. yed area slightly Click OK to close the workspace image and the color you selected is shown in the Select Color palette Click OK at the Select Color palette to apply the selected color to the property 8 4 Event Builder Qlarity is an event driven programming language An event is any type of input such as a key or button press a value change a timer action data received through the serial port and so on When an event occurs a Qlarity user application responds with an action Event Builder is a tool in Qlarity Foundry to help you add events to your Qlarity user applica tions Event Builder allows you to assign actions to events without any programming knowl edge Using the options in the Event Builder dialog box you can link one or more actions to an event even when the action involves several objects or includes one or more serial objects You assign an action to an object and its properties from drop down lists The type of object you select determines the type of event or events that can be performed by the object For example a button will have a click event and a serial object will have data receive and send data events Keep this in mind when you are adding objects to your work space The Object Documentation Help file lt F1 gt provides information about all object tem plates in the QSI libraries including events and actions that can be performed by the object type 8 4 1 Overview of Even
243. you are documenting Normally you would place the documentation declaration immediately before the element declaration However ftdoc obj declarations for object templates often appear inside the template definition itself All AutoDoc constructs that follow a documentation declaration apply to that declaration until a new declaration is encountered AutoDoc constructs that appear before a documentation dec laration are not allowed doc func MyNewFunc doc obj NewObject doc type DataType The following program elements may be documented Func A global function or an object method Prop A global variable or object property Obj An object template Override The same as a function except that it denotes an object method that is explicitly intended to be overridden in object instances Only object methods designated as override may be edited in the Event Builder 173 Documentation Body AutoDoc specification Type A user defined data type such as an enumeration or a start type Group This does not correspond directly with a Qlarity syntax structure rather it designates a collec tion of related items For example DrawBDFText GetBDFTextSize and GetB DFFontMetrics might all belong to the group BDF Text Functions When AutoDoc displays the documenta tion for items that belong to the group it contains a see also link to the group itself The doc umentation for the group displays a list of all items in the grou
244. your changes would be lost Rather you should copy the template code into your workspace or a personal library e g mylib and make your modifications there Do the following to create a new object template based on a library object template Click on the toolbar or select Add Edit Templates from the Edit menu and the Add Edit Templates dialog box is displayed You can also right click anywhere in the Templates branch of the Object Tree and click Add Edit Templates on the shortcut menu ED Add Edit Templates Template Type Base Template New Template 144 QSI Qlarity Foundry Intermediate Design Create a New Object Template 2 Click New Template and the following dialog box is displayed New Template Wizard O Create a template ready to operate in Qlarity Foundry Create a completely blank template O Copy the code of an existing template in a library Extend inherit a template from an existing template in a library Template name TabContainerV2 derived Based on 3 TabContainerv2 M 3 Select Extend inherit a template from an existing template in a library This option is used to create a new object template based on the programming code from an existing library object When you select this option a Based on box replaces the Object type box 4 From the Based on list box select the existing library object on which you want to base the new object template 5 In

Qlarity Foundry User`s Manual

Contents

Download Pdf Manuals

Related Search

Related Contents