search

AMWA-TV / bcp-005-01

AMWA BCP-005-01 NMOS EDID to Receiver Capabilities Mapping
https://specs.amwa.tv/bcp-005-01
Apache License 2.0
3 stars 4 forks source link

Architecture.md: Confusing text regarding IPMX Controller #12

Closed bgilmer77 closed 3 years ago

bgilmer77 commented 3 years ago

I find the text in the section IPMX Gateway Encoder Component Diagram to be confusing.

The text refers to an IPMX Control . Should that be IPMX Controller? If so, then the text is redundant since that term is introduced in the next sentence. If it is not IPMX Controller, then what is an IPMX Control? I started to revise the text, but ran into an issue since in one place the paragraph says it is an IS-04 Control, and the last sentence says, The IPMX Controller provides a proposed API called IS-XXi, so clearly the controller is not an IS-04 controller. Here is the revision but it still does not make sense: Figure 3 shows a component diagram for an IPMX Gateway Encoder. This diagram illustrates the role of a new architectural component shown in tan. This is a IPMX Controler that, provides an IS-04 RESTful API to support required User-Stories. It interacts with an HDMI Source by presenting an EDID to the source. It also is responsible for setup of IS-04 resources as shown in the Sequence Diagrams found below. The IPMX Controller provides a proposed API called IS-XX.

Please clarify the text.

rbgodwin commented 3 years ago

Hi Brad, thanks for the comment.

Perhaps: Figure 3 shows a component diagram for an IPMX Gateway Encoder. This diagram illustrates the role of a new architectural component shown in tan. This new component is an IPMX Controller that provides a proposed IS-XX RESTful API to support the User-Stories described above. In addition to providing the IS-XX RESTful API, the IPMX Controller interacts with an HDMI Source by presenting an EDID. It also is responsible for the setup of IS-04 resources as shown in the Sequence Diagrams found below. The IPMX Controller is analogous to the IS-04 Device Control used for IS-05.

bgilmer77 commented 3 years ago

Thanks Randy. I was asking about the text which mentions an _IPMX _Control__. I think that is an error. Should it be IPMX Controller? If that is correct, then the text is pretty repetitive.

rbgodwin commented 3 years ago

Hi Brad, I corrected the IPMX Control and tried to reword but I think it will for sure benefit from some clarifications if and when we have an actual IS-XX or point to define the API. I'm merging the changes into the main branch and we can get it out for more exposure as a public repo.