Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/steiger service docs round2 #252

Merged
merged 13 commits into from
Oct 21, 2024
47 changes: 47 additions & 0 deletions docs/services/camera_sim.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,61 @@
Camera Simulator
================
This service operates a simulated camera. This service is meant to mimic, but does not actually
control, a hardware camera.

This service can be used to simulate any hardware camera service since they are all written consistently.

Configuration
-------------
.. code-block:: YAML

camera1:
service_type: my_camera
simulated_service_type: camera_sim
interface: camera
requires_safety: false

# Keys used only by hardware service.
device_name: ZWO ASI178MM
device_id: 4
well_depth_percentage_target: 0.65
ivalaginja marked this conversation as resolved.
Show resolved Hide resolved

# Keys used by simulated and hardware service.
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.
24 changes: 24 additions & 0 deletions docs/services/thorlabs_fw102c.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,38 @@
Thorlabs Filter Wheel
=====================
This service operates a Thorlabs filter wheel.

Successfully tested with the following devices:

- `ThorLabs FW 102C <https://www.thorlabs.com/thorproduct.cfm?partnumber=FW102C#ad-image-0>`_

Configuration
-------------
.. code-block:: YAML

filter_wheel:
service_type: thorlabs_fw102c
simulated_service_type: thorlabs_fw102c_sim
requires_safety: false

visa_id: ASRL6::INSTR

filters: # named positions resolved by the proxy.
clear: 1
2.8_percent: 2
12_percent: 3
9_percent: 4

Properties
----------
None.

Commands
--------
None.

Datastreams
-----------
``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 the values specified by the service configuration.
7 changes: 5 additions & 2 deletions docs/services/thorlabs_mff101.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Thorlabs Motorized Flip Mount
=============================

This service operates a Thorlabs MFF101 motorized flip mount.
This service operates a `Thorlabs MFF101 <https://www.thorlabs.com/thorproduct.cfm?partnumber=MFF101>`_
motorized flip mount.

Configuration
-------------
Expand Down Expand Up @@ -29,4 +30,6 @@ 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, 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.
3 changes: 2 additions & 1 deletion docs/services/thorlabs_tsp01.rst
Original file line number Diff line number Diff line change
@@ -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 <https://www.thorlabs.com/thorproduct.cfm?partnumber=TSP01>`_
temperature and humidity sensor.

Configuration
-------------
Expand Down
Loading