Python client and CLI tools for interacting with Standard DAQ.
Install with Pip:
pip install std_daq_client
The only dependency is the requests library.
from std_daq_client import StdDaqClient
rest_server_url = 'http://localhost:5000'
client = StdDaqClient(url_base=rest_server_url)
client.get_status()
client.get_config()
client.set_config(daq_config={'bit_depth': 16, 'writer_user_id': 0})
client.get_logs(n_last_logs=5)
client.get_stats()
client.get_deployment_status()
client.start_writer_async({'output_file': '/tmp/output.h5', 'n_images': 10})
client.start_writer_sync({'output_file': '/tmp/output.h5', 'n_images': 10})
client.stop_writer()
All CLI tools accept the --url_base parameter used to point the client to the correct API base url. Contact your DAQ integrator to find out this address.
System state is available also on Redis in the form of Redis Streams. Each Redis instance represents a DAQ instance. Contact your DAQ integrator to find out the host and port on which Redis is running - generally this should be the same network interface as the REST api, on the default Redis port.
Currently available streams:
The JSON object encoded in UTF-8 is stored in the b'json' field.
Example on how to access the status stream:
import json
from redis.client import Redis
redis = Redis()
# Start listening for new statuses.
last_status_id = '$'
while True:
# Block until new status is available.
response = redis.xread({"daq:writer_status": last_status_id}, block=0)
# Decode status from 'json' field.
last_status_id, status = response[0][0], json.loads(response[0][1][b'json'])
print(status)
Every call returns a dictionary with some values inside. In case of state or logic problems with your request, an instance of StdDaqAdminException will be thrown. For everything else an instance of RuntimeError will be raised.
Below we will describe the different returned objects and describe their fields.
Represents the current state of the DAQ with the current state of the last acquisition (either completed or still running).
This object is returned by:
{
"acquisition": { // Stats about the currently running or last finished acquisition
"info": { // User request that generated this acquisition
"n_images": 100, // Number of images
"output_file": "/tmp/test.h5", // Output file
"run_id": 1684930336122153839 // Run_id (request timestamp by default, generated by the API)
},
"message": "Completed.", // User displayable message from the writer.
"state": "FINISHED", // State of the acquisition.
"stats": {
"n_write_completed": 100, // Number of completed writes
"n_write_requested": 100, // Number of requested writers from the driver
"start_time": 1684930336.1252322, // Start time of request as seen by writer driver
"stop_time": 1684930345.2723851 // Stop time of request as seen by writer driver
}
},
"state": "READY" // State of the writer: READY (to write), WRITING
}
The path will always be an absolute path or null (when no acquisition happened on the system yet).
| State | Description |
|---|---|
| READY | DAQ is ready to start writing. |
| WRITING | DAQ is writing at the moment. Wait for it to finish or call Stop to interrupt. |
| UNKNOWN | The DAQ is in an unknown state (usually after reboot). Call Stop to reset. |
When the state of the writer is READY, the writer can receive the next write request. Otherwise, the request will be rejected. A Stop request can always be sent and will reset the writer status to READY (use the Stop request when the writer state is UNKNOWN to try to reset it).
| State | Description |
|---|---|
| FINISHED | The acquisition has finished successfully. |
| FAILED | The acquisition has failed. |
| WRITING | Currently receiving and writing images. |
| WAITING_IMAGES | Writer is ready and waiting for images. |
| ACQUIRING_IMAGES | DAQ is receiving images but writer is not writing them yet. |
| FLUSHING_IMAGES | All needed images acquired, writer is flushing the buffer. |
In case of a FAILED acquisition, the acquisition/message will be set to the error that caused it to fail.
| Message | Description |
|---|---|
| Completed. | The acquisition has written all the images. |
| Interrupted. | The acquisition was interrupted before it acquired all the images. |
| ERROR:... | An error happened during the acquisition. |
In case of ERROR, the message will reflect what caused the acquisition to fail.
All timestamps are Unix timestamps generated on the DAQ machine and are not really correlated with external sources (clock skew can be up to 100s of milliseconds). In particular cases any of the timestamp can be null (when no acquisition happened on the system yet).
Represents the DAQ configuration that is loaded by all services. This configuration describes the data source and the way the data source is processed by stream processors.
This object is returned by:
{
"bit_depth": 16, // Bit depth of the image. Supported values are dependent on the detector.
"detector_name": "EG9M", // Name of the detector. Must be unique, used as internal DAQ identifier.
"detector_type": "eiger", // Type of detector. Currently supported: eiger, jungfrau, gigafrost, bsread
"image_pixel_height": 3264, // Assembled image height in pixels, including gap pixels.
"image_pixel_width": 3106, // Assembled image width in pixels, including gap pixels.
"n_modules": 2, // Number of modules to assemble.
"start_udp_port": 50000, // Start UDP port where the detector is streaming modules.
"writer_user_id": 12345, // User_id under which the writer will create and write files.
"module_positions": { // Dictionary with mapping between module number -> image position.
"0": [0, 3263, 513, 3008 ], // Format: [start_x, start_y, end_x, end_y]
"1": [516, 3263, 1029, 3008 ]
}
}
Must be an integer representing the user_id. For e-accounts, it's simply the number after the 'e'. For example e12345 has a user_id of 12345. For other users you can find out their user_id by running:
id -u [user_name]
Possible values: eiger, gigafrost, jungfrau, bsread
This is not something you usually change without hardware changes on the beamline.
Current data flow statistics of the DAQ.
This object is returned by:
{
"detector": { // Detector statistics
"bytes_per_second": 0.0, // Throughput
"images_per_second": 0.0 // Frequency
},
"writer": { // Writer statistics
"bytes_per_second": 0.0, // Throughput
"images_per_second": 0.0 // Frequency
}
}
The statistics is refreshed and aggregated with 1 Hz.
Log of all acquisitions that produced a file. It is a list of acquisition objects in reverse chronological order.
This object is returned by:
[
{
"info": { // User request that generated this acquisition
"n_images": 100, // Number of images
"output_file": "/tmp/test.h5", // Output file
"run_id": 1684930336122153839 // Run_id (request timestamp by default, generated by the API)
},
"message": "Completed.", // User displayable message from the writer.
"state": "FINISHED", // Final state of the acquisition.
"stats": { // Stats of the acquisition
"n_write_completed": 100, // Number of completed writes
"n_write_requested": 100, // Number of requested writers
"start_time": 1684930336.1252322, // Start time of request as seen by writer driver
"stop_time": 1684930345.2723851 // Stop time of request as seen by writer driver
}
},
{ ... }
]
In case the file could not be created or another error occurred this will not be logged in the acquisition log.
FAQs
Python client for standard-daq
We found that std-daq-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.