Skip to content

Ensure all zapxml clusters are generated by alchemy. Record errors for the ones that have differences and resolve. #37391

@andy31415

Description

@andy31415

https://github.com/project-chip/connectedhomeip/tree/master/src/app/zap-templates/zcl/data-model/chip contains our zapxml data model.

Historically we have found that manual editing based on spec easily contains errors and we are encouraging people to use Alchemy - https://github.com/project-chip/alchemy - to generate them.

Only a subset is currently generated like that (grep XML generated by Alchemy; DO NOT EDIT.):

- src/app/zap-templates/zcl/data-model/chip/camera-av-settings-user-level-management-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/camera-av-stream-management-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/chime-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/device-energy-management-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/device-energy-management-mode-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/energy-evse-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/energy-evse-mode-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/push-av-stream-transport-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/tls-certificate-management-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/water-heater-management-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/water-heater-mode-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/webrtc-provider-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/webrtc-requestor-cluster.xml
- src/app/zap-templates/zcl/data-model/chip/zone-management-cluster.xml

All others should be converted to use alchemy. In case alchemy shows differences, we should determine how to resolve as they represent mismatch between specification and SDK (or alchemy bugs are also possible, as well as unparsable SDK differences).

We need:

  • convert every cluster
  • when conversion does not work, create an issue to resolve (and we will follow up on it)

Sub-issues

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

In Progress - DEPENDENCIES

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions