diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index b01f858f1..d1e17f791 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -1775,7 +1775,7 @@ margin-bottom: 20px; "log2Decim" : { "type" : "integer" }, - "fcPos" : { + "fcPosRx" : { "type" : "integer", "description" : "See BladeRF2MIMO::fcPos_t" }, @@ -1821,6 +1821,10 @@ margin-bottom: 20px; "log2Interp" : { "type" : "integer" }, + "fcPosTx" : { + "type" : "integer", + "description" : "See BladeRF2MIMO::fcPos_t" + }, "txBandwidth" : { "type" : "integer" }, @@ -1970,6 +1974,10 @@ margin-bottom: 20px; defs.Channel = { "required" : [ "deltaFrequency", "id", "index", "title", "uid" ], "properties" : { + "direction" : { + "type" : "integer", + "description" : "0 for Rx only, 1 for Tx only or 2 for any direction (MIMO)" + }, "index" : { "type" : "integer", "description" : "Index in the list of channels" @@ -2868,9 +2876,6 @@ margin-bottom: 20px; "testSourceSettings" : { "$ref" : "#/definitions/TestSourceSettings" }, - "testMISettings" : { - "$ref" : "#/definitions/TestMISettings" - }, "xtrxInputSettings" : { "$ref" : "#/definitions/XtrxInputSettings" }, @@ -2881,11 +2886,10 @@ margin-bottom: 20px; "description" : "Base device settings. Only the device settings corresponding to the device specified in the deviceHwType field is or should be present." }; defs.DeviceState = { - "required" : [ "state" ], "properties" : { "state" : { "type" : "string", - "description" : "State: notStarted, idle, ready, running, error" + "description" : "Unique state: notStarted, idle, ready, running, error" } }, "description" : "Device running state" @@ -3904,6 +3908,94 @@ margin-bottom: 20px; } }, "description" : "KiwiSDR" +}; + defs.LimeRFEDevice = { + "properties" : { + "deviceRef" : { + "type" : "string", + "description" : "Serial device name or server address" + } + }, + "description" : "LimeRFE device active in the system" +}; + defs.LimeRFEDevices = { + "required" : [ "nbDevices" ], + "properties" : { + "nbDevices" : { + "type" : "integer", + "description" : "Number of LimeRFE serial interfaces" + }, + "limeRFEDevices" : { + "type" : "array", + "description" : "List of LimeRFE devices", + "items" : { + "$ref" : "#/definitions/LimeRFEDevice" + } + } + }, + "description" : "List of LimeRFE devices (serial or server address)" +}; + defs.LimeRFESettings = { + "properties" : { + "devicePath" : { + "type" : "string", + "description" : "Path to the device serial interface (ex /dev/ttyUSB2)" + }, + "rxChannels" : { + "type" : "integer", + "description" : "Rx channels group (see LimeRFEController.ChannelGroups enumeration)" + }, + "rxWidebandChannel" : { + "type" : "integer" + }, + "rxHAMChannel" : { + "type" : "integer", + "description" : "Rx HAM channel selection (see LimeRFEController.HAMChannel enumeration)" + }, + "rxCellularChannel" : { + "type" : "integer", + "description" : "Rx cellular channel selection (see LimeRFEController.HAMChannel enumeration)" + }, + "rxPort" : { + "type" : "integer", + "description" : "Rx port selected (see LimeRFEController.RxPort enumeration)" + }, + "attenuationFactor" : { + "type" : "integer", + "description" : "Rx attenuation factor. Attenuation is 2 times this factor in dB (0..7 => 0..14dB)" + }, + "amfmNotch" : { + "type" : "integer" + }, + "txChannels" : { + "type" : "integer", + "description" : "Tx channels group (see LimeRFEController.ChannelGroups enumeration)" + }, + "txWidebandChannel" : { + "type" : "integer" + }, + "txHAMChannel" : { + "type" : "integer", + "description" : "Tx HAM channel selection (see LimeRFEController.HAMChannel enumeration)" + }, + "txCellularChannel" : { + "type" : "integer", + "description" : "Tx cellular channel selection (see LimeRFEController.HAMChannel enumeration)" + }, + "txPort" : { + "type" : "integer", + "description" : "Tx port selected (see LimeRFEController.TxPort enumeration)" + }, + "rxOn" : { + "type" : "integer", + "description" : "Boolean 1 if Rx is active else 0" + }, + "txOn" : { + "type" : "integer", + "description" : "Boolean 1 if Tx is active else 0" + } + }, + "description" : "LimeRFE" }; defs.LimeSdrInputReport = { "properties" : { @@ -4257,6 +4349,10 @@ margin-bottom: 20px; "filterChainHash" : { "type" : "integer" }, + "play" : { + "type" : "integer", + "description" : "boolean (1 to play, 0 to stop)" + }, "streamIndex" : { "type" : "integer", "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." @@ -4298,6 +4394,10 @@ margin-bottom: 20px; "filterChainHash" : { "type" : "integer" }, + "play" : { + "type" : "integer", + "description" : "boolean (1 to play, 0 to stop)" + }, "streamIndex" : { "type" : "integer", "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." @@ -5806,7 +5906,7 @@ margin-bottom: 20px; "description" : "A sample rate expressed in samples per second (S/s)" }; defs.SamplingDevice = { - "required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial", "state" ], + "required" : [ "bandwidth", "centerFrequency", "hwType", "index", "sequence", "serial" ], "properties" : { "index" : { "type" : "integer", @@ -5847,7 +5947,15 @@ margin-bottom: 20px; }, "state" : { "type" : "string", - "description" : "State: notStarted, idle, ready, running, error" + "description" : "Single subsystem state: notStarted, idle, ready, running, error" + }, + "stateRx" : { + "type" : "string", + "description" : "Rx subsystem state (MIMO): notStarted, idle, ready, running, error" + }, + "stateTx" : { + "type" : "string", + "description" : "Tx subsystem state (MIMO): notStarted, idle, ready, running, error" } }, "description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device" @@ -6154,96 +6262,6 @@ margin-bottom: 20px; "type" : "string" } } -}; - defs.TestMISettings = { - "properties" : { - "fileRecordName" : { - "type" : "string" - }, - "useReverseAPI" : { - "type" : "integer", - "description" : "Synchronize with reverse API (1 for yes, 0 for no)" - }, - "reverseAPIAddress" : { - "type" : "string" - }, - "reverseAPIPort" : { - "type" : "integer" - }, - "reverseAPIDeviceIndex" : { - "type" : "integer" - }, - "streams" : { - "type" : "array", - "description" : "Settings for each of the streams", - "items" : { - "$ref" : "#/definitions/TestMiStreamSettings" - } - } - }, - "description" : "TestMISettings" -}; - defs.TestMiStreamSettings = { - "properties" : { - "streamIndex" : { - "type" : "integer", - "description" : "Index of the stream to which the settings apply" - }, - "centerFrequency" : { - "type" : "integer", - "format" : "uint64" - }, - "frequencyShift" : { - "type" : "integer" - }, - "sampleRate" : { - "type" : "integer" - }, - "log2Decim" : { - "type" : "integer" - }, - "fcPos" : { - "type" : "integer" - }, - "sampleSizeIndex" : { - "type" : "integer" - }, - "amplitudeBits" : { - "type" : "integer" - }, - "autoCorrOptions" : { - "type" : "integer" - }, - "modulation" : { - "type" : "integer" - }, - "modulationTone" : { - "type" : "integer" - }, - "amModulation" : { - "type" : "integer" - }, - "fmDeviation" : { - "type" : "integer" - }, - "dcFactor" : { - "type" : "number", - "format" : "float" - }, - "iFactor" : { - "type" : "number", - "format" : "float" - }, - "qFactor" : { - "type" : "number", - "format" : "float" - }, - "phaseImbalance" : { - "type" : "number", - "format" : "float" - } - }, - "description" : "TestMiStreamSettings" }; defs.TestSourceSettings = { "properties" : { @@ -7139,6 +7157,15 @@ margin-bottom: 20px;
  • devicesetDeviceSettingsPut
  • +
  • + devicesetDeviceSubsystemRunDelete +
  • +
  • + devicesetDeviceSubsystemRunGet +
  • +
  • + devicesetDeviceSubsystemRunPost +
  • devicesetFocusPatch
  • @@ -7209,6 +7236,18 @@ margin-bottom: 20px;
  • instanceDevices
  • +
  • + instanceLimeRFEConfigGet +
  • +
  • + instanceLimeRFEConfigPut +
  • +
  • + instanceLimeRFERunPut +
  • +
  • + instanceLimeRFESerialGet +
  • instanceLocationGet
  • @@ -7258,7 +7297,7 @@ margin-bottom: 20px;