Skip to content

Commit 57eccf0

Browse files
actions-useractions-user
committed
Update documentation
1 parent f05a7a7 commit 57eccf0

42 files changed

Lines changed: 208 additions & 9 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_sources/parts_gc/api_documentation/gem_control.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ GEM Control API Documentation
99
pi_current_controller
1010
torque_controller
1111
pi_speed_controller
12+
mpc_current_controller
1213
gem_adapter
1314
reference_plotter
1415
utils

‎index.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,10 @@ <h2>GEM-Control Content<a class="headerlink" href="#gem-control-content" title="
342342
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/pi_current_controller.html">PI Current Controller</a></li>
343343
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/torque_controller.html">Torque Controller</a></li>
344344
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/pi_speed_controller.html">PI Speed Controller</a></li>
345+
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
346+
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
347+
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/mpc_current_controller.html#example-usage">Example Usage</a></li>
348+
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/mpc_current_controller.html#simulation-results">Simulation Results</a></li>
345349
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/gem_adapter.html">GEM Adapter</a></li>
346350
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/reference_plotter.html">Reference Plotter</a></li>
347351
<li class="toctree-l2"><a class="reference internal" href="parts_gc/api_documentation/utils.html">Utils</a></li>

‎parts_gc/api_documentation/block_diagrams/block_diagram.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@
7676
<li class="toctree-l2"><a class="reference internal" href="../pi_current_controller.html">PI Current Controller</a></li>
7777
<li class="toctree-l2"><a class="reference internal" href="../torque_controller.html">Torque Controller</a></li>
7878
<li class="toctree-l2"><a class="reference internal" href="../pi_speed_controller.html">PI Speed Controller</a></li>
79+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
80+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
81+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#example-usage">Example Usage</a></li>
82+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#simulation-results">Simulation Results</a></li>
7983
<li class="toctree-l2"><a class="reference internal" href="../gem_adapter.html">GEM Adapter</a></li>
8084
<li class="toctree-l2"><a class="reference internal" href="../reference_plotter.html">Reference Plotter</a></li>
8185
<li class="toctree-l2"><a class="reference internal" href="../utils.html">Utils</a></li>

‎parts_gc/api_documentation/block_diagrams/block_diagrams.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@
7272
<li class="toctree-l2"><a class="reference internal" href="../pi_current_controller.html">PI Current Controller</a></li>
7373
<li class="toctree-l2"><a class="reference internal" href="../torque_controller.html">Torque Controller</a></li>
7474
<li class="toctree-l2"><a class="reference internal" href="../pi_speed_controller.html">PI Speed Controller</a></li>
75+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
76+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
77+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#example-usage">Example Usage</a></li>
78+
<li class="toctree-l2"><a class="reference internal" href="../mpc_current_controller.html#simulation-results">Simulation Results</a></li>
7579
<li class="toctree-l2"><a class="reference internal" href="../gem_adapter.html">GEM Adapter</a></li>
7680
<li class="toctree-l2"><a class="reference internal" href="../reference_plotter.html">Reference Plotter</a></li>
7781
<li class="toctree-l2"><a class="reference internal" href="../utils.html">Utils</a></li>

‎parts_gc/api_documentation/gem_adapter.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<link rel="index" title="Index" href="../../genindex.html" />
2121
<link rel="search" title="Search" href="../../search.html" />
2222
<link rel="next" title="Reference Plotter" href="reference_plotter.html" />
23-
<link rel="prev" title="PI Speed Controller" href="pi_speed_controller.html" />
23+
<link rel="prev" title="Finite-Control-Set Model Predictive Control (FCS-MPC)" href="mpc_current_controller.html" />
2424
</head>
2525

2626
<body class="wy-body-for-nav">
@@ -69,6 +69,10 @@
6969
<li class="toctree-l2"><a class="reference internal" href="pi_current_controller.html">PI Current Controller</a></li>
7070
<li class="toctree-l2"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
7171
<li class="toctree-l2"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
72+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
73+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
74+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#example-usage">Example Usage</a></li>
75+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#simulation-results">Simulation Results</a></li>
7276
<li class="toctree-l2 current"><a class="current reference internal" href="#">GEM Adapter</a><ul>
7377
<li class="toctree-l3"><a class="reference internal" href="#gem_controllers.gem_adapter.GymElectricMotorAdapter"><code class="docutils literal notranslate"><span class="pre">GymElectricMotorAdapter</span></code></a><ul>
7478
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.gem_adapter.GymElectricMotorAdapter.build_block_diagram"><code class="docutils literal notranslate"><span class="pre">GymElectricMotorAdapter.build_block_diagram()</span></code></a></li>
@@ -292,7 +296,7 @@ <h1>GEM Adapter<a class="headerlink" href="#gem-adapter" title="Link to this hea
292296
</div>
293297
</div>
294298
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
295-
<a href="pi_speed_controller.html" class="btn btn-neutral float-left" title="PI Speed Controller" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
299+
<a href="mpc_current_controller.html" class="btn btn-neutral float-left" title="Finite-Control-Set Model Predictive Control (FCS-MPC)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
296300
<a href="reference_plotter.html" class="btn btn-neutral float-right" title="Reference Plotter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
297301
</div>
298302

‎parts_gc/api_documentation/gem_control.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@
6969
<li class="toctree-l2"><a class="reference internal" href="pi_current_controller.html">PI Current Controller</a></li>
7070
<li class="toctree-l2"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
7171
<li class="toctree-l2"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
72+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
73+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
74+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#example-usage">Example Usage</a></li>
75+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#simulation-results">Simulation Results</a></li>
7276
<li class="toctree-l2"><a class="reference internal" href="gem_adapter.html">GEM Adapter</a></li>
7377
<li class="toctree-l2"><a class="reference internal" href="reference_plotter.html">Reference Plotter</a></li>
7478
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
@@ -110,6 +114,10 @@ <h1>GEM Control API Documentation<a class="headerlink" href="#gem-control-api-do
110114
<li class="toctree-l1"><a class="reference internal" href="pi_current_controller.html">PI Current Controller</a></li>
111115
<li class="toctree-l1"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
112116
<li class="toctree-l1"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
117+
<li class="toctree-l1"><a class="reference internal" href="mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
118+
<li class="toctree-l1"><a class="reference internal" href="mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
119+
<li class="toctree-l1"><a class="reference internal" href="mpc_current_controller.html#example-usage">Example Usage</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="mpc_current_controller.html#simulation-results">Simulation Results</a></li>
113121
<li class="toctree-l1"><a class="reference internal" href="gem_adapter.html">GEM Adapter</a></li>
114122
<li class="toctree-l1"><a class="reference internal" href="reference_plotter.html">Reference Plotter</a></li>
115123
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utils</a></li>

‎parts_gc/api_documentation/gem_controllers.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@
6868
<li class="toctree-l2"><a class="reference internal" href="pi_current_controller.html">PI Current Controller</a></li>
6969
<li class="toctree-l2"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
7070
<li class="toctree-l2"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
71+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
72+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
73+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#example-usage">Example Usage</a></li>
74+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#simulation-results">Simulation Results</a></li>
7175
<li class="toctree-l2"><a class="reference internal" href="gem_adapter.html">GEM Adapter</a></li>
7276
<li class="toctree-l2"><a class="reference internal" href="reference_plotter.html">Reference Plotter</a></li>
7377
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>

‎parts_gc/api_documentation/mpc_current_controller.html‎

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="../../_static/js/theme.js"></script>
2020
<link rel="index" title="Index" href="../../genindex.html" />
21-
<link rel="search" title="Search" href="../../search.html" />
21+
<link rel="search" title="Search" href="../../search.html" />
22+
<link rel="next" title="GEM Adapter" href="gem_adapter.html" />
23+
<link rel="prev" title="PI Speed Controller" href="pi_speed_controller.html" />
2224
</head>
2325

2426
<body class="wy-body-for-nav">
@@ -59,9 +61,41 @@
5961
<li class="toctree-l1"><a class="reference internal" href="../../parts_gem/random_component.html">Random Component</a></li>
6062
</ul>
6163
<p class="caption" role="heading"><span class="caption-text">GEM-Control Contents:</span></p>
62-
<ul>
64+
<ul class="current">
6365
<li class="toctree-l1"><a class="reference internal" href="../usage_guide/usage_guides.html">Usage Guides</a></li>
64-
<li class="toctree-l1"><a class="reference internal" href="gem_control.html">GEM Control API Documentation</a></li>
66+
<li class="toctree-l1 current"><a class="reference internal" href="gem_control.html">GEM Control API Documentation</a><ul class="current">
67+
<li class="toctree-l2"><a class="reference internal" href="stages/stages.html">Stages</a></li>
68+
<li class="toctree-l2"><a class="reference internal" href="block_diagrams/block_diagrams.html">Block Diagrams</a></li>
69+
<li class="toctree-l2"><a class="reference internal" href="pi_current_controller.html">PI Current Controller</a></li>
70+
<li class="toctree-l2"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
71+
<li class="toctree-l2"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
72+
<li class="toctree-l2 current"><a class="current reference internal" href="#">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
73+
<li class="toctree-l2"><a class="reference internal" href="#mpc-current-controller">MPC Current Controller</a><ul>
74+
<li class="toctree-l3"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController</span></code></a><ul>
75+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.control"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.control()</span></code></a></li>
76+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.control_environment"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.control_environment()</span></code></a></li>
77+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.get_signal_value"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.get_signal_value()</span></code></a></li>
78+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.make"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.make()</span></code></a></li>
79+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.reset"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.reset()</span></code></a></li>
80+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.tune"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.tune()</span></code></a></li>
81+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.signal_names"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.signal_names</span></code></a></li>
82+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.signals"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.signals</span></code></a></li>
83+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.stages"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.stages</span></code></a></li>
84+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.u_abc_k1"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.u_abc_k1</span></code></a></li>
85+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.u_lim"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.u_lim</span></code></a></li>
86+
<li class="toctree-l4"><a class="reference internal" href="#gem_controllers.mpc_current_controller.MPCCurrentController.w_q"><code class="docutils literal notranslate"><span class="pre">MPCCurrentController.w_q</span></code></a></li>
87+
</ul>
88+
</li>
89+
</ul>
90+
</li>
91+
<li class="toctree-l2"><a class="reference internal" href="#example-usage">Example Usage</a></li>
92+
<li class="toctree-l2"><a class="reference internal" href="#simulation-results">Simulation Results</a></li>
93+
<li class="toctree-l2"><a class="reference internal" href="gem_adapter.html">GEM Adapter</a></li>
94+
<li class="toctree-l2"><a class="reference internal" href="reference_plotter.html">Reference Plotter</a></li>
95+
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
96+
<li class="toctree-l2"><a class="reference internal" href="gem_controllers.html">GEM Controllers</a></li>
97+
</ul>
98+
</li>
6599
</ul>
66100

67101
</div>
@@ -78,6 +112,7 @@
78112
<div role="navigation" aria-label="Page navigation">
79113
<ul class="wy-breadcrumbs">
80114
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
115+
<li class="breadcrumb-item"><a href="gem_control.html">GEM Control API Documentation</a></li>
81116
<li class="breadcrumb-item active">Finite-Control-Set Model Predictive Control (FCS-MPC)</li>
82117
<li class="wy-breadcrumbs-aside">
83118
<a href="../../_sources/parts_gc/api_documentation/mpc_current_controller.rst.txt" rel="nofollow"> View page source</a>
@@ -377,7 +412,10 @@ <h1>Simulation Results<a class="headerlink" href="#simulation-results" title="Li
377412

378413
</div>
379414
</div>
380-
<footer>
415+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
416+
<a href="pi_speed_controller.html" class="btn btn-neutral float-left" title="PI Speed Controller" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
417+
<a href="gem_adapter.html" class="btn btn-neutral float-right" title="GEM Adapter" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
418+
</div>
381419

382420
<hr/>
383421

‎parts_gc/api_documentation/pi_current_controller.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@
9393
</li>
9494
<li class="toctree-l2"><a class="reference internal" href="torque_controller.html">Torque Controller</a></li>
9595
<li class="toctree-l2"><a class="reference internal" href="pi_speed_controller.html">PI Speed Controller</a></li>
96+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html">Finite-Control-Set Model Predictive Control (FCS-MPC)</a></li>
97+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#mpc-current-controller">MPC Current Controller</a></li>
98+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#example-usage">Example Usage</a></li>
99+
<li class="toctree-l2"><a class="reference internal" href="mpc_current_controller.html#simulation-results">Simulation Results</a></li>
96100
<li class="toctree-l2"><a class="reference internal" href="gem_adapter.html">GEM Adapter</a></li>
97101
<li class="toctree-l2"><a class="reference internal" href="reference_plotter.html">Reference Plotter</a></li>
98102
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>

0 commit comments

Comments
 (0)