API Style

[ciozi137]

• command/method:
  • no spaces
  • camelCase is encouraged fore readability, not required (case should be ignored by the application)
  • Example: setTemperature rather than Set Temperature
• parameter names:
  • no spaces
  • lowercase or camelCase
  • no units (share units via HELP reply)
  • Example: temperature not Temperature (K)

old:

{
    "jsonrpc": "2.0",
    "method": "Set Magnet",
    "params": {
        "Field (T)": 0,
        "Rate (T/min)": 0,
        "Axis": "Z",
        "Mode": "Persistent"
    },
    "id": "5f33f29a28a3f2018034cefa8c763baf"
}

new:

{
    "jsonrpc": "2.0",
    "method": "setMagnetField",
    "params": {
        "field": 0,
        "rate": 0,
        "axis": "z",
        "mode": "persistent"
    },
    "id": "ac3caf5f75f9d4ed9b1bf5cd8a3812d2"
}

[ciozi137]

Unified API commands to be enforced in Instrument Framework v1.14+:

Instrument.CBridge.lvclass:

• getCapacitance

Instrument.Cryostat.lvclass:

• getLN2Level
• getLHeLevel
• getMagnet
• getMagnetVector
• setMagnet
• setMagnetVector
• getAngle
• setAngle
• getTemperature
• setTemperature
• getHeater
• setHeater
• getChamber
• setChamber
• getPressure

Instrument.DelayLine.lvclass:

• getDelay
• setDelay

Instrument.LockinAPI.lvclass:

• setAI
• setAO
• setAO_Amplitude
• setAO_DC
• setAO_Frequency
• setAO_Phase
• setAO_Function
• setAO_I+
• setREF
• setREF_Frequency
• setREF_Phase
• setREF_TC
• setREF_Roll-Off
• setDAQ
• setSampling
• setOffset
• setState
• getState
• getAO
• getAI
• getResults
• getSampling
• getAOconfig
• getREFconfig
• setInputGain
• setOutputGain
• getInputGain
• getOutputGain
• setSamplingMode
• getSamplingMode
• setSweep
• setSweepTime
• setSweepTable
• getStatus
• getSweepResults
• getSweepWaveforms
• startSweep
• stopSweep
• setAUX
• getAUX

Instrument.Strain.lvclass:

• getStrain
• setStrain

Instrument.VNA.lvclass:

• getData
• setAverage
• setFormat
• setMeasurement
• setPower
• setSweep

Instrument.SCPI.lvclass:

• sendSCPI
• receiveSCPI

Instrument.SignalGenerator.lvclass:

• setFrequency
• setFunction
• setLevel
• setOffset
• setPhase
• setPower

[ciozi137]

Instrument.Amplifier.lvclass:

• setChannel
• getChannel
• setAllChannels
• getAllChannels