Schemas / Modular
rig.modular.port
v1.4.0 · stable maturity: draft 17 fields 3 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
direction |
enumin · out · bidirectional | required | in, out, bidirectional |
signal |
enumaudio · cv · gate · trigger | required | audio, cv, gate, trigger |
connector |
enumbanana-4mm · ts-3-5mm | required | banana-4mm, ts-3-5mm (3.5 mm tip-sleeve) |
impedanceOhm |
float0 – * | optional | Optional. Ohms. Absent = unset |
lowVolts |
float | optional | Optional. Lower end of the accepted or produced window (V). Absent = unset |
highVolts |
float | optional | Optional. Upper end of the accepted or produced window (V). Absent = unset. Not below lowVolts |
tolerance |
float0 – 1 | optional | Optional. Fraction of highVolts, 0-1. 0.01 is +/- 1%. Absent = unset |
thresholdVolts |
float | optional | Optional. Logic trip voltage (V). Absent = unset. When offBelowVolts and onAboveVolts are set, it lies between them |
offBelowVolts |
float | optional | Optional. At or below this voltage a logic signal reads off (V). Absent = unset |
onAboveVolts |
float | optional | Optional. At or above this voltage a logic signal reads on (V). Absent = unset. Not below offBelowVolts |
minSlewVoltsPerMicrosecond |
float0 – * | optional | Optional. Minimum edge slew a trigger input requires (V/us). Absent = unset |
maxTransitionMicroseconds |
float0 – * | optional | Optional. Maximum transition time a trigger input accepts (us). Absent = unset |
voltsPerOctave |
float> 0 | optional | Optional. Pitch law, volts per octave. Absent = unset |
decibelsPerVolt |
float | optional | Optional. Level law, decibels per volt. Absent = unset |
referencePitch |
int0 – 127 | optional | Optional. MIDI note that referenceVolts stands for. Middle C is 60. State with referenceVolts, or omit both |
referenceVolts |
float | optional | Optional. Voltage at referencePitch (V). State with referencePitch, or omit both. When lowVolts and highVolts are set, it lies between them |
minHertz |
float0 – * | optional | Optional. Lowest frequency the window is specified at (Hz). Absent = unset. An open upper bound stays omitted |
One patch jack and the signal window it accepts or produces. Format when present.
The window is the contract other modules have to meet. A sample on the wire is host cache: do not store the voltage that happens to be present this frame.
Required: direction, signal, connector.
highVolts is greater than or equal to lowVolts. onAboveVolts is greater than or equal to offBelowVolts. A trigger input states slew and transition; a gate input states the trip and the off/on window. Pitch states voltsPerOctave and, when the spec pins a note to a voltage, both reference fields. A level law such as 12 dB/V is decibelsPerVolt on that jack, not a second volts-per-octave figure.
Bushing colour is paint on this entity (rig.paint.fill_stroke fillRgba). Tip and sleeve, when the author knows which net each lands on, are child rig.circuit.pin entities. This jack is not that pin, not rig.node.pin, not rig.sensor.gpio, and not rig.mod.trigger.
Published windows for EuroSynth, and the Eurorack figures a mixed case has to compare: eurosynth.md.
JSON Schema
Resolves at https://rig.works/schemas/rig.modular.port.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.modular.port.schema.json",
"title": "rig.modular.port",
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"enum": [
"in",
"out",
"bidirectional"
]
},
"signal": {
"type": "string",
"enum": [
"audio",
"cv",
"gate",
"trigger"
]
},
"connector": {
"type": "string",
"enum": [
"banana-4mm",
"ts-3-5mm"
]
},
"impedanceOhm": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"lowVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"highVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"tolerance": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0,
"maximum": 1
},
"thresholdVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"offBelowVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"onAboveVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"minSlewVoltsPerMicrosecond": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"maxTransitionMicroseconds": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
},
"voltsPerOctave": {
"$ref": "./_defs.schema.json#/$defs/float",
"exclusiveMinimum": 0
},
"decibelsPerVolt": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"referencePitch": {
"$ref": "./_defs.schema.json#/$defs/int",
"minimum": 0,
"maximum": 127
},
"referenceVolts": {
"$ref": "./_defs.schema.json#/$defs/float"
},
"minHertz": {
"$ref": "./_defs.schema.json#/$defs/float",
"minimum": 0
}
},
"required": [
"direction",
"signal",
"connector"
],
"x-rig-maturity": "draft"
}