Severson-Group / Severson-Group/docs.amdc.dev
Add AMDC article of Autogen in "Control with AMDC" section
@Daehoon-Sung is already working on this.
Since Dec 30, 2025.
- Dominant language
- Jupyter Notebook
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 1
Description
Context
Related Issues / PRs:
- https://github.com/Severson-Group/docs.amdc.dev/pull/85
- https://github.com/Severson-Group/AMDC-Examples/issues/6
- #143
- https://github.com/Severson-Group/docs.amdc.dev/pull/148
In this issue, we focused on creating the AMDC tutorial using Simulink Autogen. In this issue, we will create an additional AMDC article, explaining the theory and approach of what we are doing with Simulink + AMDC.
See this comment:
1. Control with AMDC Article
Item 1 should focus on explaining the theory and approach of what we are doing with Simulink + AMDC, and not be a set of steps for the user to follow. Take a close look at the structure of the Current Sensor Calibration article and the still-in-progress Encoder article. This document should contain items like the following:
- brief explanation of why it is a good idea to use simulink for creating control code (i.e., explain that it facilitates simulation, graphical control development)
- explanation of what exactly is generated from Simulink and how that is used in the AMDC. Explaining that this produces a function that the AMDC should call at a fixed time interval. Before calling the function, the AMDC should configure the inputs to it and after calling it (presumably from sampled sensor data), the AMDC should take the outputs and route them to the correct outputs (i.e. duty ratios).
- Document how to configure the development environment (what toolboxes to install, where to place files within the repo, what the recommended workflow looks like).
- Provide important considerations and settings in Simulink for successful development of AMDC control code -- including items that Steve identifies for us here: https://github.com/Severson-Group/AMDC-Examples/issues/6
- An example SLX file that is all ready to download and autogen code -- all settings configured.
Approach
I think the first step is to copy paste this article, which almost addresses the items above. However, we should make this simpler and make sure that is following the structure in the Control with AMDC section, see the structure of the Current Sensor Calibration article and the still-in-progress https://github.com/Severson-Group/docs.amdc.dev/pull/103..
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.