From 9ee6ebbefecad271e24122e0d7e4787f006dc7a1 Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 18:01:10 +0200 Subject: [PATCH 1/6] Add a bunch of new service docs pages --- docs/services/aimtti_plp.rst | 20 +++++++ docs/services/allied_vision_camera.rst | 77 ++++++++++++++++++++++++++ docs/services/empty_service.rst | 20 +++++++ docs/services/ni_daq.rst | 21 +++++++ docs/services/nkt_superk.rst | 14 +++++ docs/services/thorlabs_cld101x.rst | 14 +++++ docs/services/thorlabs_pm.rst | 14 +++++ 7 files changed, 180 insertions(+) create mode 100644 docs/services/aimtti_plp.rst create mode 100644 docs/services/allied_vision_camera.rst create mode 100644 docs/services/empty_service.rst create mode 100644 docs/services/ni_daq.rst create mode 100644 docs/services/nkt_superk.rst create mode 100644 docs/services/thorlabs_cld101x.rst create mode 100644 docs/services/thorlabs_pm.rst diff --git a/docs/services/aimtti_plp.rst b/docs/services/aimtti_plp.rst new file mode 100644 index 000000000..3f648846f --- /dev/null +++ b/docs/services/aimtti_plp.rst @@ -0,0 +1,20 @@ +Aim TTi PL-P Series Power Supply +======================== + + + +Configuration +------------- + + +Properties +---------- +None. + +Commands +-------- +None. + +Datastreams +----------- +None. diff --git a/docs/services/allied_vision_camera.rst b/docs/services/allied_vision_camera.rst new file mode 100644 index 000000000..4bf7961c0 --- /dev/null +++ b/docs/services/allied_vision_camera.rst @@ -0,0 +1,77 @@ +Allied Vision Camera +==================== + +This service controls an Allied Vision camera. It is a wrapper around the Vimba SDK, which requires the installation +of the Vimba SDK from Allied Vision. The service uses the Python API for VImba SDK, called ``VimbaPython``. + +Vimba SDK is now superceded by Vimba X SDK, which is the latest version of the SDK. The service might be updated in the +future to use the Vimba X SDK and its Python API ``VmbPy`` instead. + +Vimba SDK: [https://www.alliedvision.com/en/products/software/](https://www.alliedvision.com/en/products/software/) +``VimbaPython`` library: [https://github.com/alliedvision/VimbaPython](https://github.com/alliedvision/VimbaPython) + +Vimba X SDK: [https://www.alliedvision.com/en/products/software/](https://www.alliedvision.com/en/products/software/) +VmbPy: [https://github.com/alliedvision/VmbPy](https://github.com/alliedvision/VmbPy) + +The service has been successfully tested with the following camera models: +- Alvium 1800 U-158m +- Alvium 1800 U-500m + +Configuration +------------- + +.. code-block:: YAML + + camera1: + service_type: allied_vision_camera + simulated_service_type: camera_sim + requires_safety: false + + camera_id: "DEV_1AB22C011222" + device_name: AV Alvium 1800 U-158m + + offset_x: 0 + offset_y: 0 + width: 32 + height: 32 + sensor_width: 1456 + sensor_height: 1088 + + exposure_time: 200 + gain: 0 + +Properties +---------- +``exposure_time``: Exposure time of the camera. + +``gain``: Gain of the camera. + +``brightness``: Brightness of the camera. + +``width``: The width of the camera. + +``height``: The height of the camera. + +``offset_x``: The x offset of the camera. + +``offset_y``: The y offset of the camera. + +``sensor_width``: The width of the sensor. + +``sensor_height``: The height of the sensor. + +``camera_id``: The camera ID. + +Commands +-------- +``start_acquisition()``: This + +``end_acquisition()``: This + +Datastreams +----------- +``temperature``: The temperature as measured by this sensor in Celsius. + +``images``: The images acquired by the camera. + +``is_acquiring``: Whether the camera is currently acquiring images. \ No newline at end of file diff --git a/docs/services/empty_service.rst b/docs/services/empty_service.rst new file mode 100644 index 000000000..d844beacf --- /dev/null +++ b/docs/services/empty_service.rst @@ -0,0 +1,20 @@ +Empty Service +======================== + + + +Configuration +------------- +None. + +Properties +---------- +None. + +Commands +-------- +None. + +Datastreams +----------- +None. diff --git a/docs/services/ni_daq.rst b/docs/services/ni_daq.rst new file mode 100644 index 000000000..5e3b87a74 --- /dev/null +++ b/docs/services/ni_daq.rst @@ -0,0 +1,21 @@ +NI DAQ +======================== + + + +Configuration +------------- + + + +Properties +---------- +None. + +Commands +-------- +None. + +Datastreams +----------- +None. diff --git a/docs/services/nkt_superk.rst b/docs/services/nkt_superk.rst new file mode 100644 index 000000000..761641543 --- /dev/null +++ b/docs/services/nkt_superk.rst @@ -0,0 +1,14 @@ +NKT Super K Compact Tunable Laser +================================= + +Configuration +------------- + +Properties +---------- + +Commands +-------- + +Datastreams +----------- diff --git a/docs/services/thorlabs_cld101x.rst b/docs/services/thorlabs_cld101x.rst new file mode 100644 index 000000000..cc0b28590 --- /dev/null +++ b/docs/services/thorlabs_cld101x.rst @@ -0,0 +1,14 @@ +Thorlabs Compact Laser Diode +============================ + +Configuration +------------- + +Properties +---------- + +Commands +-------- + +Datastreams +----------- diff --git a/docs/services/thorlabs_pm.rst b/docs/services/thorlabs_pm.rst new file mode 100644 index 000000000..da3b5be48 --- /dev/null +++ b/docs/services/thorlabs_pm.rst @@ -0,0 +1,14 @@ +Thorlabs Picomotor +=================== + +Configuration +------------- + +Properties +---------- + +Commands +-------- + +Datastreams +----------- From eecd15d5dbbc4f7f4c7898a085ed0007f72a1357 Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 18:05:13 +0200 Subject: [PATCH 2/6] Write URLs correctly for rst format --- docs/services/allied_vision_camera.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/services/allied_vision_camera.rst b/docs/services/allied_vision_camera.rst index 4bf7961c0..15e64c29e 100644 --- a/docs/services/allied_vision_camera.rst +++ b/docs/services/allied_vision_camera.rst @@ -7,11 +7,9 @@ of the Vimba SDK from Allied Vision. The service uses the Python API for VImba S Vimba SDK is now superceded by Vimba X SDK, which is the latest version of the SDK. The service might be updated in the future to use the Vimba X SDK and its Python API ``VmbPy`` instead. -Vimba SDK: [https://www.alliedvision.com/en/products/software/](https://www.alliedvision.com/en/products/software/) -``VimbaPython`` library: [https://github.com/alliedvision/VimbaPython](https://github.com/alliedvision/VimbaPython) - -Vimba X SDK: [https://www.alliedvision.com/en/products/software/](https://www.alliedvision.com/en/products/software/) -VmbPy: [https://github.com/alliedvision/VmbPy](https://github.com/alliedvision/VmbPy) +Vimba SDK and Vimba X SDK: `https://www.alliedvision.com/en/products/software/ `_ +``VimbaPython`` library: `https://github.com/alliedvision/VimbaPython `_ +``VmbPy``: `https://github.com/alliedvision/VmbPy `_ The service has been successfully tested with the following camera models: - Alvium 1800 U-158m From e35f039a8a5eb06c3389d905a0cc5c7438844b0f Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 19:58:45 +0200 Subject: [PATCH 3/6] Fix typo and be explicit --- docs/services/allied_vision_camera.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/services/allied_vision_camera.rst b/docs/services/allied_vision_camera.rst index 15e64c29e..41e1bf59e 100644 --- a/docs/services/allied_vision_camera.rst +++ b/docs/services/allied_vision_camera.rst @@ -2,14 +2,14 @@ Allied Vision Camera ==================== This service controls an Allied Vision camera. It is a wrapper around the Vimba SDK, which requires the installation -of the Vimba SDK from Allied Vision. The service uses the Python API for VImba SDK, called ``VimbaPython``. +of the Vimba SDK from Allied Vision. The service uses the Python API for Vimba SDK, called ``VimbaPython``. Vimba SDK is now superceded by Vimba X SDK, which is the latest version of the SDK. The service might be updated in the future to use the Vimba X SDK and its Python API ``VmbPy`` instead. Vimba SDK and Vimba X SDK: `https://www.alliedvision.com/en/products/software/ `_ -``VimbaPython`` library: `https://github.com/alliedvision/VimbaPython `_ -``VmbPy``: `https://github.com/alliedvision/VmbPy `_ +``VimbaPython`` Python API: `https://github.com/alliedvision/VimbaPython `_ +``VmbPy`` Python API: `https://github.com/alliedvision/VmbPy `_ The service has been successfully tested with the following camera models: - Alvium 1800 U-158m From 072c5de8bf2b2cd680c1d0ae88a29b6343b538a8 Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 19:59:50 +0200 Subject: [PATCH 4/6] Minor stuff --- docs/services/aimtti_plp.rst | 2 +- docs/services/empty_service.rst | 2 +- docs/services/ni_daq.rst | 2 +- docs/services/thorlabs_pm.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/services/aimtti_plp.rst b/docs/services/aimtti_plp.rst index 3f648846f..af21dbb8b 100644 --- a/docs/services/aimtti_plp.rst +++ b/docs/services/aimtti_plp.rst @@ -1,5 +1,5 @@ Aim TTi PL-P Series Power Supply -======================== +================================ diff --git a/docs/services/empty_service.rst b/docs/services/empty_service.rst index d844beacf..44079f5de 100644 --- a/docs/services/empty_service.rst +++ b/docs/services/empty_service.rst @@ -1,5 +1,5 @@ Empty Service -======================== +============= diff --git a/docs/services/ni_daq.rst b/docs/services/ni_daq.rst index 5e3b87a74..984561d3d 100644 --- a/docs/services/ni_daq.rst +++ b/docs/services/ni_daq.rst @@ -1,5 +1,5 @@ NI DAQ -======================== +====== diff --git a/docs/services/thorlabs_pm.rst b/docs/services/thorlabs_pm.rst index da3b5be48..0aba31ecd 100644 --- a/docs/services/thorlabs_pm.rst +++ b/docs/services/thorlabs_pm.rst @@ -1,5 +1,5 @@ Thorlabs Picomotor -=================== +================== Configuration ------------- From 471afe1d3f69343dc518bfa620758aea1c03e687 Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 20:01:55 +0200 Subject: [PATCH 5/6] camera_id is not a property --- docs/services/allied_vision_camera.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/services/allied_vision_camera.rst b/docs/services/allied_vision_camera.rst index 41e1bf59e..5be2b683d 100644 --- a/docs/services/allied_vision_camera.rst +++ b/docs/services/allied_vision_camera.rst @@ -58,8 +58,6 @@ Properties ``sensor_height``: The height of the sensor. -``camera_id``: The camera ID. - Commands -------- ``start_acquisition()``: This From b5dd5ae45ddd3ba42a85f6401c8ffd87078d23f5 Mon Sep 17 00:00:00 2001 From: Iva Laginja Date: Wed, 24 Apr 2024 22:57:02 +0200 Subject: [PATCH 6/6] Fill blanks. It was an end-of-day Pr... --- docs/services/allied_vision_camera.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/services/allied_vision_camera.rst b/docs/services/allied_vision_camera.rst index 5be2b683d..e21be8624 100644 --- a/docs/services/allied_vision_camera.rst +++ b/docs/services/allied_vision_camera.rst @@ -1,11 +1,11 @@ Allied Vision Camera ==================== -This service controls an Allied Vision camera. It is a wrapper around the Vimba SDK, which requires the installation -of the Vimba SDK from Allied Vision. The service uses the Python API for Vimba SDK, called ``VimbaPython``. +This service controls an Allied Vision camera. It is a wrapper around the Vimba SDK, which requires its installation. +The service uses the Python API for Vimba SDK, called ``VimbaPython``. -Vimba SDK is now superceded by Vimba X SDK, which is the latest version of the SDK. The service might be updated in the -future to use the Vimba X SDK and its Python API ``VmbPy`` instead. +Vimba SDK is now superceded by Vimba X SDK. The service might be updated in the future to use the Vimba X SDK and its +Python API ``VmbPy`` instead. Vimba SDK and Vimba X SDK: `https://www.alliedvision.com/en/products/software/ `_ ``VimbaPython`` Python API: `https://github.com/alliedvision/VimbaPython `_ @@ -60,9 +60,9 @@ Properties Commands -------- -``start_acquisition()``: This +``start_acquisition()``: This starts the acquisition of images from the camera. -``end_acquisition()``: This +``end_acquisition()``: This ends the acquisition of images from the camera. Datastreams -----------