5.8.2

Author: Quantum Leaps

README-MacOS.txt

@@ -4,8 +4,8 @@ Please refer to the companion webiste to this project at:
 http://www.state-machine.com/arduino
 
 
-Software Installation
-=====================
+Software Installation on Windows
+================================
 The QP-nano adaptation for Arduino is distributed in a single ZIP
 archive qpn-<ver>_arduino-1.6.x.zip, where <ver> stands for version of
 the QP-nano framework.
@@ -18,11 +18,55 @@ sketchbook location will be shown at the top of the Preferences dialog
 box. Once you identify the Sketchbook folder, you simply unzip the whole
 archive to your Sketchbook.
 
-****
-NOTE: Currently, the QP-nano for Arduino project is available only
-on Windows. If you are interested in other platforms, such as Linux
-or MacOS, please consider contribuing a tested port.
-****
+
+Software Installation on MacOS
+==============================
+The Mac funtionality has been tested, but other users will likely find
+issues. Please submit issues at https://sourceforge.net/p/qpc/bugs/ and
+submit questions and suggestions at
+https://sourceforge.net/p/qpc/discussion/668726/
+
+Install Dependencies
+--------------------
+1. Install the AVR-GCC tooltrain for Mac OS X. Following are the commands
+to install using Homebrew (must have Homebrew installed):
+
+  > ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+  > brew tap osx-cross/avr
+  > brew install avr-libc
+  > brew install avrdude --with-usb
+
+2. Install Arduino for Mac OS X by placing the Arduino application in the
+Applications folder. Open the application at least one time to overcome
+security warnings.
+
+3. Install Install QP-nano for Arduino into your Documents/Arduino folder
+(documentation refers to this as the Arduino Sketchbook folder).
+
+4. Install QM.
+
+Instructions for Configuring External Tools for a Model
+
+1. Ensure the model is not open in QM.
+
+2. Copy the Blinky model's settings
+(libraries/qpn_avr/examples/blinky/.blinky.macos) from your Arduino
+Sketchbook folder to the model's folder.
+
+3. Rename the settings file to your model's name (i.e., .mymodel).
+
+4. Open QM and edit the settings from External Tools.
+
+Once you have a working .model file, copy it to other models and use it as
+a starting point.
+
+Known Issues
+------------
+1. The serialterm External Tool is working by opening a Terminal window.
+An additional Terminal window also appears and can be safely closed. When
+the Terminal window displaying the Arduino's output is closed, the port is
+busy and can no longer be accessed. Work-around is to unplug and
+re-connect the Arduino from the Mac's USB port.
 
 
 Building the Examples in the QM Modeling Tool

README.txt

@@ -4,14 +4,14 @@
 * @ingroup qep
 * @cond
 ******************************************************************************
-* Last updated for version 5.8.1
-* Last updated on  2017-02-19
+* Last updated for version 5.8.2
+* Last updated on  2017-02-22
 *
 *                    Q u a n t u m     L e a P s
 *                    ---------------------------
 *                    innovating embedded systems
 *
-* Copyright (C) Quantum Leaps, www.state-machine.com.
+* Copyright (C) Quantum Leaps, LLC. All rights reserved.
 *
 * This program is open source software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
@@ -32,7 +32,7 @@
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact information:
-* http:www.state-machine.com
+* http://www.state-machine.com
 * mailto:info@state-machine.com
 ******************************************************************************
 * @endcond
@@ -73,14 +73,6 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
 *
 * @note Must be called only ONCE before QHSM_INIT().
 *
-* @note
-* QHsm inherits QHsm, so by the @ref oop convention it should call the
-* constructor of the superclass, i.e., QHsm_ctor(). However, this would pull
-* in the QHsmVtbl, which in turn will pull in the code for QHsm_init_() and
-* QHsm_dispatch_() implemetations. To avoid this code size penalty, in case
-* ::QHsm is not used in a given project, the QHsm_ctor() performs direct
-* intitialization of the Vtbl, which avoids pulling in the code for QHsm.
-*
 * @usage
 * The following example illustrates how to invoke QHsm_ctor() in the
 * "constructor" of a derived state machine:
@@ -91,31 +83,11 @@ void QHsm_ctor(QHsm * const me, QStateHandler initial) {
         &QHsm_init_,
         &QHsm_dispatch_
     };
-    /* do not call the QHsm_ctor() here */
-    me->vptr = &vtbl;
+    me->vptr  = &vtbl;
     me->state = Q_STATE_CAST(&QHsm_top);
     me->temp  = initial;
 }
 
-/****************************************************************************/
-/**
-* @description
-* QHsm_top() is the ultimate root of state hierarchy in all HSMs derived
-* from ::QHsm.
-*
-* @param[in] me pointer (see @ref oop)
-*
-* @returns Always returns #Q_RET_IGNORED, which means that the top state
-*          ignores all events.
-*
-* @note The parameter @p me to this state handler is not used. It is provided
-* for conformance with the state-handler function signature ::QStateHandler.
-*/
-QState QHsm_top(void const * const me) {
-    (void)me;  /* suppress the "unused parameter" compiler warning */
-    return (QState)Q_RET_IGNORED; /* the top state ignores all events */
-}
-
 /****************************************************************************/
 /**
 * @description
@@ -133,14 +105,14 @@ void QHsm_init_(QHsm * const me) {
     * transition must be initialized, and the initial transition must not
     * be taken yet.
     */
-    Q_REQUIRE_ID(600, (me->vptr != (QHsmVtbl const *)0)
+    Q_REQUIRE_ID(200, (me->vptr != (QHsmVtbl const *)0)
                       && (me->temp != Q_STATE_CAST(0))
                       && (t == Q_STATE_CAST(&QHsm_top)));
 
     r = (*me->temp)(me); /* execute the top-most initial transition */
 
     /* the top-most initial transition must be taken */
-    Q_ASSERT_ID(610, r == (QState)Q_RET_TRAN);
+    Q_ASSERT_ID(210, r == (QState)Q_RET_TRAN);
 
     /* drill down into the state hierarchy with initial transitions... */
     do {
@@ -152,7 +124,7 @@ void QHsm_init_(QHsm * const me) {
         (void)(*me->temp)(me);
         while (me->temp != t) {
             ++ip;
-            Q_ASSERT_ID(620, ip < (int_fast8_t)Q_DIM(path));
+            Q_ASSERT_ID(220, ip < (int_fast8_t)Q_DIM(path));
             path[ip] = me->temp;
             (void)(*me->temp)(me);
         }
@@ -175,6 +147,25 @@ void QHsm_init_(QHsm * const me) {
     me->temp  = t; /* mark the configuration as stable */
 }
 
+/****************************************************************************/
+/**
+* @description
+* QHsm_top() is the ultimate root of state hierarchy in all HSMs derived
+* from ::QHsm.
+*
+* @param[in] me pointer (see @ref oop)
+*
+* @returns Always returns #Q_RET_IGNORED, which means that the top state
+*          ignores all events.
+*
+* @note The parameter @p me to this state handler is not used. It is provided
+* for conformance with the state-handler function signature ::QStateHandler.
+*/
+QState QHsm_top(void const * const me) {
+    (void)me; /* suppress the "unused parameter" compiler warning */
+    return (QState)Q_RET_IGNORED; /* the top state ignores all events */
+}
+
 /****************************************************************************/
 /**
 * @description
@@ -193,16 +184,18 @@ void QHsm_dispatch_(QHsm * const me) {
     QState r;
     int_fast8_t iq; /* helper transition entry path index */
 
-    /** @pre the state configuration must be stable */
-    Q_REQUIRE_ID(700, t == me->temp);
+    /** @pre the current state must be initialized and
+    * the state configuration must be stable
+    */
+    Q_REQUIRE_ID(400, (t != Q_STATE_CAST(0))
+                      && (t == me->temp));
 
     /* process the event hierarchically... */
     do {
         s = me->temp;
         r = (*s)(me); /* invoke state handler s */
 
-        /* unhandled due to a guard? */
-        if (r == (QState)Q_RET_UNHANDLED) {
+        if (r == (QState)Q_RET_UNHANDLED) { /* unhandled due to a guard? */
             iq = (int_fast8_t)Q_SIG(me); /* save the original signal */
             Q_SIG(me) = (QSignal)QEP_EMPTY_SIG_; /* find the superstate */
             r = (*s)(me); /* invoke state handler s */
@@ -256,7 +249,7 @@ void QHsm_dispatch_(QHsm * const me) {
             me->temp = path[0];
 
             /* entry path must not overflow */
-            Q_ASSERT_ID(710, ip < QHSM_MAX_NEST_DEPTH_);
+            Q_ASSERT_ID(410, ip < QHSM_MAX_NEST_DEPTH_);
 
             /* retrace the entry path in reverse (correct) order... */
             Q_SIG(me) = (QSignal)Q_ENTRY_SIG;
@@ -344,7 +337,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
                             iq = (int_fast8_t)1; /* indicate that LCA found */
 
                             /* entry path must not overflow */
-                            Q_ASSERT_ID(810, ip < QHSM_MAX_NEST_DEPTH_);
+                            Q_ASSERT_ID(510, ip < QHSM_MAX_NEST_DEPTH_);
                             --ip; /* do not enter the source */
                             r = (QState)Q_RET_HANDLED; /* terminate loop */
                         }
@@ -358,7 +351,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
                     if (iq == (int_fast8_t)0) {
 
                         /* entry path must not overflow */
-                        Q_ASSERT_ID(820, ip < QHSM_MAX_NEST_DEPTH_);
+                        Q_ASSERT_ID(520, ip < QHSM_MAX_NEST_DEPTH_);
 
                         Q_SIG(me) = (QSignal)Q_EXIT_SIG;
                         (void)(*s)(me); /* exit the source */
@@ -369,9 +362,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
                         iq = ip;
                         r = (QState)Q_RET_IGNORED; /* LCA NOT found */
                         do {
-                            s = path[iq];
-                            /* is this the LCA? */
-                            if (t == s) {
+                            if (t == path[iq]) { /* is this the LCA? */
                                 r = (QState)Q_RET_HANDLED; /* LCA found */
 
                                 /* do not enter LCA */
@@ -383,7 +374,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
                             }
                         } while (iq >= (int_fast8_t)0);
 
-                        /* LCAnot found? */
+                        /* LCA not found? */
                         if (r != (QState)Q_RET_HANDLED) {
                             /* (g) check each source->super->...
                             * for each target->super...
@@ -396,12 +387,11 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
                                     Q_SIG(me) = (QSignal)QEP_EMPTY_SIG_;
                                     (void)(*t)(me); /* find super of t */
                                 }
-                                t = me->temp; /*  set to super of t */
+                                t = me->temp; /* set to super of t */
                                 iq = ip;
                                 do {
-                                    s = path[iq];
                                     /* is this LCA? */
-                                    if (t == s) {
+                                    if (t == path[iq]) {
                                         /* do not enter LCA */
                                         ip = (int_fast8_t)(iq-(int_fast8_t)1);
                                         /* cause breaking out of inner loop */
@@ -466,7 +456,7 @@ QStateHandler QHsm_childState_(QHsm * const me,
     me->temp = me->state; /* establish stable state configuration */
 
     /** @post the child must be confirmed */
-    Q_ENSURE_ID(910, isConfirmed != false);
+    Q_ENSURE_ID(710, isConfirmed != false);
 
     return child; /* return the child */
 }

libraries/qpn_avr/qepn.c

@@ -4,8 +4,8 @@
 * @ingroup qfn
 * @cond
 ******************************************************************************
-* Last updated for version 5.8.0
-* Last updated on  2016-11-18
+* Last updated for version 5.8.1
+* Last updated on  2016-12-16
 *
 *                    Q u a n t u m     L e a P s
 *                    ---------------------------
@@ -343,6 +343,12 @@ void QF_init(uint_fast8_t maxActive) {
         }
 #endif /* (QF_TIMEEVT_CTR_SIZE != 0) */
     }
+
+#ifdef QV_INIT /* initialization of the QV-nano kernel defined? */
+    QV_INIT(); /* port-specific initialization of the QV-nano kernel */
+#elif defined QK_INIT /* initialization of the QK-nano kernel defined? */
+    QK_INIT(); /* port-specific initialization of the QK-nano kernel */
+#endif
 }
 
 /****************************************************************************/