Skip to content

Commit

Permalink
feat: Protocol Info In Device
Browse files Browse the repository at this point in the history
Signed-off-by: Darryl Mocek <[email protected]>
  • Loading branch information
dmocek committed Dec 8, 2023
1 parent b1d57dd commit ec2f394
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs_src/design/ucr/Protocol-Info-In-Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The Device Profile describes the device. There are many different manufacturers
Any users that create Device Profiles and Devices that have protocol-specific attribute values.

## Description
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
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's). 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.

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.
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 a single one will do.

## Existing solutions
<!--
Expand All @@ -30,7 +30,7 @@ List and describe each approach. Highlight possible gaps.
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).

- If only the Device contains a protocol-specific attribute, it is used for that device.
- If only the Device Profile contains a protocol-specific attribute, it is used for all Devices that have that Device Profile.
- If only the Device Profile contains a protocol-specific attribute, it is used for all Devices having that Device Profile.
- 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.

## Related Issues
Expand Down

0 comments on commit ec2f394

Please sign in to comment.