v1.0.0-rc.31

frontend/src/openapi/services/DefaultService.ts

@@ -10,7 +10,9 @@ import type { detector_list } from '../models/detector_list';
 import type { detector_selection } from '../models/detector_selection';
 import type { detector_settings } from '../models/detector_settings';
 import type { detector_status } from '../models/detector_status';
+import type { file_writer_settings } from '../models/file_writer_settings';
 import type { fpga_status } from '../models/fpga_status';
+import type { image_buffer_status } from '../models/image_buffer_status';
 import type { image_format_settings } from '../models/image_format_settings';
 import type { instrument_metadata } from '../models/instrument_metadata';
 import type { jfjoch_statistics } from '../models/jfjoch_statistics';
@@ -219,6 +221,42 @@ export class DefaultService {
         });
     }
 
+    /**
+     * Change file writer settings
+     * This can only be done when detector is `Idle`, `Error` or `Inactive` states.
+     *
+     * @param requestBody
+     * @returns any Everything OK
+     * @throws ApiError
+     */
+    public static putConfigFileWriter(
+        requestBody?: file_writer_settings,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/config/file_writer',
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Input parsing or validation error`,
+                500: `Error within Jungfraujoch code - see output message.`,
+            },
+        });
+    }
+
+    /**
+     * Get file writer settings
+     * Can be done anytime
+     * @returns file_writer_settings Everything OK
+     * @throws ApiError
+     */
+    public static getConfigFileWriter(): CancelablePromise<file_writer_settings> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/config/file_writer',
+        });
+    }
+
     /**
      * Change instrument metadata
      * This can only be done when detector is `Idle`, `Error` or `Inactive` states.
@@ -848,6 +886,31 @@ export class DefaultService {
         });
     }
 
+    /**
+     * Generate maximum pixel value plot
+     * Provides maximum viable pixel value (excluding overloads and error pixels); binning is configurable and maximum of a bin is returned
+     * @param binning Binning of frames for the plot (0 = default binning)
+     * @param compression Enable DEFLATE compression of output data.
+     * @returns plots Response will be by default compressed with deflate algorithm, if using curl, use --compressed option.
+     * @throws ApiError
+     */
+    public static getPlotMaxValue(
+        binning?: number,
+        compression: boolean = true,
+    ): CancelablePromise<plots> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/plot/max_value',
+            query: {
+                'binning': binning,
+                'compression': compression,
+            },
+            errors: {
+                400: `Input parsing or validation error`,
+            },
+        });
+    }
+
     /**
      * Generate ROI sum plot
      * Sum of ROI rectangle per image; binning is configurable
@@ -998,6 +1061,31 @@ export class DefaultService {
         });
     }
 
+    /**
+     * Generate plot with number of received packets per image
+     * Number of collected packets per image; binning is configurable
+     * @param binning Binning of frames for the plot (0 = default binning)
+     * @param compression Enable DEFLATE compression of output data.
+     * @returns plots Everything OK
+     * @throws ApiError
+     */
+    public static getPlotPacketsReceived(
+        binning?: number,
+        compression: boolean = true,
+    ): CancelablePromise<plots> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/plot/packets_received',
+            query: {
+                'binning': binning,
+                'compression': compression,
+            },
+            errors: {
+                400: `Input parsing or validation error`,
+            },
+        });
+    }
+
     /**
      * Generate radial integration profile
      * Generate average radial integration profile
@@ -1269,6 +1357,81 @@ export class DefaultService {
         });
     }
 
+    /**
+     * Get Start message in CBOR format
+     * Contains metadata for a dataset (e.g., experimental geometry)
+     * @returns binary Return start message
+     * @throws ApiError
+     */
+    public static getImageBufferStartCbor(): CancelablePromise<Blob> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/image_buffer/start.cbor',
+            errors: {
+                404: `No measurement so far`,
+                500: `Error within Jungfraujoch code - see output message.`,
+            },
+        });
+    }
+
+    /**
+     * Get image message in CBOR format
+     * Contains full image data and metadata. The image must come from the latest data collection.
+     * @param imageNumber Image number. If omitted, the image with the highest number in the image buffer will be provided.
+     * @returns binary Return image message
+     * @throws ApiError
+     */
+    public static getImageBufferImageCbor(
+        imageNumber?: number,
+    ): CancelablePromise<Blob> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/image_buffer/image.cbor',
+            query: {
+                'image_number': imageNumber,
+            },
+            errors: {
+                404: `Image not present in the buffer - either not yet measured or already replaced by a next image.`,
+                500: `Error within Jungfraujoch code - see output message.`,
+            },
+        });
+    }
+
+    /**
+     * Clear image buffer
+     * Turns off image buffer for the last data collection. Can be only run when Jungfraujoch is not collecting data.
+     * @returns any Done
+     * @throws ApiError
+     */
+    public static postImageBufferClear(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/image_buffer/clear',
+            errors: {
+                500: `Error within Jungfraujoch code - see output message.`,
+            },
+        });
+    }
+
+    /**
+     * Get status of the image buffers
+     * Can be run at any stage of Jungfraujoch operation, including during data collection.
+     * The status of the image buffer is volatile during data collection - if data collection goes for more images than available buffer slots,
+     * then image might be replaced in the buffer between calling /images and /image.cbor.
+     *
+     * @returns image_buffer_status Done
+     * @throws ApiError
+     */
+    public static getImageBufferStatus(): CancelablePromise<image_buffer_status> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/image_buffer/status',
+            errors: {
+                500: `Error within Jungfraujoch code - see output message.`,
+            },
+        });
+    }
+
     /**
      * Get Jungfraujoch version of jfjoch_broker
      * @returns string Release number of Jungfraujoch