From 842cb5e306409bb0af5e5a542b71a5910ef4fee3 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 09:46:36 -0400 Subject: [PATCH 01/13] add thorlabs filter wheel docs --- docs/services/thorlabs_fw102c.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/services/thorlabs_fw102c.rst b/docs/services/thorlabs_fw102c.rst index e3f2162b0..1c477bb02 100644 --- a/docs/services/thorlabs_fw102c.rst +++ b/docs/services/thorlabs_fw102c.rst @@ -1,14 +1,35 @@ Thorlabs Filter Wheel ===================== +This service operates a `ThorLabs FW 102C `_ +filter wheel. Configuration ------------- +.. code-block:: YAML + + filter_wheel: + service_type: thorlabs_fw102c + simulated_service_type: thorlabs_fw102c_sim + requires_safety: false + + visa_id: ASRL6::INSTR + + filters: + clear: 1 + 2.8_percent: 2 + 12_percent: 3 + 9_percent: 4 Properties ---------- +None. Commands -------- +None. Datastreams ----------- +``position``: The requested position of the filter wheel. + +``current_position``: The current position of the filter wheel. \ No newline at end of file From 5c0c919b2d2888c552093742f1bd708891f3f99d Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 09:52:58 -0400 Subject: [PATCH 02/13] add link to thorlabs temperature sensor in docs. --- docs/services/thorlabs_tsp01.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/services/thorlabs_tsp01.rst b/docs/services/thorlabs_tsp01.rst index a8b8d4e6b..6f96da6dc 100644 --- a/docs/services/thorlabs_tsp01.rst +++ b/docs/services/thorlabs_tsp01.rst @@ -1,7 +1,8 @@ Thorlabs Temperature Sensor =========================== -This service retrieves data from a Thorlabs TSP01B temperature and humidity sensor. +This service retrieves data from a `Thorlabs TSP01 `_ +temperature and humidity sensor. Configuration ------------- From d4f163807579623045e4dc832f2cd43e0f8dcae5 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 09:57:49 -0400 Subject: [PATCH 03/13] update thorlabs flip mount docs. --- docs/services/thorlabs_mff101.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/services/thorlabs_mff101.rst b/docs/services/thorlabs_mff101.rst index f8d44b5f8..12ed66482 100644 --- a/docs/services/thorlabs_mff101.rst +++ b/docs/services/thorlabs_mff101.rst @@ -1,7 +1,8 @@ Thorlabs Motorized Flip Mount ============================= -This service operates a Thorlabs MFF101 motorized flip mount. +This service operates a `Thorlabs MFF101 `_ +motorized flip mount. Configuration ------------- @@ -29,4 +30,5 @@ Commands Datastreams ----------- -``position``: the current (commanded) position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. +``current_position``: the current position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. +``commanded_position``: the commanded position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. From 07df852ae8c96e3b108e3323858e6badd601ca85 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 10:50:29 -0400 Subject: [PATCH 04/13] update thorlabs filter wheel docs. --- docs/services/thorlabs_fw102c.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/services/thorlabs_fw102c.rst b/docs/services/thorlabs_fw102c.rst index 1c477bb02..1ef9eaf5b 100644 --- a/docs/services/thorlabs_fw102c.rst +++ b/docs/services/thorlabs_fw102c.rst @@ -1,7 +1,10 @@ Thorlabs Filter Wheel ===================== -This service operates a `ThorLabs FW 102C `_ -filter wheel. +This service operates a Thorlabs filter wheel. + +Successfully tested with the following devices: + +- `ThorLabs FW 102C `_ Configuration ------------- @@ -30,6 +33,6 @@ None. Datastreams ----------- -``position``: The requested position of the filter wheel. +``position``: The commanded position of the filter wheel. This can have value 1, 2, 3, 4, 5, 6 indicating those respective positions. -``current_position``: The current position of the filter wheel. \ No newline at end of file +``current_position``: The current position of the filter wheel. This can have value 1, 2, 3, 4, 5, 6 indicating those respective positions. \ No newline at end of file From 3906be5be75debe7d663117bd00917fb12e0e64f Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 10:50:43 -0400 Subject: [PATCH 05/13] update thorlabs flip mount docs. --- docs/services/thorlabs_mff101.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/services/thorlabs_mff101.rst b/docs/services/thorlabs_mff101.rst index 12ed66482..88caf8cc2 100644 --- a/docs/services/thorlabs_mff101.rst +++ b/docs/services/thorlabs_mff101.rst @@ -31,4 +31,5 @@ Commands Datastreams ----------- ``current_position``: the current position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. + ``commanded_position``: the commanded position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. From 8191273977ff53dc19d92ff08d97cd5f7e0a4a21 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 11:07:14 -0400 Subject: [PATCH 06/13] reformat temperature sensor description in the docs. --- docs/services/thorlabs_tsp01.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/services/thorlabs_tsp01.rst b/docs/services/thorlabs_tsp01.rst index 6f96da6dc..2c5b6b68a 100644 --- a/docs/services/thorlabs_tsp01.rst +++ b/docs/services/thorlabs_tsp01.rst @@ -1,8 +1,11 @@ Thorlabs Temperature Sensor =========================== -This service retrieves data from a `Thorlabs TSP01 `_ -temperature and humidity sensor. +This service retrieves data from a Thorlabs temperature and humidity sensor. + +Successfully tested with the following devices: + +- `Thorlabs TSP01 `_ Configuration ------------- From a357cf8d647830bdf3b1c87965cdfdf04c377d35 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 11:08:33 -0400 Subject: [PATCH 07/13] Revert "reformat temperature sensor description in the docs." This reverts commit 8191273977ff53dc19d92ff08d97cd5f7e0a4a21. --- docs/services/thorlabs_tsp01.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/services/thorlabs_tsp01.rst b/docs/services/thorlabs_tsp01.rst index 2c5b6b68a..6f96da6dc 100644 --- a/docs/services/thorlabs_tsp01.rst +++ b/docs/services/thorlabs_tsp01.rst @@ -1,11 +1,8 @@ Thorlabs Temperature Sensor =========================== -This service retrieves data from a Thorlabs temperature and humidity sensor. - -Successfully tested with the following devices: - -- `Thorlabs TSP01 `_ +This service retrieves data from a `Thorlabs TSP01 `_ +temperature and humidity sensor. Configuration ------------- From 10f6852f7aaa4a8ccfa09f49280ee968cd75daf2 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 11:09:22 -0400 Subject: [PATCH 08/13] small grammar fix. --- docs/services/thorlabs_mff101.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/services/thorlabs_mff101.rst b/docs/services/thorlabs_mff101.rst index 88caf8cc2..c6dd12bef 100644 --- a/docs/services/thorlabs_mff101.rst +++ b/docs/services/thorlabs_mff101.rst @@ -30,6 +30,6 @@ Commands Datastreams ----------- -``current_position``: the current position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. +``current_position``: the current position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. -``commanded_position``: the commanded position of the flip mount. This can be set to either 1 or 2, indication position 1 or 2. Other values will be silently ignored. +``commanded_position``: the commanded position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. From 3ddbf7a81ed34aec47052bf1c4114d7869d85899 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Thu, 17 Oct 2024 11:32:59 -0400 Subject: [PATCH 09/13] add camera_sim docs. --- docs/services/camera_sim.rst | 45 ++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/docs/services/camera_sim.rst b/docs/services/camera_sim.rst index 86d8b442f..a7176d8e8 100644 --- a/docs/services/camera_sim.rst +++ b/docs/services/camera_sim.rst @@ -1,14 +1,59 @@ Camera Simulator ================ +This service operates a simulated camera. This service is meant to mimic, but does not actually +control, a hardware camera. + +When applicable, all services have a corresponding simulated service to be able to test control +software before commanding actual hardware devices. Configuration ------------- +.. code-block:: YAML + + camera: + service_type: zwo_camera + simulated_service_type: camera_sim + interface: hicat_camera + requires_safety: false + + device_name: ZWO ASI178MM + device_id: 4 + well_depth_percentage_target: 0.65 + exposure_time: 1000 + width: 1680 + height: 1680 + offset_x: 336 + offset_y: 204 + gain: 0 Properties ---------- +``exposure_time``: Simulated exposure time (in microseconds) of the camera. + +``gain``: Simulated gain of the camera. + +``width``: The width of the camera frames. + +``height``: The height of the camera frames. + +``offset_x``: The x offset of the camera frames on the sensor. + +``offset_y``: The y offset of the camera frames on the sensor. + +``sensor_width``: The width of the simulated sensor. + +``sensor_height``: The height of the simulated sensor. Commands -------- +``start_acquisition()``: This starts the acquisition of images from the camera. + +``end_acquisition()``: This ends the acquisition of images from the camera. Datastreams ----------- +``temperature``: The simulated temperature (in Celsius) as measured by the camera. + +``images``: The images acquired by the camera. + +``is_acquiring``: Whether the camera is currently acquiring images. From 88021823eff7aaf00add4028c70bccd8d822601b Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Fri, 18 Oct 2024 11:59:53 -0400 Subject: [PATCH 10/13] camera_sim documentation updates. --- docs/services/camera_sim.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/services/camera_sim.rst b/docs/services/camera_sim.rst index a7176d8e8..0e5683377 100644 --- a/docs/services/camera_sim.rst +++ b/docs/services/camera_sim.rst @@ -3,22 +3,24 @@ Camera Simulator This service operates a simulated camera. This service is meant to mimic, but does not actually control, a hardware camera. -When applicable, all services have a corresponding simulated service to be able to test control -software before commanding actual hardware devices. +This service can be used to simulate any hardware camera service since they are all written consistently. Configuration ------------- .. code-block:: YAML - camera: - service_type: zwo_camera + camera1: + service_type: my_camera simulated_service_type: camera_sim - interface: hicat_camera + interface: camera requires_safety: false + # Keys used only by hardware service. device_name: ZWO ASI178MM device_id: 4 well_depth_percentage_target: 0.65 + + # Keys used by simulated and hardware service. exposure_time: 1000 width: 1680 height: 1680 From 118f503aab4793dadb0cb4e9410faf3d19fea831 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Fri, 18 Oct 2024 12:03:05 -0400 Subject: [PATCH 11/13] thorlabs flip mount documentation capitalization fix. --- docs/services/thorlabs_mff101.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/services/thorlabs_mff101.rst b/docs/services/thorlabs_mff101.rst index c6dd12bef..488c87bd2 100644 --- a/docs/services/thorlabs_mff101.rst +++ b/docs/services/thorlabs_mff101.rst @@ -30,6 +30,6 @@ Commands Datastreams ----------- -``current_position``: the current position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. +``current_position``: The current position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. -``commanded_position``: the commanded position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. +``commanded_position``: The commanded position of the flip mount. This can be set to either 1 or 2, indicating position 1 or 2. Other values will be silently ignored. From af5d9ebfa94f0027b4f047fae3a8315c88bfbb16 Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Fri, 18 Oct 2024 12:08:11 -0400 Subject: [PATCH 12/13] add comment to filter wheel docs about named filter positions. --- docs/services/thorlabs_fw102c.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/services/thorlabs_fw102c.rst b/docs/services/thorlabs_fw102c.rst index 1ef9eaf5b..a0d0c76d5 100644 --- a/docs/services/thorlabs_fw102c.rst +++ b/docs/services/thorlabs_fw102c.rst @@ -17,7 +17,7 @@ Configuration visa_id: ASRL6::INSTR - filters: + filters: # named positions resolved by the proxy. clear: 1 2.8_percent: 2 12_percent: 3 From 7a15e375267e44dda9bd1ec2899ae6614e67ffcf Mon Sep 17 00:00:00 2001 From: Sarah Steiger Date: Fri, 18 Oct 2024 12:11:00 -0400 Subject: [PATCH 13/13] update filter wheel docs - fw positions defined by config. --- docs/services/thorlabs_fw102c.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/services/thorlabs_fw102c.rst b/docs/services/thorlabs_fw102c.rst index a0d0c76d5..c7f2c5a99 100644 --- a/docs/services/thorlabs_fw102c.rst +++ b/docs/services/thorlabs_fw102c.rst @@ -33,6 +33,6 @@ None. Datastreams ----------- -``position``: The commanded position of the filter wheel. This can have value 1, 2, 3, 4, 5, 6 indicating those respective positions. +``position``: The commanded position of the filter wheel. This can have the values specified by the service configuration. -``current_position``: The current position of the filter wheel. This can have value 1, 2, 3, 4, 5, 6 indicating those respective positions. \ No newline at end of file +``current_position``: The current position of the filter wheel. This can have the values specified by the service configuration. \ No newline at end of file