feat: Device refactor for 2.0 #223
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DeltaHeadMan
reviewed
Feb 2, 2024
There was a problem hiding this comment.
What is meant by clear text, exactly? Human readable?
DeltaHeadMan
reviewed
Feb 2, 2024
| ### 3.1. Device Identifier | ||
| The Device module **MUST** expose a read-only, clear-text unique identifier of the device via the `Device.id` method. | ||
|
|
||
| This API will likely only be permitted to fisrt-party apps and **MUST** only be surfaced in the Manage SDK. |
DeltaHeadMan
reviewed
Feb 2, 2024
|
|
||
| The `type` method **MUST** return one of: | ||
|
|
||
| - `STB` |
There was a problem hiding this comment.
Should this match the Comcast/Sky Ontology?
DeltaHeadMan
reviewed
Feb 2, 2024
|
|
||
| ### 5.3. Make | ||
| The Device module **MUST** expose the read-only manufacturer of the device, e.g. "Raspberry Pi, ltd", via the `Device.make` method. | ||
|
|
There was a problem hiding this comment.
String is implementation defined, e.g. a serialized string on EntOS devices.
DeltaHeadMan
reviewed
Feb 2, 2024
| ### 5.5. Serial Number | ||
| The Device module **MUST** expose the read-only serial number of the device via the `Device.serialNumber` method. | ||
|
|
||
| This API will likely only be permitted to fisrt-party apps and **MUST** only be surfaced in the Manage SDK. |
DeltaHeadMan
reviewed
Feb 2, 2024
|
|
||
| This API will likely only be permitted to fisrt-party apps and **MUST** only be surfaced in the Manage SDK. | ||
|
|
||
| The value of this **MUST** be unique within a make and model, even across distributors. |
There was a problem hiding this comment.
Hmmm... I would say that this is also implementation defined
DeltaHeadMan
reviewed
Feb 2, 2024
| **TODO**: Confirm RDK-M distributor name. | ||
|
|
||
| ### 6.2. Partner | ||
| The Device module **MUST** expose the read-only distribution partner of the device, e.g. "RDK Demos". |
There was a problem hiding this comment.
The is the partner id from the ontology?
DeltaHeadMan
reviewed
Feb 2, 2024
| **TODO**: Confirm RDK-M distributor name. | ||
|
|
||
| ### 6.2. Partner | ||
| The Device module **MUST** expose the read-only distribution partner of the device, e.g. "RDK Demos". |
There was a problem hiding this comment.
The partner may not be known - presumably return an empty string?
DeltaHeadMan
reviewed
Feb 2, 2024
| **NOTE**: we probably need a registry of Firebolt distributors to avoid collisions. | ||
|
|
||
| ### 3.2. Anonymized Device Identifier | ||
| The Device module **MUST** expose a read-only, anonymized device identifier that is consistent across launches of the same app via the `Device.uid` method. |
DeltaHeadMan
reviewed
Feb 3, 2024
| ## 3. Device Identifiers | ||
|
|
||
| ### 3.1. Device Identifier | ||
| The Device module **MUST** expose a read-only, clear-text unique identifier of the device via the `Device.id` method. |
There was a problem hiding this comment.
What is the durability of this attribute? Does it survive device reset? Is it available even on a new device?
DeltaHeadMan
reviewed
Feb 3, 2024
|
|
||
| This API will likely only be permitted to fisrt-party apps and **MUST** only be surfaced in the Manage SDK. | ||
|
|
||
| The value of this **MUST** be unique within a distributor. |
There was a problem hiding this comment.
Or is the scope implementation defined?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.