{"id":655,"date":"2025-07-21T12:12:34","date_gmt":"2025-07-21T12:12:34","guid":{"rendered":"https:\/\/tipcontrol.com\/?page_id=655"},"modified":"2025-07-21T12:12:34","modified_gmt":"2025-07-21T12:12:34","slug":"wait-function","status":"publish","type":"page","link":"https:\/\/tipcontrol.com\/?page_id=655","title":{"rendered":"wait function"},"content":{"rendered":"\n

wait(name, timeout)<\/code> Command Documentation<\/h3>\n\n\n\n

The wait(name, timeout)<\/code> command is designed to pause program execution, waiting for a specific notification to be received. It listens for a notification identified by a given name, with the ability to specify a maximum wait time in milliseconds. If no notification is received within the specified timeout, the command returns NIL<\/code>.<\/p>\n\n\n\n

Structure of the wait<\/code> Command<\/h4>\n\n\n\n

The typical usage of the wait<\/code> command is as follows:<\/p>\n\n\n\n

Components<\/strong>:<\/p>\n\n\n\n

    \n
  1. name<\/code>\u00a0(String Literal)<\/strong>: Specifies the name of the notification to wait for. It must be a string literal that uniquely identifies the notification within the system.<\/li>\n\n\n\n
  2. timeout<\/code>\u00a0(Milliseconds)<\/strong>: An integer value representing the maximum time (in milliseconds) to wait for the notification. After this duration, if no notification is received, the function returns\u00a0NIL<\/code>.<\/li>\n<\/ol>\n\n\n\n

    Simple Example<\/h4>\n\n\n\n

    notification=NIL; \/\/ declare variable outside of loop<\/p>\n\n\n\n

    dowhile(notification == NIL)<\/p>\n\n\n\n

    {<\/p>\n\n\n\n

    drv.digitalIO.toggle(); \/\/ toggle a LED for example<\/p>\n\n\n\n

        \/\/ Wait for notification named “blink” for up to 1000 milliseconds<\/p>\n\n\n\n

      notification = wait(“blink”, 1000);<\/p>\n\n\n\n

    };<\/p>\n\n\n\n

    lib.log(\u201cReceived stop notification: \u201c+notification);<\/p>\n\n\n\n

    Explanation<\/strong>:<\/p>\n\n\n\n

      \n
    • Waiting for Notifications<\/strong>: The command waits for up to 1000 milliseconds for a notification named “blink”.<\/li>\n\n\n\n
    • Handling NIL<\/strong>: If no notification is received within the timeout,\u00a0NIL<\/code>\u00a0is returned, indicating a timeout.<\/li>\n<\/ul>\n\n\n\n

      Practical Use<\/h3>\n\n\n\n
        \n
      • Asynchronous Event Handling<\/strong>: Use\u00a0wait<\/code>\u00a0to synchronize with events or signals in a non-blocking manner, allowing programs to handle time-based or event-driven logic flexibly.<\/li>\n\n\n\n
      • Timeout Mechanism<\/strong>: Incorporates a timeout to prevent indefinite waiting, ensuring that the program can continue execution even if an expected event does not occur.<\/li>\n<\/ul>\n\n\n\n

        Considerations<\/h3>\n\n\n\n
          \n
        • String Literal Requirement<\/strong>: The\u00a0name<\/code>\u00a0parameter must be a string literal, ensuring consistent and unambiguous identification of notifications.<\/li>\n\n\n\n
        • Timeout Specified in Milliseconds<\/strong>: Be sure to specify an appropriate timeout value depending on the responsiveness and expected behavior of the system or application.<\/li>\n<\/ul>\n\n\n\n

          The wait(name, timeout)<\/code> command provides a structured approach to coordinating program actions with external events, using notifications to enable asynchronous processing and improve program responsiveness.<\/p>\n","protected":false},"excerpt":{"rendered":"

          wait(name, timeout) Command Documentation The wait(name, timeout) command is designed to pause program execution, waiting for a specific notification to be received. It listens for a notification identified by a given name, with the ability to specify a maximum wait time in milliseconds. If no notification is received within the specified timeout, the command returns NIL. […]<\/p>\n","protected":false},"author":4,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-655","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/pages\/655","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/tipcontrol.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=655"}],"version-history":[{"count":1,"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/pages\/655\/revisions"}],"predecessor-version":[{"id":656,"href":"https:\/\/tipcontrol.com\/index.php?rest_route=\/wp\/v2\/pages\/655\/revisions\/656"}],"wp:attachment":[{"href":"https:\/\/tipcontrol.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=655"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}