ICALEPCS2023 - List of Authors (Wegmann, P.)

Paper	Title	Page
THMBCMO10	SECoP Integration for the Ophyd Hardware Abstraction Layer	1212
	P. Wegmann, K. Kiefer, O. Mannix, L. Rossa, W. Smith HZB, Berlin, Germany E. Faulhaber MLZ, Garching, Germany M. Zolliker PSI, Villigen PSI, Switzerland
	At the core of the Bluesky experimental control ecosystem the ophyd hardware abstraction, a consistent high-level interface layer, is extremely powerful for complex device integration. It introduces the device data model to EPICS and eases integration of alien control protocols. This paper focuses on the integration of the Sample Environment Communication Protocol (SECoP)* into the ophyd layer, enabling seamless incorporation of sample environment hardware into beamline experiments at photon and neutron sources. The SECoP integration was designed to have a simple interface and provide plug-and-play functionality while preserving all metadata and structural information about the controlled hardware. Leveraging the self-describing characteristics of SECoP, automatic generation and configuration of ophyd devices is facilitated upon connecting to a Sample Environment Control (SEC) node. This work builds upon a modified SECoP-client provided by the Frappy framework*, intended for programming SEC nodes with a SECoP interface. This paper presents an overview of the architecture and implementation of the ophyd-SECoP integration and includes examples for better understanding. Klaus Kiefer et al. "An introduction to SECoP - the sample environment communication protocol". **Markus Zolliker and Enrico Faulhaber url: https://github.com/sampleenvironment/Frappy.
	Slides THMBCMO10 [0.596 MB]
	Poster THMBCMO10 [0.809 MB]
DOI •	reference for this paper ※ doi:10.18429/JACoW-ICALEPCS2023-THMBCMO10
About •	Received ※ 05 October 2023 — Accepted ※ 08 December 2023 — Issued ※ 14 December 2023
Cite •	reference for this paper using ※ BibTeX, ※ LaTeX, ※ Text/Word, ※ RIS, ※ EndNote (xml)

THPDP014	SECoP and SECoP@HMC - Metadata in the Sample Environment Communication Protocol	1322
	K. Kiefer, B. Klemke, L. Rossa, P. Wegmann HZB, Berlin, Germany G. Brandl, E. Faulhaber, A. Zaft MLZ, Garching, Germany N. Ekström, A. Pettersson ESS, Lund, Sweden J. Kotanski, T. Kracht DESY, Hamburg, Germany M. Zolliker PSI, Villigen PSI, Switzerland
	Funding: The project SECoP@HMC receives funding by the Helmholtz Association’s Initiative and Networking Fund (IVF). The integration of sample environment (SE) equipment in x-ray and neutron experiments is a complex challenge both in the physical world and in the digital world. Dif-ferent experiment control software offer different interfac-es for the connection of SE equipment. Therefore, it is time-consuming to integrate new SE or to share SE equipment between facilities. To tackle this problem, the International Society for Sample Environment (ISSE, [1]) developed the Sample Environment Communication Protocol (SECoP) to standardize the communication between instrument control software and SE equipment [2]. SECoP offers, on the one hand, a generalized way to control SE equipment. On the other hand, SECoP holds the possibility to transport SE metadata in a well-defined way. In addition, SECoP provides machine readable self-description of the SE equipment which enables a fully automated integration into the instrument control soft-ware and into the processes for data storage. Using SECoP as a common standard for controlling SE equipment and generating SE metadata will save resources and intrinsi-cally give the opportunity to supply standardized and FAIR data compliant SE metadata. It will also supply a well-defined interface for user-provided SE equipment, for equipment shared by different research facilities and for industry. In this article will show how SECoP can help to provide a meaningful and complete set of metadata for SE equipment and we will present SECoP and the SECoP@HMC project supported by the Helmholtz Metadata Collaboration. *K. Kiefer, et al. (2020). An introduction to SECoP - the sample environment communication protocol. Journal of Neutron Research, 21(3-4), pp.181-195
DOI •	reference for this paper ※ doi:10.18429/JACoW-ICALEPCS2023-THPDP014
About •	Received ※ 06 October 2023 — Revised ※ 10 October 2023 — Accepted ※ 14 December 2023 — Issued ※ 22 December 2023
Cite •	reference for this paper using ※ BibTeX, ※ LaTeX, ※ Text/Word, ※ RIS, ※ EndNote (xml)

Paper

Title

Page

SECoP Integration for the Ophyd Hardware Abstraction Layer

1212

P. Wegmann, K. Kiefer, O. Mannix, L. Rossa, W. Smith
HZB, Berlin, Germany
E. Faulhaber
MLZ, Garching, Germany
M. Zolliker
PSI, Villigen PSI, Switzerland

At the core of the Bluesky experimental control ecosystem the ophyd hardware abstraction, a consistent high-level interface layer, is extremely powerful for complex device integration. It introduces the device data model to EPICS and eases integration of alien control protocols. This paper focuses on the integration of the Sample Environment Communication Protocol (SECoP)* into the ophyd layer, enabling seamless incorporation of sample environment hardware into beamline experiments at photon and neutron sources. The SECoP integration was designed to have a simple interface and provide plug-and-play functionality while preserving all metadata and structural information about the controlled hardware. Leveraging the self-describing characteristics of SECoP, automatic generation and configuration of ophyd devices is facilitated upon connecting to a Sample Environment Control (SEC) node. This work builds upon a modified SECoP-client provided by the Frappy framework**, intended for programming SEC nodes with a SECoP interface. This paper presents an overview of the architecture and implementation of the ophyd-SECoP integration and includes examples for better understanding.
*Klaus Kiefer et al. "An introduction to SECoP - the sample environment communication protocol".
**Markus Zolliker and Enrico Faulhaber url: https://github.com/sampleenvironment/Frappy.

Slides THMBCMO10 [0.596 MB]

Poster THMBCMO10 [0.809 MB]

DOI •

reference for this paper ※ doi:10.18429/JACoW-ICALEPCS2023-THMBCMO10

About •

Received ※ 05 October 2023 — Accepted ※ 08 December 2023 — Issued ※ 14 December 2023

Cite •

reference for this paper using ※ BibTeX, ※ LaTeX, ※ Text/Word, ※ RIS, ※ EndNote (xml)

THPDP014

SECoP and SECoP@HMC - Metadata in the Sample Environment Communication Protocol

1322

K. Kiefer, B. Klemke, L. Rossa, P. Wegmann
HZB, Berlin, Germany
G. Brandl, E. Faulhaber, A. Zaft
MLZ, Garching, Germany
N. Ekström, A. Pettersson
ESS, Lund, Sweden
J. Kotanski, T. Kracht
DESY, Hamburg, Germany
M. Zolliker
PSI, Villigen PSI, Switzerland

Funding: The project SECoP@HMC receives funding by the Helmholtz Association’s Initiative and Networking Fund (IVF).
The integration of sample environment (SE) equipment in x-ray and neutron experiments is a complex challenge both in the physical world and in the digital world. Dif-ferent experiment control software offer different interfac-es for the connection of SE equipment. Therefore, it is time-consuming to integrate new SE or to share SE equipment between facilities. To tackle this problem, the International Society for Sample Environment (ISSE, [1]) developed the Sample Environment Communication Protocol (SECoP) to standardize the communication between instrument control software and SE equipment [2]. SECoP offers, on the one hand, a generalized way to control SE equipment. On the other hand, SECoP holds the possibility to transport SE metadata in a well-defined way. In addition, SECoP provides machine readable self-description of the SE equipment which enables a fully automated integration into the instrument control soft-ware and into the processes for data storage. Using SECoP as a common standard for controlling SE equipment and generating SE metadata will save resources and intrinsi-cally give the opportunity to supply standardized and FAIR data compliant SE metadata. It will also supply a well-defined interface for user-provided SE equipment, for equipment shared by different research facilities and for industry. In this article will show how SECoP can help to provide a meaningful and complete set of metadata for SE equipment and we will present SECoP and the SECoP@HMC project supported by the Helmholtz Metadata Collaboration.
*K. Kiefer, et al. (2020). An introduction to SECoP - the sample environment communication protocol. Journal of Neutron Research, 21(3-4), pp.181-195

DOI •

reference for this paper ※ doi:10.18429/JACoW-ICALEPCS2023-THPDP014

About •

Received ※ 06 October 2023 — Revised ※ 10 October 2023 — Accepted ※ 14 December 2023 — Issued ※ 22 December 2023

Cite •

reference for this paper using ※ BibTeX, ※ LaTeX, ※ Text/Word, ※ RIS, ※ EndNote (xml)