File tree Expand file tree Collapse file tree 1 file changed +39
-0
lines changed Expand file tree Collapse file tree 1 file changed +39
-0
lines changed Original file line number Diff line number Diff line change @@ -48,6 +48,45 @@ is open to all.
48
48
49
49
.. _stepper-api-reference :
50
50
51
+ Stepper API Test Suite
52
+ ======================
53
+
54
+ The stepper API test suite provides a set of tests that can be used to verify the functionality of
55
+ stepper drivers.
56
+
57
+ .. zephyr-app-commands ::
58
+ :zephyr-app: tests/drivers/stepper/stepper_api
59
+ :board: <board>
60
+ :west-args: --extra-dtc-overlay <path/to/board.overlay>
61
+ :goals: build flash
62
+
63
+ Sample Output
64
+ =============
65
+
66
+ Below is a snippet of the test output for the tmc50xx stepper driver. Since
67
+ :c:func: `stepper_set_microstep_interval ` is not implemented by the driver the corresponding tests
68
+ have been skipped.
69
+
70
+ .. code-block :: console
71
+
72
+ ===================================================================
73
+ TESTSUITE stepper succeeded
74
+
75
+ ------ TESTSUITE SUMMARY START ------
76
+
77
+ SUITE PASS - 100.00% [stepper]: pass = 4, fail = 0, skip = 2, total = 6 duration = 0.069 seconds
78
+ - PASS - [stepper.test_actual_position] duration = 0.016 seconds
79
+ - PASS - [stepper.test_get_micro_step_res] duration = 0.013 seconds
80
+ - SKIP - [stepper.test_set_micro_step_interval_invalid_zero] duration = 0.007 seconds
81
+ - PASS - [stepper.test_set_micro_step_res_incorrect] duration = 0.010 seconds
82
+ - PASS - [stepper.test_stop] duration = 0.016 seconds
83
+ - SKIP - [stepper.test_target_position_w_fixed_step_interval] duration = 0.007 seconds
84
+
85
+ ------ TESTSUITE SUMMARY END ------
86
+
87
+ ===================================================================
88
+ PROJECT EXECUTION SUCCESSFUL
89
+
51
90
API Reference
52
91
*************
53
92
You can’t perform that action at this time.
0 commit comments