diff --git a/swagger/sdrangel/api/swagger/swagger.yaml b/swagger/sdrangel/api/swagger/swagger.yaml index 37b56f6f4..9e0a1f53c 100644 --- a/swagger/sdrangel/api/swagger/swagger.yaml +++ b/swagger/sdrangel/api/swagger/swagger.yaml @@ -1252,6 +1252,123 @@ paths: "501": $ref: "#/responses/Response_501" + /sdrangel/deviceset/{deviceSetIndex}/spectrum/report: + x-swagger-router-controller: deviceset + get: + description: Get the latest main spectrum measurement results + operationId: devicesetSpectrumReportGet + tags: + - DeviceSet + parameters: + - in: path + name: deviceSetIndex + type: integer + required: true + description: Index of device set in the device set list + responses: + "200": + description: On success return the results of the selected measurement + schema: + $ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrumReport" + "404": + description: Invalid index + schema: + $ref: "#/definitions/ErrorResponse" + "500": + $ref: "#/responses/Response_500" + "501": + $ref: "#/responses/Response_501" + + /sdrangel/deviceset/{deviceSetIndex}/spectrum/actions: + x-swagger-router-controller: deviceset + post: + description: post an action or actions on the main spectrum + operationId: devicesetSpectrumActionsPost + tags: + - DeviceSet + parameters: + - in: path + name: deviceSetIndex + type: integer + required: true + description: Index of device set in the device set list + - name: body + in: body + description: Action(s) to apply to the main spectrum + required: true + schema: + $ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/SpectrumActions" + responses: + "202": + description: Message to perform action was sent successfully + schema: + $ref: "#/definitions/SuccessResponse" + "400": + description: Unknown action, no action given, or an action that needs a spectrum display + schema: + $ref: "#/definitions/ErrorResponse" + "404": + description: Invalid index + schema: + $ref: "#/definitions/ErrorResponse" + "500": + $ref: "#/responses/Response_500" + "501": + $ref: "#/responses/Response_501" + + /sdrangel/deviceset/{deviceSetIndex}/spectrum/data: + x-swagger-router-controller: deviceset + get: + description: Get the main spectrum power values, reduced to a number of bins + operationId: devicesetSpectrumDataGet + tags: + - DeviceSet + parameters: + - in: path + name: deviceSetIndex + type: integer + required: true + description: Index of device set in the device set list + - name: bins + in: query + description: Number of bins to return, 1 to 4096 (default 128). The spectrum is grouped down to this many + required: false + type: integer + - name: startFrequency + in: query + description: Lowest frequency to return in Hz. Default is the start of the spectrum + required: false + type: integer + format: int64 + - name: stopFrequency + in: query + description: Highest frequency to return in Hz. Default is the end of the spectrum + required: false + type: integer + format: int64 + - name: reduce + in: query + description: How several bins are combined into one, max or mean (default max) + required: false + type: string + responses: + "200": + description: On success return the reduced spectrum + schema: + $ref: "http://swgserver:8081/api/swagger/include/GLSpectrum.yaml#/GLSpectrumData" + "400": + description: Invalid bins, frequency range or reduction + schema: + $ref: "#/definitions/ErrorResponse" + "404": + description: Invalid index + schema: + $ref: "#/definitions/ErrorResponse" + "500": + $ref: "#/responses/Response_500" + "501": + $ref: "#/responses/Response_501" + /sdrangel/deviceset/{deviceSetIndex}/spectrum/server: x-swagger-router-controller: deviceset get: