Compare commits

..

No commits in common. "main" and "feature-20260222-update-shellnix" have entirely different histories.

10 changed files with 148 additions and 958 deletions

View file

@ -1,5 +1 @@
/target /target
.envrc
.direnv/
*~

701
hostcontrol/Cargo.lock generated

File diff suppressed because it is too large Load diff

View file

@ -4,8 +4,6 @@ version = "0.1.0"
edition = "2021" edition = "2021"
[dependencies] [dependencies]
anyhow = "1.0.100"
clap = { version = "4.0", features = ["derive"] }
nalgebra = { version = "0.33" } nalgebra = { version = "0.33" }
serialport = { version = "4", default-features = false } serialport = { version = "4", default-features = false }
thiserror = "2" thiserror = "2"
@ -13,6 +11,3 @@ nalgebra-macros = "^0.2.2"
env_logger = "0.11.8" env_logger = "0.11.8"
egui = "0.31.1" egui = "0.31.1"
eframe = "0.31.1" eframe = "0.31.1"
log = "0.4.29"
image = { version = "0.25", default-features = false, features = ["png","jpeg"] }
nokhwa = { version = "0.10.0", features = [ "input-native" ] }

View file

@ -5,9 +5,6 @@ pkgs.mkShell {
buildInputs = with pkgs; [ buildInputs = with pkgs; [
cargo cargo
# Needed for a bindgen dependency in nokhwa
rustPlatform.bindgenHook
# Useful tools # Useful tools
clippy clippy
rustfmt rustfmt

View file

@ -1,31 +0,0 @@
use anyhow::{Context, Result};
use image::RgbImage;
use nokhwa::pixel_format::RgbFormat;
use nokhwa::utils::{CameraIndex, RequestedFormat, RequestedFormatType};
use nokhwa::Camera as NokhwaCamera;
pub struct Camera {
camera: NokhwaCamera,
}
impl Camera {
pub fn new(camera_index: u32) -> Result<Self> {
let index = CameraIndex::Index(camera_index);
let format =
RequestedFormat::new::<RgbFormat>(RequestedFormatType::AbsoluteHighestResolution);
let mut camera =
NokhwaCamera::new(index, format).context("could not find/access webcam")?;
camera.open_stream().context("failed to open stream")?;
Ok(Self { camera })
}
pub fn capture(&mut self) -> Result<RgbImage> {
for _ in 0..5 {
// Hack to have camera flush frames in buffer.
let _ = self.camera.frame();
}
let frame = self.camera.frame().context("Could not capture image")?;
println!("snap!");
Ok(frame.decode_image::<RgbFormat>()?)
}
}

View file

@ -1,46 +0,0 @@
use crate::stage_io::StageIO;
use crate::xy_stage::{Result, XYStage};
pub struct GCodeStage {
stage_io: StageIO,
max_range_μm: nalgebra::Vector3<f64>,
}
impl GCodeStage {
pub fn new(stage_io: StageIO) -> Result<Self> {
let mut res = Self {
stage_io,
// TODO: determine max range with some M-code ?
max_range_μm: nalgebra::vector![100.0 * 1000.0, 100.0 * 1000.0, 50.0 * 1000.0],
};
res.stage_io.send_request("G28\n")?;
Ok(res)
}
}
impl XYStage for GCodeStage {
/// Move to absolute coordinates (x,y,z) in micrometers.
fn move_absolute_cartesian(&mut self, a: nalgebra::Vector3<f64>) -> Result<()> {
// TODO: check range
self.stage_io.send_request(format!(
"G1 X{} Y{} Z{}\n",
a[0] / 1000.0,
a[1] / 1000.0,
a[2] / 1000.0
))?;
self.stage_io.send_request("G4 P1\n")?; // make sure move finished.
Ok(())
}
/// Get range of valid cartesian coordinates box. For now, assuming one
/// corner is fixed at (0,0,0), the other remote corner is this range.
fn get_range(&self) -> nalgebra::Vector3<f64> {
self.max_range_μm
}
}
impl Drop for GCodeStage {
fn drop(&mut self) {
self.stage_io.send_request("M84\n").unwrap(); // switch off motors.
}
}

View file

@ -1,96 +1,41 @@
use clap::{Parser, ValueEnum}; use std::{thread::sleep, time::Duration};
use image::RgbImage;
use std::path::PathBuf;
mod camera; mod stage;
mod gcode_stage;
mod openflexure_stage;
mod stage_io;
use crate::camera::Camera;
use crate::stage_io::StageIO;
use crate::xy_stage::XYStage;
mod xy_stage;
#[derive(clap::Parser, Debug)]
#[command(version, about, long_about = None)]
struct CliArgs {
/// Interface to talk to movement stage
#[arg(long, default_value = "/dev/ttyACM0")]
stage_device: String,
/// Speed of the stage device (bps)
#[arg(long, default_value = "115200")]
tty_speed: u32,
/// Stage movement backend
#[arg(long, value_enum)]
backend: Backend,
/// Id of camera to fetch images from.
#[arg(long, default_value = "0")]
camera_index: u32,
/// Directory all captured images are stored.
#[arg(long, value_name = "out-dir")]
output_directory: PathBuf,
}
// [derive(DebugCopy, Clone, PartialEq, Eq, PartialOrd, Ord, ValueEnum)]
#[derive(Debug, Clone, ValueEnum)]
enum Backend {
/// OpenFlexure stage
OpenFlexure,
/// GCode stage
GCode,
}
fn store_image(number: u32, pos: nalgebra::Vector3<f64>, dir: &PathBuf, img: &RgbImage) {
let img_file = &dir.join(format!("img-{:05}-{:0},{:0}.png", number, pos[0], pos[1]));
img.save(img_file).unwrap();
}
fn main() { fn main() {
env_logger::init(); env_logger::init();
let args = CliArgs::parse(); let mut s = stage::Stage::new("/dev/ttyACM0", 1.12).unwrap();
let origin = nalgebra::vector![3000.0, 0.0, -6000.0];
//println!("{}", s.version().unwrap());
if !args.output_directory.is_dir() { //let a = nalgebra::vector![-10000.0, 0.0, -1250.0];
panic!("--out-dir needs to be an existing directory"); //let b = nalgebra::vector![18000.0, -15000.0, -1600.0];
//let c = nalgebra::vector![0.0, -15000.0, -250.0];
s.move_absolute_cartesian(origin).unwrap();
sleep(Duration::from_secs(5));
//s.move_absolute_cartesian(origin + a).unwrap();
////sleep(Duration::from_secs(5));
////s.move_absolute_cartesian(origin).unwrap();
////s.move_absolute_cartesian(origin + c).unwrap();
////sleep(Duration::from_secs(5));
////s.move_absolute_cartesian(origin + nalgebra::vector![0.0, -16000.0, -500.0]).unwrap();
////println!("D");
////sleep(Duration::from_secs(5));
////s.move_absolute_cartesian(origin + nalgebra::vector![0.0, 0.0, 0.0]).unwrap();
//println!("{:?}", s.get_position_cartesian());
//Ok(())
} }
let origin = nalgebra::vector![0.0, 0.0, 0.0]; struct App {
// Picture source
let mut cam = Camera::new(args.camera_index).unwrap();
cam.capture().unwrap(); // Warm up camera.
// Movement
let stage_io = StageIO::new(&args.stage_device, args.tty_speed).unwrap();
let mut stage: Box<dyn XYStage> = match args.backend {
Backend::GCode => Box::new(gcode_stage::GCodeStage::new(stage_io).unwrap()),
Backend::OpenFlexure => {
Box::new(openflexure_stage::OpenFlexureStage::new(stage_io, 1.12).unwrap())
}
};
// Local testing. Just take a line of pictures.
let mut max_xy = stage.get_range();
// Only interested in lerp-ing X for now.
max_xy[1] = 0.0;
max_xy[2] = 0.0;
for n in 0..10 {
let pos = max_xy * n as f64 / 10.0;
stage.move_absolute_cartesian(pos).unwrap();
store_image(n, pos, &args.output_directory, &cam.capture().unwrap());
}
} }
#[derive(Default)] impl Default for App {
struct App {} fn default() -> Self {
App {}
}
}
impl eframe::App for App { impl eframe::App for App {
fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) { fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
@ -99,3 +44,25 @@ impl eframe::App for App {
}); });
} }
} }
//
// let mut s = stage::Stage::new("/dev/ttyACM0", 1.12).unwrap();
// let origin = nalgebra::vector![3000.0, 0.0, -6000.0];
// println!("{}", s.version().unwrap());
//
// let a = nalgebra::vector![18000.0, 0.0, -1250.0];
// let b = nalgebra::vector![18000.0, -15000.0, -1600.0];
// let c = nalgebra::vector![0.0, -15000.0, -250.0];
//
// s.move_absolute_cartesian(origin).unwrap();
// //sleep(Duration::from_secs(5));
// //s.move_absolute_cartesian(origin + a).unwrap();
// //sleep(Duration::from_secs(5));
// //s.move_absolute_cartesian(origin + c).unwrap();
// //sleep(Duration::from_secs(5));
// //s.move_absolute_cartesian(origin + nalgebra::vector![0.0, -16000.0, -500.0]).unwrap();
// //println!("D");
// //sleep(Duration::from_secs(5));
// //s.move_absolute_cartesian(origin + nalgebra::vector![0.0, 0.0, 0.0]).unwrap();
// println!("{:?}", s.get_position_cartesian());
//}

View file

@ -1,7 +1,7 @@
//! Stage controller for openflexure-delta like stage controllers. //! Stage controller for openflexure-delta like stage controllers.
use crate::stage_io::StageIO; use std::time::Duration;
use crate::xy_stage::{Result, StageError, XYStage}; use thiserror::Error;
fn new_camera_rotation(theta: f64) -> nalgebra::Matrix3<f64> { fn new_camera_rotation(theta: f64) -> nalgebra::Matrix3<f64> {
nalgebra::matrix![ nalgebra::matrix![
@ -22,56 +22,70 @@ fn new_delta_into_cartesian(flex_h: f64, flex_a: f64, flex_b: f64) -> nalgebra::
] ]
} }
pub struct OpenFlexureStage { pub struct Stage {
stage_io: StageIO, serial: Box<dyn serialport::SerialPort>,
delta_pos: nalgebra::Vector3<i32>, delta_pos: nalgebra::Vector3<i32>,
cartesian_to_delta: nalgebra::Matrix3<f64>, cartesian_to_delta: nalgebra::Matrix3<f64>,
delta_to_cartesian: nalgebra::Matrix3<f64>, delta_to_cartesian: nalgebra::Matrix3<f64>,
} }
impl OpenFlexureStage { #[derive(Error, Debug)]
pub fn new(stage_io: StageIO, camera_rotation: f64) -> Result<Self> { pub enum StageError {
// TODO: non-blocking moves #[error("could not connect to stage controller")]
let delta_to_cartesian = new_camera_rotation(camera_rotation).try_inverse().unwrap() Open(serialport::Error),
* new_delta_into_cartesian(80.0, 50.0, 50.0); #[error("error when sending data to the stage controller")]
let cartesian_to_delta = delta_to_cartesian.try_inverse().unwrap(); Write(std::io::Error),
let mut res = Self { #[error("error when receiving data from the stage controller")]
stage_io, Read(std::io::Error),
delta_pos: nalgebra::vector![0, 0, 0], #[error("protocol error")]
cartesian_to_delta, Mumble,
delta_to_cartesian, }
};
let pos = res pub type Result<T> = std::result::Result<T, StageError>;
.stage_io
.send_request("p?")? impl Stage {
.split(" ") pub fn new(port: &str, camera_rotation: f64) -> Result<Self> {
.map(|v| v.parse::<i32>().map_err(|_| StageError::Mumble)) // TODO: non-blocking moves
.collect::<std::result::Result<Vec<_>, _>>()?; let serial = serialport::new(port, 115200).timeout(Duration::from_secs(60)).open().map_err(|e| StageError::Open(e))?;
let delta_to_cartesian = new_camera_rotation(camera_rotation).try_inverse().unwrap() * new_delta_into_cartesian(80.0, 50.0, 50.0);
let cartesian_to_delta = delta_to_cartesian.try_inverse().unwrap();
let mut res = Self { serial, delta_pos: nalgebra::vector![0, 0, 0], cartesian_to_delta, delta_to_cartesian };
let pos = res.communicate("p?")?.split(" ").map(|v| v.parse::<i32>().map_err(|_| StageError::Mumble)).collect::<std::result::Result<Vec<_>, _>>()?;
res.delta_pos = nalgebra::vector![pos[0], pos[1], pos[2]]; res.delta_pos = nalgebra::vector![pos[0], pos[1], pos[2]];
println!( println!("Initialized stage at delta positions {}/{}/{}", pos[0], pos[1], pos[2]);
"Initialized stage at delta positions {}/{}/{}",
pos[0], pos[1], pos[2]
);
Ok(res) Ok(res)
} }
fn receive_until<S: AsRef<str>>(&mut self, needle: S) -> Result<String> {
let mut res: Vec<u8> = vec![];
loop {
let mut buf = [0u8; 1];
self.serial.read_exact(&mut buf).map_err(|e| StageError::Read(e))?;
res.push(buf[0]);
if res.ends_with(needle.as_ref().as_bytes()) {
return Ok(String::from_utf8_lossy(&res).to_string());
}
}
}
fn communicate<S: AsRef<str>>(&mut self, command: S) -> Result<String> {
self.serial.write_all(command.as_ref().as_bytes()).map_err(|e| StageError::Write(e))?;
let res = self.receive_until("\n")?;
Ok(res.trim().to_string())
}
pub fn get_position_delta(&self) -> nalgebra::Vector3<i32> { pub fn get_position_delta(&self) -> nalgebra::Vector3<i32> {
self.delta_pos.clone() self.delta_pos.clone()
} }
pub fn get_position_cartesian(&self) -> nalgebra::Vector3<f64> { pub fn get_position_cartesian(&self) -> nalgebra::Vector3<f64> {
let pos = nalgebra::vector![ let pos = nalgebra::vector![self.delta_pos[0] as f64, self.delta_pos[1] as f64, self.delta_pos[2] as f64];
self.delta_pos[0] as f64,
self.delta_pos[1] as f64,
self.delta_pos[2] as f64
];
self.delta_to_cartesian * pos self.delta_to_cartesian * pos
} }
pub fn move_relative_delta(&mut self, d: nalgebra::Vector3<i32>) -> Result<()> { pub fn move_relative_delta(&mut self, d: nalgebra::Vector3<i32>) -> Result<()> {
self.stage_io self.communicate(format!("mr {} {} {}\n", d[0], d[1], d[2]))?;
.send_request(format!("mr {} {} {}\n", d[0], d[1], d[2]))?;
self.delta_pos += nalgebra::vector![d[0], d[1], d[2]]; self.delta_pos += nalgebra::vector![d[0], d[1], d[2]];
Ok(()) Ok(())
} }
@ -81,19 +95,7 @@ impl OpenFlexureStage {
self.move_relative_delta(diff) self.move_relative_delta(diff)
} }
pub fn move_relative_cartesian(&mut self, d: nalgebra::Vector3<f64>) -> Result<()> { pub fn move_absolute_cartesian(&mut self, a: nalgebra::Vector3<f64>) -> Result<()> {
let abs = self.get_position_cartesian() + d;
self.move_absolute_cartesian(abs)
}
pub fn version(&mut self) -> Result<String> {
Ok(self.stage_io.send_request("version\n")?)
}
}
impl XYStage for OpenFlexureStage {
fn move_absolute_cartesian(&mut self, a: nalgebra::Vector3<f64>) -> Result<()> {
// TODO: check range with get_movement_box()
let current = self.get_position_delta(); let current = self.get_position_delta();
let target = self.cartesian_to_delta * a; let target = self.cartesian_to_delta * a;
let target = nalgebra::vector![target[0] as i32, target[1] as i32, target[2] as i32]; let target = nalgebra::vector![target[0] as i32, target[1] as i32, target[2] as i32];
@ -113,7 +115,12 @@ impl XYStage for OpenFlexureStage {
self.move_absolute_delta(target) self.move_absolute_delta(target)
} }
fn get_range(&self) -> nalgebra::Vector3<f64> { pub fn move_relative_cartesian(&mut self, d: nalgebra::Vector3<f64>) -> Result<()> {
nalgebra::vector![10000.0, 10000.0, 5000.0] let abs = self.get_position_cartesian() + d;
self.move_absolute_cartesian(abs)
}
pub fn version(&mut self) -> Result<String> {
self.communicate("version\n")
} }
} }

View file

@ -1,56 +0,0 @@
use log::debug;
use std::time::Duration;
use thiserror::Error;
#[derive(Error, Debug)]
pub enum StageIOError {
#[error("could not connect to stage controller")]
Open(#[from] serialport::Error),
#[error("error when sending data to the stage controller")]
Write(std::io::Error),
#[error("error when receiving data from the stage controller")]
Read(std::io::Error),
}
pub struct StageIO {
serial: Box<dyn serialport::SerialPort>,
}
pub type StageIOResult<T> = std::result::Result<T, StageIOError>;
impl StageIO {
/// Create a new serial StageIO at given serial device and speed.
pub fn new(port: &str, speed: u32) -> StageIOResult<Self> {
let serial = serialport::new(port, speed)
.timeout(Duration::from_secs(60))
.open()?;
// TODO: read and discard initial characters; some devices like to be
// chatty on start-up.
Ok(Self { serial })
}
/// Receive data until the given character string "needle" is seen.
fn receive_until<S: AsRef<str>>(&mut self, needle: S) -> StageIOResult<String> {
let mut res: Vec<u8> = vec![];
loop {
let mut buf = [0u8; 1];
self.serial
.read_exact(&mut buf)
.map_err(StageIOError::Read)?;
res.push(buf[0]);
if res.ends_with(needle.as_ref().as_bytes()) {
return Ok(String::from_utf8_lossy(&res).to_string());
}
}
}
/// Send request and wait for response deliminated with a newline
pub fn send_request<S: AsRef<str>>(&mut self, command: S) -> StageIOResult<String> {
debug!("->: {:?}", command.as_ref());
self.serial
.write_all(command.as_ref().as_bytes())
.map_err(StageIOError::Write)?;
let response = self.receive_until("\n")?;
debug!("<-: {:?}", response);
Ok(response.trim().to_string())
}
}

View file

@ -1,20 +0,0 @@
use crate::stage_io::StageIOError;
use thiserror::Error;
#[derive(Error, Debug)]
pub enum StageError {
#[error("Interface issue")]
Communication(#[from] StageIOError),
#[error("protocol error")]
Mumble,
}
pub type Result<T> = std::result::Result<T, StageError>;
pub trait XYStage {
/// Move to absolute coordinates (x,y,z) in micrometers.
fn move_absolute_cartesian(&mut self, a: nalgebra::Vector3<f64>) -> Result<()>;
/// Get range of valid cartesian coordinates box. For now, assuming one
/// corner is fixed at (0,0,0), the other remote corner is this range.
fn get_range(&self) -> nalgebra::Vector3<f64>;
}