v1.3.0

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.3.0
+
+- Update to VSCP framework v1.3.0, please see the ![changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v1.3.0) there.
+
+
 ## 1.2.0
 
 - Update to VSCP framework v1.2.0, please see the ![changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v1.2.0) there.

examples/Generic/Generic.ino

@@ -126,7 +126,7 @@ void setup() {
   vscp.setup(
     8,              // Status lamp pin
     7,              // Init button pin
-    nodeGuid,       // Node GUID,
+    nodeGuid,       // Node GUID
     255,            // Node zone (255 = all zones)
     255,            // Node sub-zone (255 = all sub-zones)
     transportRead,  // VSCP framework calls it to read a message
@@ -179,4 +179,4 @@ void loop() {
 
   }
 
-}
+}

library.json

@@ -1,6 +1,6 @@
 {
     "name": "vscp-arduino",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "keywords": "vscp, arduino-library, vscp-arduino, automation, home automation",
     "description": "Very Simple Control Procotol (VSCP) Level 1 Library for the arduino IDE.",
     "repository": {

library.properties

@@ -1,5 +1,5 @@
 name=VSCP
-version=1.2.0
+version=1.3.0
 author=Andreas Merkle
 maintainer=Andreas Merkle <vscp@blue-andi.de>
 sentence=Very Simple Control Protocol L1 framework for all Arduino boards.

src/framework/core/vscp_core.c

@@ -616,7 +616,7 @@ extern uint32_t vscp_core_getTimeSinceEpoch(void)
  * Set the time since epoch 00:00:00 UTC, January 1, 1970.
  * Note, if a segment master is present, it will overwrite the time with its
  * heartbeat message.
- * 
+ *
  * @param[in] timestamp Unix timestamp
  */
 extern void vscp_core_setTimeSinceEpoch(uint32_t timestamp)
@@ -797,7 +797,7 @@ static inline void  vscp_core_stateStartup(void)
 /**
  * Change to init state.
  * - Drop nickname id.
- * 
+ *
  * @param[in] probeSegmentMaster    Probe for segment master (true) or start own nickname discovery (false).
  */
 static inline void  vscp_core_changeToStateInit(BOOL probeSegmentMaster)
@@ -1574,7 +1574,7 @@ static inline void  vscp_core_handleProtocolHeartbeat(void)
                 vscp_core_changeToStateInit(TRUE);
             }
         }
-        
+
         /* If available, store time since epoch 00:00:00 UTC, January 1, 1970 */
         if (5 <= vscp_core_rxMessage.dataNum)
         {
@@ -1700,19 +1700,19 @@ static inline void  vscp_core_handleProtocolDropNicknameId(void)
                      (3 == vscp_core_rxMessage.dataNum))
             {
                 uint8_t waitTime    = 0;
-            
+
                 /* Wait time received? */
                 if (3 == vscp_core_rxMessage.dataNum)
                 {
                     waitTime = vscp_core_rxMessage.data[2];
                 }
-                    
+
                 /* 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)))
                 {
@@ -1980,7 +1980,7 @@ static uint8_t  vscp_core_readRegister(uint16_t page, uint8_t addr)
                 break;
         }
     }
-    
+
 #if VSCP_CONFIG_BASE_IS_ENABLED( VSCP_CONFIG_ENABLE_DM )
     /* Is the addressed register part of the decision matrix? */
     else if (FALSE != vscp_dm_isDecisionMatrix(page, addr))
@@ -2211,7 +2211,7 @@ static uint8_t  vscp_core_writeRegister(uint16_t page, uint8_t addr, uint8_t val
     /* Write protection disabled? */
     else if (0 != vscp_core_getRegAppWriteProtect())
     {
-    
+
 #if VSCP_CONFIG_BASE_IS_ENABLED( VSCP_CONFIG_ENABLE_DM )
         /* Is the addressed register part of the decision matrix? */
         if (FALSE != vscp_dm_isDecisionMatrix(page, addr))

src/framework/core/vscp_core.h

@@ -93,16 +93,16 @@ extern "C"
 #define VSCP_CORE_VERSION_MAJOR     (1)
 
 /** VSCP specification minor version number, the framework is compliant to. */
-#define VSCP_CORE_VERSION_MINOR     (11)
+#define VSCP_CORE_VERSION_MINOR     (12)
 
 /** VSCP specification sub-minor version number, the framework is compliant to. */
-#define VSCP_CORE_VERSION_SUB_MINOR (0)
+#define VSCP_CORE_VERSION_SUB_MINOR (2)
 
 /** VSCP specification version string, the framework is compliant to. */
-#define VSCP_CORE_VERSION_STR       "v1.11.00"
+#define VSCP_CORE_VERSION_STR       "v1.12.2"
 
 /** VSCP framework version string */
-#define VSCP_CORE_FRAMEWORK_VERSION "v1.2.0"
+#define VSCP_CORE_FRAMEWORK_VERSION "v1.3.0"
 
 /*******************************************************************************
     MACROS
@@ -201,7 +201,7 @@ extern uint32_t vscp_core_getTimeSinceEpoch(void);
  * Set the time since epoch 00:00:00 UTC, January 1, 1970.
  * Note, if a segment master is present, it will overwrite the time with its
  * heartbeat message.
- * 
+ *
  * @param[in] timestamp Unix timestamp
  */
 extern void vscp_core_setTimeSinceEpoch(uint32_t timestamp);

src/framework/core/vscp_dm.c

@@ -204,7 +204,7 @@ extern void vscp_dm_init(void)
  */
 extern void vscp_dm_restoreFactoryDefaultSettings(void)
 {
-    uint16_t    index   = 0;
+    uint16_t            index   = 0;
     vscp_dm_MatrixRow   row     = { 0, 0, 0, 0, 0, 0, 0, 0 };
 
 #if VSCP_CONFIG_BASE_IS_ENABLED( VSCP_CONFIG_ENABLE_DM_EXTENSION )

src/framework/core/vscp_type_alarm.h

@@ -134,6 +134,11 @@ extern "C"
  */
 #define VSCP_TYPE_ALARM_WATCHDOG         12
 
+/**
+ * Indicates a alarm reset condition.
+ */
+#define VSCP_TYPE_ALARM_RESET            13
+
 /*******************************************************************************
     MACROS
 *******************************************************************************/

src/framework/core/vscp_type_information.h

@@ -610,6 +610,11 @@ extern "C"
  */
 #define VSCP_TYPE_INFORMATION_DECREMENTED                         87
 
+/**
+ * Proximity detected.
+ */
+#define VSCP_TYPE_INFORMATION_PROXIMITY_DETECTED                  88
+
 /*******************************************************************************
     MACROS
 *******************************************************************************/

src/framework/core/vscp_type_measurement.h

@@ -263,7 +263,7 @@ extern "C"
  * Opt Unit: degree (1).
  * Opt Unit: arcminute (2).
  * Opt Unit: arcseconds (3).
- * This is a measurement of an angle.
+ * This is a measurement of an angle or a direction or similar.
  */
 #define VSCP_TYPE_MEASUREMENT_ANGLE                   30
 
@@ -470,12 +470,28 @@ extern "C"
 #define VSCP_TYPE_MEASUREMENT_RADIATION_DOSE_EXPOSURE 62
 
 /**
- * Default unit: Percent
- * Optional unit: Röntgen/R (1)
- * Ratio between power in kW and apperant power in kVA.
+ * Default unit: cos of phase angle.
+ * This is a measurment of a power factor. Power factor is an expression of energy efficiency. It is
+ * usually expressed as a percentage - and the lower the percentage, the less efficient power usage
+ * is.
  */
 #define VSCP_TYPE_MEASUREMENT_POWER_FACTOR            63
 
+/**
+ * Default unit: kVAr
+ * In electric power transmission and distribution, volt-ampere reactive (VAr) is a unit of
+ * measurement of reactive power. Reactive power exists in AC circuit when the current and voltage are
+ * not in phase.
+ */
+#define VSCP_TYPE_MEASUREMENT_REACTIVE_POWER          64
+
+/**
+ * Default unit: kVArh
+ * Reactive energy is the electrical energy produced, flowing or supplied by an electric circuit
+ * during a time interval, measured in units of kVArh or standard multiples thereof.
+ */
+#define VSCP_TYPE_MEASUREMENT_REACTIVE_ENERGY         65
+
 /*******************************************************************************
     MACROS
 *******************************************************************************/

src/framework/events/vscp_evt_alarm.c

@@ -447,3 +447,33 @@ extern BOOL vscp_evt_alarm_sendWatchdog(uint8_t index, uint8_t zone, uint8_t sub
     return vscp_core_sendEvent(&txMsg);
 }
 
+/**
+ * Alarm reset
+ * 
+ * @param[in] alarmRegister Alarm byte from standard register 128/0x80.
+ * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-255). 255 is all sub-zones.
+ * 
+ * @return If event is sent, it will return TRUE otherwise FALSE.
+ */
+extern BOOL vscp_evt_alarm_sendAlarmReset(uint8_t alarmRegister, uint8_t zone, uint8_t subZone)
+{
+    vscp_TxMessage  txMsg;
+    uint8_t         size    = 0;
+
+    vscp_core_prepareTxMessage(&txMsg, VSCP_CLASS_L1_ALARM, VSCP_TYPE_ALARM_RESET, VSCP_PRIORITY_3_NORMAL);
+
+    txMsg.data[0] = alarmRegister;
+    size += 1;
+
+    txMsg.data[1] = zone;
+    size += 1;
+
+    txMsg.data[2] = subZone;
+    size += 1;
+
+    txMsg.dataNum = size;
+
+    return vscp_core_sendEvent(&txMsg);
+}
+

src/framework/events/vscp_evt_alarm.h

@@ -212,4 +212,15 @@ extern BOOL vscp_evt_alarm_sendDisarm(uint8_t onOff, uint8_t zone, uint8_t subZo
  */
 extern BOOL vscp_evt_alarm_sendWatchdog(uint8_t index, uint8_t zone, uint8_t subZone);
 
+/**
+ * Alarm reset
+ * 
+ * @param[in] alarmRegister Alarm byte from standard register 128/0x80.
+ * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-255). 255 is all sub-zones.
+ * 
+ * @return If event is sent, it will return TRUE otherwise FALSE.
+ */
+extern BOOL vscp_evt_alarm_sendAlarmReset(uint8_t alarmRegister, uint8_t zone, uint8_t subZone);
+
 #endif  /* __VSCP_EVT_ALARM_H__ */

src/framework/events/vscp_evt_aol.c

@@ -118,7 +118,7 @@ extern BOOL vscp_evt_aol_sendSystemUnpluggedFromPowerSource(uint8_t index, uint8
 }
 
 /**
- * System unplugged from power source
+ * System unplugged from network
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -148,7 +148,7 @@ extern BOOL vscp_evt_aol_sendSystemUnpluggedFromNetwork(uint8_t index, uint8_t z
 }
 
 /**
- * System unplugged from power source
+ * Chassis intrusion
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -178,7 +178,7 @@ extern BOOL vscp_evt_aol_sendChassisIntrusion(uint8_t index, uint8_t zone, uint8
 }
 
 /**
- * System unplugged from power source
+ * Processor removal
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -208,7 +208,7 @@ extern BOOL vscp_evt_aol_sendProcessorRemoval(uint8_t index, uint8_t zone, uint8
 }
 
 /**
- * System unplugged from power source
+ * System environmental errors
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -238,7 +238,7 @@ extern BOOL vscp_evt_aol_sendSystemEnvironmentalErrors(uint8_t index, uint8_t zo
 }
 
 /**
- * System unplugged from power source
+ * High temperature
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -268,7 +268,7 @@ extern BOOL vscp_evt_aol_sendHighTemperature(uint8_t index, uint8_t zone, uint8_
 }
 
 /**
- * System unplugged from power source
+ * Fan speed problem
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -298,7 +298,7 @@ extern BOOL vscp_evt_aol_sendFanSpeedProblem(uint8_t index, uint8_t zone, uint8_
 }
 
 /**
- * System unplugged from power source
+ * Voltage fluctuations
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -328,7 +328,7 @@ extern BOOL vscp_evt_aol_sendVoltageFluctuations(uint8_t index, uint8_t zone, ui
 }
 
 /**
- * System unplugged from power source
+ * Operating system errors
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -358,7 +358,7 @@ extern BOOL vscp_evt_aol_sendOperatingSystemErrors(uint8_t index, uint8_t zone,
 }
 
 /**
- * System unplugged from power source
+ * System power-on error
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -388,7 +388,7 @@ extern BOOL vscp_evt_aol_sendSystemPowerOnError(uint8_t index, uint8_t zone, uin
 }
 
 /**
- * System unplugged from power source
+ * System is hung
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -418,7 +418,7 @@ extern BOOL vscp_evt_aol_sendSystemIsHung(uint8_t index, uint8_t zone, uint8_t s
 }
 
 /**
- * System unplugged from power source
+ * Component failure
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -448,7 +448,7 @@ extern BOOL vscp_evt_aol_sendComponentFailure(uint8_t index, uint8_t zone, uint8
 }
 
 /**
- * System unplugged from power source
+ * Remote system reboot upon report of a critical failure
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -478,7 +478,7 @@ extern BOOL vscp_evt_aol_sendRemoteSystemRebootUponReportOfACriticalFailure(uint
 }
 
 /**
- * System unplugged from power source
+ * Repair Operating System
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -508,7 +508,7 @@ extern BOOL vscp_evt_aol_sendRepairOperatingSystem(uint8_t index, uint8_t zone,
 }
 
 /**
- * System unplugged from power source
+ * Update BIOS image
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.
@@ -538,7 +538,7 @@ extern BOOL vscp_evt_aol_sendUpdateBiosImage(uint8_t index, uint8_t zone, uint8_
 }
 
 /**
- * System unplugged from power source
+ * Update Perform other diagnostic procedures
  * 
  * @param[in] index Index for record.
  * @param[in] zone Zone for which event applies to (0-255). 255 is all zones.