Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PushAvStreamTransport cluster #36877

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

PushAvStreamTransport cluster #36877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f5d710
Generated using ./alchemy zap --attribute="in-progress" ... /PushAVSt…
gmarcosb Dec 18, 2024
2d54b4b
Generated with ./scripts/tools/zap_regen_all.py
gmarcosb Dec 18, 2024
9e60322
Merge branch 'master' into camera-push
gmarcosb Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ jobs:
src/app/zap-templates/zcl/data-model/chip/global-bitmaps.xml \
src/app/zap-templates/zcl/data-model/chip/global-enums.xml \
src/app/zap-templates/zcl/data-model/chip/global-structs.xml \
src/app/zap-templates/zcl/data-model/chip/push-av-stream-transport-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/semantic-tag-namespace-enums.xml \
src/app/zap-templates/zcl/data-model/chip/access-control-definitions.xml \
src/app/zap-templates/zcl/data-model/chip/access-control-cluster.xml \
Expand Down
1 change: 1 addition & 0 deletions docs/ids_and_codes/zap_clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ Generally regenerate using one of:
| 1361 | 0x551 | CameraAvStreamManagement |
| 1363 | 0x553 | WebRTCTransportProvider |
| 1364 | 0x554 | WebRTCTransportRequestor |
| 1365 | 0x555 | PushAvStreamTransport |
| 1366 | 0x556 | Chime |
| 1872 | 0x750 | EcosystemInformation |
| 1873 | 0x751 | CommissionerControl |
Expand Down
1 change: 1 addition & 0 deletions scripts/rules.matterlint
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ load "../src/app/zap-templates/zcl/data-model/chip/media-playback-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/messages-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/mode-base-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/mode-select-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/push-av-stream-transport-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/semantic-tag-namespace-enums.xml";
load "../src/app/zap-templates/zcl/data-model/chip/network-commissioning-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/occupancy-sensing-cluster.xml";
Expand Down
229 changes: 229 additions & 0 deletions src/app/zap-templates/zcl/data-model/chip/push-av-stream-transport-cluster.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
<?xml version="1.0"?>
<!--
Copyright (c) 2024 Project CHIP Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!--
XML generated by Alchemy; DO NOT EDIT.
Source: src/app_clusters/PushAVStreamTransport.adoc
Parameters: in-progress
Git: 1.4-455-gf44904673
-->
<configurator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../zcl.xsd">
<domain name="Cameras"/>
<bitmap name="SupportedContainerFormatsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAF" mask="0x01"/>
</bitmap>

<bitmap name="SupportedIngestMethodsBitmap" type="bitmap8">
<cluster code="0x0555"/>
<field name="CMAFIngest" mask="0x01"/>
</bitmap>

<enum name="ContainerFormatEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAF" value="0x00"/>
</enum>

<enum name="IngestMethodsEnum" type="enum8">
<cluster code="0x0555"/>
<item name="CMAFIngest" value="0x00"/>
</enum>

<enum name="StatusCodeEnum" type="enum8">
<cluster code="0x0555"/>
<item name="AllocationNotPermitted" value="0x02"/>
<item name="InvalidTLSEndpoint" value="0x03"/>
<item name="InvalidStream" value="0x04"/>
<item name="InvalidURL" value="0x05"/>
<item name="InvalidZone" value="0x06"/>
<item name="UnsupportedContainerFormat" value="0x07"/>
<item name="UnsupportedIngestMethod" value="0x08"/>
<item name="InvalidTriggerType" value="0x09"/>
<item name="InvalidTransportStatus" value="0x10"/>
</enum>

<enum name="StreamMultiplexingEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Interleaved" value="0x00"/>
</enum>

<enum name="TransportStatusEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Active" value="0x00"/>
<item name="Inactive" value="0x01"/>
</enum>

<enum name="TransportTriggerTypeEnum" type="enum8">
<cluster code="0x0555"/>
<item name="Command" value="0x00"/>
<item name="Motion" value="0x01"/>
<item name="Continuous" value="0x02"/>
</enum>

<enum name="TriggerActivationReasonEnum" type="enum8">
<cluster code="0x0555"/>
<item name="UserInitiated" value="0x00"/>
<item name="Automation" value="0x01"/>
<item name="Emergency" value="0x02"/>
</enum>

<struct name="CMAFContainerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ChunkDuration" type="int16u" default="4"/>
<item fieldId="1" name="CENCKey" type="octet_string" optional="true"/>
</struct>

<struct name="ContainerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ContainerType" type="ContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="CMAFContainerOptions" type="CMAFContainerOptionsStruct" optional="true"/>
</struct>

<struct name="MetadataOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="Multiplexing" type="StreamMultiplexingEnum" min="0x00" max="0x00"/>
<item fieldId="1" name="IncludeMotionZones" type="boolean"/>
<item fieldId="2" name="EnableMetadataPrivacySensitive" type="boolean"/>
</struct>

<struct name="TransportConfigurationStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="ConnectionID" type="int16u"/>
<item fieldId="1" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
<item fieldId="2" name="TransportOptions" type="TransportOptionsStruct"/>
</struct>

<struct name="TransportMotionTriggerTimeControlStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="InitialDuration" type="int16u" default="10" min="1"/>
<item fieldId="1" name="AugmentationDuration" type="int16u" default="5"/>
<item fieldId="2" name="MaxDuration" type="elapsed_s" default="30" min="1"/>
<item fieldId="3" name="BlindDuration" type="int16u" default="30"/>
</struct>

<struct name="TransportOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="StreamType" type="StreamTypeEnum" min="0x00" max="0x03"/>
<item fieldId="1" name="VideoStreamID" type="int16u" optional="true"/>
<item fieldId="2" name="AudioStreamID" type="int16u" optional="true"/>
<item fieldId="3" name="EndpointID" type="int16u"/>
<item fieldId="4" name="URL" type="long_char_string" length="256"/>
<item fieldId="5" name="TriggerOptions" type="TransportTriggerOptionsStruct"/>
<item fieldId="6" name="IngestMethod" type="IngestMethodsEnum" min="0x00" max="0x00"/>
<item fieldId="7" name="ContainerFormat" type="ContainerFormatEnum" min="0x00" max="0x00"/>
<item fieldId="8" name="ContainerOptions" type="ContainerOptionsStruct"/>
<item fieldId="9" name="MetadataOptions" type="MetadataOptionsStruct" optional="true"/>
<item fieldId="10" name="ExpiryTime" type="epoch_s" optional="true"/>
</struct>

<struct name="TransportTriggerOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="0" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<item fieldId="1" name="MotionZones" array="true" type="TransportZoneOptionsStruct" isNullable="true" optional="true"/>
<item fieldId="2" name="MotionSensitivity" type="int8u" isNullable="true" optional="true" default="5" min="1" max="10"/>
gmarcosb marked this conversation as resolved.
Show resolved Hide resolved
<item fieldId="3" name="MotionTimeControl" type="TransportMotionTriggerTimeControlStruct" optional="true"/>
<item fieldId="4" name="MaxPreRollLen" type="int16u" optional="true"/>
</struct>

<struct name="TransportZoneOptionsStruct" apiMaturity="provisional">
<cluster code="0x0555"/>
<item fieldId="1" name="Zone" type="int16u" isNullable="true"/>
<item fieldId="2" name="Sensitivity" type="int8u" optional="true" default="5" min="1" max="10"/>
</struct>

<cluster>
<domain name="Cameras"/>
<name>Push AV Stream Transport</name>
<code>0x0555</code>
<define>PUSH_AV_STREAM_TRANSPORT_CLUSTER</define>
<description/>
<client init="false" tick="false">true</client>
<features>
<feature bit="0" code="PERZONESENS" name="PerZoneSensitivity" summary="Supports a sensitivity value per Zone">
<optionalConform/>
</feature>
</features>
<server init="false" tick="false">true</server>
<globalAttribute code="0xFFFD" side="either" value="1"/>
<attribute code="0x0000" side="server" define="SUPPORTED_CONTAINER_FORMATS" type="SupportedContainerFormatsBitmap" min="0x00" max="0x01">SupportedContainerFormats</attribute>
<attribute code="0x0001" side="server" define="SUPPORTED_INGEST_METHODS" type="SupportedIngestMethodsBitmap" min="0x00" max="0x01">SupportedIngestMethods</attribute>
<attribute code="0x0002" side="server" define="CURRENT_CONNECTIONS" type="array" entryType="int16u">CurrentConnections</attribute>
<command code="0x00" source="client" name="AllocatePushTransport" optional="false" response="AllocatePushTransportResponse">
bzbarsky-apple marked this conversation as resolved.
Show resolved Hide resolved
<description>This command SHALL allocate a transport and return a PushTransportConnectionID.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="TransportOptions" type="TransportOptionsStruct"/>
</command>

<command code="0x01" source="server" name="AllocatePushTransportResponse" optional="false" disableDefaultResponse="true">
<description>This command SHALL be generated in response to an AllocatePushTransport command.</description>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportOptions" type="TransportOptionsStruct"/>
<arg id="2" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
</command>

<command code="0x02" source="client" name="DeallocatePushTransport" optional="false">
<description>This command SHALL be generated to request the Node deallocates the specified transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
</command>

<command code="0x03" source="client" name="ModifyPushTransport" optional="false">
<description>This command is used to request the Node modifies the configuration of the specified push transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportOptions" type="TransportOptionsStruct"/>
</command>

<command code="0x04" source="client" name="SetTransportStatus" optional="false">
gmarcosb marked this conversation as resolved.
Show resolved Hide resolved
<description>This command SHALL be generated to request the Node modifies the Transport Status of the transport.</description>
<access op="invoke" privilege="manage"/>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="TransportStatus" type="TransportStatusEnum" min="0x00" max="0x01"/>
</command>

<command code="0x05" source="client" name="ManuallyTriggerTransport" optional="false">
<description>This command SHALL be generated to request the Node to manually start the specified push transport.</description>
<arg id="0" name="ConnectionID" type="int16u"/>
<arg id="1" name="ActivationReason" type="TriggerActivationReasonEnum" min="0x00" max="0x02"/>
<arg id="2" name="TimeControl" type="TransportMotionTriggerTimeControlStruct" optional="true"/>
</command>

<command code="0x06" source="client" name="FindTransport" optional="false" response="FindTransportResponse">
<description>This command SHALL return the Stream Options Configuration for the specified push transport.</description>
<arg id="0" name="ConnectionID" type="int16u" optional="true" isNullable="true"/>
gmarcosb marked this conversation as resolved.
Show resolved Hide resolved
</command>

<command code="0x07" source="server" name="FindTransportResponse" optional="false" disableDefaultResponse="true">
<description>This command SHALL be generated in response to a FindTransport command.</description>
<arg id="0" name="StreamConfigurations" array="true" type="TransportConfigurationStruct"/>
</command>

<event code="0x0000" name="PushTransportBegin" priority="info" side="server">
<field id="0" name="ConnectionID" type="int16u"/>
<field id="1" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<field id="2" name="ActivationReason" type="TriggerActivationReasonEnum" optional="true" min="0x00" max="0x02"/>
<description>This event SHALL indicate a push transport transmission has begun.</description>
</event>

<event code="0x0001" name="PushTransportEnd" priority="info" side="server">
<field id="0" name="ConnectionID" type="int16u"/>
<field id="1" name="TriggerType" type="TransportTriggerTypeEnum" min="0x00" max="0x02"/>
<field id="2" name="ActivationReason" type="TriggerActivationReasonEnum" optional="true" min="0x00" max="0x02"/>
<description>This event SHALL indicate a push transport transmission has ended.</description>
</event>

</cluster>
</configurator>
1 change: 1 addition & 0 deletions src/app/zap-templates/zcl/zcl-with-test-extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
"mode-base-cluster.xml",
"mode-select-cluster.xml",
"mode-select-extensions.xml",
"push-av-stream-transport-cluster.xml",
"semantic-tag-namespace-enums.xml",
"network-commissioning-cluster.xml",
"occupancy-sensing-cluster.xml",
Expand Down
1 change: 1 addition & 0 deletions src/app/zap-templates/zcl/zcl.json
View file
Open in desktop
gmarcosb marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"messages-cluster.xml",
"mode-base-cluster.xml",
"mode-select-cluster.xml",
"push-av-stream-transport-cluster.xml",
"semantic-tag-namespace-enums.xml",
"network-commissioning-cluster.xml",
"occupancy-sensing-cluster.xml",
Expand Down
2 changes: 2 additions & 0 deletions src/app/zap_cluster_list.json
View file
Open in desktop
gmarcosb marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
"MESSAGES_CLUSTER": [],
"MODE_SELECT_CLUSTER": [],
"NETWORK_COMMISSIONING_CLUSTER": [],
"PUSH_AV_STREAM_TRANSPORT_CLUSTER": [],
"SAMPLE_MEI_CLUSTER": [],
"NITROGEN_DIOXIDE_CONCENTRATION_MEASUREMENT_CLUSTER": [],
"OCCUPANCY_SENSING_CLUSTER": [],
Expand Down Expand Up @@ -231,6 +232,7 @@
"NITROGEN_DIOXIDE_CONCENTRATION_MEASUREMENT_CLUSTER": [
"concentration-measurement-server"
],
"PUSH_AV_STREAM_TRANSPORT_CLUSTER": [],
"SAMPLE_MEI_CLUSTER": ["sample-mei-server"],
"OCCUPANCY_SENSING_CLUSTER": ["occupancy-sensor-server"],
"ON_OFF_CLUSTER": ["on-off-server"],
Expand Down
Loading
Loading