jfjoch_broker: Allow to query image pusher status
Some checks failed
Build Packages / build:rpm (ubuntu2204) (push) Has been cancelled
Build Packages / build:rpm (ubuntu2404) (push) Has been cancelled
Build Packages / Generate python client (push) Has been cancelled
Build Packages / Build documentation (push) Has been cancelled
Build Packages / Unit tests (push) Has been cancelled
Build Packages / Create release (push) Has been cancelled
Build Packages / build:rpm (rocky9_nocuda) (push) Has started running
Build Packages / build:rpm (rocky8_nocuda) (push) Has been cancelled
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Has been cancelled
Build Packages / build:rpm (rocky9_sls9) (push) Has been cancelled
Build Packages / build:rpm (rocky8_sls9) (push) Has been cancelled
Build Packages / build:rpm (rocky8) (push) Has been cancelled
Build Packages / build:rpm (rocky9) (push) Has been cancelled
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Has been cancelled

This commit is contained in:
2026-03-05 12:26:48 +01:00
parent 4ede10aa6a
commit 343e9a1172
34 changed files with 559 additions and 79 deletions

View File

@@ -145,6 +145,7 @@ Class | Method | HTTP request | Description
*DefaultApi* | [**image_buffer_image_tiff_get**](docs/DefaultApi.md#image_buffer_image_tiff_get) | **GET** /image_buffer/image.tiff | Get preview image in TIFF format
*DefaultApi* | [**image_buffer_start_cbor_get**](docs/DefaultApi.md#image_buffer_start_cbor_get) | **GET** /image_buffer/start.cbor | Get Start message in CBOR format
*DefaultApi* | [**image_buffer_status_get**](docs/DefaultApi.md#image_buffer_status_get) | **GET** /image_buffer/status | Get status of the image buffers
*DefaultApi* | [**image_pusher_status_get**](docs/DefaultApi.md#image_pusher_status_get) | **GET** /image_pusher/status | Get status of image pusher
*DefaultApi* | [**initialize_post**](docs/DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
*DefaultApi* | [**pedestal_post**](docs/DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
*DefaultApi* | [**preview_pedestal_tiff_get**](docs/DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
@@ -191,6 +192,7 @@ Class | Method | HTTP request | Description
- [GridScan](docs/GridScan.md)
- [ImageBufferStatus](docs/ImageBufferStatus.md)
- [ImageFormatSettings](docs/ImageFormatSettings.md)
- [ImagePusherStatus](docs/ImagePusherStatus.md)
- [ImagePusherType](docs/ImagePusherType.md)
- [IndexingAlgorithm](docs/IndexingAlgorithm.md)
- [IndexingSettings](docs/IndexingSettings.md)

View File

@@ -11,7 +11,6 @@ Name | Type | Description | Notes
**message_severity** | **str** | Level of the message to display | [optional] [default to 'error']
**gpu_count** | **int** | Number of installed GPUs | [optional]
**broker_version** | **str** | Version of the jfjoch_broker | [optional]
**connected_writers** | **int** | Number of connected writers For ZeroMQ image socket: number is constant For TCP/IP image socket: number is updated live during operation | [optional]
## Example

View File

@@ -48,6 +48,7 @@ Method | HTTP request | Description
[**image_buffer_image_tiff_get**](DefaultApi.md#image_buffer_image_tiff_get) | **GET** /image_buffer/image.tiff | Get preview image in TIFF format
[**image_buffer_start_cbor_get**](DefaultApi.md#image_buffer_start_cbor_get) | **GET** /image_buffer/start.cbor | Get Start message in CBOR format
[**image_buffer_status_get**](DefaultApi.md#image_buffer_status_get) | **GET** /image_buffer/status | Get status of the image buffers
[**image_pusher_status_get**](DefaultApi.md#image_pusher_status_get) | **GET** /image_pusher/status | Get status of image pusher
[**initialize_post**](DefaultApi.md#initialize_post) | **POST** /initialize | Initialize detector and data acquisition
[**pedestal_post**](DefaultApi.md#pedestal_post) | **POST** /pedestal | Collect dark current for the detector
[**preview_pedestal_tiff_get**](DefaultApi.md#preview_pedestal_tiff_get) | **GET** /preview/pedestal.tiff | Get pedestal in TIFF format
@@ -3007,6 +3008,69 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **image_pusher_status_get**
> ImagePusherStatus image_pusher_status_get()
Get status of image pusher
### Example
```python
import jfjoch_client
from jfjoch_client.models.image_pusher_status import ImagePusherStatus
from jfjoch_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:5232
# See configuration.py for a list of all supported configuration parameters.
configuration = jfjoch_client.Configuration(
host = "http://localhost:5232"
)
# Enter a context with an instance of the API client
with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Get status of image pusher
api_response = api_instance.image_pusher_status_get()
print("The response of DefaultApi->image_pusher_status_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->image_pusher_status_get: %s\n" % e)
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ImagePusherStatus**](ImagePusherStatus.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, text/plain
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Everything OK | - |
**500** | Error encountered when trying to read status | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **initialize_post**
> initialize_post()

View File

@@ -0,0 +1,32 @@
# ImagePusherStatus
Informs about status of the image pusher.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**pusher_type** | [**ImagePusherType**](ImagePusherType.md) | | [default to ImagePusherType.NONE]
**addr** | **List[str]** | List of addresses of image pushers. For HDF5 socket - no addresses will be returned. For ZeroMQ - list of addresses for each socket will be provided. For TCP/IP - single address to connect all writers will be provided. |
**connected_writers** | **int** | Number of connected writers For ZeroMQ image socket: number is constant For TCP/IP image socket: number is updated live during operation |
## Example
```python
from jfjoch_client.models.image_pusher_status import ImagePusherStatus
# TODO update the JSON string below
json = "{}"
# create an instance of ImagePusherStatus from a JSON string
image_pusher_status_instance = ImagePusherStatus.from_json(json)
# print the JSON string representation of the object
print(ImagePusherStatus.to_json())
# convert the object into a dict
image_pusher_status_dict = image_pusher_status_instance.to_dict()
# create an instance of ImagePusherStatus from a dict
image_pusher_status_from_dict = ImagePusherStatus.from_dict(image_pusher_status_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)