1use std::time::{Duration, Instant};
25
26use serde_json::json;
27use strum_macros::FromRepr;
28
29use crate::command_client::CommandClient;
30use crate::ethercat::{SdoClient, SdoResult};
31use crate::fb::Ton;
32use crate::motion::FbSetModeOfOperation;
33use super::axis_config::AxisConfig;
34use super::axis_view::AxisView;
35use super::homing::HomingMethod;
36use super::cia402::{
37 Cia402Control, Cia402Status, Cia402State,
38 ModesOfOperation, RawControlWord, RawStatusWord,
39};
40
41#[derive(Debug, Clone, PartialEq)]
46enum AxisOp {
47 Idle,
48 Enabling(u8),
49 Disabling(u8),
50 Moving(MoveKind, u8, bool, bool),
51 Homing(u8),
52 SoftHoming(u8),
53 Halting(u8),
54 FaultRecovery(u8),
55}
56
57#[repr(u8)]
63#[derive(Debug, Clone, PartialEq, FromRepr)]
64enum HaltState {
65 WaitStopped = 0,
68 WaitCancelAck = 10,
71 WaitCancelAckClear = 20,
75}
76
77const HALT_STAGE_TIMEOUT: Duration = Duration::from_secs(3);
79
80const HALT_STABLE_WINDOW: i32 = 50;
85
86const HALT_STOPPED_VELOCITY: i32 = 100;
92
93const HALT_STABLE_TICKS_REQUIRED: u8 = 5;
97
98#[repr(u8)]
99#[derive(Debug, Clone, PartialEq, FromRepr)]
100enum HomeState {
101 EnsurePpMode = 0,
102 WaitPpMode = 1,
103 Search = 5,
104 WaitSearching = 10,
105 WaitFoundSensor = 20,
106 WaitStoppedFoundSensor = 30,
107 WaitFoundSensorAck = 40,
108 WaitFoundSensorAckClear = 45,
109 DebounceFoundSensor = 50,
110 BackOff = 60,
111 WaitBackingOff = 70,
112 WaitLostSensor = 80,
113 WaitStoppedLostSensor = 90,
114 WaitLostSensorAck = 100,
115 WaitLostSensorAckClear = 120,
116 WaitHomeOffsetDone = 125,
117
118 WriteHomingModeOp = 160,
119 WaitWriteHomingModeOp = 165,
120
121 WriteHomingMethod = 205,
122 WaitWriteHomingMethodDone = 210,
123 ClearHomingTrigger = 215,
124 TriggerHoming = 217,
125 WaitHomingStarted = 218,
126 WaitHomingDone = 220,
127 ResetHomingTrigger = 222,
128 WaitHomingTriggerCleared = 223,
129 WriteMotionModeOfOperation = 230,
130 WaitWriteMotionModeOfOperation = 235,
131 SendCurrentPositionTarget = 240,
132 WaitCurrentPositionTargetSent = 245
133
134}
135
136#[derive(Debug, Clone, PartialEq)]
137enum MoveKind {
138 Absolute,
139 Relative,
140}
141
142#[derive(Debug, Clone, Copy, PartialEq)]
143enum SoftHomeSensor {
144 PositiveLimit,
145 NegativeLimit,
146 HomeSensor,
147}
148
149#[derive(Debug, Clone, Copy, PartialEq)]
150enum SoftHomeSensorType {
151 Pnp,
153 Npn,
155}
156
157pub struct Axis {
167 config: AxisConfig,
168 sdo: SdoClient,
169
170 op: AxisOp,
172 home_offset: i32,
173 last_raw_position: i32,
174 op_started: Option<Instant>,
175 op_timeout: Duration,
176 homing_timeout: Duration,
177 move_start_timeout: Duration,
178 pending_move_target: i32,
179 pending_move_vel: u32,
180 pending_move_accel: u32,
181 pending_move_decel: u32,
182 homing_method: i8,
183 homing_sdo_tid: u32,
184 soft_home_sensor: SoftHomeSensor,
185 soft_home_sensor_type: SoftHomeSensorType,
186 soft_home_direction: f64,
187 halt_stable_count: u8,
188 prev_positive_limit: bool,
189 prev_negative_limit: bool,
190 prev_home_sensor: bool,
191
192
193
194 fb_mode_of_operation : FbSetModeOfOperation,
195
196 pub is_error: bool,
200 pub error_code: u32,
202 pub error_message: String,
204 pub motor_on: bool,
206 pub is_busy: bool,
212 pub in_motion: bool,
214 pub moving_positive: bool,
216 pub moving_negative: bool,
218 pub position: f64,
220 pub raw_position: i64,
222 pub speed: f64,
224 pub at_max_limit: bool,
226 pub at_min_limit: bool,
228 pub at_positive_limit_switch: bool,
230 pub at_negative_limit_switch: bool,
232 pub home_sensor: bool,
234
235
236 ton : Ton
238}
239
240impl Axis {
241 pub fn new(config: AxisConfig, device_name: &str) -> Self {
246 let op_timeout = Duration::from_secs_f64(config.operation_timeout_secs);
247 let homing_timeout = Duration::from_secs_f64(config.homing_timeout_secs);
248 let move_start_timeout = op_timeout; Self {
250 config,
251 sdo: SdoClient::new(device_name),
252 op: AxisOp::Idle,
253 home_offset: 0,
254 last_raw_position: 0,
255 op_started: None,
256 op_timeout,
257 homing_timeout,
258 move_start_timeout,
259 pending_move_target: 0,
260 pending_move_vel: 0,
261 pending_move_accel: 0,
262 pending_move_decel: 0,
263 homing_method: 37,
264 homing_sdo_tid: 0,
265 soft_home_sensor: SoftHomeSensor::HomeSensor,
266 soft_home_sensor_type: SoftHomeSensorType::Pnp,
267 soft_home_direction: 1.0,
268 halt_stable_count: 0,
269 prev_positive_limit: false,
270 prev_negative_limit: false,
271 prev_home_sensor: false,
272 is_error: false,
273 error_code: 0,
274 error_message: String::new(),
275 motor_on: false,
276 is_busy: false,
277 in_motion: false,
278 moving_positive: false,
279 moving_negative: false,
280 position: 0.0,
281 raw_position: 0,
282 speed: 0.0,
283 at_max_limit: false,
284 at_min_limit: false,
285 at_positive_limit_switch: false,
286 at_negative_limit_switch: false,
287 home_sensor: false,
288 ton: Ton::new(),
289 fb_mode_of_operation : FbSetModeOfOperation::new()
290 }
291 }
292
293 pub fn config(&self) -> &AxisConfig {
295 &self.config
296 }
297
298 pub fn move_absolute(
308 &mut self,
309 view: &mut impl AxisView,
310 target: f64,
311 vel: f64,
312 accel: f64,
313 decel: f64,
314 ) {
315 if let Some(msg) = self.check_target_limit(target, view) {
316 self.set_op_error(&msg);
317 return;
318 }
319
320 let cpu = self.config.counts_per_user();
321 let raw_target = self.config.to_counts(target).round() as i32 + self.home_offset;
322 let raw_vel = (vel * cpu).round() as u32;
323 let raw_accel = (accel * cpu).round() as u32;
324 let raw_decel = (decel * cpu).round() as u32;
325
326 let user_pos = target > self.position;
328 let user_neg = target < self.position;
329
330 self.start_move(view, raw_target, raw_vel, raw_accel, raw_decel, MoveKind::Absolute, user_pos, user_neg);
331 }
332
333 pub fn move_relative(
339 &mut self,
340 view: &mut impl AxisView,
341 distance: f64,
342 vel: f64,
343 accel: f64,
344 decel: f64,
345 ) {
346 log::info!("Axis: request to move relative dist {} vel {} accel {} decel {}",
347 distance, vel, accel, decel
348 );
349
350 if let Some(msg) = self.check_target_limit(self.position + distance, view) {
351 self.set_op_error(&msg);
352 return;
353 }
354
355 let cpu = self.config.counts_per_user();
356 let raw_distance = self.config.to_counts(distance).round() as i32;
357 let raw_vel = (vel * cpu).round() as u32;
358 let raw_accel = (accel * cpu).round() as u32;
359 let raw_decel = (decel * cpu).round() as u32;
360
361 log::info!("Axis starting relative move: request to move relative raw dist {} raw vel {} raw accel {} raw decel {}",
362 raw_distance, raw_vel, raw_accel, raw_decel
363 );
364
365 let mut cw = RawControlWord(view.control_word());
367 cw.set_bit(4, false); view.set_control_word(cw.raw());
369
370 let user_pos = distance > 0.0;
372 let user_neg = distance < 0.0;
373
374 self.start_move(view, raw_distance, raw_vel, raw_accel, raw_decel, MoveKind::Relative, user_pos, user_neg);
375 }
376
377 fn start_move(
378 &mut self,
379 view: &mut impl AxisView,
380 raw_target: i32,
381 raw_vel: u32,
382 raw_accel: u32,
383 raw_decel: u32,
384 kind: MoveKind,
385 user_pos: bool,
386 user_neg: bool,
387 ) {
388 self.pending_move_target = raw_target;
389 self.pending_move_vel = raw_vel;
390 self.pending_move_accel = raw_accel;
391 self.pending_move_decel = raw_decel;
392
393 view.set_target_position(raw_target);
395 view.set_profile_velocity(raw_vel);
396 view.set_profile_acceleration(raw_accel);
397 view.set_profile_deceleration(raw_decel);
398
399 let mut cw = RawControlWord(view.control_word());
404 cw.set_bit(6, kind == MoveKind::Relative);
405 cw.set_bit(8, false); cw.set_bit(4, true); view.set_control_word(cw.raw());
408
409 self.op = AxisOp::Moving(kind, 1, user_pos, user_neg);
414 self.op_started = Some(Instant::now());
415 }
416
417 pub fn halt(&mut self, view: &mut impl AxisView) {
435 self.command_halt(view);
436 self.halt_stable_count = 0;
437 self.last_raw_position = view.position_actual();
438 self.op_started = Some(Instant::now());
439 self.op = AxisOp::Halting(HaltState::WaitStopped as u8);
440 }
441
442 pub fn enable(&mut self, view: &mut impl AxisView) {
450 view.set_modes_of_operation(ModesOfOperation::ProfilePosition.as_i8());
452 let mut cw = RawControlWord(view.control_word());
453 cw.cmd_shutdown();
454 view.set_control_word(cw.raw());
455
456 self.op = AxisOp::Enabling(1);
457 self.op_started = Some(Instant::now());
458 }
459
460 pub fn disable(&mut self, view: &mut impl AxisView) {
462 let mut cw = RawControlWord(view.control_word());
463 cw.cmd_disable_operation();
464 cw.set_bit(4, false);
465 cw.set_bit(8, false);
466 cw.set_bit(7, false);
467 cw.set_bit(2, true);
468 view.set_control_word(cw.raw());
469
470 self.op = AxisOp::Disabling(1);
471 self.op_started = Some(Instant::now());
472 }
473
474 pub fn reset_faults(&mut self, view: &mut impl AxisView) {
490 let sw = RawStatusWord(view.status_word());
491 let drive_in_fault = matches!(
492 sw.state(),
493 Cia402State::Fault | Cia402State::FaultReactionActive
494 );
495
496 self.is_error = false;
497 self.error_code = 0;
498 self.error_message.clear();
499
500 if drive_in_fault {
501 let mut cw = RawControlWord(view.control_word());
503 cw.cmd_clear_fault_reset();
504 view.set_control_word(cw.raw());
505 self.op = AxisOp::FaultRecovery(1);
506 self.op_started = Some(Instant::now());
507 } else {
508 self.op = AxisOp::Idle;
510 self.op_started = None;
511 self.is_busy = false;
512 self.in_motion = false;
513 }
514 }
515
516 pub fn home(&mut self, view: &mut impl AxisView, method: HomingMethod) {
524 if method.is_integrated() {
525 self.homing_method = match method {
526 HomingMethod::CurrentPosition => self.config.soft_home_method,
527 _ => method.cia402_code(),
528 };
529 self.op = AxisOp::Homing(0);
530 self.op_started = Some(Instant::now());
531 let _ = view;
532 } else {
533 self.configure_soft_homing(method);
534 self.start_soft_homing(view);
535 }
536 }
537
538 pub fn set_position(&mut self, view: &impl AxisView, user_units: f64) {
547 self.home_offset = view.position_actual() - self.config.to_counts(user_units).round() as i32;
548 }
549
550 pub fn set_position_persistent(
567 &mut self,
568 client: &mut CommandClient,
569 user_units: f64,
570 ) {
571 self.config.home_position = user_units;
578 let desired_counts = self.config.to_counts(user_units).round() as i32;
579 self.homing_sdo_tid = self.sdo.write(client, 0x607C, 0, json!(desired_counts));
580 self.op = AxisOp::SoftHoming(HomeState::WaitHomeOffsetDone as u8);
581 self.op_started = Some(Instant::now());
582 log::info!(
583 "set_position_persistent: writing 0x607C = {} counts ({} user units)",
584 desired_counts, user_units
585 );
586 }
587
588 pub fn set_home_position(&mut self, user_units: f64) {
592 self.config.home_position = user_units;
593 }
594
595 pub fn set_software_max_limit(&mut self, user_units: f64) {
597 self.config.max_position_limit = user_units;
598 self.config.enable_max_position_limit = true;
599 }
600
601 pub fn set_software_min_limit(&mut self, user_units: f64) {
603 self.config.min_position_limit = user_units;
604 self.config.enable_min_position_limit = true;
605 }
606
607 pub fn sdo_write(
613 &mut self,
614 client: &mut CommandClient,
615 index: u16,
616 sub_index: u8,
617 value: serde_json::Value,
618 ) {
619 self.sdo.write(client, index, sub_index, value);
620 }
621
622 pub fn sdo_read(
624 &mut self,
625 client: &mut CommandClient,
626 index: u16,
627 sub_index: u8,
628 ) -> u32 {
629 self.sdo.read(client, index, sub_index)
630 }
631
632 pub fn sdo_result(
634 &mut self,
635 client: &mut CommandClient,
636 tid: u32,
637 ) -> SdoResult {
638 self.sdo.result(client, tid, Duration::from_secs(5))
639 }
640
641 pub fn tick(&mut self, view: &mut impl AxisView, client: &mut CommandClient) {
655 self.check_faults(view);
656 self.progress_op(view, client);
657 self.update_outputs(view);
658 self.check_limits(view);
659 }
660
661 fn update_outputs(&mut self, view: &impl AxisView) {
666 let raw = view.position_actual();
667 self.raw_position = raw as i64;
668 self.position = self.config.to_user((raw - self.home_offset) as f64);
669
670 let vel = view.velocity_actual();
671 let user_vel = self.config.to_user(vel as f64);
672 self.speed = user_vel.abs();
673 self.moving_positive = user_vel > 0.0;
674 self.moving_negative = user_vel < 0.0;
675 self.is_busy = self.op != AxisOp::Idle;
676 self.in_motion = matches!(self.op, AxisOp::Moving(_, _, _, _) | AxisOp::SoftHoming(_));
677
678 let sw = RawStatusWord(view.status_word());
679 self.motor_on = sw.state() == Cia402State::OperationEnabled;
680
681 self.last_raw_position = raw;
682 }
683
684 fn check_faults(&mut self, view: &impl AxisView) {
689 let sw = RawStatusWord(view.status_word());
690 let state = sw.state();
691
692 if matches!(state, Cia402State::Fault | Cia402State::FaultReactionActive) {
693 if !matches!(self.op, AxisOp::FaultRecovery(_)) {
694 self.is_error = true;
695 let ec = view.error_code();
696 if ec != 0 {
697 self.error_code = ec as u32;
698 }
699 self.error_message = format!("Drive fault (state: {})", state);
700 self.op = AxisOp::Idle;
702 self.op_started = None;
703 }
704 }
705 }
706
707 fn op_timed_out(&self) -> bool {
712 self.op_started
713 .map_or(false, |t| t.elapsed() > self.op_timeout)
714 }
715
716 fn homing_timed_out(&self) -> bool {
717 self.op_started
718 .map_or(false, |t| t.elapsed() > self.homing_timeout)
719 }
720
721 fn move_start_timed_out(&self) -> bool {
722 self.op_started
723 .map_or(false, |t| t.elapsed() > self.move_start_timeout)
724 }
725
726 fn op_stage_timed_out(&self, limit: Duration) -> bool {
730 self.op_started
731 .map_or(false, |t| t.elapsed() > limit)
732 }
733
734 fn set_op_error(&mut self, msg: &str) {
735 self.is_error = true;
736 self.error_message = msg.to_string();
737 self.op = AxisOp::Idle;
738 self.op_started = None;
739 self.is_busy = false;
740 self.in_motion = false;
741 log::error!("Axis error: {}", msg);
742 }
743
744 fn restore_pp_after_error(&mut self, msg: &str) {
745 self.is_error = true;
746 self.error_message = msg.to_string();
747 self.op = AxisOp::SoftHoming(HomeState::WriteMotionModeOfOperation as u8);;
748 log::error!("Axis error: {}", msg);
749 }
750
751 fn finish_op_error(&mut self) {
752 self.op = AxisOp::Idle;
753 self.op_started = None;
754 self.is_busy = false;
755 self.in_motion = false;
756 }
757
758 fn complete_op(&mut self) {
759 self.op = AxisOp::Idle;
760 self.op_started = None;
761 self.is_busy = false;
766 self.in_motion = false;
767 }
768
769 fn effective_max_limit(&self, view: &impl AxisView) -> Option<f64> {
778 let static_limit = if self.config.enable_max_position_limit {
779 Some(self.config.max_position_limit)
780 } else {
781 None
782 };
783 match (static_limit, view.dynamic_max_position_limit()) {
784 (Some(s), Some(d)) => Some(s.min(d)),
785 (Some(v), None) | (None, Some(v)) => Some(v),
786 (None, None) => None,
787 }
788 }
789
790 fn effective_min_limit(&self, view: &impl AxisView) -> Option<f64> {
794 let static_limit = if self.config.enable_min_position_limit {
795 Some(self.config.min_position_limit)
796 } else {
797 None
798 };
799 match (static_limit, view.dynamic_min_position_limit()) {
800 (Some(s), Some(d)) => Some(s.max(d)),
801 (Some(v), None) | (None, Some(v)) => Some(v),
802 (None, None) => None,
803 }
804 }
805
806 fn check_target_limit(&self, target: f64, view: &impl AxisView) -> Option<String> {
811 if let Some(max) = self.effective_max_limit(view) {
812 if target > max {
813 return Some(format!(
814 "Target {:.3} exceeds max software limit {:.3}",
815 target, max
816 ));
817 }
818 }
819 if let Some(min) = self.effective_min_limit(view) {
820 if target < min {
821 return Some(format!(
822 "Target {:.3} exceeds min software limit {:.3}",
823 target, min
824 ));
825 }
826 }
827 None
828 }
829
830 fn check_limits(&mut self, view: &mut impl AxisView) {
839 let eff_max = self.effective_max_limit(view);
841 let eff_min = self.effective_min_limit(view);
842 let sw_max = eff_max.map_or(false, |m| self.position >= m);
843 let sw_min = eff_min.map_or(false, |m| self.position <= m);
844
845 self.at_max_limit = sw_max;
846 self.at_min_limit = sw_min;
847
848 let hw_pos = view.positive_limit_active();
850 let hw_neg = view.negative_limit_active();
851
852 self.at_positive_limit_switch = hw_pos;
853 self.at_negative_limit_switch = hw_neg;
854
855 self.home_sensor = view.home_sensor_active();
857
858 self.prev_positive_limit = hw_pos;
860 self.prev_negative_limit = hw_neg;
861 self.prev_home_sensor = view.home_sensor_active();
862
863 let mut commanded_positive = false;
865 let mut commanded_negative = false;
866
867 let is_moving = matches!(self.op, AxisOp::Moving(_, _, _, _));
868 let is_soft_homing = matches!(self.op, AxisOp::SoftHoming(_));
869
870 if !is_moving && !is_soft_homing {
871 return; }
873
874 match &self.op {
875 AxisOp::Moving(_, _, pos, neg) => {
876 commanded_positive = *pos;
878 commanded_negative = *neg;
879 }
880 AxisOp::SoftHoming(_) => {
881 match self.soft_home_sensor {
882 SoftHomeSensor::PositiveLimit => commanded_positive = true,
883 SoftHomeSensor::NegativeLimit => commanded_negative = true,
884 SoftHomeSensor::HomeSensor => {
885 commanded_positive = self.moving_positive;
886 commanded_negative = self.moving_negative;
887 }
888 }
889 }
890 _ => {}
891 }
892
893 let suppress_pos = is_soft_homing && self.soft_home_sensor == SoftHomeSensor::PositiveLimit;
895 let suppress_neg = is_soft_homing && self.soft_home_sensor == SoftHomeSensor::NegativeLimit;
896
897 let effective_hw_pos = hw_pos && !suppress_pos;
898 let effective_hw_neg = hw_neg && !suppress_neg;
899
900 let effective_sw_max = sw_max && !is_soft_homing;
902 let effective_sw_min = sw_min && !is_soft_homing;
903
904 let positive_blocked = (effective_sw_max || effective_hw_pos) && commanded_positive;
905 let negative_blocked = (effective_sw_min || effective_hw_neg) && commanded_negative;
906
907
908 if positive_blocked || negative_blocked {
909 let mut cw = RawControlWord(view.control_word());
910 cw.set_bit(8, true); view.set_control_word(cw.raw());
912
913 let msg = if effective_hw_pos && commanded_positive {
914 "Positive limit switch active".to_string()
915 } else if effective_hw_neg && commanded_negative {
916 "Negative limit switch active".to_string()
917 } else if effective_sw_max && commanded_positive {
918 format!(
919 "Software position limit: position {:.3} >= max {:.3}",
920 self.position, eff_max.unwrap_or(self.position)
921 )
922 } else {
923 format!(
924 "Software position limit: position {:.3} <= min {:.3}",
925 self.position, eff_min.unwrap_or(self.position)
926 )
927 };
928
929 if is_soft_homing {
930 self.set_op_error(&msg);
933 } else {
934 log::info!("Axis move halted by limit: {}", msg);
947 self.command_halt(view);
948 self.halt_stable_count = 0;
949 self.last_raw_position = view.position_actual();
950 self.op_started = Some(Instant::now());
951 self.op = AxisOp::Halting(HaltState::WaitStopped as u8);
952 }
953 }
954 }
955
956 fn progress_op(&mut self, view: &mut impl AxisView, client: &mut CommandClient) {
961 match self.op.clone() {
962 AxisOp::Idle => {}
963 AxisOp::Enabling(step) => self.tick_enabling(view, step),
964 AxisOp::Disabling(step) => self.tick_disabling(view, step),
965 AxisOp::Moving(kind, step, pos, neg) => self.tick_moving(view, kind, step, pos, neg),
966 AxisOp::Homing(step) => self.tick_homing(view, client, step),
967 AxisOp::SoftHoming(step) => self.tick_soft_homing(view, client, step),
968 AxisOp::Halting(step) => self.tick_halting(view, step),
969 AxisOp::FaultRecovery(step) => self.tick_fault_recovery(view, step),
970 }
971 }
972
973 fn tick_enabling(&mut self, view: &mut impl AxisView, step: u8) {
978 match step {
979 1 => {
980 let sw = RawStatusWord(view.status_word());
981 if sw.state() == Cia402State::ReadyToSwitchOn {
982 let mut cw = RawControlWord(view.control_word());
983 cw.cmd_enable_operation();
984 view.set_control_word(cw.raw());
985 self.op = AxisOp::Enabling(2);
986 } else if self.op_timed_out() {
987 self.set_op_error("Enable timeout: waiting for ReadyToSwitchOn");
988 }
989 }
990 2 => {
991 let sw = RawStatusWord(view.status_word());
992 if sw.state() == Cia402State::OperationEnabled {
993 self.complete_op();
1000 } else if self.op_timed_out() {
1001 self.set_op_error("Enable timeout: waiting for OperationEnabled");
1002 }
1003 }
1004 _ => self.complete_op(),
1005 }
1006 }
1007
1008 fn tick_disabling(&mut self, view: &mut impl AxisView, step: u8) {
1012 match step {
1013 1 => {
1014 let sw = RawStatusWord(view.status_word());
1015 if sw.state() != Cia402State::OperationEnabled {
1016 self.complete_op();
1017 } else if self.op_timed_out() {
1018 self.set_op_error("Disable timeout: drive still in OperationEnabled");
1019 }
1020 }
1021 _ => self.complete_op(),
1022 }
1023 }
1024
1025 fn tick_moving(&mut self, view: &mut impl AxisView, kind: MoveKind, step: u8, pos: bool, neg: bool) {
1031 match step {
1032 1 => {
1033 let sw = RawStatusWord(view.status_word());
1035 if sw.raw() & (1 << 12) != 0 {
1036 let mut cw = RawControlWord(view.control_word());
1038 cw.set_bit(4, false);
1039 view.set_control_word(cw.raw());
1040 self.op = AxisOp::Moving(kind, 2, pos, neg);
1041 } else if self.move_start_timed_out() {
1042 self.set_op_error("Move timeout: set-point not acknowledged");
1043 }
1044 },
1045 2 => {
1046 let sw = RawStatusWord(view.status_word());
1048 if sw.raw() & (1 << 12) == 0 {
1049 self.op = AxisOp::Moving(kind, 3, pos, neg);
1051 }
1052 },
1053 3 => {
1054 let sw = RawStatusWord(view.status_word());
1056 if sw.target_reached() {
1057 self.complete_op();
1058 }
1059 },
1060 _ => self.complete_op(),
1061 }
1062 }
1063
1064 fn tick_homing(
1090 &mut self,
1091 view: &mut impl AxisView,
1092 client: &mut CommandClient,
1093 step: u8,
1094 ) {
1095 match step {
1096 0 => {
1097 self.homing_sdo_tid = self.sdo.write(
1099 client,
1100 0x6098,
1101 0,
1102 json!(self.homing_method),
1103 );
1104 self.op = AxisOp::Homing(1);
1105 }
1106 1 => {
1107 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1109 SdoResult::Ok(_) => {
1110 if self.config.homing_speed == 0.0 && self.config.homing_accel == 0.0 {
1112 self.op = AxisOp::Homing(8);
1113 } else {
1114 self.op = AxisOp::Homing(2);
1115 }
1116 }
1117 SdoResult::Pending => {
1118 if self.homing_timed_out() {
1119 self.set_op_error("Homing timeout: SDO write for homing method");
1120 }
1121 }
1122 SdoResult::Err(e) => {
1123 self.set_op_error(&format!("Homing SDO error: {}", e));
1124 }
1125 SdoResult::Timeout => {
1126 self.set_op_error("Homing timeout: SDO write timed out");
1127 }
1128 }
1129 }
1130 2 => {
1131 let speed_counts = self.config.to_counts(self.config.homing_speed).round() as u32;
1133 self.homing_sdo_tid = self.sdo.write(
1134 client,
1135 0x6099,
1136 1,
1137 json!(speed_counts),
1138 );
1139 self.op = AxisOp::Homing(3);
1140 }
1141 3 => {
1142 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1143 SdoResult::Ok(_) => { self.op = AxisOp::Homing(4); }
1144 SdoResult::Pending => {
1145 if self.homing_timed_out() {
1146 self.set_op_error("Homing timeout: SDO write for homing speed (switch)");
1147 }
1148 }
1149 SdoResult::Err(e) => { self.set_op_error(&format!("Homing SDO error: {}", e)); }
1150 SdoResult::Timeout => { self.set_op_error("Homing timeout: SDO write timed out"); }
1151 }
1152 }
1153 4 => {
1154 let speed_counts = self.config.to_counts(self.config.homing_speed).round() as u32;
1156 self.homing_sdo_tid = self.sdo.write(
1157 client,
1158 0x6099,
1159 2,
1160 json!(speed_counts),
1161 );
1162 self.op = AxisOp::Homing(5);
1163 }
1164 5 => {
1165 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1166 SdoResult::Ok(_) => { self.op = AxisOp::Homing(6); }
1167 SdoResult::Pending => {
1168 if self.homing_timed_out() {
1169 self.set_op_error("Homing timeout: SDO write for homing speed (zero)");
1170 }
1171 }
1172 SdoResult::Err(e) => { self.set_op_error(&format!("Homing SDO error: {}", e)); }
1173 SdoResult::Timeout => { self.set_op_error("Homing timeout: SDO write timed out"); }
1174 }
1175 }
1176 6 => {
1177 let accel_counts = self.config.to_counts(self.config.homing_accel).round() as u32;
1179 self.homing_sdo_tid = self.sdo.write(
1180 client,
1181 0x609A,
1182 0,
1183 json!(accel_counts),
1184 );
1185 self.op = AxisOp::Homing(7);
1186 }
1187 7 => {
1188 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1189 SdoResult::Ok(_) => { self.op = AxisOp::Homing(8); }
1190 SdoResult::Pending => {
1191 if self.homing_timed_out() {
1192 self.set_op_error("Homing timeout: SDO write for homing acceleration");
1193 }
1194 }
1195 SdoResult::Err(e) => { self.set_op_error(&format!("Homing SDO error: {}", e)); }
1196 SdoResult::Timeout => { self.set_op_error("Homing timeout: SDO write timed out"); }
1197 }
1198 }
1199 8 => {
1200 view.set_modes_of_operation(ModesOfOperation::Homing.as_i8());
1210 let mut cw = RawControlWord(view.control_word());
1212 cw.set_bit(4, false);
1213 view.set_control_word(cw.raw());
1214 self.fb_mode_of_operation.reset();
1215 self.fb_mode_of_operation.start(ModesOfOperation::Homing as i8);
1216 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1217 self.op = AxisOp::Homing(9);
1218 }
1219 9 => {
1220 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1222 if !self.fb_mode_of_operation.is_busy() {
1223 if self.fb_mode_of_operation.is_error() {
1224 self.set_op_error(&format!(
1225 "Homing: failed to enter Homing mode: {} {}",
1226 self.fb_mode_of_operation.error_code(),
1227 self.fb_mode_of_operation.error_message()
1228 ));
1229 } else {
1230 self.op = AxisOp::Homing(10);
1231 }
1232 }
1233 }
1234 10 => {
1235 let mut cw = RawControlWord(view.control_word());
1237 cw.set_bit(4, true);
1238 view.set_control_word(cw.raw());
1239 self.op = AxisOp::Homing(11);
1240 }
1241 11 => {
1242 let sw = view.status_word();
1254 if sw & (1 << 13) != 0 {
1255 self.set_op_error("Homing error: drive reported homing failure");
1256 } else {
1257 self.op = AxisOp::Homing(12);
1258 }
1259 }
1260 12 => {
1261 let sw = view.status_word();
1269 let error = sw & (1 << 13) != 0;
1270 let attained = sw & (1 << 12) != 0;
1271
1272 if error {
1273 self.set_op_error("Homing error: drive reported homing failure");
1274 } else if attained {
1275 self.op = AxisOp::Homing(13);
1276 } else if self.homing_timed_out() {
1277 self.set_op_error(&format!("Homing timeout: procedure did not complete (sw=0x{:04X})", sw));
1278 }
1279 }
1280 13 => {
1281 self.home_offset = view.position_actual()
1284 - self.config.to_counts(self.config.home_position).round() as i32;
1285 let mut cw = RawControlWord(view.control_word());
1287 cw.set_bit(4, false);
1288 view.set_control_word(cw.raw());
1289 self.op = AxisOp::Homing(14);
1290 }
1291 14 => {
1292 view.set_modes_of_operation(ModesOfOperation::ProfilePosition.as_i8());
1298 self.fb_mode_of_operation.reset();
1299 self.fb_mode_of_operation.start(ModesOfOperation::ProfilePosition as i8);
1300 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1301 self.op = AxisOp::Homing(15);
1302 }
1303 15 => {
1304 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1306 if !self.fb_mode_of_operation.is_busy() {
1307 if self.fb_mode_of_operation.is_error() {
1308 self.set_op_error(&format!(
1309 "Homing: failed to restore PP mode: {} {}",
1310 self.fb_mode_of_operation.error_code(),
1311 self.fb_mode_of_operation.error_message()
1312 ));
1313 } else {
1314 log::info!("Homing complete — home offset: {}", self.home_offset);
1315 self.complete_op();
1316 }
1317 }
1318 }
1319 _ => self.complete_op(),
1320 }
1321 }
1322
1323 fn configure_soft_homing(&mut self, method: HomingMethod) {
1326 match method {
1327 HomingMethod::LimitSwitchPosPnp => {
1328 self.soft_home_sensor = SoftHomeSensor::PositiveLimit;
1329 self.soft_home_sensor_type = SoftHomeSensorType::Pnp;
1330 self.soft_home_direction = 1.0;
1331 }
1332 HomingMethod::LimitSwitchNegPnp => {
1333 self.soft_home_sensor = SoftHomeSensor::NegativeLimit;
1334 self.soft_home_sensor_type = SoftHomeSensorType::Pnp;
1335 self.soft_home_direction = -1.0;
1336 }
1337 HomingMethod::LimitSwitchPosNpn => {
1338 self.soft_home_sensor = SoftHomeSensor::PositiveLimit;
1339 self.soft_home_sensor_type = SoftHomeSensorType::Npn;
1340 self.soft_home_direction = 1.0;
1341 }
1342 HomingMethod::LimitSwitchNegNpn => {
1343 self.soft_home_sensor = SoftHomeSensor::NegativeLimit;
1344 self.soft_home_sensor_type = SoftHomeSensorType::Npn;
1345 self.soft_home_direction = -1.0;
1346 }
1347 HomingMethod::HomeSensorPosPnp => {
1348 self.soft_home_sensor = SoftHomeSensor::HomeSensor;
1349 self.soft_home_sensor_type = SoftHomeSensorType::Pnp;
1350 self.soft_home_direction = 1.0;
1351 }
1352 HomingMethod::HomeSensorNegPnp => {
1353 self.soft_home_sensor = SoftHomeSensor::HomeSensor;
1354 self.soft_home_sensor_type = SoftHomeSensorType::Pnp;
1355 self.soft_home_direction = -1.0;
1356 }
1357 HomingMethod::HomeSensorPosNpn => {
1358 self.soft_home_sensor = SoftHomeSensor::HomeSensor;
1359 self.soft_home_sensor_type = SoftHomeSensorType::Npn;
1360 self.soft_home_direction = 1.0;
1361 }
1362 HomingMethod::HomeSensorNegNpn => {
1363 self.soft_home_sensor = SoftHomeSensor::HomeSensor;
1364 self.soft_home_sensor_type = SoftHomeSensorType::Npn;
1365 self.soft_home_direction = -1.0;
1366 }
1367 _ => {} }
1369 }
1370
1371 fn start_soft_homing(&mut self, view: &mut impl AxisView) {
1372 self.op = AxisOp::SoftHoming(HomeState::EnsurePpMode as u8);
1373 self.op_started = Some(Instant::now());
1374 }
1375
1376 fn check_soft_home_trigger(&self, view: &impl AxisView) -> bool {
1377 let raw = match self.soft_home_sensor {
1378 SoftHomeSensor::PositiveLimit => view.positive_limit_active(),
1379 SoftHomeSensor::NegativeLimit => view.negative_limit_active(),
1380 SoftHomeSensor::HomeSensor => view.home_sensor_active(),
1381 };
1382 match self.soft_home_sensor_type {
1383 SoftHomeSensorType::Pnp => raw, SoftHomeSensorType::Npn => !raw, }
1386 }
1387
1388
1389 fn calculate_max_relative_target(&self, direction : f64) -> i32 {
1392 let dir = if !self.config.invert_direction {
1393 direction
1394 }
1395 else {
1396 -direction
1397 };
1398
1399 let target = if dir > 0.0 {
1400 i32::MAX
1401 }
1402 else {
1403 i32::MIN
1404 };
1405
1406 return target;
1407 }
1408
1409
1410 pub fn command_halt(&self, view: &mut impl AxisView) {
1415 let mut cw = RawControlWord(view.control_word());
1416 cw.set_bit(8, true); cw.set_bit(4, false); cw.set_bit(5, true); cw.set_bit(6, false); view.set_control_word(cw.raw());
1421 }
1422
1423 pub fn command_clear_halt(&self, view: &mut impl AxisView) {
1426 let mut cw = RawControlWord(view.control_word());
1427 cw.set_bit(8, false); view.set_control_word(cw.raw());
1429 }
1430
1431
1432 pub fn command_cancel_move(&self, view: &mut impl AxisView) {
1440
1441 let mut cw = RawControlWord(view.control_word());
1442
1443 cw.set_bit(4, true); cw.set_bit(5, true); cw.set_bit(6, false); if self.config().clear_halt_during_cancel {
1448 cw.set_bit(8, false); }
1451
1452 view.set_control_word(cw.raw());
1453
1454 let current_pos = view.position_actual();
1455 view.set_target_position(current_pos);
1456 view.set_profile_velocity(0);
1457 }
1458
1459
1460 fn command_homing_speed(&self, view: &mut impl AxisView) {
1462 let cpu = self.config.counts_per_user();
1463 let vel = (self.config.homing_speed * cpu).round() as u32;
1464 let accel = (self.config.homing_accel * cpu).round() as u32;
1465 let decel = (self.config.homing_decel * cpu).round() as u32;
1466 view.set_profile_velocity(vel);
1467 view.set_profile_acceleration(accel);
1468 view.set_profile_deceleration(decel);
1469 }
1470
1471 fn tick_soft_homing(&mut self, view: &mut impl AxisView, client: &mut CommandClient, step: u8) {
1487 match HomeState::from_repr(step) {
1488
1489 Some(HomeState::EnsurePpMode) => {
1490 log::info!("SoftHome: Ensuring PP mode..");
1495 self.fb_mode_of_operation.start(ModesOfOperation::ProfilePosition as i8);
1496 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1497 self.op = AxisOp::SoftHoming(HomeState::WaitPpMode as u8);
1498 },
1499 Some(HomeState::WaitPpMode) => {
1500
1501 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1502 if !self.fb_mode_of_operation.is_busy() {
1503 if self.fb_mode_of_operation.is_error() {
1504 self.set_op_error(&format!("Software homing SDO error writing homing mode of operation: {} {}",
1505 self.fb_mode_of_operation.error_code(), self.fb_mode_of_operation.error_message()
1506 ));
1507 }
1508 else {
1509 log::info!("SoftHome: Drive is in PP mode!");
1510
1511 if !self.check_soft_home_trigger(view) {
1515 log::info!("SoftHome: Not on home switch; seek out.");
1516 self.op = AxisOp::SoftHoming(HomeState::Search as u8);
1517 } else {
1518 log::info!("SoftHome: Already on home switch, skipping ahead to back-off stage.");
1519 self.op = AxisOp::SoftHoming(HomeState::WaitFoundSensor as u8);
1520 }
1521 }
1522 }
1523
1524
1525 },
1526
1527 Some(HomeState::Search) => {
1529 view.set_modes_of_operation(ModesOfOperation::ProfilePosition.as_i8());
1530
1531 let target = self.calculate_max_relative_target(self.soft_home_direction);
1541 view.set_target_position(target);
1542
1543 self.command_homing_speed(view);
1552
1553 let mut cw = RawControlWord(view.control_word());
1554 cw.set_bit(4, true); cw.set_bit(6, true); cw.set_bit(8, false); cw.set_bit(13, true); view.set_control_word(cw.raw());
1559
1560 log::info!("SoftHome[0]: SEARCH relative target={} vel={} dir={} pos={}",
1561 target, self.config.homing_speed, self.soft_home_direction, view.position_actual());
1562 self.op = AxisOp::SoftHoming(HomeState::WaitSearching as u8);
1563 }
1564 Some(HomeState::WaitSearching) => {
1565 if self.check_soft_home_trigger(view) {
1566 log::debug!("SoftHome[1]: sensor triggered during ack wait");
1567 self.op = AxisOp::SoftHoming(HomeState::WaitFoundSensor as u8);
1568 return;
1569 }
1570 let sw = RawStatusWord(view.status_word());
1571 if sw.raw() & (1 << 12) != 0 {
1572 let mut cw = RawControlWord(view.control_word());
1573 cw.set_bit(4, false);
1574 view.set_control_word(cw.raw());
1575 log::debug!("SoftHome[1]: set-point ack received, clearing bit 4");
1576 self.op = AxisOp::SoftHoming(HomeState::WaitFoundSensor as u8);
1577 } else if self.homing_timed_out() {
1578 self.set_op_error("Software homing timeout: set-point not acknowledged");
1579 }
1580 }
1581 Some(HomeState::WaitFoundSensor) => {
1591 if self.check_soft_home_trigger(view) {
1592 log::info!("SoftHome[3]: sensor triggered at pos={}. HALTING", view.position_actual());
1593 log::info!("ControlWord is : {} ", view.control_word());
1594
1595 let mut cw = RawControlWord(view.control_word());
1596 cw.set_bit(8, true); cw.set_bit(4, false); view.set_control_word(cw.raw());
1599
1600
1601 self.halt_stable_count = 0;
1602 self.op = AxisOp::SoftHoming(HomeState::WaitStoppedFoundSensor as u8);
1603 } else if self.homing_timed_out() {
1604 self.set_op_error("Software homing timeout: sensor not detected");
1605 }
1606 }
1607
1608
1609 Some(HomeState::WaitStoppedFoundSensor) => {
1610 const STABLE_WINDOW: i32 = 1;
1611 const STABLE_TICKS_REQUIRED: u8 = 10;
1612
1613 let pos = view.position_actual();
1618 if (pos - self.last_raw_position).abs() <= STABLE_WINDOW {
1619 self.halt_stable_count = self.halt_stable_count.saturating_add(1);
1620 } else {
1621 self.halt_stable_count = 0;
1622 }
1623
1624 if self.halt_stable_count >= STABLE_TICKS_REQUIRED {
1625
1626 log::info!("SoftHome[5] motor is stopped. Cancel move and wait for bit 12 go true.");
1627 self.command_cancel_move(view);
1628 self.op = AxisOp::SoftHoming(HomeState::WaitFoundSensorAck as u8);
1629
1630 } else if self.homing_timed_out() {
1631 self.set_op_error("Software homing timeout: motor did not stop after sensor trigger");
1632 }
1633 }
1634 Some(HomeState::WaitFoundSensorAck) => {
1635 let sw = RawStatusWord(view.status_word());
1636 if sw.raw() & (1 << 12) != 0 && sw.raw() & (1 << 10) != 0 {
1637
1638 log::info!("SoftHome[6]: relative move cancel ack received. Waiting before back-off...");
1639
1640 let mut cw = RawControlWord(view.control_word());
1642 cw.set_bit(4, false); cw.set_bit(5, true); view.set_control_word(cw.raw());
1645
1646 self.op = AxisOp::SoftHoming(HomeState::WaitFoundSensorAckClear as u8);
1647
1648 } else if self.homing_timed_out() {
1649 self.set_op_error("Software homing timeout: cancel not acknowledged");
1650 }
1651 },
1652 Some(HomeState::WaitFoundSensorAckClear) => {
1653 let sw = RawStatusWord(view.status_word());
1654 if sw.raw() & (1 << 12) == 0 {
1656
1657 self.command_clear_halt(view);
1659
1660 log::info!("SoftHome[6]: Handshake cleared (Bit 12 is LOW). Proceeding to delay.");
1661 self.op = AxisOp::SoftHoming(HomeState::DebounceFoundSensor as u8);
1662 self.ton.call(false, Duration::from_secs(3));
1663 }
1664 },
1665 Some(HomeState::DebounceFoundSensor) => {
1667 self.ton.call(true, Duration::from_secs(3));
1668
1669 let sw = RawStatusWord(view.status_word());
1670 if self.ton.q && sw.raw() & (1 << 12) == 0 {
1671 self.ton.call(false, Duration::from_secs(3));
1672 log::info!("SoftHome[6.a.]: delay complete, starting back-off from pos={} cw=0x{:04X} sw={:04x}",
1673 view.position_actual(), view.control_word(), view.status_word());
1674 self.op = AxisOp::SoftHoming(HomeState::BackOff as u8);
1675 }
1676 }
1677
1678 Some(HomeState::BackOff) => {
1680
1681 let target = (self.calculate_max_relative_target(-self.soft_home_direction)) / 2;
1682 view.set_target_position(target);
1683
1684
1685 self.command_homing_speed(view);
1686
1687 let mut cw = RawControlWord(view.control_word());
1688 cw.set_bit(4, true); cw.set_bit(6, true); cw.set_bit(13, true); view.set_control_word(cw.raw());
1692 log::info!("SoftHome[7]: BACK-OFF absolute target={} vel={} pos={} cw=0x{:04X}",
1693 target, self.config.homing_speed, view.position_actual(), cw.raw());
1694 self.op = AxisOp::SoftHoming(HomeState::WaitBackingOff as u8);
1695 }
1696 Some(HomeState::WaitBackingOff) => {
1697 let sw = RawStatusWord(view.status_word());
1698 if sw.raw() & (1 << 12) != 0 {
1699 let mut cw = RawControlWord(view.control_word());
1700 cw.set_bit(4, false);
1701 view.set_control_word(cw.raw());
1702 log::info!("SoftHome[WaitBackingOff]: back-off ack received, pos={}", view.position_actual());
1703 self.op = AxisOp::SoftHoming(HomeState::WaitLostSensor as u8);
1704 } else if self.homing_timed_out() {
1705 self.set_op_error("Software homing timeout: back-off not acknowledged");
1706 }
1707 }
1708 Some(HomeState::WaitLostSensor) => {
1709 if !self.check_soft_home_trigger(view) {
1710 log::info!("SoftHome[WaitLostSensor]: sensor lost at pos={}. Halting...", view.position_actual());
1711
1712 self.command_halt(view);
1713 self.op = AxisOp::SoftHoming(HomeState::WaitStoppedLostSensor as u8);
1714 } else if self.homing_timed_out() {
1715 self.set_op_error("Software homing timeout: sensor did not clear during back-off");
1716 }
1717 }
1718 Some(HomeState::WaitStoppedLostSensor) => {
1719 const STABLE_WINDOW: i32 = 1;
1720 const STABLE_TICKS_REQUIRED: u8 = 10;
1721
1722 let pos = view.position_actual();
1727 if (pos - self.last_raw_position).abs() <= STABLE_WINDOW {
1728 self.halt_stable_count = self.halt_stable_count.saturating_add(1);
1729 } else {
1730 self.halt_stable_count = 0;
1731 }
1732
1733 if self.halt_stable_count >= STABLE_TICKS_REQUIRED {
1734 log::info!("SoftHome[WaitStoppedLostSensor] motor is stopped. Cancel move and wait for bit 12 go true.");
1735 self.command_cancel_move(view);
1736 self.op = AxisOp::SoftHoming(HomeState::WaitLostSensorAck as u8);
1737 } else if self.homing_timed_out() {
1738 self.set_op_error("Software homing timeout: motor did not stop after back-off");
1739 }
1740 }
1741 Some(HomeState::WaitLostSensorAck) => {
1742 let sw = RawStatusWord(view.status_word());
1743 if sw.raw() & (1 << 12) != 0 && sw.raw() & (1 << 10) != 0 {
1744
1745 log::info!("SoftHome[WaitLostSensorAck]: relative move cancel ack received. Waiting before back-off...");
1746
1747 let mut cw = RawControlWord(view.control_word());
1749 cw.set_bit(4, false); view.set_control_word(cw.raw());
1751
1752 self.op = AxisOp::SoftHoming(HomeState::WaitLostSensorAckClear as u8);
1753
1754
1755 } else if self.homing_timed_out() {
1756 self.set_op_error("Software homing timeout: cancel not acknowledged");
1757 }
1758 }
1759 Some(HomeState::WaitLostSensorAckClear) => {
1760 let sw = RawStatusWord(view.status_word());
1762 if sw.raw() & (1 << 12) == 0 {
1763
1764 self.command_clear_halt(view);
1765
1766 let desired_counts = self.config.to_counts(self.config.home_position).round() as i32;
1767 self.homing_sdo_tid = self.sdo.write(
1770 client, 0x607C, 0, json!(desired_counts),
1771 );
1772
1773 log::info!("SoftHome[WaitLostSensorAckClear]: Handshake cleared (Bit 12 is LOW). Writing home offset {} [{} counts].",
1774 self.config.home_position, desired_counts
1775 );
1776
1777 self.op = AxisOp::SoftHoming(HomeState::WaitHomeOffsetDone as u8);
1778
1779 }
1780 },
1781
1782 Some(HomeState::WaitHomeOffsetDone) => {
1783 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1785 SdoResult::Ok(_) => { self.op = AxisOp::SoftHoming(HomeState::WriteHomingModeOp as u8); }
1786 SdoResult::Pending => {
1787 if self.homing_timed_out() {
1788 self.set_op_error("Software homing timeout: home offset SDO write");
1789 }
1790 }
1791 SdoResult::Err(e) => {
1792 self.set_op_error(&format!("Software homing SDO error: {}", e));
1793 }
1794 SdoResult::Timeout => {
1795 self.set_op_error("Software homing: home offset SDO timed out");
1796 }
1797 }
1798 },
1799 Some(HomeState::WriteHomingModeOp) => {
1800
1801 self.fb_mode_of_operation.reset();
1805 self.fb_mode_of_operation.start(ModesOfOperation::Homing as i8);
1806 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1807 self.op = AxisOp::SoftHoming(HomeState::WaitWriteHomingModeOp as u8);
1808
1809
1810 },
1811 Some(HomeState::WaitWriteHomingModeOp) => {
1812 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1814
1815 if !self.fb_mode_of_operation.is_busy() {
1816 if self.fb_mode_of_operation.is_error() {
1817 self.set_op_error(&format!("Software homing SDO error writing homing mode of operation: {} {}",
1818 self.fb_mode_of_operation.error_code(), self.fb_mode_of_operation.error_message()
1819 ));
1820 }
1821 else {
1822 log::info!("SoftHome: Drive is now in Homing Mode.");
1823 self.op = AxisOp::SoftHoming(HomeState::WriteHomingMethod as u8);
1824 }
1825 }
1826 },
1827 Some(HomeState::WriteHomingMethod) => {
1828 self.homing_sdo_tid = self.sdo.write(
1831 client, 0x6098, 0, json!(self.config.soft_home_method),
1832 );
1833 self.op = AxisOp::SoftHoming(HomeState::WaitWriteHomingMethodDone as u8);
1834 }
1835 Some(HomeState::WaitWriteHomingMethodDone) => {
1836 match self.sdo.result(client, self.homing_sdo_tid, Duration::from_secs(5)) {
1838 SdoResult::Ok(_) => {
1839 log::info!("SoftHome: Successfully wrote homing method.");
1840 self.op = AxisOp::SoftHoming(HomeState::ClearHomingTrigger as u8);
1841 }
1842 SdoResult::Pending => {
1843 if self.homing_timed_out() {
1844 self.restore_pp_after_error("Software homing timeout: homing method SDO write");
1845 }
1846 }
1847 SdoResult::Err(e) => {
1848 self.restore_pp_after_error(&format!("Software homing SDO error: {}", e));
1849 }
1850 SdoResult::Timeout => {
1851 self.restore_pp_after_error("Software homing: homing method SDO timed out");
1852 }
1853 }
1854 }
1855 Some(HomeState::ClearHomingTrigger) => {
1856 let mut cw = RawControlWord(view.control_word());
1859 cw.set_bit(4, false);
1860 view.set_control_word(cw.raw());
1861 self.op = AxisOp::SoftHoming(HomeState::TriggerHoming as u8);
1862 }
1863 Some(HomeState::TriggerHoming) => {
1864 let mut cw = RawControlWord(view.control_word());
1866 cw.set_bit(4, true);
1867 view.set_control_word(cw.raw());
1868 log::info!("SoftHome[TriggerHoming]: start homing");
1869 self.op = AxisOp::SoftHoming(HomeState::WaitHomingStarted as u8);
1870 }
1871 Some(HomeState::WaitHomingStarted) => {
1872 let sw = view.status_word();
1878 let error = sw & (1 << 13) != 0;
1879 if error {
1880 self.restore_pp_after_error("Software homing: drive reported homing error");
1881 } else if sw & (1 << 12) == 0 {
1882 self.op = AxisOp::SoftHoming(HomeState::WaitHomingDone as u8);
1883 } else if self.homing_timed_out() {
1884 self.restore_pp_after_error(&format!("Software homing timeout: drive did not acknowledge homing start (sw=0x{:04X})", sw));
1885 }
1886 }
1887 Some(HomeState::WaitHomingDone) => {
1888 let sw = view.status_word();
1890 let error = sw & (1 << 13) != 0;
1891 let attained = sw & (1 << 12) != 0;
1892 let reached = sw & (1 << 10) != 0;
1893
1894 if error {
1895 self.restore_pp_after_error("Software homing: drive reported homing error");
1896 } else if attained && reached {
1897 log::info!("SoftHome[WaitHomingDone]: homing complete (sw=0x{:04X})", sw);
1898 self.op = AxisOp::SoftHoming(HomeState::ResetHomingTrigger as u8);
1899 } else if self.homing_timed_out() {
1900 self.restore_pp_after_error(&format!("Software homing timeout: drive homing did not complete (sw=0x{:04X} attained={} reached={})", sw, attained, reached));
1901 }
1902 }
1903 Some(HomeState::ResetHomingTrigger) => {
1904 let mut cw = RawControlWord(view.control_word());
1909 cw.set_bit(4, false);
1910 view.set_control_word(cw.raw());
1911 self.op = AxisOp::SoftHoming(HomeState::WaitHomingTriggerCleared as u8);
1912 }
1913 Some(HomeState::WaitHomingTriggerCleared) => {
1914 self.home_offset = 0; self.op = AxisOp::SoftHoming(HomeState::WriteMotionModeOfOperation as u8);
1918 }
1919
1920
1921 Some(HomeState::WriteMotionModeOfOperation) => {
1922
1923 self.fb_mode_of_operation.reset();
1926 self.fb_mode_of_operation.start(ModesOfOperation::ProfilePosition as i8);
1927 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1928 self.op = AxisOp::SoftHoming(HomeState::WaitWriteMotionModeOfOperation as u8);
1929
1930 },
1931 Some(HomeState::WaitWriteMotionModeOfOperation) => {
1932 self.fb_mode_of_operation.tick(client, &mut self.sdo);
1934
1935 if !self.fb_mode_of_operation.is_busy() {
1936 if self.fb_mode_of_operation.is_error() {
1937 self.set_op_error(&format!("Software homing SDO error writing homing mode of operation: {} {}",
1938 self.fb_mode_of_operation.error_code(), self.fb_mode_of_operation.error_message()
1939 ));
1940 }
1941 else {
1942 if self.is_error {
1943 log::error!("Drive back in PP mode after error. Homing sequence did not complete!");
1944 self.finish_op_error();
1945 }
1946 else {
1947 self.op = AxisOp::SoftHoming(HomeState::SendCurrentPositionTarget as u8);
1950 }
1951
1952 }
1953 }
1954 },
1955
1956 Some(HomeState::SendCurrentPositionTarget) => {
1957 let current_pos = view.position_actual();
1959 view.set_target_position(current_pos);
1960 view.set_profile_velocity(0);
1961 let mut cw = RawControlWord(view.control_word());
1962 cw.set_bit(4, true);
1963 cw.set_bit(5, true);
1964 cw.set_bit(6, false); view.set_control_word(cw.raw());
1966 self.op = AxisOp::SoftHoming(HomeState::WaitCurrentPositionTargetSent as u8);
1967 }
1968 Some(HomeState::WaitCurrentPositionTargetSent) => {
1969 let sw = RawStatusWord(view.status_word());
1971 if sw.raw() & (1 << 12) != 0 {
1972 let mut cw = RawControlWord(view.control_word());
1973 cw.set_bit(4, false);
1974 view.set_control_word(cw.raw());
1975 log::info!("Software homing complete — position set to {} user units",
1976 self.config.home_position);
1977 self.complete_op();
1978 } else if self.homing_timed_out() {
1979 self.set_op_error("Software homing timeout: hold position not acknowledged");
1980 }
1981 }
1982 _ => self.complete_op(),
1983 }
1984 }
1985
1986 fn tick_halting(&mut self, view: &mut impl AxisView, step: u8) {
1999 match HaltState::from_repr(step) {
2000 Some(HaltState::WaitStopped) => {
2001 let pos = view.position_actual();
2005 let pos_stable = (pos - self.last_raw_position).abs() <= HALT_STABLE_WINDOW;
2006
2007 let vel = view.velocity_actual().abs();
2008 let vel_stopped = vel <= HALT_STOPPED_VELOCITY;
2009
2010 if pos_stable || vel_stopped {
2015 self.halt_stable_count = self.halt_stable_count.saturating_add(1);
2016 } else {
2017 self.halt_stable_count = 0;
2018 }
2019
2020 if self.halt_stable_count >= HALT_STABLE_TICKS_REQUIRED {
2021 self.command_cancel_move(view);
2022 self.op_started = Some(Instant::now());
2023 self.op = AxisOp::Halting(HaltState::WaitCancelAck as u8);
2024 } else if self.op_stage_timed_out(HALT_STAGE_TIMEOUT) {
2025 self.set_op_error("Halt timeout: motor did not stop");
2026 }
2027 }
2028 Some(HaltState::WaitCancelAck) => {
2029 let sw = RawStatusWord(view.status_word());
2030 let setpoint_ack = sw.raw() & (1 << 12) != 0;
2031 if setpoint_ack {
2033 let mut cw = RawControlWord(view.control_word());
2036 cw.set_bit(4, false);
2037 cw.set_bit(5, true);
2038 view.set_control_word(cw.raw());
2039 self.op_started = Some(Instant::now());
2040 self.op = AxisOp::Halting(HaltState::WaitCancelAckClear as u8);
2041 } else if self.op_stage_timed_out(HALT_STAGE_TIMEOUT) {
2042 self.set_op_error("Halt timeout: cancel not acknowledged");
2043 }
2044 }
2045 Some(HaltState::WaitCancelAckClear) => {
2046 let sw = RawStatusWord(view.status_word());
2047 if sw.raw() & (1 << 12) == 0 {
2048 self.command_clear_halt(view);
2050 self.complete_op();
2051 } else if self.op_stage_timed_out(HALT_STAGE_TIMEOUT) {
2052 self.set_op_error("Halt timeout: ack did not clear");
2053 }
2054 }
2055 None => {
2056 log::warn!("Axis halt: unknown sub-step {}, forcing idle", step);
2057 self.complete_op();
2058 }
2059 }
2060 }
2061
2062 fn tick_fault_recovery(&mut self, view: &mut impl AxisView, step: u8) {
2067 match step {
2068 1 => {
2069 let mut cw = RawControlWord(view.control_word());
2071 cw.cmd_fault_reset();
2072 view.set_control_word(cw.raw());
2073 self.op = AxisOp::FaultRecovery(2);
2074 }
2075 2 => {
2076 let sw = RawStatusWord(view.status_word());
2078 let state = sw.state();
2079 if !matches!(state, Cia402State::Fault | Cia402State::FaultReactionActive) {
2080 log::info!("Fault cleared (drive state: {})", state);
2081 self.complete_op();
2082 } else if self.op_timed_out() {
2083 self.set_op_error("Fault reset timeout: drive still faulted");
2084 }
2085 }
2086 _ => self.complete_op(),
2087 }
2088 }
2089}
2090
2091#[cfg(test)]
2096mod tests {
2097 use super::*;
2098
2099 struct MockView {
2101 control_word: u16,
2102 status_word: u16,
2103 target_position: i32,
2104 profile_velocity: u32,
2105 profile_acceleration: u32,
2106 profile_deceleration: u32,
2107 modes_of_operation: i8,
2108 modes_of_operation_display: i8,
2109 position_actual: i32,
2110 velocity_actual: i32,
2111 error_code: u16,
2112 positive_limit: bool,
2113 negative_limit: bool,
2114 home_sensor: bool,
2115 }
2116
2117 impl MockView {
2118 fn new() -> Self {
2119 Self {
2120 control_word: 0,
2121 status_word: 0x0040, target_position: 0,
2123 profile_velocity: 0,
2124 profile_acceleration: 0,
2125 profile_deceleration: 0,
2126 modes_of_operation: 0,
2127 modes_of_operation_display: 1, position_actual: 0,
2129 velocity_actual: 0,
2130 error_code: 0,
2131 positive_limit: false,
2132 negative_limit: false,
2133 home_sensor: false,
2134 }
2135 }
2136
2137 fn set_state(&mut self, state: u16) {
2138 self.status_word = state;
2139 }
2140 }
2141
2142 impl AxisView for MockView {
2143 fn control_word(&self) -> u16 { self.control_word }
2144 fn set_control_word(&mut self, word: u16) { self.control_word = word; }
2145 fn set_target_position(&mut self, pos: i32) { self.target_position = pos; }
2146 fn set_profile_velocity(&mut self, vel: u32) { self.profile_velocity = vel; }
2147 fn set_profile_acceleration(&mut self, accel: u32) { self.profile_acceleration = accel; }
2148 fn set_profile_deceleration(&mut self, decel: u32) { self.profile_deceleration = decel; }
2149 fn set_modes_of_operation(&mut self, mode: i8) { self.modes_of_operation = mode; }
2150 fn modes_of_operation_display(&self) -> i8 { self.modes_of_operation_display }
2151 fn status_word(&self) -> u16 { self.status_word }
2152 fn position_actual(&self) -> i32 { self.position_actual }
2153 fn velocity_actual(&self) -> i32 { self.velocity_actual }
2154 fn error_code(&self) -> u16 { self.error_code }
2155 fn positive_limit_active(&self) -> bool { self.positive_limit }
2156 fn negative_limit_active(&self) -> bool { self.negative_limit }
2157 fn home_sensor_active(&self) -> bool { self.home_sensor }
2158 }
2159
2160 fn test_config() -> AxisConfig {
2161 AxisConfig::new(12_800).with_user_scale(360.0)
2162 }
2163
2164 fn test_axis() -> (Axis, CommandClient, tokio::sync::mpsc::UnboundedSender<mechutil::ipc::CommandMessage>, tokio::sync::mpsc::UnboundedReceiver<String>) {
2166 use tokio::sync::mpsc;
2167 let (write_tx, write_rx) = mpsc::unbounded_channel();
2168 let (response_tx, response_rx) = mpsc::unbounded_channel();
2169 let client = CommandClient::new(write_tx, response_rx);
2170 let axis = Axis::new(test_config(), "TestDrive");
2171 (axis, client, response_tx, write_rx)
2172 }
2173
2174 #[test]
2175 fn axis_config_conversion() {
2176 let cfg = test_config();
2177 assert!((cfg.to_counts(45.0) - 1600.0).abs() < 0.01);
2179 }
2180
2181 #[test]
2182 fn enable_sequence_sets_pp_mode_and_shutdown() {
2183 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2184 let mut view = MockView::new();
2185
2186 axis.enable(&mut view);
2187
2188 assert_eq!(view.modes_of_operation, ModesOfOperation::ProfilePosition.as_i8());
2190 assert_eq!(view.control_word & 0x008F, 0x0006);
2192 assert_eq!(axis.op, AxisOp::Enabling(1));
2194
2195 view.set_state(0x0021); axis.tick(&mut view, &mut client);
2198
2199 assert_eq!(view.control_word & 0x008F, 0x000F);
2201 assert_eq!(axis.op, AxisOp::Enabling(2));
2202
2203 view.set_state(0x0027); axis.tick(&mut view, &mut client);
2206
2207 assert_eq!(axis.op, AxisOp::Idle);
2209 assert!(axis.motor_on);
2210 }
2211
2212 #[test]
2213 fn move_absolute_sets_target() {
2214 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2215 let mut view = MockView::new();
2216 view.set_state(0x0027); axis.tick(&mut view, &mut client); axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2221
2222 assert_eq!(view.target_position, 1600);
2224 assert_eq!(view.profile_velocity, 3200);
2226 assert_eq!(view.profile_acceleration, 6400);
2228 assert_eq!(view.profile_deceleration, 6400);
2229 assert!(view.control_word & (1 << 4) != 0);
2231 assert!(view.control_word & (1 << 6) == 0);
2233 assert!(matches!(axis.op, AxisOp::Moving(MoveKind::Absolute, 1, _, _)));
2235 }
2236
2237 #[test]
2238 fn move_relative_sets_relative_bit() {
2239 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2240 let mut view = MockView::new();
2241 view.set_state(0x0027);
2242 axis.tick(&mut view, &mut client);
2243
2244 axis.move_relative(&mut view, 10.0, 90.0, 180.0, 180.0);
2245
2246 assert!(view.control_word & (1 << 6) != 0);
2248 assert!(matches!(axis.op, AxisOp::Moving(MoveKind::Relative, 1, _, _)));
2249 }
2250
2251 #[test]
2252 fn move_completes_on_target_reached() {
2253 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2254 let mut view = MockView::new();
2255 view.set_state(0x0027); axis.tick(&mut view, &mut client);
2257
2258 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2259
2260 view.status_word = 0x1027; axis.tick(&mut view, &mut client);
2263 assert!(view.control_word & (1 << 4) == 0);
2265
2266 view.status_word = 0x0427; axis.tick(&mut view, &mut client);
2269 assert_eq!(axis.op, AxisOp::Idle);
2271 assert!(!axis.in_motion);
2272 }
2273
2274 #[test]
2275 fn fault_detected_sets_error() {
2276 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2277 let mut view = MockView::new();
2278 view.set_state(0x0008); view.error_code = 0x1234;
2280
2281 axis.tick(&mut view, &mut client);
2282
2283 assert!(axis.is_error);
2284 assert_eq!(axis.error_code, 0x1234);
2285 assert!(axis.error_message.contains("fault"));
2286 }
2287
2288 #[test]
2289 fn fault_recovery_sequence() {
2290 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2291 let mut view = MockView::new();
2292 view.set_state(0x0008); axis.reset_faults(&mut view);
2295 assert!(view.control_word & 0x0080 == 0);
2297
2298 axis.tick(&mut view, &mut client);
2300 assert!(view.control_word & 0x0080 != 0);
2301
2302 view.set_state(0x0040);
2304 axis.tick(&mut view, &mut client);
2305 assert_eq!(axis.op, AxisOp::Idle);
2306 assert!(!axis.is_error);
2307 }
2308
2309 #[test]
2310 fn reset_faults_software_only_is_synchronous() {
2311 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2317 let mut view = MockView::new();
2318 view.set_state(0x0027); axis.tick(&mut view, &mut client);
2320
2321 axis.set_software_min_limit(207.0);
2323 axis.move_absolute(&mut view, 200.0, 90.0, 180.0, 180.0);
2324 assert!(axis.is_error, "move past software limit must set is_error");
2325 assert!(!axis.is_busy);
2326
2327 let cw_before = view.control_word;
2330
2331 axis.reset_faults(&mut view);
2332
2333 assert!(!axis.is_error);
2335 assert_eq!(axis.error_code, 0);
2336 assert!(axis.error_message.is_empty());
2337 assert!(!axis.is_busy);
2338 assert_eq!(axis.op, AxisOp::Idle);
2339 assert_eq!(view.control_word, cw_before);
2341 }
2342
2343 #[test]
2344 fn disable_sequence() {
2345 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2346 let mut view = MockView::new();
2347 view.set_state(0x0027); axis.disable(&mut view);
2350 assert_eq!(view.control_word & 0x008F, 0x0007);
2352
2353 view.set_state(0x0023); axis.tick(&mut view, &mut client);
2356 assert_eq!(axis.op, AxisOp::Idle);
2357 }
2358
2359 #[test]
2360 fn position_tracks_with_home_offset() {
2361 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2362 let mut view = MockView::new();
2363 view.set_state(0x0027);
2364 view.position_actual = 5000;
2365
2366 axis.enable(&mut view);
2368 view.set_state(0x0021);
2369 axis.tick(&mut view, &mut client);
2370 view.set_state(0x0027);
2371 axis.tick(&mut view, &mut client);
2372
2373 assert_eq!(axis.home_offset, 5000);
2375
2376 assert!((axis.position - 0.0).abs() < 0.01);
2378
2379 view.position_actual = 6600;
2381 axis.tick(&mut view, &mut client);
2382
2383 assert!((axis.position - 45.0).abs() < 0.1);
2385 }
2386
2387 #[test]
2388 fn set_position_adjusts_home_offset() {
2389 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2390 let mut view = MockView::new();
2391 view.position_actual = 3200;
2392
2393 axis.set_position(&view, 90.0);
2394 axis.tick(&mut view, &mut client);
2395
2396 assert_eq!(axis.home_offset, 0);
2398 assert!((axis.position - 90.0).abs() < 0.01);
2399 }
2400
2401 #[test]
2402 fn halt_runs_multi_stage_close_out() {
2403 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2404 let mut view = MockView::new();
2405 view.set_state(0x0027);
2406
2407 axis.halt(&mut view);
2408
2409 assert!(view.control_word & (1 << 8) != 0, "halt bit must be set");
2411 assert!(view.control_word & (1 << 4) == 0, "new_setpoint must be cleared");
2412
2413 assert!(matches!(axis.op, AxisOp::Halting(_)),
2415 "halt should enter Halting state, not Idle");
2416 let AxisOp::Halting(step) = axis.op.clone() else { unreachable!() };
2417 assert_eq!(step, HaltState::WaitStopped as u8);
2418
2419 for _ in 0..HALT_STABLE_TICKS_REQUIRED {
2426 axis.tick(&mut view, &mut client);
2427 }
2428 assert!(matches!(axis.op, AxisOp::Halting(_)));
2430 let AxisOp::Halting(step) = axis.op.clone() else { unreachable!() };
2431 assert_eq!(step, HaltState::WaitCancelAck as u8,
2432 "should advance past WaitStopped once position/velocity is stable");
2433
2434 assert!(axis.is_busy, "is_busy must stay true across Halting stages");
2438 }
2439
2440 #[test]
2441 fn is_busy_tracks_operations() {
2442 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2443 let mut view = MockView::new();
2444
2445 axis.tick(&mut view, &mut client);
2447 assert!(!axis.is_busy);
2448
2449 axis.enable(&mut view);
2451 axis.tick(&mut view, &mut client);
2452 assert!(axis.is_busy);
2453
2454 view.set_state(0x0021);
2456 axis.tick(&mut view, &mut client);
2457 view.set_state(0x0027);
2458 axis.tick(&mut view, &mut client);
2459 assert!(!axis.is_busy);
2460
2461 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2463 axis.tick(&mut view, &mut client);
2464 assert!(axis.is_busy);
2465 assert!(axis.in_motion);
2466 }
2467
2468 #[test]
2469 fn fault_during_move_cancels_op() {
2470 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2471 let mut view = MockView::new();
2472 view.set_state(0x0027); axis.tick(&mut view, &mut client);
2474
2475 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2477 axis.tick(&mut view, &mut client);
2478 assert!(axis.is_busy);
2479 assert!(!axis.is_error);
2480
2481 view.set_state(0x0008); axis.tick(&mut view, &mut client);
2484
2485 assert!(!axis.is_busy);
2487 assert!(axis.is_error);
2488 assert_eq!(axis.op, AxisOp::Idle);
2489 }
2490
2491 #[test]
2492 fn move_absolute_rejected_by_max_limit() {
2493 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2494 let mut view = MockView::new();
2495 view.set_state(0x0027);
2496 axis.tick(&mut view, &mut client);
2497
2498 axis.set_software_max_limit(90.0);
2499 axis.move_absolute(&mut view, 100.0, 90.0, 180.0, 180.0);
2500
2501 assert!(axis.is_error);
2503 assert_eq!(axis.op, AxisOp::Idle);
2504 assert!(axis.error_message.contains("max software limit"));
2505 }
2506
2507 #[test]
2508 fn move_absolute_rejected_by_min_limit() {
2509 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2510 let mut view = MockView::new();
2511 view.set_state(0x0027);
2512 axis.tick(&mut view, &mut client);
2513
2514 axis.set_software_min_limit(-10.0);
2515 axis.move_absolute(&mut view, -20.0, 90.0, 180.0, 180.0);
2516
2517 assert!(axis.is_error);
2518 assert_eq!(axis.op, AxisOp::Idle);
2519 assert!(axis.error_message.contains("min software limit"));
2520 }
2521
2522 #[test]
2523 fn move_relative_rejected_by_max_limit() {
2524 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2525 let mut view = MockView::new();
2526 view.set_state(0x0027);
2527 axis.tick(&mut view, &mut client);
2528
2529 axis.set_software_max_limit(50.0);
2531 axis.move_relative(&mut view, 60.0, 90.0, 180.0, 180.0);
2532
2533 assert!(axis.is_error);
2534 assert_eq!(axis.op, AxisOp::Idle);
2535 assert!(axis.error_message.contains("max software limit"));
2536 }
2537
2538 #[test]
2539 fn move_within_limits_allowed() {
2540 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2541 let mut view = MockView::new();
2542 view.set_state(0x0027);
2543 axis.tick(&mut view, &mut client);
2544
2545 axis.set_software_max_limit(90.0);
2546 axis.set_software_min_limit(-90.0);
2547 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2548
2549 assert!(!axis.is_error);
2551 assert!(matches!(axis.op, AxisOp::Moving(MoveKind::Absolute, 1, _, _)));
2552 }
2553
2554 #[test]
2555 fn runtime_limit_halts_move_in_violated_direction() {
2556 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2557 let mut view = MockView::new();
2558 view.set_state(0x0027);
2559 axis.tick(&mut view, &mut client);
2560
2561 axis.set_software_max_limit(45.0);
2562 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2564
2565 view.position_actual = 1650;
2568 view.velocity_actual = 100; view.status_word = 0x1027;
2572 axis.tick(&mut view, &mut client);
2573 view.status_word = 0x0027;
2574 axis.tick(&mut view, &mut client);
2575
2576 assert!(!axis.is_error);
2580 assert!(axis.at_max_limit);
2581 assert!(axis.is_busy);
2582 assert!(matches!(axis.op, AxisOp::Halting(_)));
2583 assert!(view.control_word & (1 << 8) != 0);
2585 }
2586
2587 #[test]
2588 fn runtime_limit_allows_move_in_opposite_direction() {
2589 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2590 let mut view = MockView::new();
2591 view.set_state(0x0027);
2592 view.position_actual = 1778; axis.set_software_max_limit(45.0);
2595 axis.tick(&mut view, &mut client);
2596 assert!(axis.at_max_limit);
2597
2598 axis.move_absolute(&mut view, 0.0, 90.0, 180.0, 180.0);
2600 assert!(!axis.is_error);
2601 assert!(matches!(axis.op, AxisOp::Moving(MoveKind::Absolute, 1, _, _)));
2602
2603 view.velocity_actual = -100;
2605 view.status_word = 0x1027; axis.tick(&mut view, &mut client);
2607 assert!(!axis.is_error);
2609 }
2610
2611 #[test]
2612 fn positive_limit_switch_halts_positive_move() {
2613 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2614 let mut view = MockView::new();
2615 view.set_state(0x0027);
2616 axis.tick(&mut view, &mut client);
2617
2618 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2620 view.velocity_actual = 100; view.status_word = 0x1027;
2623 axis.tick(&mut view, &mut client);
2624 view.status_word = 0x0027;
2625
2626 view.positive_limit = true;
2628 axis.tick(&mut view, &mut client);
2629
2630 assert!(!axis.is_error);
2635 assert!(axis.at_positive_limit_switch);
2636 assert!(axis.is_busy);
2637 assert!(matches!(axis.op, AxisOp::Halting(_)));
2638 assert!(view.control_word & (1 << 8) != 0);
2640 }
2641
2642 #[test]
2643 fn negative_limit_switch_halts_negative_move() {
2644 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2645 let mut view = MockView::new();
2646 view.set_state(0x0027);
2647 axis.tick(&mut view, &mut client);
2648
2649 axis.move_absolute(&mut view, -45.0, 90.0, 180.0, 180.0);
2651 view.velocity_actual = -100; view.status_word = 0x1027;
2653 axis.tick(&mut view, &mut client);
2654 view.status_word = 0x0027;
2655
2656 view.negative_limit = true;
2658 axis.tick(&mut view, &mut client);
2659
2660 assert!(!axis.is_error);
2665 assert!(axis.at_negative_limit_switch);
2666 assert!(axis.is_busy);
2667 assert!(matches!(axis.op, AxisOp::Halting(_)));
2668 assert!(view.control_word & (1 << 8) != 0);
2669 }
2670
2671 #[test]
2672 fn limit_halt_cleanup_then_next_move_starts_cleanly() {
2673 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2678 let mut view = MockView::new();
2679 view.set_state(0x0027); axis.tick(&mut view, &mut client);
2681
2682 axis.move_absolute(&mut view, 45.0, 90.0, 180.0, 180.0);
2684 view.velocity_actual = 100;
2685 view.status_word = 0x1027;
2686 axis.tick(&mut view, &mut client);
2687 view.status_word = 0x0027;
2688 view.positive_limit = true;
2689 axis.tick(&mut view, &mut client);
2690
2691 assert!(!axis.is_error);
2693 assert!(axis.is_busy);
2694 assert!(matches!(axis.op, AxisOp::Halting(_)));
2695 assert!(view.control_word & (1 << 8) != 0);
2696
2697 view.velocity_actual = 0;
2702 view.positive_limit = false;
2703 for _ in 0..HALT_STABLE_TICKS_REQUIRED {
2704 axis.tick(&mut view, &mut client);
2705 }
2706 assert!(matches!(axis.op, AxisOp::Halting(_)));
2707 let AxisOp::Halting(step) = axis.op.clone() else { unreachable!() };
2708 assert_eq!(step, HaltState::WaitCancelAck as u8);
2709
2710 view.status_word = 0x1027;
2712 axis.tick(&mut view, &mut client);
2713 let AxisOp::Halting(step) = axis.op.clone() else { unreachable!() };
2714 assert_eq!(step, HaltState::WaitCancelAckClear as u8);
2715
2716 view.status_word = 0x0027;
2719 axis.tick(&mut view, &mut client);
2720 assert_eq!(axis.op, AxisOp::Idle);
2721 assert!(!axis.is_busy);
2722 assert!(view.control_word & (1 << 8) == 0, "halt should be cleared after close-out");
2723
2724 axis.move_absolute(&mut view, 30.0, 90.0, 180.0, 180.0);
2727 assert!(view.control_word & (1 << 4) != 0, "new-setpoint asserted on start_move tick");
2728 assert!(view.control_word & (1 << 8) == 0, "halt stays cleared");
2729 assert!(matches!(axis.op, AxisOp::Moving(MoveKind::Absolute, 1, _, _)));
2730 }
2731
2732 #[test]
2733 fn limit_switch_allows_move_in_opposite_direction() {
2734 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2735 let mut view = MockView::new();
2736 view.set_state(0x0027);
2737 view.positive_limit = true;
2739 view.velocity_actual = -100;
2740 axis.tick(&mut view, &mut client);
2741 assert!(axis.at_positive_limit_switch);
2742
2743 axis.move_absolute(&mut view, -10.0, 90.0, 180.0, 180.0);
2745 view.status_word = 0x1027;
2746 axis.tick(&mut view, &mut client);
2747
2748 assert!(!axis.is_error);
2750 assert!(matches!(axis.op, AxisOp::Moving(_, _, _, _)));
2751 }
2752
2753 #[test]
2754 fn limit_switch_ignored_when_not_moving() {
2755 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2756 let mut view = MockView::new();
2757 view.set_state(0x0027);
2758 view.positive_limit = true;
2759
2760 axis.tick(&mut view, &mut client);
2761
2762 assert!(axis.at_positive_limit_switch);
2764 assert!(!axis.is_error);
2765 }
2766
2767 #[test]
2768 fn home_sensor_output_tracks_view() {
2769 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2770 let mut view = MockView::new();
2771 view.set_state(0x0027);
2772
2773 axis.tick(&mut view, &mut client);
2774 assert!(!axis.home_sensor);
2775
2776 view.home_sensor = true;
2777 axis.tick(&mut view, &mut client);
2778 assert!(axis.home_sensor);
2779
2780 view.home_sensor = false;
2781 axis.tick(&mut view, &mut client);
2782 assert!(!axis.home_sensor);
2783 }
2784
2785 #[test]
2786 fn velocity_output_converted() {
2787 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
2788 let mut view = MockView::new();
2789 view.set_state(0x0027);
2790 view.velocity_actual = 3200;
2792
2793 axis.tick(&mut view, &mut client);
2794
2795 assert!((axis.speed - 90.0).abs() < 0.1);
2796 assert!(axis.moving_positive);
2797 assert!(!axis.moving_negative);
2798 }
2799
2800 fn soft_homing_config() -> AxisConfig {
2803 let mut cfg = AxisConfig::new(12_800).with_user_scale(360.0);
2804 cfg.homing_speed = 10.0;
2805 cfg.homing_accel = 20.0;
2806 cfg.homing_decel = 20.0;
2807 cfg
2808 }
2809
2810 fn soft_homing_axis() -> (Axis, CommandClient, tokio::sync::mpsc::UnboundedSender<mechutil::ipc::CommandMessage>, tokio::sync::mpsc::UnboundedReceiver<String>) {
2811 use tokio::sync::mpsc;
2812 let (write_tx, write_rx) = mpsc::unbounded_channel();
2813 let (response_tx, response_rx) = mpsc::unbounded_channel();
2814 let client = CommandClient::new(write_tx, response_rx);
2815 let axis = Axis::new(soft_homing_config(), "TestDrive");
2816 (axis, client, response_tx, write_rx)
2817 }
2818
2819 fn enable_axis(axis: &mut Axis, view: &mut MockView, client: &mut CommandClient) {
2821 view.set_state(0x0027); axis.tick(view, client);
2823 }
2824
2825 fn complete_soft_homing(
2830 axis: &mut Axis,
2831 view: &mut MockView,
2832 client: &mut CommandClient,
2833 resp_tx: &tokio::sync::mpsc::UnboundedSender<mechutil::ipc::CommandMessage>,
2834 trigger_pos: i32,
2835 clear_sensor: impl FnOnce(&mut MockView),
2836 ) {
2837 use mechutil::ipc::CommandMessage as IpcMsg;
2838
2839 axis.tick(view, client);
2842 assert!(matches!(axis.op, AxisOp::SoftHoming(5)));
2843
2844 view.position_actual = trigger_pos + 100;
2846 axis.tick(view, client);
2847 view.position_actual = trigger_pos + 120;
2848 axis.tick(view, client);
2849 for _ in 0..10 { axis.tick(view, client); }
2851 assert!(matches!(axis.op, AxisOp::SoftHoming(6)));
2852
2853 view.status_word = 0x1027;
2855 axis.tick(view, client);
2856 assert!(matches!(axis.op, AxisOp::SoftHoming(60)));
2857 view.status_word = 0x0027;
2858
2859 for _ in 0..100 { axis.tick(view, client); }
2861 assert!(matches!(axis.op, AxisOp::SoftHoming(7)));
2862
2863 axis.tick(view, client);
2866 assert!(matches!(axis.op, AxisOp::SoftHoming(8)));
2867
2868 view.status_word = 0x1027;
2870 axis.tick(view, client);
2871 assert!(matches!(axis.op, AxisOp::SoftHoming(9)));
2872 view.status_word = 0x0027;
2873
2874 axis.tick(view, client);
2876 assert!(matches!(axis.op, AxisOp::SoftHoming(9)));
2877 clear_sensor(view);
2878 view.position_actual = trigger_pos - 200;
2879 axis.tick(view, client);
2880 assert!(matches!(axis.op, AxisOp::SoftHoming(10)));
2881
2882 axis.tick(view, client);
2884 assert!(matches!(axis.op, AxisOp::SoftHoming(11)));
2885 for _ in 0..10 { axis.tick(view, client); }
2886 assert!(matches!(axis.op, AxisOp::SoftHoming(12)));
2887
2888 view.status_word = 0x1027;
2891 axis.tick(view, client);
2892 view.status_word = 0x0027;
2893 assert!(matches!(axis.op, AxisOp::SoftHoming(13)));
2894
2895 let tid = axis.homing_sdo_tid;
2897 resp_tx.send(IpcMsg::response(tid, json!(null))).unwrap();
2898 client.poll();
2899 axis.tick(view, client);
2900 assert!(matches!(axis.op, AxisOp::SoftHoming(14)));
2901
2902 axis.tick(view, client);
2904 let tid = axis.homing_sdo_tid;
2905 resp_tx.send(IpcMsg::response(tid, json!(null))).unwrap();
2906 client.poll();
2907 axis.tick(view, client);
2908 assert!(matches!(axis.op, AxisOp::SoftHoming(16)));
2909
2910 view.modes_of_operation_display = ModesOfOperation::Homing.as_i8();
2912 axis.tick(view, client);
2913 assert!(matches!(axis.op, AxisOp::SoftHoming(17)));
2914
2915 view.status_word = 0x1427; axis.tick(view, client);
2918 assert!(matches!(axis.op, AxisOp::SoftHoming(18)));
2919 view.modes_of_operation_display = ModesOfOperation::ProfilePosition.as_i8();
2920 view.status_word = 0x0027;
2921
2922 axis.tick(view, client);
2924 assert!(matches!(axis.op, AxisOp::SoftHoming(19)));
2925
2926 view.status_word = 0x1027;
2928 axis.tick(view, client);
2929 view.status_word = 0x0027;
2930
2931 assert_eq!(axis.op, AxisOp::Idle);
2932 assert!(!axis.is_busy);
2933 assert!(!axis.is_error);
2934 assert_eq!(axis.home_offset, 0); }
2936
2937 #[test]
2938 fn soft_homing_pnp_home_sensor_full_sequence() {
2939 let (mut axis, mut client, resp_tx, _write_rx) = soft_homing_axis();
2940 let mut view = MockView::new();
2941 enable_axis(&mut axis, &mut view, &mut client);
2942
2943 axis.home(&mut view, HomingMethod::HomeSensorPosPnp);
2944
2945 axis.tick(&mut view, &mut client); view.status_word = 0x1027;
2948 axis.tick(&mut view, &mut client); view.status_word = 0x0027;
2950 axis.tick(&mut view, &mut client); view.home_sensor = true;
2954 view.position_actual = 5000;
2955 axis.tick(&mut view, &mut client);
2956 assert!(matches!(axis.op, AxisOp::SoftHoming(4)));
2957
2958 complete_soft_homing(&mut axis, &mut view, &mut client, &resp_tx, 5000,
2959 |v| { v.home_sensor = false; });
2960 }
2961
2962 #[test]
2963 fn soft_homing_npn_home_sensor_full_sequence() {
2964 let (mut axis, mut client, resp_tx, _write_rx) = soft_homing_axis();
2965 let mut view = MockView::new();
2966 view.home_sensor = true;
2968 enable_axis(&mut axis, &mut view, &mut client);
2969
2970 axis.home(&mut view, HomingMethod::HomeSensorPosNpn);
2971
2972 axis.tick(&mut view, &mut client);
2974 view.status_word = 0x1027;
2975 axis.tick(&mut view, &mut client);
2976 view.status_word = 0x0027;
2977 axis.tick(&mut view, &mut client);
2978
2979 view.home_sensor = false;
2981 view.position_actual = 3000;
2982 axis.tick(&mut view, &mut client);
2983 assert!(matches!(axis.op, AxisOp::SoftHoming(4)));
2984
2985 complete_soft_homing(&mut axis, &mut view, &mut client, &resp_tx, 3000,
2986 |v| { v.home_sensor = true; }); }
2988
2989 #[test]
2990 fn soft_homing_limit_switch_suppresses_halt() {
2991 let (mut axis, mut client, _resp_tx, _write_rx) = soft_homing_axis();
2992 let mut view = MockView::new();
2993 enable_axis(&mut axis, &mut view, &mut client);
2994
2995 axis.home(&mut view, HomingMethod::LimitSwitchPosPnp);
2997
2998 axis.tick(&mut view, &mut client); view.status_word = 0x1027; axis.tick(&mut view, &mut client); view.status_word = 0x0027;
3003 axis.tick(&mut view, &mut client); view.positive_limit = true;
3007 view.velocity_actual = 100; view.position_actual = 8000;
3009 axis.tick(&mut view, &mut client);
3010
3011 assert!(matches!(axis.op, AxisOp::SoftHoming(4)));
3013 assert!(!axis.is_error);
3014 }
3015
3016 #[test]
3017 fn soft_homing_opposite_limit_still_protects() {
3018 let (mut axis, mut client, _resp_tx, _write_rx) = soft_homing_axis();
3019 let mut view = MockView::new();
3020 enable_axis(&mut axis, &mut view, &mut client);
3021
3022 axis.home(&mut view, HomingMethod::HomeSensorPosPnp);
3024
3025 axis.tick(&mut view, &mut client); view.status_word = 0x1027; axis.tick(&mut view, &mut client); view.status_word = 0x0027;
3030 axis.tick(&mut view, &mut client); view.negative_limit = true;
3035 view.velocity_actual = -100; axis.tick(&mut view, &mut client);
3037
3038 assert!(axis.is_error);
3040 assert!(axis.error_message.contains("Negative limit switch"));
3041 }
3042
3043 #[test]
3044 #[test]
3062 fn soft_homing_negative_direction_sets_negative_target() {
3063 let (mut axis, mut client, _resp_tx, _write_rx) = soft_homing_axis();
3064 let mut view = MockView::new();
3065 enable_axis(&mut axis, &mut view, &mut client);
3066
3067 axis.home(&mut view, HomingMethod::HomeSensorNegPnp);
3068 axis.tick(&mut view, &mut client); assert!(view.target_position < 0);
3072 }
3073
3074 #[test]
3075 fn home_integrated_method_starts_hardware_homing() {
3076 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
3077 let mut view = MockView::new();
3078 enable_axis(&mut axis, &mut view, &mut client);
3079
3080 axis.home(&mut view, HomingMethod::CurrentPosition);
3081 assert!(matches!(axis.op, AxisOp::Homing(0)));
3082 assert_eq!(axis.homing_method, 37);
3083 }
3084
3085 #[test]
3086 fn home_integrated_arbitrary_code() {
3087 let (mut axis, mut client, _resp_tx, _write_rx) = test_axis();
3088 let mut view = MockView::new();
3089 enable_axis(&mut axis, &mut view, &mut client);
3090
3091 axis.home(&mut view, HomingMethod::Integrated(35));
3092 assert!(matches!(axis.op, AxisOp::Homing(0)));
3093 assert_eq!(axis.homing_method, 35);
3094 }
3095
3096 #[test]
3097 fn hardware_homing_skips_speed_sdos_when_zero() {
3098 use mechutil::ipc::CommandMessage;
3099
3100 let (mut axis, mut client, resp_tx, mut write_rx) = test_axis();
3101 let mut view = MockView::new();
3102 enable_axis(&mut axis, &mut view, &mut client);
3103
3104 axis.home(&mut view, HomingMethod::Integrated(37));
3106
3107 axis.tick(&mut view, &mut client);
3109 assert!(matches!(axis.op, AxisOp::Homing(1)));
3110
3111 let _ = write_rx.try_recv();
3113
3114 let tid = axis.homing_sdo_tid;
3116 resp_tx.send(CommandMessage::response(tid, serde_json::json!(null))).unwrap();
3117 client.poll();
3118 axis.tick(&mut view, &mut client);
3119
3120 assert!(matches!(axis.op, AxisOp::Homing(8)));
3122 }
3123
3124 #[test]
3125 fn hardware_homing_writes_speed_sdos_when_nonzero() {
3126 use mechutil::ipc::CommandMessage;
3127
3128 let (mut axis, mut client, resp_tx, mut write_rx) = soft_homing_axis();
3129 let mut view = MockView::new();
3130 enable_axis(&mut axis, &mut view, &mut client);
3131
3132 axis.home(&mut view, HomingMethod::Integrated(37));
3134
3135 axis.tick(&mut view, &mut client);
3137 assert!(matches!(axis.op, AxisOp::Homing(1)));
3138 let _ = write_rx.try_recv();
3139
3140 let tid = axis.homing_sdo_tid;
3142 resp_tx.send(CommandMessage::response(tid, serde_json::json!(null))).unwrap();
3143 client.poll();
3144 axis.tick(&mut view, &mut client);
3145 assert!(matches!(axis.op, AxisOp::Homing(2)));
3147 }
3148
3149 #[test]
3150 fn soft_homing_edge_during_ack_step() {
3151 let (mut axis, mut client, _resp_tx, _write_rx) = soft_homing_axis();
3152 let mut view = MockView::new();
3153 enable_axis(&mut axis, &mut view, &mut client);
3154
3155 axis.home(&mut view, HomingMethod::HomeSensorPosPnp);
3156 axis.tick(&mut view, &mut client); view.home_sensor = true;
3160 view.position_actual = 2000;
3161 axis.tick(&mut view, &mut client);
3162
3163 assert!(matches!(axis.op, AxisOp::SoftHoming(4)));
3165 }
3166
3167 #[test]
3168 fn soft_homing_applies_home_position() {
3169 let mut cfg = soft_homing_config();
3170 cfg.home_position = 90.0;
3171
3172 use tokio::sync::mpsc;
3173 let (write_tx, _write_rx) = mpsc::unbounded_channel();
3174 let (resp_tx, response_rx) = mpsc::unbounded_channel();
3175 let mut client = CommandClient::new(write_tx, response_rx);
3176 let mut axis = Axis::new(cfg, "TestDrive");
3177
3178 let mut view = MockView::new();
3179 enable_axis(&mut axis, &mut view, &mut client);
3180
3181 axis.home(&mut view, HomingMethod::HomeSensorPosPnp);
3182
3183 axis.tick(&mut view, &mut client);
3185 view.status_word = 0x1027;
3186 axis.tick(&mut view, &mut client);
3187 view.status_word = 0x0027;
3188 axis.tick(&mut view, &mut client);
3189
3190 view.home_sensor = true;
3192 view.position_actual = 5000;
3193 axis.tick(&mut view, &mut client);
3194 assert!(matches!(axis.op, AxisOp::SoftHoming(4)));
3195
3196 complete_soft_homing(&mut axis, &mut view, &mut client, &resp_tx, 5000,
3198 |v| { v.home_sensor = false; });
3199
3200 assert_eq!(axis.home_offset, 0);
3202 }
3203
3204 #[test]
3205 fn soft_homing_default_home_position_zero() {
3206 let (mut axis, mut client, resp_tx, _write_rx) = soft_homing_axis();
3207 let mut view = MockView::new();
3208 enable_axis(&mut axis, &mut view, &mut client);
3209
3210 axis.home(&mut view, HomingMethod::HomeSensorPosPnp);
3211
3212 axis.tick(&mut view, &mut client);
3214 view.status_word = 0x1027;
3215 axis.tick(&mut view, &mut client);
3216 view.status_word = 0x0027;
3217 axis.tick(&mut view, &mut client);
3218
3219 view.home_sensor = true;
3221 view.position_actual = 5000;
3222 axis.tick(&mut view, &mut client);
3223
3224 complete_soft_homing(&mut axis, &mut view, &mut client, &resp_tx, 5000,
3225 |v| { v.home_sensor = false; });
3226
3227 assert_eq!(axis.home_offset, 0);
3228 }
3229}