control: json: Correct hysteresis definitions
The action target_from_group_max has been implementing the reversed
definitions of positive hysteresis and negative hysteresis. The positive
hysteresis should be for the value increasing case and vice versa. This
commit corrects that in source code and events.md.
Signed-off-by: Chau Ly <chaul@amperecomputing.com>
Change-Id: I1b84884d16d5f20d0fdcd9033188ffd31e91f907
diff --git a/control/json/actions/target_from_group_max.cpp b/control/json/actions/target_from_group_max.cpp
index 341c67d..45216bb 100644
--- a/control/json/actions/target_from_group_max.cpp
+++ b/control/json/actions/target_from_group_max.cpp
@@ -54,12 +54,12 @@
if (groupValue != _prevGroupValue)
{
// Value is decreasing and the change is greater than the
- // positive hysteresis; or value is increasing and the change
+ // negative hysteresis; or value is increasing and the change
// is greater than the positive hysteresis
if (((groupValue < _prevGroupValue) &&
- (_prevGroupValue - groupValue > _posHysteresis)) ||
+ (_prevGroupValue - groupValue > _negHysteresis)) ||
((groupValue > _prevGroupValue) &&
- (groupValue - _prevGroupValue > _negHysteresis)))
+ (groupValue - _prevGroupValue > _posHysteresis)))
{
/*The speed derived from mapping*/
uint64_t groupSpeed = _speedFromGroupsMap[_groupIndex];
diff --git a/docs/control/events.md b/docs/control/events.md
index fa3becc..9c15014 100644
--- a/docs/control/events.md
+++ b/docs/control/events.md
@@ -653,8 +653,8 @@
The above JSON will cause the action to read the property specified in the group
"zone0_ambient" from all members of the group. The change in the group's members
value will be checked against "neg_hysteresis" and "pos_hysteresis" to decide if
-it is worth taking action. "neg_hysteresis" is for the increasing case and
-"pos_hysteresis" is for the decreasing case. The maximum property value in the
+it is worth taking action. "pos_hysteresis" is for the increasing case and
+"neg_hysteresis" is for the decreasing case. The maximum property value in the
group will be mapped to the "map" to get the output "target". Each configured
event using this action will be provided with a key in a static map to store its
mapping result. The static map will be shared across the events of this action.