Skip to content

Update JSON schemas for consistency #38

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.

Sign up for GitHub

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

Merged
NateMeyer merged 1 commit into from
May 7, 2026
Merged

Update JSON schemas for consistency #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
193 changes: 193 additions & 0 deletions doc/data/fcal.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
{
"$id": "https://example.com/schemas/fcal",
"title": "Factory Calibration",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1
},
"serial": {
"type": "string",
"maxLength": 256
},
"timestamp": {
"type": "string",
"description": "UTC date/time in ISO 8601 format"
},
"channel1": {
"type": "object",
"properties": {
"attenuatorScale": {
"type": "number"
},
"paths": {
"type": "array",
"items": {
"$ref": "/schemas/channelPathCalibration"
}
},
"pgaLoadScales":{
"type": "array",
"items": {
"$ref": "/schemas/pgaLoadScale"
}
}
}
},
"channel2": {
"type": "object",
"properties": {
"attenuatorScale": {
"type": "number"
},
"paths": {
"type": "array",
"items": {
"$ref": "/schemas/channelPathCalibration"
}
},
"pgaLoadScales":{
"type": "array",
"items": {
"$ref": "/schemas/pgaLoadScale"
}
}
}
},
"channel3": {
"type": "object",
"properties": {
"attenuatorScale": {
"type": "number"
},
"paths": {
"type": "array",
"items": {
"$ref": "/schemas/channelPathCalibration"
}
},
"pgaLoadScales":{
"type": "array",
"items": {
"$ref": "/schemas/pgaLoadScale"
}
}
}
},
"channel4": {
"type": "object",
"properties": {
"attenuatorScale": {
"type": "number"
},
"paths": {
"type": "array",
"items": {
"$ref": "/schemas/channelPathCalibration"
}
},
"pgaLoadScales":{
"type": "array",
"items": {
"$ref": "/schemas/pgaLoadScale"
}
}
}
},
"adc":{
"type": "object",
"properties": {
"fineGainBranch1": {
"type": "number"
},
"fineGainBranch2": {
"type": "number"
},
"fineGainBranch3": {
"type": "number"
},
"fineGainBranch4": {
"type": "number"
},
"fineGainBranch5": {
"type": "number"
},
"fineGainBranch6": {
"type": "number"
},
"fineGainBranch7": {
"type": "number"
},
"fineGainBranch8": {
"type": "number"
}
}
}
},
"required": [
"version",
"serial",
"channel1",
"channel2",
"channel3",
"channel4",
"adc"
],
"$defs": {
"channelPathCalibration": {
"$id": "https://example.com/schemas/channelPathCalibration",
"title": "Channel Path Calibration",
"type": "object",
"properties": {
"pgaPreampGain": {
"enum": ["high", "low"]
},
"pgaLadderAttenuator": {
"type": "number"
},
"trimScaleDac": {
"type": "number"
},
"trimOffsetDacScale": {
"type": "number"
},
"trimOffsetDacZero": {
"type": "number"
},
"bufferInputVpp": {
"type": "number"
}
},
"required": [
"pgaPreampGain",
"pgaLadderAttenuator",
"trimScaleDac",
"trimOffsetDacScale",
"trimOffsetDacZero",
"bufferInputVpp"
]
},
"pgaLoadScale": {
"$id": "https://example.com/schemas/pgaLoadScale",
"title": "PGA Load Scale",
"type": "object",
"properties": {
"sampleRate": {
"type": "number"
},
"channelCount": {
"type": "number"
},
"scale": {
"type": "number"
}
},
"required": [
"sampleRate",
"channelCount",
"scale"
]
}
}
}
19 changes: 10 additions & 9 deletions doc/data/hwid.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Hardware Identity Description",
"$id": "https://example.com/schemas/hwid",
"title": "Hardware Identity",
"type": "object",
"properties": {
"version": {
"type": "integer",
"minimum": 1
},
"Serial Number": {
"serial": {
"type": "string",
"maxLength": 256
},
"Board Revision": {
"boardRevision": {
"type": "number"
},
"Build Config": {
"buildConfiguration": {
"type": "string",
"maxLength": 256
},
"Build Date": {
"buildDate": {
"type": "string",
"maxLength": 256
"maxLength": 256,
"description": "UTC date/time in ISO 8601 format"
},
"Mfg Signature": {
"manufacturingSignature": {
"type": "string",
"maxLength": 256
}
},
"required": [
"version",
"Serial Number"
"serial"
]
}
Loading