Repository navigation
Expand file tree
/
Copy pathcreateattributed.html
More file actions
151 lines (137 loc) · 8.16 KB
/
Copy pathcreateattributed.html
File metadata and controls
151 lines (137 loc) · 8.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Creating a project with the Attributed Robot Model | RobotDotNet </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Creating a project with the Attributed Robot Model | RobotDotNet ">
<meta name="generator" content="docfx 2.48.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">
<h1 id="creating-a-project-with-the-attributed-robot-model">Creating a project with the Attributed Robot Model</h1>
<p>The Attributed Robot Model is a new way of creating a Command-Based Robot that removes nearly all of the boilerplate code (aka hookup code, like the usual OI class) usually required. This model uses a process called "reflection" to find the subsystems and commands and hook them up correctly. Consequently, the robot will take a little longer (read: a second or two) to initialize upon startup, but the difference is not noticable in most situations.</p>
<h2 id="creating-a-basic-project">Creating a basic project</h2>
<ol>
<li>Create a new robot project using the Attributed Command Robot template. You should see the following files:<ul>
<li><strong>ProjectName.cs</strong><ul>
<li>This contains your Robot class. Your robot class derives from the <a href="xref:WPILib.Extras.AttributedCommandModel.AttributedRobot">AttributedRobot</a> class. This class sets everything up to execute when you want.</li>
</ul>
</li>
<li><strong>RobotMap.cs</strong><ul>
<li>This class should have the ports defined for each piece of hardware attached to the robot as constants.</li>
</ul>
</li>
<li><strong>Program.cs</strong><ul>
<li>This class contains the entry point to the project. You should never have to edit this file.</li>
</ul>
</li>
<li><strong>Subsystems/ExampleSubsystem.cs</strong><ul>
<li>This class is an example subsystem that will automatically be set up and have its default command set to be an instance of <em>ExampleCommand</em>.</li>
</ul>
</li>
<li><strong>Commands/ExampleCommand.cs</strong><ul>
<li>This class is an example command that is automatically set up as the default command for an instance of 8ExampleSubsystem8. NOTE: It MUST have the constructor taking an <em>ExampleSubsystem</em> for it to work.</li>
</ul>
</li>
<li><strong>Commands/ExampleAutonomousCommand.cs</strong><ul>
<li>This class is an example command that is automatically set up to start when the robot enters Autonomous mode. NOTE: It does not require the constructor taking an <em>ExampleSubsystem</em> for it to work, but that is the only way for it to <em>Require</em> the subsystem.</li>
</ul>
</li>
</ul>
</li>
<li><p>To add a new subsystem, right click on your project and click Add > New Item. Create a Subsystem. This is the same template as used fror a Command-Based Robot. To make it automatically load, add the folloing code on a new line before <em>class:</em> (Note this is called adding an attribute to the class)</p>
<blockquote><p>[WPILib.Extras.AttributedCommandModel.ExportSubsystem]</p>
</blockquote>
<p> The subsystem will now automatically load. To specify a default command, use the following:</p>
<blockquote><p>[WPILib.Extras.AttributedCommandModel.ExportSubsystem(DefaultCommandType=typeof(CommandType))]</p>
</blockquote>
<p> Where <em>CommandType</em> is the type of the command.</p>
</li>
<li>To add a new command, right click on your project and click Add > New Item. Create a Command. This is the same template as used for a Command-Based Robot. To set it up to auto-load, there are a few different ways: default command, phase command, and button command. The default command is configured on the respective subsystem as seen above. If your command is a default command, it MUST have a constructor that takes ONLY an instance of the subsystem it is the default command for, or your project will fail to run. To set it up as a phase command, add the <em>RunCommandAtPhaseStart</em> attribute to the commmand class. You will have to specify which phase to start the command on with the <em>MatchPhase</em> enumeration. If your command acts on a button, you will have to pick the correct attribute. There is one attribute for each of the different button classes. Use the correct method (and pass in the required parameters), and the library will automatically set up the command to execute when you want it to.</li>
</ol>
<p>For more information, see the docs for the <a href="xref:WPILib.Extras.AttributedCommandModel">Attributed Command Model</a></p>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/robotdotnet/WPILib-Docs/blob/master/tutorials/createattributed.md/#L1" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2017 RobotDotNet
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>