Skip to content

Commit d00632c

Browse files
committed
1 parent 12b3cd1 commit d00632c

3 files changed

Lines changed: 115 additions & 40 deletions

File tree

openapi/ProtocolMap-BLE.yaml

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,34 @@ components:
1919
type: object
2020
properties:
2121
ble:
22-
required:
23-
- serviceID
24-
- characteristicID
25-
type: object
26-
properties:
27-
serviceID:
28-
type: string
29-
format: uuid
30-
example: 00001809-0000-1000-8000-00805f9b34fb
31-
characteristicID:
32-
type: string
33-
format: uuid
34-
example: 00002a1c-0000-1000-8000-00805f9b34fb
35-
22+
oneOf:
23+
- $ref: '#/components/schemas/BLE-Property'
24+
- type: object
25+
required:
26+
- read
27+
- write
28+
properties:
29+
read:
30+
$ref: '#/components/schemas/BLE-Property'
31+
write:
32+
$ref: '#/components/schemas/BLE-Property'
33+
34+
## Reusable BLE property object
35+
BLE-Property:
36+
required:
37+
- serviceID
38+
- characteristicID
39+
type: object
40+
properties:
41+
serviceID:
42+
type: string
43+
format: uuid
44+
example: 00001809-0000-1000-8000-00805f9b34fb
45+
characteristicID:
46+
type: string
47+
format: uuid
48+
example: 00002a1c-0000-1000-8000-00805f9b34fb
49+
3650
## Defines different types of BLE events
3751
ProtocolMap-BLE-Event:
3852
required:

openapi/ProtocolMap-Zigbee.yaml

Lines changed: 79 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,51 @@ components:
1919
type: object
2020
properties:
2121
zigbee:
22-
required:
23-
- endpointID
24-
- clusterID
25-
- attributeID
26-
type: object
27-
properties:
28-
endpointID:
29-
type: integer
30-
format: int32
31-
example: 1
32-
clusterID:
33-
type: integer
34-
format: int32
35-
example: 6
36-
attributeID:
37-
type: integer
38-
format: int32
39-
example: 16
40-
type:
41-
type: integer
42-
format: int32
43-
example: 1
44-
profileID:
45-
type: integer
46-
format: int32
47-
example: 260
22+
oneOf:
23+
- $ref: '#/components/schemas/Zigbee-Property'
24+
- type: object
25+
required:
26+
- read
27+
- write
28+
properties:
29+
read:
30+
$ref: '#/components/schemas/Zigbee-Property'
31+
write:
32+
$ref: '#/components/schemas/Zigbee-Property'
33+
34+
## Reusable Zigbee property object
35+
Zigbee-Property:
36+
required:
37+
- endpointID
38+
- clusterID
39+
- attributeID
40+
- attributeType
41+
type: object
42+
properties:
43+
endpointID:
44+
type: integer
45+
format: int32
46+
example: 1
47+
clusterID:
48+
type: integer
49+
format: int32
50+
example: 6
51+
attributeID:
52+
type: integer
53+
format: int32
54+
example: 16
55+
attributeType:
56+
type: integer
57+
format: int32
58+
example: 32
59+
profileID:
60+
type: integer
61+
format: int32
62+
example: 260
63+
manufacturerCode:
64+
type: integer
65+
format: int32
66+
example: 4174
4867

4968
ProtocolMap-Zigbee-Event:
5069
required:
@@ -145,3 +164,37 @@ components:
145164
example: connection_events
146165
enum:
147166
- connection_events
167+
168+
## Protocol mapping for Zigbee action
169+
ProtocolMap-Zigbee-Action:
170+
required:
171+
- zigbee
172+
type: object
173+
properties:
174+
zigbee:
175+
required:
176+
- endpointID
177+
- clusterID
178+
- commandID
179+
type: object
180+
properties:
181+
endpointID:
182+
type: integer
183+
format: int32
184+
example: 1
185+
clusterID:
186+
type: integer
187+
format: int32
188+
example: 6
189+
commandID:
190+
type: integer
191+
format: int32
192+
example: 0
193+
profileID:
194+
type: integer
195+
format: int32
196+
example: 260
197+
manufacturerCode:
198+
type: integer
199+
format: int32
200+
example: 4174

openapi/ProtocolMap.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,12 @@ components:
3131
oneOf:
3232
- $ref: './ProtocolMap-BLE.yaml#/components/schemas/ProtocolMap-BLE-Event'
3333
- $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-Event'
34+
35+
## Protocol Map for an action
36+
ProtocolMap-Action:
37+
type: object
38+
properties:
39+
sdfProtocolMap:
40+
oneOf:
41+
- $ref: './ProtocolMap-Zigbee.yaml#/components/schemas/ProtocolMap-Zigbee-Action'
3442

0 commit comments

Comments
 (0)