diff --git a/sdrbase/resources/webapi.qrc b/sdrbase/resources/webapi.qrc index 2e2ae2aaf..65a81c6f0 100644 --- a/sdrbase/resources/webapi.qrc +++ b/sdrbase/resources/webapi.qrc @@ -71,6 +71,7 @@ webapi/doc/swagger/include/NoiseFigure.yaml webapi/doc/swagger/include/PacketDemod.yaml webapi/doc/swagger/include/PacketMod.yaml + webapi/doc/swagger/include/PagerDemod.yaml webapi/doc/swagger/include/Perseus.yaml webapi/doc/swagger/include/PERTester.yaml webapi/doc/swagger/include/PlutoSdr.yaml diff --git a/sdrbase/resources/webapi/doc/html2/index.html b/sdrbase/resources/webapi/doc/html2/index.html index 8e73c62d9..db36abac3 100644 --- a/sdrbase/resources/webapi/doc/html2/index.html +++ b/sdrbase/resources/webapi/doc/html2/index.html @@ -3081,6 +3081,9 @@ margin-bottom: 20px; "PacketModReport" : { "$ref" : "#/definitions/PacketModReport" }, + "PagerDemodReport" : { + "$ref" : "#/definitions/PagerDemodReport" + }, "SigMFFileSinkReport" : { "$ref" : "#/definitions/SigMFFileSinkReport" }, @@ -3221,6 +3224,9 @@ margin-bottom: 20px; "PacketModSettings" : { "$ref" : "#/definitions/PacketModSettings" }, + "PagerDemodSettings" : { + "$ref" : "#/definitions/PagerDemodSettings" + }, "RadioClockSettings" : { "$ref" : "#/definitions/RadioClockSettings" }, @@ -8071,6 +8077,86 @@ margin-bottom: 20px; } }, "description" : "PacketMod" +}; + defs.PagerDemodReport = { + "properties" : { + "channelPowerDB" : { + "type" : "number", + "format" : "float", + "description" : "power received in channel (dB)" + }, + "channelSampleRate" : { + "type" : "integer" + } + }, + "description" : "PagerDemod" +}; + defs.PagerDemodSettings = { + "properties" : { + "baud" : { + "type" : "integer", + "description" : "Baud rate" + }, + "inputFrequencyOffset" : { + "type" : "integer", + "format" : "int64" + }, + "rfBandwidth" : { + "type" : "number", + "format" : "float" + }, + "fmDeviation" : { + "type" : "number", + "format" : "float" + }, + "correlationThreshold" : { + "type" : "number", + "format" : "float" + }, + "udpEnabled" : { + "type" : "integer", + "description" : "Whether to forward received messages to specified UDP port" + }, + "udpAddress" : { + "type" : "string", + "description" : "UDP address to forward received messages to" + }, + "udpPort" : { + "type" : "integer", + "description" : "UDP port to forward received messages to" + }, + "udpFormat" : { + "type" : "integer", + "description" : "0 for binary, 1 for NMEA" + }, + "rgbColor" : { + "type" : "integer" + }, + "title" : { + "type" : "string" + }, + "streamIndex" : { + "type" : "integer", + "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + } + }, + "description" : "PagerDemod" }; defs.PerseusReport = { "properties" : { @@ -9774,6 +9860,76 @@ margin-bottom: 20px; } }, "description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device" +}; + defs.SatelliteDeviceSettings = { + "properties" : { + "deviceSet" : { + "type" : "string", + "description" : "Name of the device set (E.g. R0)" + }, + "presetGroup" : { + "type" : "string", + "description" : "Group for preset to load on AOS" + }, + "presetFrequency" : { + "type" : "integer", + "format" : "int64", + "description" : "Frequency of preset to load on AOS" + }, + "presetDescription" : { + "type" : "string", + "description" : "Description of preset to load on AOS" + }, + "doppler" : { + "type" : "array", + "description" : "Whether to apply doppler correction to each channel (1 for yes, 0 for no)", + "items" : { + "type" : "integer" + } + }, + "startOnAOS" : { + "type" : "integer", + "description" : "Start acquisition on AOS (1 for yes, 0 for no)" + }, + "stopOnLOS" : { + "type" : "integer", + "description" : "Stop acquisition on LOS (1 for yes, 0 for no)" + }, + "startStopFileSinks" : { + "type" : "integer", + "description" : "Start/stop file sinks on AOS/LOS (1 for yes, 0 for no)" + }, + "frequency" : { + "type" : "integer", + "format" : "int64", + "description" : "Frequency to override in preset" + }, + "aosCommand" : { + "type" : "string", + "description" : "Command to execute on AOS" + }, + "losCommand" : { + "type" : "string", + "description" : "Command to execute on LOS" + } + }, + "description" : "Device set settings" +}; + defs.SatelliteDeviceSettingsList = { + "properties" : { + "satellite" : { + "type" : "string", + "description" : "Name of the satellite" + }, + "deviceSettings" : { + "type" : "array", + "description" : "Device set settings", + "items" : { + "$ref" : "#/definitions/SatelliteDeviceSettings" + } + } + }, + "description" : "List of device set settings for a satellite" }; defs.SatelliteTrackerSettings = { "properties" : { @@ -9896,6 +10052,13 @@ margin-bottom: 20px; "type" : "string", "description" : "Command to execute on LOS for all satellites" }, + "deviceSettings" : { + "type" : "array", + "description" : "Device set settings to apply on AOS / LOS", + "items" : { + "$ref" : "#/definitions/SatelliteDeviceSettingsList" + } + }, "title" : { "type" : "string" }, @@ -46842,7 +47005,7 @@ except ApiException as e:
- Generated 2021-06-27T09:52:10.238+02:00 + Generated 2021-07-12T19:39:02.669+02:00
diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml index e88297ad3..c224609ac 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelReport.yaml @@ -59,6 +59,8 @@ ChannelReport: $ref: "/doc/swagger/include/RemoteSource.yaml#/RemoteSourceReport" PacketModReport: $ref: "/doc/swagger/include/PacketMod.yaml#/PacketModReport" + PagerDemodReport: + $ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodReport" SigMFFileSinkReport: $ref: "/doc/swagger/include/SigMFFileSink.yaml#/SigMFFileSinkReport" SSBModReport: diff --git a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml index 0596bb494..7550dbda5 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/ChannelSettings.yaml @@ -79,6 +79,8 @@ ChannelSettings: $ref: "/doc/swagger/include/PacketDemod.yaml#/PacketDemodSettings" PacketModSettings: $ref: "/doc/swagger/include/PacketMod.yaml#/PacketModSettings" + PagerDemodSettings: + $ref: "/doc/swagger/include/PagerDemod.yaml#/PagerDemodSettings" RadioClockSettings: $ref: "/doc/swagger/include/RadioClock.yaml#/RadioClockSettings" RemoteSinkSettings: diff --git a/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml b/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml new file mode 100644 index 000000000..673520276 --- /dev/null +++ b/sdrbase/resources/webapi/doc/swagger/include/PagerDemod.yaml @@ -0,0 +1,58 @@ +PagerDemodSettings: + description: PagerDemod + properties: + baud: + description: "Baud rate" + type: integer + inputFrequencyOffset: + type: integer + format: int64 + rfBandwidth: + type: number + format: float + fmDeviation: + type: number + format: float + correlationThreshold: + type: number + format: float + udpEnabled: + description: "Whether to forward received messages to specified UDP port" + type: integer + udpAddress: + description: "UDP address to forward received messages to" + type: string + udpPort: + description: "UDP port to forward received messages to" + type: integer + udpFormat: + description: "0 for binary, 1 for NMEA" + type: integer + rgbColor: + type: integer + title: + type: string + streamIndex: + description: MIMO channel. Not relevant when connected to SI (single Rx). + type: integer + useReverseAPI: + description: Synchronize with reverse API (1 for yes, 0 for no) + type: integer + reverseAPIAddress: + type: string + reverseAPIPort: + type: integer + reverseAPIDeviceIndex: + type: integer + reverseAPIChannelIndex: + type: integer + +PagerDemodReport: + description: PagerDemod + properties: + channelPowerDB: + description: power received in channel (dB) + type: number + format: float + channelSampleRate: + type: integer diff --git a/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml b/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml index 6d7636b2d..801812462 100644 --- a/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml +++ b/sdrbase/resources/webapi/doc/swagger/include/SatelliteTracker.yaml @@ -92,6 +92,11 @@ SatelliteTrackerSettings: losCommand: description: "Command to execute on LOS for all satellites" type: string + deviceSettings: + description: "Device set settings to apply on AOS / LOS" + type: array + items: + $ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteDeviceSettingsList" title: type: string rgbColor: @@ -107,3 +112,56 @@ SatelliteTrackerSettings: type: integer reverseAPIChannelIndex: type: integer + +SatelliteDeviceSettingsList: + description: "List of device set settings for a satellite" + properties: + satellite: + description: "Name of the satellite" + type: string + deviceSettings: + description: "Device set settings" + type: array + items: + $ref: "/doc/swagger/include/SatelliteTracker.yaml#/SatelliteDeviceSettings" + +SatelliteDeviceSettings: + description: "Device set settings" + properties: + deviceSet: + description: "Name of the device set (E.g. R0)" + type: string + presetGroup: + description: "Group for preset to load on AOS" + type: string + presetFrequency: + description: "Frequency of preset to load on AOS" + type: integer + format: int64 + presetDescription: + description: "Description of preset to load on AOS" + type: string + doppler: + description: "Whether to apply doppler correction to each channel (1 for yes, 0 for no)" + type: array + items: + type: integer + startOnAOS: + description: "Start acquisition on AOS (1 for yes, 0 for no)" + type: integer + stopOnLOS: + description: "Stop acquisition on LOS (1 for yes, 0 for no)" + type: integer + startStopFileSinks: + description: "Start/stop file sinks on AOS/LOS (1 for yes, 0 for no)" + type: integer + frequency: + description: "Frequency to override in preset" + type: integer + format: int64 + aosCommand: + description: "Command to execute on AOS" + type: string + losCommand: + description: "Command to execute on LOS" + type: string diff --git a/swagger/sdrangel/code/html2/index.html b/swagger/sdrangel/code/html2/index.html index 8e73c62d9..db36abac3 100644 --- a/swagger/sdrangel/code/html2/index.html +++ b/swagger/sdrangel/code/html2/index.html @@ -3081,6 +3081,9 @@ margin-bottom: 20px; "PacketModReport" : { "$ref" : "#/definitions/PacketModReport" }, + "PagerDemodReport" : { + "$ref" : "#/definitions/PagerDemodReport" + }, "SigMFFileSinkReport" : { "$ref" : "#/definitions/SigMFFileSinkReport" }, @@ -3221,6 +3224,9 @@ margin-bottom: 20px; "PacketModSettings" : { "$ref" : "#/definitions/PacketModSettings" }, + "PagerDemodSettings" : { + "$ref" : "#/definitions/PagerDemodSettings" + }, "RadioClockSettings" : { "$ref" : "#/definitions/RadioClockSettings" }, @@ -8071,6 +8077,86 @@ margin-bottom: 20px; } }, "description" : "PacketMod" +}; + defs.PagerDemodReport = { + "properties" : { + "channelPowerDB" : { + "type" : "number", + "format" : "float", + "description" : "power received in channel (dB)" + }, + "channelSampleRate" : { + "type" : "integer" + } + }, + "description" : "PagerDemod" +}; + defs.PagerDemodSettings = { + "properties" : { + "baud" : { + "type" : "integer", + "description" : "Baud rate" + }, + "inputFrequencyOffset" : { + "type" : "integer", + "format" : "int64" + }, + "rfBandwidth" : { + "type" : "number", + "format" : "float" + }, + "fmDeviation" : { + "type" : "number", + "format" : "float" + }, + "correlationThreshold" : { + "type" : "number", + "format" : "float" + }, + "udpEnabled" : { + "type" : "integer", + "description" : "Whether to forward received messages to specified UDP port" + }, + "udpAddress" : { + "type" : "string", + "description" : "UDP address to forward received messages to" + }, + "udpPort" : { + "type" : "integer", + "description" : "UDP port to forward received messages to" + }, + "udpFormat" : { + "type" : "integer", + "description" : "0 for binary, 1 for NMEA" + }, + "rgbColor" : { + "type" : "integer" + }, + "title" : { + "type" : "string" + }, + "streamIndex" : { + "type" : "integer", + "description" : "MIMO channel. Not relevant when connected to SI (single Rx)." + }, + "useReverseAPI" : { + "type" : "integer", + "description" : "Synchronize with reverse API (1 for yes, 0 for no)" + }, + "reverseAPIAddress" : { + "type" : "string" + }, + "reverseAPIPort" : { + "type" : "integer" + }, + "reverseAPIDeviceIndex" : { + "type" : "integer" + }, + "reverseAPIChannelIndex" : { + "type" : "integer" + } + }, + "description" : "PagerDemod" }; defs.PerseusReport = { "properties" : { @@ -9774,6 +9860,76 @@ margin-bottom: 20px; } }, "description" : "Information about a logical device available from an attached hardware device that can be used as a sampling device" +}; + defs.SatelliteDeviceSettings = { + "properties" : { + "deviceSet" : { + "type" : "string", + "description" : "Name of the device set (E.g. R0)" + }, + "presetGroup" : { + "type" : "string", + "description" : "Group for preset to load on AOS" + }, + "presetFrequency" : { + "type" : "integer", + "format" : "int64", + "description" : "Frequency of preset to load on AOS" + }, + "presetDescription" : { + "type" : "string", + "description" : "Description of preset to load on AOS" + }, + "doppler" : { + "type" : "array", + "description" : "Whether to apply doppler correction to each channel (1 for yes, 0 for no)", + "items" : { + "type" : "integer" + } + }, + "startOnAOS" : { + "type" : "integer", + "description" : "Start acquisition on AOS (1 for yes, 0 for no)" + }, + "stopOnLOS" : { + "type" : "integer", + "description" : "Stop acquisition on LOS (1 for yes, 0 for no)" + }, + "startStopFileSinks" : { + "type" : "integer", + "description" : "Start/stop file sinks on AOS/LOS (1 for yes, 0 for no)" + }, + "frequency" : { + "type" : "integer", + "format" : "int64", + "description" : "Frequency to override in preset" + }, + "aosCommand" : { + "type" : "string", + "description" : "Command to execute on AOS" + }, + "losCommand" : { + "type" : "string", + "description" : "Command to execute on LOS" + } + }, + "description" : "Device set settings" +}; + defs.SatelliteDeviceSettingsList = { + "properties" : { + "satellite" : { + "type" : "string", + "description" : "Name of the satellite" + }, + "deviceSettings" : { + "type" : "array", + "description" : "Device set settings", + "items" : { + "$ref" : "#/definitions/SatelliteDeviceSettings" + } + } + }, + "description" : "List of device set settings for a satellite" }; defs.SatelliteTrackerSettings = { "properties" : { @@ -9896,6 +10052,13 @@ margin-bottom: 20px; "type" : "string", "description" : "Command to execute on LOS for all satellites" }, + "deviceSettings" : { + "type" : "array", + "description" : "Device set settings to apply on AOS / LOS", + "items" : { + "$ref" : "#/definitions/SatelliteDeviceSettingsList" + } + }, "title" : { "type" : "string" }, @@ -46842,7 +47005,7 @@ except ApiException as e:
- Generated 2021-06-27T09:52:10.238+02:00 + Generated 2021-07-12T19:39:02.669+02:00