Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Device registration and manufacturer information #428

Merged
merged 2 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions resources/icarDeviceResource.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@
"manufacturer": {
"$ref": "../types/icarDeviceManufacturerType.json",
"description": "The device data as defined by the manufacturer."
},
"registration": {
"$ref": "../types/icarDeviceRegistrationIdentifierType.json",
"description": "A registration identifier for the device (most devices should eventually have a registration issued by `org.icar` or other entity)."
}
}
}
8 changes: 8 additions & 0 deletions types/icarDeviceReferenceType.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@
"serial": {
"type": "string",
"description": "Optionally, the serial number of the device."
},
"manufacturerName": {
"type": "string",
"description": "The manufacturer of the device. This is called `manufacturerName` to distinguish it from the manufacturer-specific parameters in icarDevice."
},
"registration": {
"$ref": "../types/icarDeviceRegistrationIdentifierType.json",
"description": "A registration identifier for the device (most devices should eventually have a registration issued by `org.icar` or other entity)."
}
}
}
Expand Down
11 changes: 11 additions & 0 deletions types/icarDeviceRegistrationIdentifierType.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"description": "A device registration scheme and ID that identifies a registered device. The primary scheme used should be `org.icar`.",

"type": "object",

"allOf": [
{
"$ref": "../types/icarIdentifierType.json"
}
]
}
6 changes: 6 additions & 0 deletions well-known/icarDeviceRegistrationIdentifierType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Well-known Registration Schemes for measurement, sensing, imaging, wearable, or control devices.

| Short URI | Resolvable URI | Organisation | Description |
| --- | --- | --- | --- |
| org.icar | https://www.icar.org/index.php/icar-recording-guidelines/#section11 | ICAR | A device registration scheme operated by ICAR. |