VSCP framework v0.5.0 merged

Author: BlueAndi

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.0 (unreleased)
+
+- Update to VSCP framework v0.5.0, please see the ![changelog](https://github.com/BlueAndi/vscp-framework/blob/v0.5.0/CHANGELOG.md) there.
+- Seeed-Studio-CAN_BUS_Shield example got a retry mechanism in the send routine.
+- Sparkfun_CAN-BUS_Shield example got a retry mechanism in the send routine.
+
 ## 0.3.0
 
 - DigInDebounce class for digital input debouncing implemented.

VSCP/library.properties

@@ -1,8 +1,8 @@
 name=VSCP
-version=0.2.1
+version=0.4.0
 author=Andreas Merkle
 maintainer=Andreas Merkle <vscp@blue-andi.de>
-sentence=Very Simple Control Protocol framework for all Arduino boards.
+sentence=Very Simple Control Protocol L1 framework for all Arduino boards.
 paragraph=
 url=http://github.com/BlueAndi/vscp-arduino
 architectures=avr

VSCP/src/framework/vscp_config.h

@@ -112,8 +112,8 @@ extern "C"
 
 #ifndef VSCP_CONFIG_HEARTBEAT_NODE
 
-/** Enable sending node heartbeat. */
-#define VSCP_CONFIG_HEARTBEAT_NODE              VSCP_CONFIG_BASE_DISABLED
+/** Enable sending node heartbeat (mandatory since 2015-09-10). */
+#define VSCP_CONFIG_HEARTBEAT_NODE              VSCP_CONFIG_BASE_ENABLED
 
 #endif  /* Undefined VSCP_CONFIG_HEARTBEAT_NODE */
 
@@ -224,8 +224,8 @@ extern "C"
 
 #ifndef VSCP_CONFIG_HEARTBEAT_NODE_PERIOD
 
-/** Node heartbeat period in ms. */
-#define VSCP_CONFIG_HEARTBEAT_NODE_PERIOD       ((uint16_t)1000)
+/** Node heartbeat period in ms (recommended 30s - 60s). */
+#define VSCP_CONFIG_HEARTBEAT_NODE_PERIOD       ((uint16_t)30000)
 
 #endif  /* Undefined VSCP_CONFIG_HEARTBEAT_NODE_PERIOD */
 

VSCP/src/framework/vscp_config_overwrite.h

@@ -76,7 +76,7 @@ extern "C"
 
 #define VSCP_CONFIG_HEARTBEAT_SUPPORT_SEGMENT   VSCP_CONFIG_BASE_DISABLED
 
-#define VSCP_CONFIG_HEARTBEAT_NODE              VSCP_CONFIG_BASE_DISABLED
+#define VSCP_CONFIG_HEARTBEAT_NODE              VSCP_CONFIG_BASE_ENABLED
 
 #define VSCP_CONFIG_IDLE_CALLOUT                VSCP_CONFIG_BASE_DISABLED
 
@@ -110,7 +110,7 @@ extern "C"
 
 #define VSCP_CONFIG_MULTI_MSG_TIMEOUT           ((uint16_t)1000)
 
-#define VSCP_CONFIG_HEARTBEAT_NODE_PERIOD       ((uint16_t)1000)
+#define VSCP_CONFIG_HEARTBEAT_NODE_PERIOD       ((uint16_t)30000)
 
 #define VSCP_CONFIG_DM_PAGE                     1
 

VSCP/src/framework/vscp_core.c

@@ -1606,53 +1606,59 @@ static inline void  vscp_core_handleProtocolDropNicknameId(void)
                 vscp_core_changeToStateReset(0);
             }
             /* Additional flags received? */
-            else if (2 <= vscp_core_rxMessage.dataNum)
+            else if ((2 == vscp_core_rxMessage.dataNum) ||
+                     (3 == vscp_core_rxMessage.dataNum))
             {
-                /* Clear the nickname? */
-                if (0 == (vscp_core_rxMessage.data[1] & 0x20))
+                uint8_t waitTime    = 0;
+            
+                /* Wait time received? */
+                if (3 == vscp_core_rxMessage.dataNum)
                 {
-                    vscp_core_writeNicknameId(VSCP_NICKNAME_NOT_INIT);
+                    waitTime = vscp_core_rxMessage.data[2];
                 }
-
-                /* Set persistent memory to default? */
-                if (0 != (vscp_core_rxMessage.data[1] & 0x40))
+                    
+                /* Byte 1:
+                 * Bit 5 - Reset device. Keep nickname.
+                 * Bit 6 - Set persistent storage to default.
+                 * Bit 7 - Go idle. Do not start up again.
+                 */
+            
+                /* Set persistent memory to default (bit 6)? */
+                if (0 != (vscp_core_rxMessage.data[1] & (1 << 6)))
                 {
-                    /* Backup nickname */
+                    /* Backup nickname, because restore factory settings will clear it. */
                     uint8_t nicknameBackup  = vscp_core_nickname;
 
                     /* Set defaults to persistent memory. */
                     vscp_core_restoreFactoryDefaultSettings();
 
-                    /* Keep nickname? */
-                    if (0 != (vscp_core_rxMessage.data[1] & 0x20))
+                    /* Restore nickname? */
+                    if (0 != (vscp_core_rxMessage.data[1] & (1 << 5)))
                     {
                         /* Restore nickname */
                         vscp_core_writeNicknameId(nicknameBackup);
                     }
                 }
 
-                /* Reset device?
+                /* Reset device (bit 5)?
                  * Note that "reset device" has a higher priority than "go idle".
                  * There is no exact description in the specification yet.
                  */
-                if ((0 != (vscp_core_rxMessage.data[1] & 0x20)) ||
-                    (0 == (vscp_core_rxMessage.data[1] & 0x80)))
+                if (0 != (vscp_core_rxMessage.data[1] & (1 << 5)))
                 {
-                    /* Wait time received? */
-                    if (3 == vscp_core_rxMessage.dataNum)
-                    {
-                        vscp_core_changeToStateReset(vscp_core_rxMessage.data[2]);
-                    }
-                    else
-                    {
-                        vscp_core_changeToStateReset(0);
-                    }
+                    vscp_core_changeToStateReset(waitTime);
                 }
-                /* Change to idle state? */
-                else if (0 != (vscp_core_rxMessage.data[1] & 0x80))
+                /* Change to idle state (bit 7)? */
+                else if (0 != (vscp_core_rxMessage.data[1] & (1 << 7)))
                 {
+                    vscp_core_writeNicknameId(VSCP_NICKNAME_NOT_INIT);
                     vscp_core_changeToStateIdle();
                 }
+                else
+                {
+                    vscp_core_writeNicknameId(VSCP_NICKNAME_NOT_INIT);
+                    vscp_core_changeToStateReset(waitTime);
+                }
             }
         }
     }

VSCP/src/framework/vscp_core.h

@@ -103,7 +103,7 @@ extern "C"
 #define VSCP_CORE_VERSION_STR       "v1.10.16"
 
 /** VSCP framework version string */
-#define VSCP_CORE_FRAMEWORK_VERSION "v0.4.0"
+#define VSCP_CORE_FRAMEWORK_VERSION "v0.5.0"
 
 /*******************************************************************************
     MACROS