From 7a46d6c079f1a9888b251f9f5fca5497eccbc221 Mon Sep 17 00:00:00 2001 From: f4exb Date: Fri, 7 Aug 2020 07:58:46 +0200 Subject: [PATCH] FileSink: REST API source files --- .../webapi/doc/swagger/include/FileSink.yaml | 94 +++++++++++++++++++ .../api/swagger/include/ChannelActions.yaml | 2 + .../api/swagger/include/ChannelSettings.yaml | 2 + .../api/swagger/include/FileSink.yaml | 94 +++++++++++++++++++ swagger/sdrangel/api/swagger/swagger.yaml | 2 + 5 files changed, 194 insertions(+) create mode 100644 sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml create mode 100644 swagger/sdrangel/api/swagger/include/FileSink.yaml diff --git a/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml b/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml new file mode 100644 index 000000000..1f8f1423e --- /dev/null +++ b/sdrbase/resources/webapi/doc/swagger/include/FileSink.yaml @@ -0,0 +1,94 @@ +FileSinkSettings: + description: FileSink + properties: + inputFrequencyOffset: + type: integer + fileRecordName: + type: string + description: full path of the reference file + rgbColor: + type: integer + title: + type: string + log2Decim: + type: integer + spectrumSquelchMode: + type: integer + description: > + Spectrum squelch system + * 0 - deactivated + * 1 - activated + spectrumSquelch: + type: number + format: float + description: Squelch level in power dB + preRecordTime: + type: integer + description: Number of seconds to record before recording is triggered (manual or squelch) + squelchPostRecordTime: + type: integer + description: Number of seconds to record after spectrum squelch cloeses + squelchRecordingEnable: + type: integer + description: > + Automatic recording triggered by spectrum squalch + * 0 - disabled + * 1 - enabled + 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 + +FileSinkReport: + description: FileSink + properties: + spectrumSquelch: + type: integer + description: > + Spectrum squelch status + * 0 - closed + * 1 - open + spectrumMax: + type: number + format: float + description: Current spectrum max in squared magnitude (power) + sinkSampleRate: + type: integer + channelSampleRate: + type: integer + recording: + type: integer + description: > + Recording status + * 0 - not recording + * 1 - recording + recordTimeMs: + type: integer + description: Total recording time in milliseconds + recordSize: + type: integer + format: int64 + description: Total recording data size in bytes + recordCaptures: + type: integer + description: Number of record flles not including current if recording + +FileSinkActions: + description: FileSink + properties: + record: + type: integer + description: > + Record action + * 0 - stop recording + * 1 - start recording diff --git a/swagger/sdrangel/api/swagger/include/ChannelActions.yaml b/swagger/sdrangel/api/swagger/include/ChannelActions.yaml index dcc6496dd..bb5ed9c5a 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelActions.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelActions.yaml @@ -17,5 +17,7 @@ ChannelActions: originatorChannelIndex: description: Optional for reverse API. This is the channel index from where the message comes from. type: integer + FileSinkActions: + $ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkActions" FileSourceActions: $ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceActions" diff --git a/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml b/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml index fa36107b9..cd2fca850 100644 --- a/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml +++ b/swagger/sdrangel/api/swagger/include/ChannelSettings.yaml @@ -33,6 +33,8 @@ ChannelSettings: $ref: "http://swgserver:8081/api/swagger/include/DATVDemod.yaml#/DATVDemodSettings" DSDDemodSettings: $ref: "http://swgserver:8081/api/swagger/include/DSDDemod.yaml#/DSDDemodSettings" + FileSinkSettings: + $ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkSettings" FileSourceSettings: $ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceSettings" FreeDVDemodSettings: diff --git a/swagger/sdrangel/api/swagger/include/FileSink.yaml b/swagger/sdrangel/api/swagger/include/FileSink.yaml new file mode 100644 index 000000000..1f8f1423e --- /dev/null +++ b/swagger/sdrangel/api/swagger/include/FileSink.yaml @@ -0,0 +1,94 @@ +FileSinkSettings: + description: FileSink + properties: + inputFrequencyOffset: + type: integer + fileRecordName: + type: string + description: full path of the reference file + rgbColor: + type: integer + title: + type: string + log2Decim: + type: integer + spectrumSquelchMode: + type: integer + description: > + Spectrum squelch system + * 0 - deactivated + * 1 - activated + spectrumSquelch: + type: number + format: float + description: Squelch level in power dB + preRecordTime: + type: integer + description: Number of seconds to record before recording is triggered (manual or squelch) + squelchPostRecordTime: + type: integer + description: Number of seconds to record after spectrum squelch cloeses + squelchRecordingEnable: + type: integer + description: > + Automatic recording triggered by spectrum squalch + * 0 - disabled + * 1 - enabled + 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 + +FileSinkReport: + description: FileSink + properties: + spectrumSquelch: + type: integer + description: > + Spectrum squelch status + * 0 - closed + * 1 - open + spectrumMax: + type: number + format: float + description: Current spectrum max in squared magnitude (power) + sinkSampleRate: + type: integer + channelSampleRate: + type: integer + recording: + type: integer + description: > + Recording status + * 0 - not recording + * 1 - recording + recordTimeMs: + type: integer + description: Total recording time in milliseconds + recordSize: + type: integer + format: int64 + description: Total recording data size in bytes + recordCaptures: + type: integer + description: Number of record flles not including current if recording + +FileSinkActions: + description: FileSink + properties: + record: + type: integer + description: > + Record action + * 0 - stop recording + * 1 - start recording diff --git a/swagger/sdrangel/api/swagger/swagger.yaml b/swagger/sdrangel/api/swagger/swagger.yaml index 0a90fb5eb..24438c16d 100644 --- a/swagger/sdrangel/api/swagger/swagger.yaml +++ b/swagger/sdrangel/api/swagger/swagger.yaml @@ -2342,6 +2342,8 @@ definitions: $ref: "http://swgserver:8081/api/swagger/include/BFMDemod.yaml#/BFMDemodReport" DSDDemodReport: $ref: "http://swgserver:8081/api/swagger/include/DSDDemod.yaml#/DSDDemodReport" + FileSinkReport: + $ref: "http://swgserver:8081/api/swagger/include/FileSink.yaml#/FileSinkReport" FileSourceReport: $ref: "http://swgserver:8081/api/swagger/include/FileSource.yaml#/FileSourceReport" FreeDVDemodReport: