Add device_model_id and software_version_id properties

[ssilverman]

Also capitalize "Manufacturer" in the manufacturer_id description
for consistency.

Fixes #13

[ssilverman]

@mayanigrosh @sammysmallman Have a look at this and check for correctness and consistency?

[mayanigrosh]

I think the second sentence should be removed, because nothing specifies that.

[ssilverman]

The spec says this, and that’s why I used “may”:

The recommended method for representing the UID in text is in hexadecimal format with a colon separating the Manufacturer ID and the Device ID.
An example of such would be: mmmm:dddddddd, where mmmm is the Manufacturer ID in hexadecimal and dddddddd is the Device ID in hexadecimal.

Would you rather see “it’s possible” instead of “may”?

[ssilverman]

Or… is “Device ID” different from “Device Model ID”?

[mayanigrosh]

"Device Model ID" and "Software Version ID" both appear as fields under DEVICE_INFO.
The Data Description for Device Model ID says

This field identifies the Device Model ID of the Root Device or the Sub-Device. The Manufacturer shall not use the same ID to represent more than one unique model type.

[sammysmallman]

Yes we want device_model_id. We're identifying a type of device and the software it is running, rather than a particular instance of a device. The use case is that we have a parameter definition from Device 1. If Device 2 is the same model made by the same manufacturer and running the same software, the get response would be the same thus we don't need to do a get request again, we can just used the previously retrieved parameter definition.

I'd just omit the part about displaying it as hex.

[peternewman]

Lets use GitHub's features and be explicit:

Suggested change

	"$comment": "The Device Model ID is a 16-bit value determined by the manufacturer. Users may expect to see these values in the UI as hexadecimal.",
	"$comment": "The Device Model ID is a 16-bit value determined by the manufacturer.",

[mayanigrosh]

@mayanigrosh @sammysmallman Have a look at this and check for correctness and consistency?

I'd like to argue that the two new keys be required.

[ssilverman]

@mayanigrosh @sammysmallman Have a look at this and check for correctness and consistency?

I'd like to argue that the two new keys be required.

Are you also saying that you’d like for manufacturer_id to be required? The three values form a tuple.

[ssilverman]

I'm still not sure I agree with this change. See my comment here: #13 (comment)
Also see this comment: #13 (comment)

In short, the data isn't necessary because each message doesn't need to be self-contained.

[mayanigrosh]

@mayanigrosh @sammysmallman Have a look at this and check for correctness and consistency?

I'd like to argue that the two new keys be required.

Are you also saying that you’d like for manufacturer_id to be required? The three values form a tuple.

manufacturer_id is already required
I'm suggesting that device_model_id and software_version_id also be required. I'd prefer if they were separate keys and not grouped into an object like in Sammy's original suggestion.

[peternewman]

More generally, the description fields this adds are just the title with the word the prepended. Whereas the comment has potentially useful info.

From a UI perspective unless the description is mandatory, wouldn't we be better leaving it blank and then people don't need to show needlessly repetitive info. Or moving the $comment into description and then people can show that. I can't remember, is one for the developer and one for the user?

[peternewman]

Lets use GitHub's features and be explicit:

Suggested change

	"$comment": "The Device Model ID is a 16-bit value determined by the manufacturer. Users may expect to see these values in the UI as hexadecimal.",
	"$comment": "The Device Model ID is a 16-bit value determined by the manufacturer.",

[peternewman]

It's not just a random 32-bit value they picked:

Suggested change

	"$comment": "The Software Version ID is a 32-bit value determined by the manufacturer.",
	"$comment": "The Software Version ID is a 32-bit value for a particular software release determined by the manufacturer.",