Schemas / Modular
rig.modular.module
v1.4.0 · stable maturity: draft 8 fields 1 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
hp |
int1 – * | required | Faceplate width in horizontal-pitch units |
pitchMm |
float> 0 | optional | Optional. Millimetres per HP. Absent = 5.08 (Eurocard horizontal pitch) |
widthMm |
float0 – * | optional | Optional. Finished faceplate width (mm). Absent = unset. hp times pitchMm is the nominal width, which a host computes |
heightMm |
float0 – * | optional | Optional. Finished faceplate height (mm). Absent = unset |
thicknessMm |
float0 – * | optional | Optional. Panel thickness (mm). Absent = unset |
depthMm |
float0 – * | optional | Optional. Depth from the inside face of the panel to the furthest rear point (mm). Absent = unset |
fastener |
enumm3 · m2-5 | optional | Optional. Panel thread. m3, m2-5 (M2.5). Absent = unset |
spec |
entity | optional | Optional. Named spec this module claims. Absent = no claim |
One modular faceplate. Format when present.
The entity is the module a person slides into a rig.modular.case. Display name is rig.meta.named. Pose in the case is rig.spatial.transform. A drawn outline is geometry in the document unit; labels are rig.media.text.
Required: hp.
widthMm is the manufactured width, after the clearance a spec cuts out of hp * pitchMm. Store it when the spec or the calipers give it. Do not also store the nominal product.
Jacks are children carrying rig.modular.port. Current draw is rig.modular.power on this entity. The header that draw comes through is a rig.circuit.part child; each contact is a rig.circuit.pin. A PCB behind the panel is rig.pcb.board when the author is describing copper.
spec is the same kind of pointer as on the case: a named entity, not a brand baked into the schema id. Published EuroSynth figures: eurosynth.md.
JSON Schema
Resolves at https://rig.works/schemas/rig.modular.module.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.modular.module.schema.json",
"title": "rig.modular.module",
"type": "object",
"additionalProperties": false,
"properties": {
"hp": {
"$ref": "./_defs.schema.json#/$defs/int",
"minimum": 1
},
"pitchMm": {
"$ref": "./_defs.schema.json#/$defs/float",
"exclusiveMinimum": 0
},
"widthMm": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"heightMm": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"thicknessMm": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"depthMm": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"fastener": {
"type": "string",
"enum": [
"m3",
"m2-5"
]
},
"spec": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"hp"
],
"x-rig-maturity": "draft"
}