Deprecated "dataNum" replaced with "dataSize".

#7

Author: BlueAndi

README.md

@@ -50,10 +50,10 @@ vscp.prepareTxMessage(txMsg, VSCP_CLASS_L1_INFORMATION, VSCP_TYPE_INFORMATION_ON
 ### Add the class and type specific data.
 
 ```
-txMsg.data[0] = 1;  // Index
-txMsg.data[1] = 0;  // Zone
-txMsg.data[2] = 0;  // Sub zone
-txMsg.dataNum = 3;
+txMsg.data[0]   = 1;  // Index
+txMsg.data[1]   = 0;  // Zone
+txMsg.data[2]   = 0;  // Sub zone
+txMsg.dataSize  = 3;
 ```
 
 ### Send the event.

examples/Generic/Generic.ino

@@ -46,16 +46,16 @@ bool transportRead(vscp_RxMessage * const rxMsg) {
     rxMsg->vscpType     = ...
     rxMsg->oAddr        = ...
     rxMsg->hardCoded    = ...
-    rxMsg->dataNum      = ...
+    rxMsg->dataSize     = ...
     
     // Protect against data buffer out of bounce access
-    if (VSCP_L1_DATA_SIZE < rxMsg->dataNum)
+    if (VSCP_L1_DATA_SIZE < rxMsg->dataSize)
     {
-        rxMsg->dataNum = VSCP_L1_DATA_SIZE;
+        rxMsg->dataSize = VSCP_L1_DATA_SIZE;
     }
     
     // Copy the payload
-    for(index = 0; index < rxMsg->dataNum; ++index)
+    for(index = 0; index < rxMsg->dataSize; ++index)
     {
         rxMsg->data[index] = ...
     }
@@ -79,10 +79,10 @@ bool transportWrite(vscp_TxMessage const * const txMsg) {
     ... = rxMsg->vscpType;
     ... = rxMsg->oAddr;
     ... = rxMsg->hardCoded;
-    ... = rxMsg->dataNum;
+    ... = rxMsg->dataSize;
         
     // Copy the payload
-    for(index = 0; index < rxMsg->dataNum; ++index)
+    for(index = 0; index < rxMsg->dataSize; ++index)
     {
         ... = rxMsg->data[index];
     }
@@ -163,10 +163,10 @@ void loop() {
 
     // Send a VSCP message here ... e.g. a CLASS1.INFORMATION ON event
     vscp.prepareTxMessage(txMsg, VSCP_CLASS_L1_INFORMATION, VSCP_TYPE_INFORMATION_ON, VSCP_PRIORITY_3_NORMAL);
-    txMsg.data[0] = 1;  // Index
-    txMsg.data[1] = 0;  // Zone
-    txMsg.data[2] = 0;  // Sub zone
-    txMsg.dataNum = 3;
+    txMsg.data[0]   = 1;  // Index
+    txMsg.data[1]   = 0;  // Zone
+    txMsg.data[2]   = 0;  // Sub zone
+    txMsg.dataSize  = 3;
     vscp.write(txMsg);
 
   } else {

examples/Seeed-Studio-CAN_BUS_Shield/Seeed-Studio-CAN_BUS_Shield.ino

@@ -50,7 +50,7 @@ bool transportRead(vscp_RxMessage * const rxMsg) {
   {
     unsigned long   canMsgId  = 0;
 
-    if (CAN_OK == canCom.readMsgBufID(&canMsgId, &rxMsg->dataNum, rxMsg->data)) {
+    if (CAN_OK == canCom.readMsgBufID(&canMsgId, &rxMsg->dataSize, rxMsg->data)) {
 
         rxMsg->vscpClass  = (uint16_t)((canMsgId >> 16) & 0x01ff);
         rxMsg->vscpType   = (uint8_t)((canMsgId >> 8) & 0x00ff);
@@ -88,7 +88,7 @@ bool transportWrite(vscp_TxMessage const * const txMsg) {
     }
 
     // Send CAN message
-    if (CAN_OK != canCom.sendMsgBuf(canMsgId, 1, 0, txMsg->dataNum, (unsigned char*)txMsg->data)) {
+    if (CAN_OK != canCom.sendMsgBuf(canMsgId, 1, 0, txMsg->dataSize, (unsigned char*)txMsg->data)) {
 
       // CAN message couldn't be sent, try again.
       ++retryCnt;
@@ -225,4 +225,4 @@ void loop() {
 
   }
 
-}
+}

examples/Sparkfun_CAN-BUS_Shield/Sparkfun_CAN-BUS_Shield.ino

@@ -54,16 +54,16 @@ bool transportRead(vscp_RxMessage * const rxMsg) {
       rxMsg->oAddr      = (uint8_t)((canMsg.adrsValue >> 0) & 0x00ff);
       rxMsg->hardCoded  = (uint8_t)((canMsg.adrsValue >> 25) & 0x0001);
       rxMsg->priority   = (VSCP_PRIORITY)((canMsg.adrsValue >> 26) & 0x0007);
-      rxMsg->dataNum    = canMsg.dataLength;
+      rxMsg->dataSize   = canMsg.dataLength;
 
       // Protect against a buffer out of bounce access
-      if (VSCP_L1_DATA_SIZE < rxMsg->dataNum) {
+      if (VSCP_L1_DATA_SIZE < rxMsg->dataSize) {
 
-        rxMsg->dataNum = VSCP_L1_DATA_SIZE;
+        rxMsg->dataSize = VSCP_L1_DATA_SIZE;
       }
 
       // Copy payload
-      for(index = 0; index < rxMsg->dataNum; ++index) {
+      for(index = 0; index < rxMsg->dataSize; ++index) {
 
         rxMsg->data[index] = canMsg.data[index];
       }
@@ -94,7 +94,7 @@ bool transportWrite(vscp_TxMessage const * const txMsg) {
 
   canMsg.rtr = 0;
 
-  canMsg.dataLength = txMsg->dataNum;
+  canMsg.dataLength = txMsg->dataSize;
 
   for(index = 0; index < canMsg.dataLength; ++index) {
 
@@ -242,4 +242,4 @@ void loop() {
 
   }
 
-}
+}

src/framework/user/vscp_tp_adapter.c

@@ -140,7 +140,7 @@ extern BOOL vscp_tp_adapter_writeMessage(vscp_TxMessage const * const msg)
     BOOL    status  = FALSE;
 
     if ((NULL != msg) &&                        /* Message shall exists */
-        (VSCP_L1_DATA_SIZE >= msg->dataNum))    /* Number of data bytes is limited */
+        (VSCP_L1_DATA_SIZE >= msg->dataSize))   /* Number of data bytes is limited */
     {
         if (NULL != vscp_tp_adapter_writeFunc)
         {