-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhelp.html
More file actions
188 lines (183 loc) · 5.29 KB
/
help.html
File metadata and controls
188 lines (183 loc) · 5.29 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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type"/>
<link href="iabStyle.css" rel="StyleSheet" type="text/css"/>
<link href="../iabStyle.css" rel="StyleSheet" type="text/css"/>
<link href="../../iabStyle.css" rel="StyleSheet" type="text/css"/>
<link href="../../../iabStyle.css" rel="StyleSheet" type="text/css"/>
</head>
<body>
<div class="page_container" style="font-size: x-small;">
<div id="toc_container"> <span class="toc_span">adc_config</span>
<span class="toc_span_items"><a href="#misc">Misc ↓</a></span>
<span class="toc_span_items"><a href="#parameters">Params ↓</a></span>
<span class="toc_span_items"><a href="#ports">Ports ↓</a></span>
</div>
<p class="component">
This component configures the ADC unit either from parameters or JSON string input.</p>
<!-- Parameters -->
<div class="section_heading">
<span class="toc_span" id="parameters">Parameters</span>
<div class="toc_span_items"><a href="#toc_container">Top ↑</a></div>
<div class="toc_span_items"><a href="#misc">Misc ↓</a></div>
<div class="toc_span_items"><a href="#ports">Ports ↓</a></div>
</div>
<table class="table_params">
<tbody>
<tr>
<th style="width:60px;">name</th>
<th>type</th><th>description</th>
<th>default</th>
<th>min.</th>
<th>max.</th>
</tr>
<tr>
<td>device_id</td>
<td>integer</td><td>The ADC Device number to be configured. For internal ADCs, this is the unit. For external ADCs, this is the address enumeration.</td>
<td>0</td>
<td>0</td>
<td>9</td>
</tr>
<tr>
<td>f_s_hz</td>
<td>integer</td><td>Total sampling frequency in Hz. With n channels enabled, the sampling frequency of each channel is f_s_hz/n Hz.</td>
<td>1000</td>
<td>100</td>
<td>1000000000</td>
</tr>
<tr>
<td>mode</td>
<td>boolean</td><td>The ADC conversion mode. False for Single-shot. True for Continuous.</td>
<td>0</td>
<td>0</td>
<td>1</td>
</tr>
<tr>
<td>channel_[0..15]</td>
<td>integer</td><td>Pin mapping for individual channels of this ADC instance/unit. For fixed-mapped ADC, any non-negative number means enabled channel.</td>
<td>-1</td>
<td>-1</td>
<td>999</td>
</tr>
</tbody>
</table>
<!-- Ports -->
<div class="section_heading">
<span class="toc_span" id="ports">Ports</span>
<span class="toc_span_items"><a href="#toc_container">Top ↑</a></span>
<span class="toc_span_items"><a href="#misc">Misc ↓</a></span>
<span class="toc_span_items"><a href="#parameters">Params ↑</a></span>
</div>
<table class="table">
<tbody>
<tr>
<th>In Ev.</th>
<th>Description</th>
</tr>
<tr>
<td class="ports">init</td>
<td>Initialise the ADC unit with the configuration defined in either the parameters or the <a href="#[In]JSON">JSON</a> input port.</td>
</tr>
<tr>
<th>Data In</th>
<th>Description</th>
</tr>
<tr>
<td class="ports"><a name="[In]JSON">JSON</a></td>
<td>Alternative definition to the parameters to override. The format of it is:
<table>
<tbody>
<tr style="background-color:#333333;">
<td colspan="1" rowspan="1">
<p>
<span style="color:white;">{"id":</span>
<span style="color:red;">0</span>
<span style="color:white;">,"fs":</span>
<span style="color:red;">1000</span>
<span style="color:white;">,"m":</span>
<span style="color:red;">0</span>
<span style="color:white;">,"c0":</span>
<span style="color:red;">-1</span>
<span style="color:white;">,"c1":</span>
<span style="color:red;">123</span>
<span style="color:white;">,"c2":</span>
<span style="color:red;">-1</span>
<span style="color:white;">,"c3":</span>
<span style="color:red;">0</span>
<span style="color:white;">, ... ,"c15":</span>
<span style="color:red;">-1</span>
<span style="color:white;">}</span>
</p>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<th>Data Out</th>
<th>Description</th>
</tr>
<tr>
<th>Out Ev.</th>
<th>Description</th>
</tr>
<tr>
<td class="ports"><a name="[Out]done">--</a></td>
<td>Triggerred when the configuration is completed without any error</td>
</tr>
<tr>
<td class="ports"><a name="[Out]error">error</a></td>
<td>Triggerred when:
<ol start="1">
<li>
<span>the same unit is already initialised</span>
</li>
<li>
<span>the parameters are invalid</span>
</li>
<li>
<span>the JSON port gives invalid format</span>
</li>
</ol>
</td>
</tr>
</tbody>
</table>
<!-- Misc -->
<div class="section_heading">
<span class="toc_span" id="misc">Misc</span>
<span class="toc_span_items"><a href="#toc_container">Top ↑</a></span>
<span class="toc_span_items"><a href="#ports">Ports ↑</a></span>
<span class="toc_span_items"><a href="#parameters">Params ↑</a></span>
</div>
<table>
<tbody>
<tr class="fsm_row">
<td style="width:90px;"> <b>State Machine</b> </td>
<td colspan="5">None</td>
</tr>
<tr>
<td class="heading-cell"> <b>Toolbox</b> </td>
<td> Core </td>
<td class="heading-cell"> <b>Version</b> </td>
<td> v1.0. </td>
</tr>
<tr>
<td class="heading-cell"> <b>Licence Type</b> </td>
<td> LGPLv3 </td>
<td class="heading-cell"> <b>Component Supplier</b> </td>
<td> <a href="http://www.inx-systems.net" target="_blank">inx ltd.</a>
</td>
</tr>
<tr>
<td class="heading-cell"> <b>Minumum DCC</b> </td>
<td>A0000</td>
<td class="heading-cell"> <b>Profiles</b> </td>
<td> All. </td>
</tr>
</tbody>
</table>
</div>
</body>
</html>