Skip to content

Commit 49dbe9c

Browse files
Update README.md
1 parent cc39122 commit 49dbe9c

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,19 @@ This module wraps the **DSP‑402** drive-control state machine (CiA 402) to sim
2222

2323
---
2424

25+
## 🧠 Typical Use Case
26+
27+
The module is used in systems with drives/axes that support CiA DSP402 (e.g., Beckhoff AX5000, Elmo, Kollmorgen), enabling the host to easily control the drive's state machine without manually encoding complex Controlword sequences.
28+
29+
---
30+
31+
## 🔌 Dependencies
32+
33+
- [module_ethercat](https::/github.com/robotkernel-hal/module_ethercat.git) or another process data source
34+
- Real-time capable host for cycle-exact communication (recommended)
35+
36+
---
37+
2538
## 🧩 Configuration
2639

2740
### Simple Single-Axis Setup
@@ -116,6 +129,25 @@ devices:
116129

117130
---
118131

132+
## 🔄 Runtime Behavior
133+
134+
The module:
135+
136+
1. Reads Statusword from input PDOs.
137+
2. Applies internal DSP402 state logic.
138+
3. Outputs an appropriate Controlword to guide the drive into desired states (e.g. Switch On, Enable Operation).
139+
140+
It simplifies FSM control typically required for enabling axes in automation systems.
141+
142+
---
143+
144+
## 🔍 Debugging Tips
145+
146+
- Ensure that pdin and pdout references are correct and that they map to real EtherCAT slave PDOs.
147+
- Use status_word_name and control_word_name strings that match exactly with your PDO definitions (as per SDO configuration or ESI files).
148+
149+
---
150+
119151
## 🖼️ State Machine Diagram
120152

121153
```mermaid

0 commit comments

Comments
 (0)