Fixed wrong datamodel on Occupancy Sensing Cluster (#24363)

* Updated Occupancy Cluster XML according to spec * Zap generated files * Updated code to comply with changes Updated occupancy-sensor-server code to comply with changes Updated examples/lighting-app/infineon/cyw30739/src/ButtonHandler.cpp
project-chip · Jul 14, 2023 · 5580513 · 5580513
1 parent 008ff46
commit 5580513
Show file tree

Hide file tree

Showing 32 changed files with 685 additions and 157 deletions.
diff --git a/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter b/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter
@@ -3383,9 +3383,26 @@ server cluster RelativeHumidityMeasurement = 1029 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
@@ -2721,9 +2721,26 @@ server cluster RelativeHumidityMeasurement = 1029 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/chef/devices/noip_rootnode_dimmablelight_bCwGYSDpoe.matter b/examples/chef/devices/noip_rootnode_dimmablelight_bCwGYSDpoe.matter
@@ -1378,9 +1378,26 @@ server cluster FixedLabel = 64 {
 }
 
 client cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/chef/devices/rootnode_dimmablelight_bCwGYSDpoe.matter b/examples/chef/devices/rootnode_dimmablelight_bCwGYSDpoe.matter
@@ -1244,9 +1244,26 @@ server cluster FixedLabel = 64 {
 }
 
 client cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/chef/devices/rootnode_occupancysensor_iHyVgifZuo.matter b/examples/chef/devices/rootnode_occupancysensor_iHyVgifZuo.matter
@@ -1111,9 +1111,26 @@ server cluster FixedLabel = 64 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/chef/devices/rootnode_thermostat_bm3fb8dhYi.matter b/examples/chef/devices/rootnode_thermostat_bm3fb8dhYi.matter
@@ -1278,6 +1278,23 @@ client cluster RelativeHumidityMeasurement = 1029 {
 }
 
 client cluster OccupancySensing = 1030 {
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/contact-sensor-app/contact-sensor-common/contact-sensor-app.matter b/examples/contact-sensor-app/contact-sensor-common/contact-sensor-app.matter
@@ -1345,9 +1345,26 @@ server cluster BooleanState = 69 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/lighting-app/infineon/cyw30739/src/ButtonHandler.cpp b/examples/lighting-app/infineon/cyw30739/src/ButtonHandler.cpp
@@ -75,7 +75,7 @@ wiced_result_t app_button_init(void)
 void app_button_event_handler(const button_manager_button_t * button_mgr, button_manager_event_t event,
  button_manager_button_state_t state)
 {
- uint8_t attributeValue;
+ chip::BitMask<OccupancySensing::OccupancyBitmap> attributeValue;
  if (button_mgr[0].configuration->button == PLATFORM_BUTTON_1 && event == BUTTON_CLICK_EVENT && state == BUTTON_STATE_RELEASED)
  {
  if (LightMgr().IsLightOn())
@@ -93,7 +93,9 @@ void app_button_event_handler(const button_manager_button_t * button_mgr, button
  {
  // update the current occupancy here for hardcoded endpoint 1
  OccupancySensing::Attributes::Occupancy::Get(1, &attributeValue);
- printf("Button Holding Toggle: %d -> %d\n", attributeValue, !attributeValue);
- OccupancySensing::Attributes::Occupancy::Set(1, !attributeValue);
+ uint8_t bitValue = attributeValue.Raw();
+ printf("Button Holding Toggle: %d -> %d\n", bitValue, !bitValue);
+ attributeValue.SetRaw(!bitValue);
+ OccupancySensing::Attributes::Occupancy::Set(1, attributeValue);
  }
 }
diff --git a/examples/lighting-app/lighting-common/lighting-app.matter b/examples/lighting-app/lighting-common/lighting-app.matter
@@ -1815,9 +1815,26 @@ server cluster ColorControl = 768 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/examples/placeholder/linux/apps/app1/config.matter b/examples/placeholder/linux/apps/app1/config.matter
@@ -2352,9 +2352,26 @@ server cluster RelativeHumidityMeasurement = 1029 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  attribute access(write: manage) int16u PIROccupiedToUnoccupiedDelay = 16;
  attribute access(write: manage) int16u PIRUnoccupiedToOccupiedDelay = 17;
  attribute access(write: manage) int8u PIRUnoccupiedToOccupiedThreshold = 18;

diff --git a/examples/placeholder/linux/apps/app2/config.matter b/examples/placeholder/linux/apps/app2/config.matter
@@ -2321,9 +2321,26 @@ server cluster RelativeHumidityMeasurement = 1029 {
 }
 
 server cluster OccupancySensing = 1030 {
- readonly attribute bitmap8 occupancy = 0;
- readonly attribute enum8 occupancySensorType = 1;
- readonly attribute bitmap8 occupancySensorTypeBitmap = 2;
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
+ readonly attribute OccupancyBitmap occupancy = 0;
+ readonly attribute OccupancySensorTypeEnum occupancySensorType = 1;
+ readonly attribute OccupancySensorTypeBitmap occupancySensorTypeBitmap = 2;
  attribute access(write: manage) int16u PIROccupiedToUnoccupiedDelay = 16;
  attribute access(write: manage) int16u PIRUnoccupiedToOccupiedDelay = 17;
  attribute access(write: manage) int8u PIRUnoccupiedToOccupiedThreshold = 18;

diff --git a/examples/pump-app/pump-common/pump-app.matter b/examples/pump-app/pump-common/pump-app.matter
@@ -1280,6 +1280,23 @@ server cluster FlowMeasurement = 1028 {
 }
 
 client cluster OccupancySensing = 1030 {
+ enum OccupancySensorTypeEnum : ENUM8 {
+ kPir = 0;
+ kUltrasonic = 1;
+ kPIRAndUltrasonic = 2;
+ kPhysicalContact = 3;
+ }
+
+ bitmap OccupancyBitmap : BITMAP8 {
+ kOccupied = 0x1;
+ }
+
+ bitmap OccupancySensorTypeBitmap : BITMAP8 {
+ kPir = 0x1;
+ kUltrasonic = 0x2;
+ kPhysicalContact = 0x4;
+ }
+
  readonly attribute command_id generatedCommandList[] = 65528;
  readonly attribute command_id acceptedCommandList[] = 65529;
  readonly attribute event_id eventList[] = 65530;

diff --git a/src/app/clusters/occupancy-sensor-server/occupancy-sensor-server.cpp b/src/app/clusters/occupancy-sensor-server/occupancy-sensor-server.cpp
@@ -33,25 +33,29 @@ using namespace chip::app::Clusters::OccupancySensing;
 void emberAfOccupancySensingClusterServerInitCallback(EndpointId endpoint)
 {
  auto deviceType = halOccupancyGetSensorType(endpoint);
- Attributes::OccupancySensorType::Set(endpoint, deviceType);
 
- uint8_t deviceTypeBitmap = 0;
+ chip::BitMask<OccupancySensorTypeBitmap> deviceTypeBitmap = 0;
  switch (deviceType)
  {
  case HAL_OCCUPANCY_SENSOR_TYPE_PIR:
- deviceTypeBitmap = EMBER_AF_OCCUPANCY_SENSOR_TYPE_BITMAP_PIR;
+ deviceTypeBitmap.Set(OccupancySensorTypeBitmap::kPir);
+ Attributes::OccupancySensorType::Set(endpoint, OccupancySensorTypeEnum::kPir);
  break;
 
  case HAL_OCCUPANCY_SENSOR_TYPE_ULTRASONIC:
- deviceTypeBitmap = EMBER_AF_OCCUPANCY_SENSOR_TYPE_BITMAP_ULTRASONIC;
+ deviceTypeBitmap.Set(OccupancySensorTypeBitmap::kUltrasonic);
+ Attributes::OccupancySensorType::Set(endpoint, OccupancySensorTypeEnum::kUltrasonic);
  break;
 
  case HAL_OCCUPANCY_SENSOR_TYPE_PIR_AND_ULTRASONIC:
- deviceTypeBitmap = (EMBER_AF_OCCUPANCY_SENSOR_TYPE_BITMAP_PIR | EMBER_AF_OCCUPANCY_SENSOR_TYPE_BITMAP_ULTRASONIC);
+ deviceTypeBitmap.Set(OccupancySensorTypeBitmap::kPir);
+ deviceTypeBitmap.Set(OccupancySensorTypeBitmap::kUltrasonic);
+ Attributes::OccupancySensorType::Set(endpoint, OccupancySensorTypeEnum::kPIRAndUltrasonic);
  break;
 
  case HAL_OCCUPANCY_SENSOR_TYPE_PHYSICAL:
- deviceTypeBitmap = EMBER_AF_OCCUPANCY_SENSOR_TYPE_BITMAP_PHYSICAL_CONTACT;
+ deviceTypeBitmap.Set(OccupancySensorTypeBitmap::kPhysicalContact);
+ Attributes::OccupancySensorType::Set(endpoint, OccupancySensorTypeEnum::kPhysicalContact);
  break;
 
  default:
@@ -67,8 +71,10 @@ void emberAfOccupancySensingClusterServerInitCallback(EndpointId endpoint)
 //******************************************************************************
 void halOccupancyStateChangedCallback(EndpointId endpoint, HalOccupancyState occupancyState)
 {
- if (occupancyState == HAL_OCCUPANCY_STATE_OCCUPIED)
+ chip::BitMask<OccupancyBitmap> mappedOccupancyState;
+ if (occupancyState & HAL_OCCUPANCY_STATE_OCCUPIED)
  {
+ mappedOccupancyState.Set(OccupancyBitmap::kOccupied);
  emberAfOccupancySensingClusterPrintln("Occupancy detected");
  }
  else