-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.codebanner.json
303 lines (303 loc) · 15 KB
/
.codebanner.json
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
{
"folders": [
"lib",
"projects",
"test"
],
"include_patterns": [
"*.cpp",
"*.hpp",
"*.h",
"*.c"
],
"exclude_patterns": [
"projects/platformio/*"
],
"license": "MIT - See LICENSE file",
"project": "Scrutiny Debugger",
"repo": "github.com/scrutinydebugger/scrutiny-embedded",
"copyright_owner": "Scrutiny Debugger",
"copyright_start_date": "2021",
"copyright_end_date": null,
"files": {
"lib/inc/scrutiny.hpp": {
"docstring": "Main .h file to be included in a project"
},
"lib/inc/scrutiny_config.hpp": {
"docstring": "Definition of a run-time configuration of the scrutiny module.\nTo be filled in startup phase"
},
"lib/inc/scrutiny_loop_handler.hpp": {
"docstring": "LoopHandler definition.\nLoop Handler is to be run in a specific time domain and will make some features available that depends on the execution requency such as embedded datalogging"
},
"lib/inc/scrutiny_main_handler.hpp": {
"docstring": "The main scrutiny class to be manipulated by the user"
},
"lib/inc/scrutiny_setup.hpp": {
"docstring": "Compile-time configuration of embedded Scrutiny module.\nThis configuration is global for the module and should be set once per project"
},
"lib/inc/scrutiny_software_id.hpp": {
"docstring": "Contains the definition of the Scrutiny ID global var used for tagging of firmware."
},
"lib/inc/scrutiny_timebase.hpp": {
"docstring": "Minimalist helper to keep track of time"
},
"lib/inc/scrutiny_types.hpp": {
"docstring": "Aliases on the types used by the Scrutiny project"
},
"lib/inc/protocol/scrutiny_codec_v1_0.hpp": {
"docstring": "Definitions of encode/decode functions for the scrutiny protocol V1.0"
},
"lib/inc/protocol/scrutiny_comm_handler.hpp": {
"docstring": "Manage the tranport-ish layer of the communication protocol. Converts Request/Response to byte stream and validate CRC"
},
"lib/inc/protocol/scrutiny_protocol.hpp": {
"docstring": "Main include file for the scrutiny protocol"
},
"lib/inc/protocol/scrutiny_protocol_definitions.hpp": {
"docstring": "Defines Request/Rsponse objects and commands/subfunctions IDs.\n Not version specific"
},
"lib/src/scrutiny_config.cpp": {
"docstring": "Implementation of the run-time Scrutiny configuration"
},
"lib/src/scrutiny_loop_handler.cpp": {
"docstring": "LoopHandler implementation.\nLoop Handler is to be run in a specific time domain and will make some features available that depends on the execution requency such as embedded datalogging"
},
"lib/src/scrutiny_main_handler.cpp": {
"docstring": "The main scrutiny class to be manipulated by the user."
},
"lib/src/scrutiny_software_id.cpp": {
"docstring": "Instanciation of the global ID used for firmware tagging"
},
"lib/src/protocol/scrutiny_codec_v1_0.cpp": {
"docstring": "Encode/Decode functions for the Scrutiny Protocol V1.0"
},
"lib/src/protocol/scrutiny_comm_handler.cpp": {
"docstring": "Manage the tranport-ish layer of the communication protocol. Converts Request/Response to byte stream and validate CRC"
},
"lib/src/protocol/scrutiny_protocol_definitions.cpp": {
"docstring": "Instanciation of protocol definitions such as magic payload."
},
"test/scrutiny_test.cpp": {
"docstring": "Base class for CPP unit tests.\n All test should inherit this class.\n Includes bunch of helper for easy testing."
},
"test/test_crc.cpp": {
"docstring": "Test CRC calculation"
},
"test/test_timebase.cpp": {
"docstring": "Test our minimalist time tracker"
},
"test/scrutiny_test.hpp": {
"docstring": "Base class for CPP unit tests.\n All test should inherit this class.\n Includes bunch of helper for easy testing."
},
"test/commands/test_comm_control.cpp": {
"docstring": "Test the behaviour of the embedded module when CommControl commands are received"
},
"test/commands/test_get_info.cpp": {
"docstring": "Test the behaviour of the embedded module when GetInfo commands are received"
},
"test/commands/test_memory_control.cpp": {
"docstring": "Test the behaviour of the embedded module when MemoryControl commands are received"
},
"test/commands/test_user_command.cpp": {
"docstring": "Test the behaviour of the embedded module when UserCommand commands are received"
},
"test/protocol/test_comm_handler.cpp": {
"docstring": "Test the tranport-ish layer good behaviour at high level."
},
"test/protocol/test_protocol_rx_parsing.cpp": {
"docstring": "Make sure reception of request bytes are correctly decoded"
},
"test/protocol/test_protocol_tx_parsing.cpp": {
"docstring": "Make sure Response objects are correctly encoded in bytes"
},
"lib/inc/scrutiny_tools.hpp": {
"docstring": "Some simple tools used across the project"
},
"projects/testapp/src/file1.cpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/src/argument_parser.cpp": {
"docstring": "For CLI parsing"
},
"projects/testapp/src/main.cpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/src/file2.cpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/src/file3.cpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/src/comm_channels/udp_bridge.cpp": {
"docstring": "Class that open a UDP port and handle a single client."
},
"projects/testapp/include/file1.hpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/include/file2.hpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/include/file3.hpp": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/testapp/include/comm_channels/udp_bridge.hpp": {
"docstring": "Class that open a UDP port and handle a single client."
},
"projects/testapp/include/argument_parser.hpp": {
"docstring": "For CLI parsing"
},
"projects/testapp/include/comm_channels/abstract_comm_channel.hpp": {
"docstring": "Define the interface for a communication channel used by the testapp to run the scrutiny embedded lib"
},
"projects/testapp/include/comm_channels/nix_serial_port_bridge.hpp": {
"docstring": "Class that make a *Nix Serial port available as a communication channel for the Testapp"
},
"projects/testapp/include/comm_channels/win_serial_port_bridge.hpp": {
"docstring": "Class that make a Windows Serial port available as a communication channel for the Testapp"
},
"projects/testapp/src/comm_channels/nix_serial_port_bridge.cpp": {
"docstring": "Class that make a *Nix Serial port available as a communication channel for the Testapp"
},
"projects/testapp/src/comm_channels/win_serial_port_bridge.cpp": {
"docstring": "Class that make a Windows Serial port available as a communication channel for the Testapp"
},
"lib/inc/scrutiny_common_codecs.hpp": {
"docstring": "Some codecs function used across the project"
},
"lib/inc/scrutiny_ipc.hpp": {
"docstring": "Some tools for inter-process communications"
},
"lib/inc/datalogging/scrutiny_datalogging.hpp": {
"docstring": "The datalogging main include"
},
"lib/inc/datalogging/scrutiny_datalogging_types.hpp": {
"docstring": "Types used across datalogging feature"
},
"lib/inc/datalogging/scrutiny_datalogging_trigger.hpp": {
"docstring": "The definition of the datalogging trigger conditions operators"
},
"lib/inc/datalogging/scrutiny_datalogger.hpp": {
"docstring": "The definition of the datalogger object that should exist in each loop"
},
"lib/src/scrutiny_tools.cpp": {
"docstring": "Some tools used across the project"
},
"lib/src/scrutiny_common_codecs.cpp": {
"docstring": "Some common encoding/decoding functions used across the project."
},
"lib/src/datalogging/scrutiny_datalogger.cpp": {
"docstring": "The implementation of the datalogger object that should exist in each loop "
},
"lib/src/datalogging/datalogging.cpp": {
"docstring": "Implementation of some datalogging features"
},
"projects/testapp/src/include_test.cpp": {
"docstring": "Just a file that make sure that we can include scrutiny.hpp in a blank file without breaking anything"
},
"test/test_ipc.cpp": {
"docstring": "Test for the Inter-process communication tools"
},
"test/test_variable_fetching.cpp": {
"docstring": "Test the capacity to read a variable from the memory given the debugging info"
},
"test/test_types.cpp": {
"docstring": "Some tests dones on scrutiny types"
},
"test/commands/test_memory_control_rpv.cpp": {
"docstring": "Test the memory control command dedicated for Runtime Published Values"
},
"test/datalogging/test_fetch_operands.cpp": {
"docstring": "Test the capacity to decode an operand for log trigger"
},
"lib/src/datalogging/scrutiny_datalogging_trigger.cpp": {
"docstring": "The implementation of the datalogging trigger conditions operators"
},
"test/datalogging/test_trigger_conditions.cpp": {
"docstring": "Test datalogging trigger conditions"
},
"test/datalogging/test_datalogging_types.cpp": {
"docstring": "Run some tests on datalogging types"
},
"lib/inc/datalogging/scrutiny_datalogging_data_encoding.hpp": {
"docstring": "File to be included to get access to the datalogging encoders/readers. Abstract the handling of different encoding."
},
"lib/inc/datalogging/scrutiny_datalogger_raw_encoder.hpp": {
"docstring": "Class that handles the encoding of the datalogger data. RawFormat just copy to memory, no encoding scheme."
},
"lib/src/datalogging/scrutiny_datalogger_raw_encoder.cpp": {
"docstring": "Class that handles the encoding of the datalogger data. RawFormat just copy to memory, no encoding scheme."
},
"test/test_codecs.cpp": {
"docstring": "Tests the different codecs function used across this project"
},
"test/commands/test_datalog_control.cpp": {
"docstring": "Test the DataLogControl command used to configure, control and reads the datalogger"
},
"test/datalogging/test_datalogger.cpp": {
"docstring": "Test suite for the datalogger object. Test its capacity to log, trigger access bitfields and report error on bad config."
},
"test/datalogging/raw_format_parser.hpp": {
"docstring": "Class that can reads the data encoded by the datalogging encoder. It does what the server would do for testing purpose"
},
"test/datalogging/test_raw_encoder.cpp": {
"docstring": "Test suite for the RawFormat encoder."
},
"test/datalogging/raw_format_parser.cpp": {
"docstring": "Class that can reads the data encoded by the datalogging encoder. It does what the server would do for testing purpose"
},
"lib/inc/static_analysis_build_config.hpp": {
"docstring": "Stubbed configuration file used for static analysis with hardcoded values instead of values coming from cmake"
},
"lib/inc/scrutiny_c_compatible_types.h": {
"docstring": "Types declaration that are valid in both C and C++. The C++ library extend them, the C-Wrapper uses them directly"
},
"projects/c_testapp/include/argument_parser.h": {
"docstring": "For CLI parsing"
},
"projects/c_testapp/include/tools.h": {
"docstring": "Some tools used across the C TestApp project"
},
"projects/c_testapp/include/comm_channels/abstract_comm_channel.h": {
"docstring": "Define the interface for a communication channel used by the testapp to run the scrutiny embedded lib"
},
"projects/c_testapp/include/comm_channels/nix_serial_port_bridge.h": {
"docstring": "Serial interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/include/comm_channels/udp_bridge.h": {
"docstring": "UDP interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/include/comm_channels/win_serial_port_bridge.h": {
"docstring": "Serial interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/src/main.c": {
"docstring": "Entry point of C TestApp"
},
"projects/c_testapp/src/argument_parser.c": {
"docstring": "For CLI parsing"
},
"projects/c_testapp/src/include_test.c": {
"docstring": "Just a file that make sure that we can include scrutiny.hpp in a blank file without breaking anything"
},
"projects/c_testapp/src/comm_channels/win_serial_port_bridge.c": {
"docstring": "Serial interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/src/comm_channels/nix_serial_port_bridge.c": {
"docstring": "Serial interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/src/comm_channels/udp_bridge.c": {
"docstring": "UDP interface fopr the C testapp. Used to talk with the server"
},
"projects/c_testapp/include/file2.h": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/c_testapp/include/file1.h": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/c_testapp/src/file1.c": {
"docstring": "Placeholder file for variable extraction test"
},
"projects/c_testapp/src/file2.c": {
"docstring": "Placeholder file for variable extraction test"
}
}
}