Skip to content

Commit db3bb1b

Browse files
committed
Add Protocol-specific Attribute Values in Device UCR.
Signed-off-by: Darryl Mocek <[email protected]>
1 parent bb6b701 commit db3bb1b

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Use Case Title
2+
Protocol-specific Attribute Values in Device
3+
4+
## Submitters
5+
Darryl Mocek (Oracle Corporation)
6+
7+
## Changelog
8+
9+
## Market Segments
10+
Any segments using EdgeX with device services that contain protocol-specific values in Device Profile attributes.
11+
12+
## Motivation
13+
The Device Profile describes the device. There are many different manufacturers of the same type of device (e.g. HVAC). The Device Profile of a specific type of device could used be for many or all of the Devices of that type, reducing the need to duplicate a Device Profile just to account for differences in the protocol-specific attribute values.
14+
15+
## Target Users
16+
Any users that create Device Profiles and Devices that have protocol-specific attribute values.
17+
18+
## Description
19+
The Device Profile **describes** the device and its attributes, it's type. Different manufacturers can build the same type of device using different protocols and the same device using the same protocol but different configuration (e.g. different Modbus HoldingRegister). For example, two different manufacturers may build an HVAC using ModBus, and another may build an HVAC using SNMP. In the case of two Modbus devices, there will need to be two different Device Profiles, even though the devices are the same and have the same attributes, because the protocol configurations (e.g. HoldingRegister) will conflict. Device Profile
20+
21+
If the protocol information resides in the Device, which describes a specific (instance of a) device only a single Device Profile is needed as all devices of the same type can use the same Device Profile. This becomes more important as you have more devices, potentially increasing the number and management of Device Profiles when one will do.
22+
23+
## Existing solutions
24+
<!--
25+
How is the given use case currently implemented in the industry, with or without EdgeX?
26+
List and describe each approach. Highlight possible gaps.
27+
-->
28+
29+
## Requirements
30+
The requirement is to support the protocol-specific attribute values (e.g. HoldingRegister) in the Device as well as the Device Profile (for backward compatibility).
31+
32+
- If only the Device contains a protocol-specific attribute, it is used for that device.
33+
- If only the Device Profile contains a protocol-specific attribute, it is used for all Devices that have that Device Profile.
34+
- If both the Device Profile and the Device contain a protocol-specific attribute, the entry in the Device overrides the one in the Device Profile.
35+
36+
## Related Issues
37+
38+
## References
39+
- https://github.com/edgexfoundry/device-modbus/blob/master/src/main/resources/MBUS-RTH-LCD.profile.yaml

0 commit comments

Comments
 (0)