|
| 1 | +<?xml version="1.0"?> |
| 2 | +<!-- |
| 3 | +Copyright (c) 2023-24 Project CHIP Authors |
| 4 | +
|
| 5 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | +you may not use this file except in compliance with the License. |
| 7 | +You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | +Unless required by applicable law or agreed to in writing, software |
| 12 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +See the License for the specific language governing permissions and |
| 15 | +limitations under the License. |
| 16 | +--> |
| 17 | +<configurator> |
| 18 | + <domain name="CHIP"/> |
| 19 | + |
| 20 | + Data types |
| 21 | + <struct name="LocationInfoStruct"> |
| 22 | + <cluster code="0x0150"/> |
| 23 | + <item name="LocationInfo" type="HomeLocationStruct" optional="false" isNullable="true"/> |
| 24 | + <item name="LandmarkTag" type="LandmarkTag" optional="false" isNullable="true"/> |
| 25 | + <item name="PositionTag" type="PositionTag" optional="false" isNullable="true"/> |
| 26 | + <item name="SurfaceTag" type="FloorSurfaceTag" optional="false" isNullable="true"/> |
| 27 | + </struct> |
| 28 | + |
| 29 | + <struct name="MapStruct"> |
| 30 | + <cluster code="0x0150"/> |
| 31 | + <item name="MapID" type="int8u" optional="false"/> |
| 32 | + <item name="Name" type="char_string" length="64" optional="false"/> |
| 33 | + </struct> |
| 34 | + |
| 35 | + <struct name="LocationStruct"> |
| 36 | + <cluster code="0x0150"/> |
| 37 | + <item name="LocationID" type="int32u" optional="false" isNullable="false"/> |
| 38 | + <item name="MapID" type="int8u" optional="false" isNullable="true"/> |
| 39 | + <item name="LocationInfo" type="LocationInfoStruct" optional="false" isNullable="false"/> |
| 40 | + </struct> |
| 41 | + |
| 42 | + <enum name="OperationalStatusEnum" type="enum8"> |
| 43 | + <cluster code="0x0150"/> |
| 44 | + <item value="0x00" name="Pending"/> |
| 45 | + <item value="0x01" name="Operating"/> |
| 46 | + <item value="0x02" name="Skipped"/> |
| 47 | + <item value="0x03" name="Completed"/> |
| 48 | + </enum> |
| 49 | + |
| 50 | + <struct name="ProgressStruct"> |
| 51 | + <cluster code="0x0150"/> |
| 52 | + <item name="LocationID" type="int32u" optional="false"/> |
| 53 | + <item name="Status" type="OperationalStatusEnum" optional="false"/> |
| 54 | + <item name="TotalOperationalTime" type="elapsed_s" optional="true" isNullable="true"/> |
| 55 | + <item name="EstimatedTime" type="elapsed_s" optional="true" isNullable="true"/> |
| 56 | + </struct> |
| 57 | + |
| 58 | + <enum name="SelectLocationsStatus" type="enum8"> |
| 59 | + <cluster code="0x0150"/> |
| 60 | + <item value="0x00" name="Success"/> |
| 61 | + <item value="0x01" name="UnsupportedLocation"/> |
| 62 | + <item value="0x02" name="DuplicatedLocations"/> |
| 63 | + <item value="0x03" name="InvalidInMode"/> |
| 64 | + <item value="0x04" name="InvalidSet"/> |
| 65 | + </enum> |
| 66 | + |
| 67 | + <enum name="SkipCurrentLocationStatus" type="enum8"> |
| 68 | + <cluster code="0x0150"/> |
| 69 | + <item value="0x00" name="Success"/> |
| 70 | + <item value="0x01" name="InvalidLocationList"/> |
| 71 | + <item value="0x02" name="InvalidInMode"/> |
| 72 | + </enum> |
| 73 | + |
| 74 | + <cluster> |
| 75 | + <domain>General</domain> |
| 76 | + <name>Service Area</name> |
| 77 | + <description>The Service Area cluster provides an interface for controlling the locations where a device should operate, and for querying the current location.</description> |
| 78 | + <code>0x0150</code> |
| 79 | + <define>SERVICE_AREA_CLUSTER</define> |
| 80 | + |
| 81 | + <features> |
| 82 | + <feature bit="0" code="LISTORDER" name="ListOrder" summary="The device operates at the selected locations in the list order"> |
| 83 | + <optionalConform/> |
| 84 | + </feature> |
| 85 | + <feature bit="1" code="SELRUN" name="SelectWhileRunning" summary="The device allows changing the selected locations while running"> |
| 86 | + <optionalConform/> |
| 87 | + </feature> |
| 88 | + </features> |
| 89 | + |
| 90 | + <!-- Attributes --> |
| 91 | + <attribute side="server" code="0x0000" define="SupportedLocations" type="array" entryType="LocationStruct" writable="false" isNullable="false" optional="false">SupportedLocations</attribute> |
| 92 | + <attribute side="server" code="0x0001" define="SupportedMaps" type="array" entryType="MapStruct" writable="false" isNullable="true" optional="false">SupportedMaps</attribute> |
| 93 | + <attribute side="server" code="0x0002" define="SelectedLocations" type="array" entryType="int32u" writable="false" isNullable="true" optional="false">SelectedLocations</attribute> |
| 94 | + <attribute side="server" code="0x0003" define="CurrentLocation" type="int32u" writable="false" isNullable="true" optional="true">CurrentLocation</attribute> |
| 95 | + <attribute side="server" code="0x0004" define="EstimatedEndTime" type="epoch_s" writable="false" isNullable="true" optional="true" >EstimatedEndTime</attribute> |
| 96 | + <attribute side="server" code="0x0005" define="Progress" type="array" entryType="ProgressStruct" writable="false" isNullable="true" optional="true">Progress</attribute> |
| 97 | + |
| 98 | + <!-- Commands --> |
| 99 | + <command source="client" code="0x00" name="SelectLocations" response="SelectLocationsResponse" optional="false"> |
| 100 | + <description> |
| 101 | + Command used to select a set of device locations, where the device is to operate |
| 102 | + </description> |
| 103 | + <arg name="NewLocations" type="int32u" array="true" isNullable="true"/> |
| 104 | + </command> |
| 105 | + |
| 106 | + <command source="server" code="0x01" name="SelectLocationsResponse" disableDefaultResponse="true" optional="false"> |
| 107 | + <description> |
| 108 | + This command is sent by the device on receipt of the SelectLocations command. |
| 109 | + </description> |
| 110 | + <arg name="Status" type="SelectLocationsStatus" optional="false"/> |
| 111 | + <arg name="StatusText" type="char_string" length="256" optional="true"/> |
| 112 | + </command> |
| 113 | + |
| 114 | + <command source="client" code="0x02" name="SkipCurrentLocation" response="SkipCurrentLocationResponse" optional="true"> |
| 115 | + <description> |
| 116 | + This command is used to skip the current location where the device operates. |
| 117 | + </description> |
| 118 | + </command> |
| 119 | + |
| 120 | + <command source="server" code="0x03" name="SkipCurrentLocationResponse" disableDefaultResponse="true" optional="true"> |
| 121 | + <description> |
| 122 | + This command is sent by the device on receipt of the SelectLocations command. |
| 123 | + </description> |
| 124 | + <arg name="Status" type="SkipCurrentLocationStatus" optional="false"/> |
| 125 | + <arg name="StatusText" type="char_string" length="256" optional="true"/> |
| 126 | + </command> |
| 127 | + |
| 128 | + </cluster> |
| 129 | + |
| 130 | +</configurator> |
0 commit comments