Crate qhyccd_rs

Source
Expand description

§QHYCCD SDK bindings for Rust

This crate provides a safe interface to the QHYCCD SDK for controlling QHYCCD cameras, filter wheels and focusers. The libqhyccd-sys crate provides the raw FFI bindings. It uses tracing for logging and eyre for error handling.

§Example

use qhyccd_rs::Sdk;
let sdk = Sdk::new().expect("SDK::new failed");
let sdk_version = sdk.version().expect("get_sdk_version failed");
println!("SDK version: {:?}", sdk_version);

Structs§

CCDChipArea
this struct is used in get_overscan_area, get_effective_area, set_roi and get_roi
CCDChipInfo
Camera sensor info
Camera
The representation of a camera. It is constructed by the SDK and can be used to interact with the camera.
FilterWheel
The representation of a filter wheel. It is constructed by the SDK and can be used to interact with the filter wheel - every filter wheel is always plugged into a camera.
ImageData
the image data coming from the camera in get_live_frame and get_single_frame
ReadoutMode
used to store readout mode numbers and their descriptions coming from get_readout_mode_name
SDKVersion
returned from SDK::version
Sdk
The representation of the SDK. It automatically allocates the SDK when constructed and automatically frees resource when deconstructed.

Enums§

BayerMode
this struct is returned from is_control_available when used with Control::CamColor
Control
Controls used in is_control_available and set_parameter nad get_parameter documentation is taken from the QHYCCD SDK here https://www.qhyccd.cn/file/repository/publish/SDK/code/QHYCCD%20SDK_API_EN_V2.3.pdf
QHYError
Errors that can occur when interacting with the QHYCCD SDK most functions from the SDK return u32::MAX on error where it is different, is is noted in the documentation
StreamMode
Stream mode used in set_stream_mode