Updated to vscp-framework v2.2.0

Author: BlueAndi

CHANGELOG.md

@@ -1,17 +1,21 @@
+## 2.2.0
+
+- Update to VSCP framework v2.2.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v2.2.0) there.
+
 ## 2.1.0
 
 - Update to VSCP framework v2.1.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v2.1.0) there.
 
 ## 2.0.4
 
 - Fixed problem with backslashes in include paths.
-- Fixed problem with wrong include path in vscp_evt_information.c module. Thanks to michpro!
+- Fixed problem with wrong include path in `vscp_evt_information.c` module. Thanks to michpro!
 - Examples updated to be working with latest CAN libraries.
 
 ## 2.0.3
 
 - Update to VSCP framework v2.0.3, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v2.0.3) there.
-- Deprecated "dataNum" replaced with "dataSize". Thanks to michpro!
+- Deprecated `dataNum` replaced with `dataSize`. Thanks to michpro!
 
 ## 2.0.2
 
@@ -42,7 +46,7 @@
 - Update to VSCP framework v0.9.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v0.9.0) there.
 - The update includes the following bugfixes:
   - Bugfix: Fix of misspellings/typos, thanks to TomasRoj.
-  - Bugfix: VSCP measurement events fixed, because internal the parameters unit and index in the vscp_data_coding_getFormatByte() call were reversed. Thanks to troky!
+  - Bugfix: VSCP measurement events fixed, because internally the parameters `unit` and `index` in the `vscp_data_coding_getFormatByte()` call were reversed. Thanks to troky!
 
 ## 0.7.1
 
@@ -53,11 +57,11 @@
 
 - Update to VSCP framework v0.8.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v0.8.0) there.
 - Folder structure changed inside framework folder, in preparation for the abstract event modules.
-- Abstract event modules introduced, see framework/events.
+- Abstract event modules introduced, see `framework/events`.
 
 ## 0.6.1
 
-- Folder structure changed, please see https://www.arduino.cc/en/Guide/Libraries#toc4 for easier installation.
+- Folder structure changed, please see [Arduino Library Guide](https://www.arduino.cc/en/Guide/Libraries#toc4) for easier installation.
 
 ## 0.6.0
 
@@ -76,14 +80,14 @@
 
 ## 0.3.0
 
-- DigInDebounce class for digital input debouncing implemented.
+- `DigInDebounce` class for digital input debouncing implemented.
 - Update to VSCP framework v0.4.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v0.4.0) there.
 - Status lamp and init button connection fixed.
 
 ## 0.2.0
 
-Updated to VSCP framework v0.3.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v0.3.0) there.
+- Updated to VSCP framework v0.3.0, please see the [changelog](https://github.com/BlueAndi/vscp-framework/releases/tag/v0.3.0) there.
 
 ## 0.1.0
 
-Base is the VSCP framework v0.2.2
+- Base is the VSCP framework v0.2.2

library.json

@@ -1,6 +1,6 @@
 {
     "name": "vscp-arduino",
-    "version": "2.1.0",
+    "version": "2.2.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=2.1.0
+version=2.2.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.h

@@ -102,7 +102,7 @@ extern "C"
 #define VSCP_CORE_VERSION_STR       "v1.15.9"
 
 /** VSCP framework version string */
-#define VSCP_CORE_FRAMEWORK_VERSION "v2.1.0"
+#define VSCP_CORE_FRAMEWORK_VERSION "v2.2.0"
 
 /*******************************************************************************
     MACROS

src/framework/core/vscp_type_control.h

@@ -155,22 +155,23 @@ extern "C"
 #define VSCP_TYPE_CONTROL_DEACTIVATE             16
 
 /**
- * Reserved.
+ * Turn off all devices identified by zone/subzone/index.
  */
-#define VSCP_TYPE_CONTROL_RESERVED17             17
+#define VSCP_TYPE_CONTROL_TURN_ALL_OFF           17
 
 /**
- * Reserved.
+ * Turn on all devices identified by zone/subzone/index.
  */
-#define VSCP_TYPE_CONTROL_RESERVED18             18
+#define VSCP_TYPE_CONTROL_TURN_ALL_ON            18
 
 /**
- * Reserved.
+ * Turn on/off all devices identified by zone/subzone/index.
  */
-#define VSCP_TYPE_CONTROL_RESERVED19             19
+#define VSCP_TYPE_CONTROL_TURN_ALL_X             19
 
 /**
  * Dim all dimmer devices on a segment to a specified dim value.
+ * This is mainly constructed for dimming of lamps but is general for all dimmable devices.
  */
 #define VSCP_TYPE_CONTROL_DIM_LAMPS              20
 

src/framework/events/vscp_evt_alarm.c

@@ -91,8 +91,8 @@ extern BOOL vscp_evt_alarm_sendGeneralEvent(void)
  * Warning
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -122,8 +122,8 @@ extern BOOL vscp_evt_alarm_sendWarning(uint8_t onOff, uint8_t zone, uint8_t subZ
  * 
  * @param[in] alarmRegister Alarm byte from standard register 128/0x80 or a code of choice describing
  * the alarm.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -152,8 +152,8 @@ extern BOOL vscp_evt_alarm_sendAlarmOccurred(uint8_t alarmRegister, uint8_t zone
  * Alarm sound on/off
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -182,8 +182,8 @@ extern BOOL vscp_evt_alarm_sendAlarmSoundOnOff(uint8_t onOff, uint8_t zone, uint
  * Alarm light on/off
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -212,8 +212,8 @@ extern BOOL vscp_evt_alarm_sendAlarmLightOnOff(uint8_t onOff, uint8_t zone, uint
  * Power on/off
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -242,8 +242,8 @@ extern BOOL vscp_evt_alarm_sendPowerOnOff(uint8_t onOff, uint8_t zone, uint8_t s
  * Emergency Stop
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -272,8 +272,8 @@ extern BOOL vscp_evt_alarm_sendEmergencyStop(uint8_t onOff, uint8_t zone, uint8_
  * Emergency Pause
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -302,8 +302,8 @@ extern BOOL vscp_evt_alarm_sendEmergencyPause(uint8_t onOff, uint8_t zone, uint8
  * Emergency Reset
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -332,8 +332,8 @@ extern BOOL vscp_evt_alarm_sendEmergencyReset(uint8_t onOff, uint8_t zone, uint8
  * Emergency Resume
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -362,8 +362,8 @@ extern BOOL vscp_evt_alarm_sendEmergencyResume(uint8_t onOff, uint8_t zone, uint
  * Arm
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -392,8 +392,8 @@ extern BOOL vscp_evt_alarm_sendArm(uint8_t onOff, uint8_t zone, uint8_t subZone)
  * Disarm
  * 
  * @param[in] onOff Alarm is on/off.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -422,8 +422,8 @@ extern BOOL vscp_evt_alarm_sendDisarm(uint8_t onOff, uint8_t zone, uint8_t subZo
  * Watchdog
  * 
  * @param[in] index index.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */
@@ -453,8 +453,8 @@ extern BOOL vscp_evt_alarm_sendWatchdog(uint8_t index, uint8_t zone, uint8_t sub
  * 
  * @param[in] alarmRegister Alarm byte from standard register 128/0x80 or a code of choice describing
  * the alarm.
- * @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.
+ * @param[in] zone Zone for which event applies to (0-254). 255 is all zones.
+ * @param[in] subZone Sub-zone for which event applies to (0-254). 255 is all sub-zones.
  * 
  * @return If event is sent, it will return TRUE otherwise FALSE.
  */