Bugfix/lighting-output-internal-process-api (#1086)

* Fixed Lighting_Command to ignore write priority and use its own. 

* Fixed BACnetLightingOperation reserved range.

* Refactor overridden into the lighting command module. Added Overridden status flags API.  Added Lighting Output API to implement a momentary override to the output that is cleared at the next lighting command.  Integrated lighting command overridden behavior into the lighting output object.

* Added Trim_Fade_Time, High_End_Trim, Low_End_Trim, Last_On_Value and Default_On_Value properties to lighting output.
Added TRIM_ACTIVE flag to lighting command. Added Last_On_Value and Default_On_Value to lighting command for restore and toggle.
This commit is contained in:
Steve Karg
2025-09-04 15:04:42 -05:00
committed by GitHub
parent 8a9c808b76
commit 71c03b29e8
10 changed files with 1854 additions and 514 deletions
+204 -12
View File
@@ -1,11 +1,7 @@
/* @file
* @brief test BACnet integer encode/decode APIs
* @brief test BACnet Lighting Command encode/decode APIs
* @date June 2022
* @brief tests sRGB to and from from CIE xy and brightness API
*
* @section LICENSE
* Copyright (c) 2022 Steve Karg <skarg@users.sourceforge.net>
*
* @author Steve Karg <skarg@users.sourceforge.net>
* @copyright SPDX-License-Identifier: MIT
*/
#include <stdint.h>
@@ -20,6 +16,7 @@
*/
static float Tracking_Value;
static uint16_t Tracking_Elapsed_Milliseconds;
/**
* @brief Callback for tracking value updates
@@ -33,6 +30,25 @@ static void dimmer_tracking_value(uint32_t key, float old_value, float value)
Tracking_Value = value;
}
/**
* @brief Callback for non-standard Lighting_Operation timer values
* @param data - Lighting Command data structure
* @param milliseconds - elapsed time in milliseconds
*/
static void dimmer_timer_task(
struct bacnet_lighting_command_data *data, uint16_t milliseconds)
{
Tracking_Elapsed_Milliseconds = milliseconds;
switch (data->Lighting_Operation) {
case BACNET_LIGHTS_PROPRIETARY_MIN:
break;
case BACNET_LIGHTS_PROPRIETARY_MAX:
break;
default:
break;
}
}
/**
* @brief compare two floating point values to 3 decimal places
*
@@ -127,20 +143,56 @@ static void test_lighting_command_command_unit(void)
#endif
{
BACNET_LIGHTING_COMMAND_DATA data = { 0 };
struct lighting_command_notification observer1 = { 0 };
struct lighting_command_notification observer2 = { 0 };
struct lighting_command_timer_notification timer_observer1 = { 0 };
struct lighting_command_timer_notification timer_observer2 = { 0 };
uint16_t milliseconds = 10;
uint32_t fade_time = 1000;
float target_level = 100.0f;
float target_step = 1.0f;
float ramp_rate = 1000.0f;
float override_level;
lighting_command_init(&data);
data.Notification_Head.callback = dimmer_tracking_value;
/* lighting command subscribe */
observer1.callback = dimmer_tracking_value;
lighting_command_notification_add(&data, &observer1);
/* add again to verify skipping */
lighting_command_notification_add(&data, &observer1);
/* add second tracker */
lighting_command_notification_add(&data, &observer2);
/* lighting command timer subscribe */
timer_observer1.callback = dimmer_timer_task;
lighting_command_timer_notfication_add(&data, &timer_observer1);
/* add again to verify skipping */
lighting_command_timer_notfication_add(&data, &timer_observer1);
/* add second tracker */
lighting_command_timer_notfication_add(&data, &timer_observer2);
/* basic STOP and NONE states */
lighting_command_stop(&data);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
lighting_command_none(&data);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
/* normalized range clamp testing */
data.Max_Actual_Value = 95.0f;
data.Min_Actual_Value = 5.0f;
target_level = lighting_command_normalized_range_clamp(&data, 0.1f);
zassert_true(is_float_equal(target_level, 0.0f), NULL);
target_level = lighting_command_normalized_range_clamp(&data, 100.0f);
zassert_true(is_float_equal(target_level, data.Max_Actual_Value), NULL);
target_level = lighting_command_normalized_range_clamp(&data, 1.0f);
zassert_true(is_float_equal(target_level, data.Min_Actual_Value), NULL);
data.Max_Actual_Value = 100.0f;
data.Min_Actual_Value = 1.0f;
/* fade up */
target_level = 100.0f;
lighting_command_fade_to(&data, 100.0f, fade_time);
milliseconds = fade_time / 2;
lighting_command_timer(&data, milliseconds);
@@ -169,7 +221,7 @@ static void test_lighting_command_command_unit(void)
milliseconds = 10;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_TRIM_ACTIVE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.Low_Trim_Value), NULL);
target_level = 0.0f;
milliseconds = 10;
@@ -184,9 +236,52 @@ static void test_lighting_command_command_unit(void)
milliseconds = 10;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_TRIM_ACTIVE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.High_Trim_Value), NULL);
data.High_Trim_Value = data.Max_Actual_Value;
/* override */
override_level = 42.0f;
target_level = 100.0f;
milliseconds = 10;
data.Overridden = true;
data.Overridden_Momentary = false;
lighting_command_override(&data, override_level);
lighting_command_timer(&data, milliseconds);
zassert_true(is_float_equal(Tracking_Value, override_level), NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(is_float_equal(Tracking_Value, override_level), NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
data.Overridden = false;
lighting_command_override(&data, target_level);
lighting_command_timer(&data, milliseconds);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
/* momentary override - self clearing flags */
override_level = 42.0f;
target_level = 100.0f;
milliseconds = 10;
data.Overridden = true;
data.Overridden_Momentary = true;
lighting_command_override(&data, override_level);
lighting_command_timer(&data, milliseconds);
zassert_true(is_float_equal(Tracking_Value, override_level), NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_false(data.Overridden, NULL);
zassert_true(data.Overridden_Momentary, NULL);
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_false(data.Overridden, NULL);
zassert_false(data.Overridden_Momentary, NULL);
/* step clamping */
target_step = lighting_command_step_increment_clamp(0.0f);
zassert_true(is_float_equal(target_step, 0.1f), NULL);
target_step = lighting_command_step_increment_clamp(100.1f);
zassert_true(is_float_equal(target_step, 100.0f), NULL);
/* step UP - inhibit ON */
target_step = 1.0f;
@@ -303,7 +398,8 @@ static void test_lighting_command_command_unit(void)
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
target_level = 100.0f;
lighting_command_ramp_to(&data, target_level, 100.0f);
ramp_rate = 100.0f;
lighting_command_ramp_to(&data, target_level, ramp_rate);
lighting_command_timer(&data, milliseconds);
zassert_true(
data.In_Progress == BACNET_LIGHTING_RAMP_ACTIVE, "In_Progress=%d",
@@ -316,8 +412,9 @@ static void test_lighting_command_command_unit(void)
/* slower ramp up */
target_level = 100.0f;
milliseconds = 100;
ramp_rate = 1.0f;
do {
lighting_command_ramp_to(&data, target_level, 1.0f);
lighting_command_ramp_to(&data, target_level, ramp_rate);
lighting_command_timer(&data, milliseconds);
if (data.Lighting_Operation == BACNET_LIGHTS_RAMP_TO) {
zassert_true(
@@ -335,8 +432,28 @@ static void test_lighting_command_command_unit(void)
/* slower ramp down */
target_level = data.Min_Actual_Value;
milliseconds = 33;
ramp_rate = 0.1f;
do {
lighting_command_ramp_to(&data, target_level, 0.1f);
lighting_command_ramp_to(&data, target_level, ramp_rate);
lighting_command_timer(&data, milliseconds);
if (data.Lighting_Operation == BACNET_LIGHTS_RAMP_TO) {
zassert_true(
data.In_Progress == BACNET_LIGHTING_RAMP_ACTIVE,
"In_Progress=%d", data.In_Progress);
zassert_true(
isgreater(data.Tracking_Value, data.Min_Actual_Value),
"Tracking_Value=%f", Tracking_Value);
zassert_true(
isless(data.Tracking_Value, data.Max_Actual_Value),
"Tracking_Value=%f", Tracking_Value);
}
} while (data.Lighting_Operation != BACNET_LIGHTS_STOP);
/* large elapsed timer - ramp up */
target_level = data.Max_Actual_Value;
milliseconds = 2000;
ramp_rate = 0.1f;
do {
lighting_command_ramp_to(&data, target_level, ramp_rate);
lighting_command_timer(&data, milliseconds);
if (data.Lighting_Operation == BACNET_LIGHTS_RAMP_TO) {
zassert_true(
@@ -351,13 +468,88 @@ static void test_lighting_command_command_unit(void)
}
} while (data.Lighting_Operation != BACNET_LIGHTS_STOP);
/* out-of-service */
target_level = 100.0f;
milliseconds = 10;
data.Out_Of_Service = false;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
data.Out_Of_Service = true;
lighting_command_fade_to(&data, 0.0f, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
/* previous target level - unchanged */
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
target_level = 0.0f;
data.Out_Of_Service = false;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
/* restore-on, toggle-restore */
target_level = 0.0f;
milliseconds = 10;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
lighting_command_restore_on(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.Last_On_Value), NULL);
lighting_command_toggle_restore(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, 0.0f), NULL);
lighting_command_toggle_restore(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.Last_On_Value), NULL);
/* default-on, toggle-default */
target_level = 0.0f;
milliseconds = 10;
lighting_command_fade_to(&data, target_level, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, target_level), NULL);
lighting_command_default_on(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.Default_On_Value), NULL);
lighting_command_toggle_default(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, 0.0f), NULL);
lighting_command_toggle_default(&data, 0);
lighting_command_timer(&data, milliseconds);
zassert_true(data.In_Progress == BACNET_LIGHTING_IDLE, NULL);
zassert_true(is_float_equal(Tracking_Value, data.Default_On_Value), NULL);
/* non-standard lighting operation */
milliseconds = 10;
data.Lighting_Operation = BACNET_LIGHTS_PROPRIETARY_MIN;
lighting_command_timer(&data, milliseconds);
zassert_equal(data.Lighting_Operation, BACNET_LIGHTS_PROPRIETARY_MIN, NULL);
data.Lighting_Operation = BACNET_LIGHTS_PROPRIETARY_MAX;
lighting_command_timer(&data, milliseconds);
zassert_equal(data.Lighting_Operation, BACNET_LIGHTS_PROPRIETARY_MAX, NULL);
/* null check code coverage */
lighting_command_override(NULL, override_level);
lighting_command_fade_to(NULL, 0.0f, 0);
lighting_command_ramp_to(NULL, 0.0f, 0.0f);
lighting_command_step(NULL, BACNET_LIGHTS_STEP_OFF, 0.0f);
lighting_command_blink_warn(NULL, BACNET_LIGHTS_WARN, NULL);
lighting_command_stop(NULL);
lighting_command_none(NULL);
lighting_command_restore_on(NULL, 0);
lighting_command_default_on(NULL, 0);
lighting_command_toggle_restore(NULL, 0);
lighting_command_toggle_default(NULL, 0);
lighting_command_timer(NULL, 0);
lighting_command_init(NULL);
}