{"id":3191,"date":"2025-04-17T09:49:24","date_gmt":"2025-04-17T09:49:24","guid":{"rendered":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?post_type=spl_knowledgebase&p=3191"},"modified":"2025-05-07T11:26:44","modified_gmt":"2025-05-07T11:26:44","slug":"equ-directive-2","status":"publish","type":"spl_knowledgebase","link":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/","title":{"rendered":"#EQU directive"},"content":{"rendered":"\n

The #EQU<\/code> directive assigns a text string<\/em> to a label.<\/p>\n\n\n\n

Example<\/p>\n\n\n\n

DefaultBGColour    #EQU     'FF808080<\/pre>\n\n\n\n
In any regular program line\u00a0after this,\u00a0<\/em>wherever the word\u00a0DefaultBGColour<\/code>\u00a0appears as an argument in an instruction or\u00a0hash function<\/a>, the\u00a0text 'FF808080<\/code>\u00a0will replace it.<\/p>\n\n\n\n
Note: This is not a hash command. There must not be any spaces in the keyword.<\/p>\n\n\n\n
Rules:<\/p>\n\n\n\n
    \n
  1. This is not a hash command. There must not be any spaces in the keyword<\/li>\n\n\n\n
  2. #EQU<\/code>\u00a0definitions are seen only by later lines in the program – “forward referencing” is not possible. In other words, the\u00a0#EQU<\/code>\u00a0definition must appear before any lines that use it. For example, this will work:

    DefaultBGColour #EQU <\/code>‘FF808080
    .....<\/code>
    #    HMI<\/a> SetColours( b:DefaultBGColour ) Cls() ;After the definition above, will set the colour as expected

    <\/code>But this will fail:

    #HMI SetColours( b:DefaultBGColour ) Cls() ;BEFORE the definition below, will FAIL
    .....
    DefaultBGColour #EQU \"128, 128, 255\"<\/code><\/li>\n\n\n\n
  3. They can be cascaded. For example this will work:

    DefaultBGColour #EQU 'FF808080<\/code>
    .....<\/code>
    ThisScreenBGColour #EQU DefaultBGColour<\/code><\/li>\n\n\n\n
  4. #EQU<\/code> values cannot be redefined.<\/li>\n\n\n\n
  5. #EQU<\/code>\u00a0values cannot be used as arguments in\u00a0Formatting functions<\/a>.<\/li>\n<\/ol>\n\n\n\n
    #EQU<\/code>\u00a0is particularly useful for globally changing colour schemes in display screens (e.g.\u00a0SimpleHMI<\/a>) and for managing memory allocations for\u00a0Xwire<\/a>. The following sample code shows several uses:<\/p>\n\n\n\n
    Greet          #EQU    \"Hello World\"
    Pi             #EQU    3.1415926
    XWRxBlockSize  #EQU    5
    XWTxBlockSize  #EQU    2
    XWSlaveAddr    EQU     45  ;Could also be a #EQU

       defBLOCK    XWRxBlockSize
    RxB1           defByte
    RxF1           defFLOAT

       defBLOCK    XWTxBlockSize
    TxB1           defByte
    TxB2           defByte

       iiPrintText     251,Greet
       fLoadW          Pi
       ....

       NVEM0
    XWireCCB       NV0Byte     XWSlaveAddr, TxB1, XWTxBlockSize, RxB1, XWRxBlockSize

    a #EQU can refer to a previous #EQU, eg:

    Hello       #EQU    \"Hello World\"
    Greet       #EQU    Hello<\/pre>\n\n\n\n
    #EQU<\/code> can generally be used in place of EQU<\/code> and fEQU<\/code>, providing the definition appears before the use. It must not be used in place of mEQU<\/code> which triggers under the hood memory management operations during Translation (compilation).<\/p>\n\n\n\n

    See also\u00a0    EQU<\/a>, fEQU<\/a><\/code><\/p>\n","protected":false},"excerpt":{"rendered":"
    The #EQU directive assigns a text string to a label. Example DefaultBGColour #EQU ‘FF808080 In any regular program line\u00a0after this,\u00a0wherever the word\u00a0DefaultBGColour\u00a0appears as an argument in an instruction or\u00a0hash…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3171,"menu_order":19,"template":"","class_list":["post-3191","spl_knowledgebase","type-spl_knowledgebase","status-publish","hentry"],"acf":[],"yoast_head":"\n#EQU directive - SPLat Controls<\/title>\n<meta name=\"robots\" content=\"noindex, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"#EQU directive - SPLat Controls\" \/>\n<meta property=\"og:description\" content=\"The #EQU directive assigns a text string to a label. Example DefaultBGColour #EQU 'FF808080 In any regular program line\u00a0after this,\u00a0wherever the word\u00a0DefaultBGColour\u00a0appears as an argument in an instruction or\u00a0hash...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/\" \/>\n<meta property=\"og:site_name\" content=\"SPLat Controls\" \/>\n<meta property=\"article:modified_time\" content=\"2025-05-07T11:26:44+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/\",\"name\":\"#EQU directive - SPLat Controls\",\"isPartOf\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\"},\"datePublished\":\"2025-04-17T09:49:24+00:00\",\"dateModified\":\"2025-05-07T11:26:44+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Programming reference\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Directives\",\"item\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"#EQU directive\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"name\":\"SPLat Controls\",\"description\":\"OEM Embedded Machine Controllers\",\"publisher\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization\",\"name\":\"SPLat Controls\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"contentUrl\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg\",\"caption\":\"SPLat Controls\"},\"image\":{\"@id\":\"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"#EQU directive - SPLat Controls","robots":{"index":"noindex","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"og_locale":"en_US","og_type":"article","og_title":"#EQU directive - SPLat Controls","og_description":"The #EQU directive assigns a text string to a label. Example DefaultBGColour #EQU 'FF808080 In any regular program line\u00a0after this,\u00a0wherever the word\u00a0DefaultBGColour\u00a0appears as an argument in an instruction or\u00a0hash...","og_url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/","og_site_name":"SPLat Controls","article_modified_time":"2025-05-07T11:26:44+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/","name":"#EQU directive - SPLat Controls","isPartOf":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website"},"datePublished":"2025-04-17T09:49:24+00:00","dateModified":"2025-05-07T11:26:44+00:00","breadcrumb":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/equ-directive-2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/"},{"@type":"ListItem","position":2,"name":"Programming reference","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/"},{"@type":"ListItem","position":3,"name":"Directives","item":"https:\/\/webprojects.cloud\/wordpress\/splatco\/knowledgebase\/programming-reference\/directives\/"},{"@type":"ListItem","position":4,"name":"#EQU directive"}]},{"@type":"WebSite","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#website","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","name":"SPLat Controls","description":"OEM Embedded Machine Controllers","publisher":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webprojects.cloud\/wordpress\/splatco\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#organization","name":"SPLat Controls","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/","url":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","contentUrl":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-content\/uploads\/2024\/10\/logo.svg","caption":"SPLat Controls"},"image":{"@id":"https:\/\/webprojects.cloud\/wordpress\/splatco\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/3191","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase"}],"about":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/types\/spl_knowledgebase"}],"author":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/users\/1"}],"up":[{"embeddable":true,"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/spl_knowledgebase\/3171"}],"wp:attachment":[{"href":"https:\/\/webprojects.cloud\/wordpress\/splatco\/wp-json\/wp\/v2\/media?parent=3191"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}