├── .github └── workflows │ └── c-cpp.yml ├── .gitignore ├── .gitmodules ├── CMakeLists.txt ├── LICENSE ├── cmake └── ExternalAnalyzerSDK.cmake ├── docs ├── Analyzer SDK Setup.md ├── Saleae Analyzer SDK (older).pdf └── images │ ├── 10_-_build_settings_page.png │ ├── 11_-_header_includes_search_path.png │ ├── 11_5_-_add_library_path.png │ ├── 12_-_add_library_part_1.png │ ├── 13_-_add_library_part_2.png │ ├── 14_-_add_library_part_3.png │ ├── 15_-_edit_scheme.png │ ├── 16_-_debug_launch_app_menu.png │ ├── 17_-_select_debug_program.png │ ├── 18_-_breakpoint_set.png │ ├── 19_-_logic_software_add_analyzer_menu.png │ ├── 1_-_new_project.png │ ├── 20_-_analyzer_in_Logic.png │ ├── 21_-_logic_software_start_button.png │ ├── 22_-_breakpoint_hit.png │ ├── 2_-_empty_project.png │ ├── 2_5_analyzer_name.png │ ├── 2_75_-_project_location.png │ ├── 3_-_copy_files.png │ ├── 4_-_rename_analyzer_script.png │ ├── 5_-_add_target_button.png │ ├── 6_-_add_target_menu.png │ ├── 7_-_library_target.png │ ├── 8_-_library_settings.png │ ├── 8_5_-_add_files_menu.png │ ├── 9_-_add_files.png │ ├── 9_5_-_verify_sources_added.png │ ├── optional_-_Project_Settings.png │ ├── optional_-_project_settings_-_edit_products_folder_menu.png │ ├── sent_analyzer_settings.PNG │ └── sent_simulation_screenshot.PNG ├── readme.md └── src ├── SENTAnalyzer.cpp ├── SENTAnalyzer.h ├── SENTAnalyzerResults.cpp ├── SENTAnalyzerResults.h ├── SENTAnalyzerSettings.cpp ├── SENTAnalyzerSettings.h ├── SENTSimulationDataGenerator.cpp └── SENTSimulationDataGenerator.h /.github/workflows/c-cpp.yml: -------------------------------------------------------------------------------- 1 | name: C/C++ CI 2 | 3 | on: push 4 | 5 | jobs: 6 | build-linux: 7 | 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | - name: Install newer version of cmake 13 | uses: lukka/get-cmake@v3.18.0 14 | - name: Build using cmake 15 | run: mkdir build; cd build; cmake ..; cmake --build . 16 | - name: Move build results 17 | run: mkdir build/Analyzers/linux; mv build/Analyzers/*.so build/Analyzers/linux 18 | - name: Store build result as artifact 19 | uses: actions/upload-artifact@v2 20 | with: 21 | name: SENTanalyzer 22 | path: build/Analyzers 23 | 24 | build-macos: 25 | 26 | runs-on: macos-latest 27 | 28 | steps: 29 | - uses: actions/checkout@v2 30 | - name: Install newer version of cmake 31 | uses: lukka/get-cmake@v3.18.0 32 | - name: Build using cmake 33 | run: mkdir build; cd build; cmake ..; cmake --build . 34 | - name: Move build results 35 | run: mkdir build/Analyzers/macOS; mv build/Analyzers/*.so build/Analyzers/macOS 36 | - name: Store build result as artifact 37 | uses: actions/upload-artifact@v2 38 | with: 39 | name: SENTanalyzer 40 | path: build/Analyzers 41 | 42 | build-windows: 43 | 44 | runs-on: windows-latest 45 | 46 | steps: 47 | - uses: actions/checkout@v2 48 | - name: Install newer version of cmake 49 | uses: lukka/get-cmake@v3.18.0 50 | - name: Build using cmake 51 | run: mkdir build; cd build; cmake ..; cmake --build . --config Release 52 | - name: Move build results 53 | run: mkdir build/Analyzers/windows; mv build/Analyzers/Release/* build/Analyzers/windows 54 | - name: Store build result as artifact 55 | uses: actions/upload-artifact@v2 56 | with: 57 | name: SENTanalyzer 58 | path: build/Analyzers 59 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Compiled Object files 5 | *.slo 6 | *.lo 7 | *.o 8 | *.obj 9 | 10 | # Precompiled Headers 11 | *.gch 12 | *.pch 13 | 14 | # Compiled Dynamic libraries 15 | *.so 16 | *.dylib 17 | *.dll 18 | 19 | # Fortran module files 20 | *.mod 21 | *.smod 22 | 23 | # Compiled Static libraries 24 | *.lai 25 | *.la 26 | *.a 27 | *.lib 28 | 29 | # Executables 30 | *.exe 31 | *.out 32 | *.app 33 | 34 | build/* -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/.gitmodules -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required (VERSION 3.11) 2 | project(SENT_analyzer) 3 | 4 | # custom CMake Modules are located in the cmake directory. 5 | set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake) 6 | 7 | include(ExternalAnalyzerSDK) 8 | 9 | set(SOURCES 10 | src/SENTAnalyzer.cpp 11 | src/SENTAnalyzer.h 12 | src/SENTAnalyzerResults.cpp 13 | src/SENTAnalyzerResults.h 14 | src/SENTAnalyzerSettings.cpp 15 | src/SENTAnalyzerSettings.h 16 | src/SENTSimulationDataGenerator.cpp 17 | src/SENTSimulationDataGenerator.h 18 | ) 19 | 20 | add_analyzer_plugin(SENT_analyzer SOURCES ${SOURCES}) 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/} 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see {http://www.gnu.org/licenses/}. 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Sphinx-Traceability-extension Copyright (C) 2013 Oscar Ciudad 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | {http://www.gnu.org/licenses/}. 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | {http://www.gnu.org/philosophy/why-not-lgpl.html}. -------------------------------------------------------------------------------- /cmake/ExternalAnalyzerSDK.cmake: -------------------------------------------------------------------------------- 1 | include(FetchContent) 2 | 3 | # Use the C++11 standard 4 | set(CMAKE_CXX_STANDARD 11) 5 | 6 | set(CMAKE_CXX_STANDARD_REQUIRED YES) 7 | 8 | if (NOT CMAKE_RUNTIME_OUTPUT_DIRECTORY OR NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) 9 | set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin/) 10 | set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin/) 11 | endif() 12 | 13 | # Fetch the Analyzer SDK if the target does not already exist. 14 | if(NOT TARGET Saleae::AnalyzerSDK) 15 | FetchContent_Declare( 16 | analyzersdk 17 | GIT_REPOSITORY https://github.com/saleae/AnalyzerSDK.git 18 | GIT_TAG master 19 | GIT_SHALLOW True 20 | GIT_PROGRESS True 21 | ) 22 | 23 | FetchContent_GetProperties(analyzersdk) 24 | 25 | if(NOT analyzersdk_POPULATED) 26 | FetchContent_Populate(analyzersdk) 27 | include(${analyzersdk_SOURCE_DIR}/AnalyzerSDKConfig.cmake) 28 | 29 | if(APPLE OR WIN32) 30 | get_target_property(analyzersdk_lib_location Saleae::AnalyzerSDK IMPORTED_LOCATION) 31 | if(CMAKE_LIBRARY_OUTPUT_DIRECTORY) 32 | file(COPY ${analyzersdk_lib_location} DESTINATION ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}) 33 | else() 34 | message(WARNING "Please define CMAKE_RUNTIME_OUTPUT_DIRECTORY and CMAKE_LIBRARY_OUTPUT_DIRECTORY if you want unit tests to locate ${analyzersdk_lib_location}") 35 | endif() 36 | endif() 37 | 38 | endif() 39 | endif() 40 | 41 | function(add_analyzer_plugin TARGET) 42 | set(options ) 43 | set(single_value_args ) 44 | set(multi_value_args SOURCES) 45 | cmake_parse_arguments( _p "${options}" "${single_value_args}" "${multi_value_args}" ${ARGN} ) 46 | 47 | 48 | add_library(${TARGET} MODULE ${_p_SOURCES}) 49 | target_link_libraries(${TARGET} PRIVATE Saleae::AnalyzerSDK) 50 | 51 | set(ANALYZER_DESTINATION "Analyzers") 52 | install(TARGETS ${TARGET} RUNTIME DESTINATION ${ANALYZER_DESTINATION} 53 | LIBRARY DESTINATION ${ANALYZER_DESTINATION}) 54 | 55 | set_target_properties(${TARGET} PROPERTIES RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${ANALYZER_DESTINATION} 56 | LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${ANALYZER_DESTINATION}) 57 | endfunction() -------------------------------------------------------------------------------- /docs/Analyzer SDK Setup.md: -------------------------------------------------------------------------------- 1 | # Setting up an Analyzer SDK Project 2 | 3 | This document details setting up your analyzer project for development on Windows, Mac, and Linux. 4 | 5 | Documentation for the Analyzer SDK code is still in the older Saleae Analyzer SDK.pdf. 6 | 7 | ## Initial Setup (All Platforms) 8 | 9 | Before continuing this setup guide, please follow the instructions in the readme file to download, fork or clone this repository, and then run the rename_analyzer.py script. 10 | 11 | ## Visual Studio 12 | 13 | To build on Windows, open the visual studio project in the Visual Studio folder, and build. The Visual Studio solution has configurations for 32 bit and 64 bit builds. You will likely need to switch the configuration to 64 bit and build that in order to get the analyzer to load in the Windows software. 14 | 15 | To test your analyzer, you will need to tell the Saleae Logic software where to load find your compiled analyzer dll. 16 | 17 | The four build combinations produce analyzer dll files in the following locations: 18 | ``` 19 | .\Visual Studio\Win32\Debug\Analyzer.dll 20 | .\Visual Studio\Win32\Release\Analyzer.dll 21 | .\Visual Studio\x64\Debug\Analyzer.dll 22 | .\Visual Studio\x64\Release\Analyzer.dll 23 | ``` 24 | 25 | Instructions to tell the Saleae Logic software where to find your new analyzer dll can be found here: 26 | [How to set the developer directory in the Saleae software to use third party or user created analyzers.](http://support.saleae.com/hc/en-us/articles/208667506) 27 | 28 | Once you have set that directory and restarted the software, your new custom analyzer should appear in the list of analyzers you can add. 29 | 30 | ## Debugging an Analyzer with Visual Studio 31 | 32 | Newer versions of the Saleae software cannot be used to debug custom analyzers. This means that older versions of the software and SDK must be used if you wish to attach a debugger and step through your code. 33 | 34 | *Note: it is impossible to attach a debugger to any version of the software that supports the new products. We are working on a solution to this problem, but for now that means you must rely on the simulation data generator for your analyzer to produce captures you can then debug in the older software.* 35 | 36 | To debug your custom analyzer, we recommend you use the 1.1.14 SDK with the 1.1.18 software. Because older versions of the software and SDK are 32 bit only, you will only be able to compile for 32 bit initially. Later, when you build the analyzer with the latest version of the SDK, you will be able to compile for 32 bit and 64 bit. 37 | 38 | The SampleAnalyzer repository and the AnalyzerSDK repository have been setup to make switching versions of the SDK easy. The SampleAnalyzer repository has a branch named "1.1.14-for-win32-debug". This branch and the master branch have exactly the same source code - the only difference is the project settings and the AnalyzerSDK submodule reference, which now points to the 1.1.14 AnalyzerSDK. 39 | 40 | Download the 32 bit stand-alone copy of the 1.1.18 software. The 32 bit standalone copy is required because the normal installer will not let you install the 32 bit software on a 64 bit operating system. 41 | 42 | Logic 1.1.18, 32 bit stand-alone: 43 | http://downloads.saleae.com/betas/1.1.18/Logic1.1.18BetaWin32Standalone.zip 44 | 45 | This is also convenient because you will not need to uninstall the latest Saleae Logic software, or install this version. Simply unzip and run the 1.1.18 software. 46 | 47 | Please note - switching between Saleae Logic software versions has a tendency to reset the software's settings. This could cause the analyzer developer directory to get reset. If you no longer see your analyzer in the list, please verify that the analyzer developer directory is still set properly. 48 | 49 | To build and and debug your custom analyzer using the 1.1.14 sofware, follow these steps: 50 | 51 | - Switch to the "1.1.14-for-win32-debug" branch of the SampleAnalyzer repository. 52 | - Using Visual Studio, open the solution file in the Visual Studio Folder. 53 | - Switch the solution platform to from x64 to Win32. x64 is not able to build on this branch. 54 | - Build the debug configuration. 55 | - Launch the 1.1.18 32-bit Logic software. If the analyzer directory is not already configured, set that, and restart the software. 56 | - The analyzer should now be visible in the list of analyzers you can add. 57 | - In visual studio, open the Debug Menu, and select "Attach to process..." 58 | - Locate Logic.exe in the list, select it, and click the Attach button. 59 | - Add a break point on any line near the top of the WorkerThread() function, such as line 27, *mSampleRateHz = GetSampleRate();* 60 | - In the Logic software, add your custom analyzer if you haven't already, and start a simulation. 61 | - The breakpoint should hit. 62 | 63 | 64 | **Updating to the latest SDK** 65 | 66 | Once you have finished debugging your analyzer using the "1.1.14-for-win32-debug" branch, we recommend committing your changes and then cherry-picking your commits to the master branch. Please do not simply merge changed into the master branch, as that may pick up other project settings not compatible with the latest SDK. 67 | 68 | In the future, we would like to simplify this even more, so branch switching is not required. 69 | 70 | 71 | **Common issues on Windows** 72 | 73 | - The software says "Unable to 'LoadLibrary' on dll ... is not a valid Win32 application" 74 | This is most likely because the analyzer was not built for the same platform architecture as the software running it. In almost all cases, this means the analyzer was compiled for 32 bit instead of 64 bit. Details to switch from 32 bit to 64 bit are included in the Analyzer SDK documentation on page 9. First, [add a x64 target to your project](https://msdn.microsoft.com/en-us/library/ms185328(v=vs.120).aspx). Then, edit the linker settings for the 64 bit configuration. Change the additional dependencies item from Analyzer.dll to Analyzer64.dll. 75 | Note: Only the software versions 1.1.16 and later were built for 64 bit. Previous releases, including 1.1.15, were 32 bit only, which is why no 64 bit analyzer dll was provided. 76 | - The Saleae software crashes on launch when the debugger is attached. 77 | Versions after about 1.1.18 no longer allow debuggers to attach. In these cases, we recommend building with the 32 bit version of the 1.1.18 beta and the 1.1.14 SDK, and debug there. This restriction only applies to Windows. 78 | 79 | ## Linux 80 | 81 | *Note: When using git clone, please remember to use --recursive to automatically also clone the AnalyzerSDK submodule* 82 | 83 | After you have cloned, forked, or downloaded the repository, and ran the rename_analyzer.py script, there are two additional steps required to run the analyzer. 84 | 85 | First, if you are using Linux 64 bit, you need to delete the 32 bit libAnalyzer.so file, and rename the libAnalyzer64.so file to just libAnalyzer.so. 86 | 87 | ``` 88 | mv AnalyzerSDK/lib/libAnalyzer64.so AnalyzerSDK/lib/libAnalyzer.so 89 | ``` 90 | 91 | Then run build_analyzer.py 92 | 93 | ``` 94 | python build_analyzer.py 95 | ``` 96 | 97 | That's it! To debug the analyzer, you need to first tell the Saleae Logic software where to find your newly compiled *.so file. 98 | 99 | [How to set the developer directory in the Saleae software to use third party or user created analyzers.](http://support.saleae.com/hc/en-us/articles/208667506) 100 | 101 | The two variants of the newly compiled analyzer can be found here: 102 | 103 | ``` 104 | debug/libAnalyzer.so 105 | release/libAnalyzer.so 106 | ``` 107 | 108 | ### Debugging with GDB on Linux 109 | 110 | To debug your analyzer, you will need to attach gdb to the Logic application, something like this: 111 | ``` 112 | gdb /Home/YourUserName/Desktop/Logic 1.2.14 (64-bit)/Logic 113 | ``` 114 | And then test setting a breakpoint like this: 115 | ``` 116 | break MyAnalyzer::WorkerThread 117 | ``` 118 | Because your analyzer hasn't been loaded yet, GDB will notify you that it can't find this function, and ask if you want to automatically set this breakpoint if a library with a matching function is loaded in the future. Type y 119 | 120 | Then type run to start the application. Add your custom analyzer and start a simulation. This will trigger the breakpoint. 121 | 122 | ## MacOS 123 | 124 | ### Build Script Based Project 125 | 126 | *Note: When using git clone, please remember to use --recursive to automatically also clone the AnalyzerSDK submodule* 127 | 128 | After you have cloned, forked, or downloaded the repository, and ran the rename_analyzer.py script, there is one additional step required to run the analyzer. 129 | 130 | run build_analyzer.py 131 | 132 | ``` 133 | python build_analyzer.py 134 | ``` 135 | 136 | That's it! To debug the analyzer, you need to first tell the Saleae Logic software where to find your newly compiled *.dylib file. 137 | 138 | [How to set the developer directory in the Saleae software to use third party or user created analyzers.](http://support.saleae.com/hc/en-us/articles/208667506) 139 | 140 | ``` 141 | debug/libAnalyzer.dylib 142 | release/libAnalyzer.dylib 143 | ``` 144 | 145 | ### Debugging with GDB on MacOS 146 | 147 | To debug your analyzer, you will need to attach gdb to the Logic application, something like this: 148 | ``` 149 | gdb /Applications/Logic.app/Contents/MacOS/Logic 150 | ``` 151 | And then test setting a breakpoint like this: 152 | ``` 153 | break MyAnalyzer::WorkerThread 154 | ``` 155 | Because your analyzer hasn't been loaded yet, GDB will notify you that it can't find this function, and ask if you want to automatically set this breakpoint if a library with a matching function is loaded in the future. Type y 156 | 157 | Then type run to start the application. Add your custom analyzer and start a simulation. This will trigger the breakpoint. 158 | 159 | 160 | 161 | ### XCode Based Project 162 | 163 | **Note: This section hasn't yet been updated to describe the proper setup using a fork or clone of the new Github repository for the Sample Analyzer. The instructions will still work, but need improvement to work well with the git repository.** 164 | 165 | This section was written using the 1.1.32 Analyzer SDK, Xcode version 7.2.1, and OSX 10.10.5. however it is likely to work with other versions as well. 166 | 167 | - Start Xcode 168 | - Click "Create a new Xcode project" 169 | 170 | ![1](./images/1_-_new_project.png) 171 | 172 | - select "Other" from the left column, and "Empty" from the templates list. 173 | - Click next. 174 | 175 | ![2](./images/2_-_empty_project.png) 176 | 177 | - Enter a name for your Xcode Project. 178 | 179 | ![2.5](./images/2_5_analyzer_name.png) 180 | 181 | - The location should be set to the analyzer SDK folder recently downloaded, "SaleaeAnalyzerSdk-1.1.32". Do not create a new folder, this will be done for you by Xcode. 182 | - Click "Create" 183 | 184 | ![2.75](./images/2_75_-_project_location.png) 185 | 186 | - Back in Finder, copy the file "rename_analyzer.py" and "source" from the downloaded SDK directory into the freshly created folder, which will have the same name as your new analyzer. Shown here the name is "XcodeAnalyzer" 187 | 188 | ![3](./images/3_-_copy_files.png) 189 | 190 | - Open a terminal, and browse to the new project folder in the downloaded SDK folder. 191 | - Run the python script with: 192 | 193 | python rename_analyzer.py 194 | 195 | - first, it will prompt you for the class prefix for all of the source files. All classes and files will be re-named with this prefix. If you type "I2C" the classes and files will be named with "I2CAnalyzer". Please avoid using analyzer in this name, as it will get repeated like this: "I2CAnalyzerAnalyzer" 196 | - Second, it will ask you for the name to display to the user in the "Add Analyzers" menu. This should be the user facing name, and can include spaces. 197 | 198 | ![4](./images/4_-_rename_analyzer_script.png) 199 | 200 | - Next, we need to add a target to the Xcode project. Be sure that the project is selected in the Project Navigator on the left, and then click the menu highlighted below to add a target. 201 | 202 | ![5](./images/5_-_add_target_button.png) 203 | 204 | - This is the target menu. 205 | 206 | ![6](./images/6_-_add_target_menu.png) 207 | 208 | - Select "Framework & Library" under "OS X" in the left column, and select "Library" in the main area. 209 | - Click Next. 210 | 211 | ![7](./images/7_-_library_target.png) 212 | 213 | - Enter a product name, we recommend the the same name as the project, since there will only be one product. 214 | - Under framework, select "None (Plain C/C++ Library) 215 | - For Type, select "Dynamic" 216 | 217 | ![8](./images/8_-_library_settings.png) 218 | 219 | - Next, we need to add the source files. Click File -> Add Files to ""... 220 | - Note: if this is disabled, it is because you do not have the project selected in the Project Navigator. 221 | 222 | ![8.5](./images/8_5_-_add_files_menu.png) 223 | 224 | - Browse to the source folder in the Xcode project folder, and select it. Don't select the contents, be sure to select the folder itself. 225 | - select "Create groups" in the "added folders" section. 226 | - Click Add. 227 | 228 | ![9](./images/9_-_add_files.png) 229 | 230 | - Verify that the files were automatically added to the build phases "Compile Sources" and "Headers". 231 | - Select the project from the Project Navigator if not already selected. 232 | - Click "Build Phases". 233 | - Expand "Compile Sources" and "Headers" 234 | - Under "Headers", also expand "Project". 235 | - Verify that each has 4 files. 236 | 237 | ![9.5](./images/9_5_-_verify_sources_added.png) 238 | 239 | - Click "Build Settings" 240 | - If "Levels" is selected, switch it to "Combined" 241 | 242 | ![10](./images/10_-_build_settings_page.png) 243 | 244 | - Expand the section "Search Paths" 245 | - Locate "Header Search Paths" and edit the value. 246 | - Click the "+" button and enter "../include" in the new entry. 247 | 248 | ![11](./images/11_-_header_includes_search_path.png) 249 | 250 | - Locate "Library Search Paths" in the same section, and edit its value. 251 | - Click the "+" button and enter "../lib" in the new entry. 252 | 253 | ![11.5](./images/11_5_-_add_library_path.png) 254 | 255 | - Return to "Build Phases" and expand the section "Link Binary with Libraries" 256 | - Click the "+" button 257 | 258 | ![12](./images/12_-_add_library_part_1.png) 259 | 260 | - Click "Add Other..." 261 | 262 | ![13](./images/13_-_add_library_part_2.png) 263 | 264 | - Browse to the original SDK folder which contains our Xcode folder. 265 | - Open the "lib" folder 266 | - Select "libAnalyzer.dylib" 267 | - Click Open. 268 | 269 | ![14](./images/14_-_add_library_part_3.png) 270 | 271 | 272 | - At this point, you should build the project, so that the resulting library will be created. 273 | - It's worth mentioning that new Xcode versions do not save build outputs in the project directory. Instead, the default output directory looks like this: 274 | 275 | ~/Library/Developer/Xcode/DerivedData 276 | 277 | - You may want to change it. **The following steps are optional** 278 | 279 | **Optional: change build output folder** 280 | 281 | - Optional step 1: From the file menu, select "Project Settings..." 282 | 283 | ![optional 1](./images/optional_-_project_settings_-_edit_products_folder_menu.png) 284 | 285 | - Optional step 2: in the "Derived Data" dropdown, select "Project-relative Location" 286 | - Click "Done" 287 | 288 | ![optional 2](./images/optional_-_Project_Settings.png) 289 | 290 | - That's it for the optional steps. 291 | 292 | ### Running and Debugging your Analyzer 293 | 294 | - Next we will setup debugging for the project. Be sure to have the latest Saleae Logic Software installed. 295 | - On the Product menu at the top of the screen, select "Scheme" -> "Edit Scheme..." 296 | ![15](./images/15_-_edit_scheme.png) 297 | 298 | - Make sure "Run" is selected on the left. 299 | - Under "Executable" select "Other..." 300 | ![16](./images/16_-_debug_launch_app_menu.png) 301 | 302 | - Browse to the "Applications" folder (or wherever Logic is installed) and select "Logic.app" 303 | - Click Choose. 304 | 305 | ![17](./images/17_-_select_debug_program.png) 306 | 307 | 308 | - Set a breakpoint in the software so that we can test debugging. 309 | - Open "XcodeAnalyzer.cpp" on the left. The name will reflect what you selected as the class prefix in a previous step. In this example, the class prefix was "Xcode". 310 | - In the source file, add a break point to the first line of code in the WorkerThread method. This code runs when the analyzer starts processing data. 311 | 312 | 313 | 314 | ![18](./images/18_-_breakpoint_set.png) 315 | 316 | - Before proceeding, see this article with instructions to configure the software to load your new analyzer: https://trello.com/c/LEFlqhlL 317 | - Be sure to select the folder where the debug version of the custom analyzer is is saved. 318 | 319 | - Once the Saleae logic software has been configured, and has been closed, click run from Xcode. 320 | - The Saleae software should launch a few seconds later. Click the "+" button on the analyzers panel, and then select your analyzer. In this case, the user facing name of the analyzer was set by the Python script to "Xcode Analyzer". Yours may be different. 321 | - If your analyzer is missing, it could indicate that the dylib was not created, or that the developer path was not set properly. Please review the previous steps for any possible errors. 322 | - The settings dialog for your custom analyzer will appear. Click "Save". 323 | 324 | ![19](./images/19_-_logic_software_add_analyzer_menu.png) 325 | 326 | - Here is your fresh new analyzer, now added to the software. Note that our breakpoint hasn't fired yet. If you had captured data previously, it might fire now, since analyzers will automatically start processing if they are added to an existing analyzer. 327 | 328 | ![20](./images/20_-_analyzer_in_Logic.png) 329 | 330 | - Press start to start a simulation. 331 | - Since your analyzer has already been added, the simulator will call your simulation data generator code. The analyzer also starts processing the moment data has been captured, so your breakpoint should fire immediately. 332 | 333 | ![21](./images/21_-_logic_software_start_button.png) 334 | 335 | - Here you can see that the debugger was attached and your break point has been hit. You can examine variables, set new break points, or press continue from the debug menu at the bottom. 336 | 337 | ![22](./images/22_-_breakpoint_hit.png) 338 | 339 | - Congratulations! You now have an Xcode project for which you can use to develop a custom analyzer for the Saleae software. 340 | 341 | If you have any questions, please contact support. -------------------------------------------------------------------------------- /docs/Saleae Analyzer SDK (older).pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/Saleae Analyzer SDK (older).pdf -------------------------------------------------------------------------------- /docs/images/10_-_build_settings_page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/10_-_build_settings_page.png -------------------------------------------------------------------------------- /docs/images/11_-_header_includes_search_path.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/11_-_header_includes_search_path.png -------------------------------------------------------------------------------- /docs/images/11_5_-_add_library_path.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/11_5_-_add_library_path.png -------------------------------------------------------------------------------- /docs/images/12_-_add_library_part_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/12_-_add_library_part_1.png -------------------------------------------------------------------------------- /docs/images/13_-_add_library_part_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/13_-_add_library_part_2.png -------------------------------------------------------------------------------- /docs/images/14_-_add_library_part_3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/14_-_add_library_part_3.png -------------------------------------------------------------------------------- /docs/images/15_-_edit_scheme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/15_-_edit_scheme.png -------------------------------------------------------------------------------- /docs/images/16_-_debug_launch_app_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/16_-_debug_launch_app_menu.png -------------------------------------------------------------------------------- /docs/images/17_-_select_debug_program.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/17_-_select_debug_program.png -------------------------------------------------------------------------------- /docs/images/18_-_breakpoint_set.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/18_-_breakpoint_set.png -------------------------------------------------------------------------------- /docs/images/19_-_logic_software_add_analyzer_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/19_-_logic_software_add_analyzer_menu.png -------------------------------------------------------------------------------- /docs/images/1_-_new_project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/1_-_new_project.png -------------------------------------------------------------------------------- /docs/images/20_-_analyzer_in_Logic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/20_-_analyzer_in_Logic.png -------------------------------------------------------------------------------- /docs/images/21_-_logic_software_start_button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/21_-_logic_software_start_button.png -------------------------------------------------------------------------------- /docs/images/22_-_breakpoint_hit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/22_-_breakpoint_hit.png -------------------------------------------------------------------------------- /docs/images/2_-_empty_project.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/2_-_empty_project.png -------------------------------------------------------------------------------- /docs/images/2_5_analyzer_name.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/2_5_analyzer_name.png -------------------------------------------------------------------------------- /docs/images/2_75_-_project_location.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/2_75_-_project_location.png -------------------------------------------------------------------------------- /docs/images/3_-_copy_files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/3_-_copy_files.png -------------------------------------------------------------------------------- /docs/images/4_-_rename_analyzer_script.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/4_-_rename_analyzer_script.png -------------------------------------------------------------------------------- /docs/images/5_-_add_target_button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/5_-_add_target_button.png -------------------------------------------------------------------------------- /docs/images/6_-_add_target_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/6_-_add_target_menu.png -------------------------------------------------------------------------------- /docs/images/7_-_library_target.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/7_-_library_target.png -------------------------------------------------------------------------------- /docs/images/8_-_library_settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/8_-_library_settings.png -------------------------------------------------------------------------------- /docs/images/8_5_-_add_files_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/8_5_-_add_files_menu.png -------------------------------------------------------------------------------- /docs/images/9_-_add_files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/9_-_add_files.png -------------------------------------------------------------------------------- /docs/images/9_5_-_verify_sources_added.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/9_5_-_verify_sources_added.png -------------------------------------------------------------------------------- /docs/images/optional_-_Project_Settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/optional_-_Project_Settings.png -------------------------------------------------------------------------------- /docs/images/optional_-_project_settings_-_edit_products_folder_menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/optional_-_project_settings_-_edit_products_folder_menu.png -------------------------------------------------------------------------------- /docs/images/sent_analyzer_settings.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/sent_analyzer_settings.PNG -------------------------------------------------------------------------------- /docs/images/sent_simulation_screenshot.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/melexis/SENTAnalyzer/9974aea00edede2942f438260845203ec9c0464e/docs/images/sent_simulation_screenshot.PNG -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # SENT (SAE J2716) Analyzer for Saleae USB logic analyzer 2 | 3 | This plugin allows decoding SENT frames of up to 6 data nibbles and allows exporting the nibble data for further postprocessing 4 | 5 | ## Wishlist: 6 | 7 | - Builtin slow message decoding 8 | - Automatic detection of tick time 9 | - SPC support 10 | - Aggregation of individual nibble data into into FC1/FC2 data --> Loads of different configurations, could get complex 11 | 12 | ## Building the plugin: 13 | 14 | If you're just here to grab the latest copy of the analyzer, the easiest option would be to grab the build artifacts from 15 | the results of the CI pipeline. If you'd like to make modifications or are convinced you can build it better, keep reading: 16 | 17 | ### MacOS 18 | 19 | Dependencies: 20 | - XCode with command line tools 21 | - CMake 3.11+ 22 | 23 | Installing command line tools after XCode is installed: 24 | ``` 25 | xcode-select --install 26 | ``` 27 | 28 | Then open XCode, open Preferences from the main menu, go to locations, and select the only option under 'Command line tools'. 29 | 30 | Installing CMake on MacOS: 31 | 32 | 1. Download the binary distribution for MacOS, `cmake-*-Darwin-x86_64.dmg` 33 | 2. Install the usual way by dragging into applications. 34 | 3. Open a terminal and run the following: 35 | ``` 36 | /Applications/CMake.app/Contents/bin/cmake-gui --install 37 | ``` 38 | *Note: Errors may occur if older versions of CMake are installed.* 39 | 40 | Building the analyzer: 41 | ``` 42 | mkdir build 43 | cd build 44 | cmake .. 45 | cmake --build . 46 | ``` 47 | 48 | ### Ubuntu 16.04 49 | 50 | Dependencies: 51 | - CMake 3.11+ 52 | - gcc 4.8+ 53 | 54 | Misc dependencies: 55 | 56 | ``` 57 | sudo apt-get install build-essential cmake 58 | ``` 59 | 60 | Building the analyzer: 61 | ``` 62 | mkdir build 63 | cd build 64 | cmake .. 65 | cmake --build . 66 | ``` 67 | 68 | ### Windows 69 | 70 | Dependencies: 71 | - Visual Studio 2015 Update 3 72 | - CMake 3.11+ 73 | 74 | **Visual Studio 2015** 75 | 76 | *Note - newer versions of Visual Studio should be fine.* 77 | 78 | Setup options: 79 | - Programming Languages > Visual C++ > select all sub-components. 80 | 81 | Note - if CMake has any problems with the MSVC compiler, it's likely a component is missing. 82 | 83 | **CMake** 84 | 85 | Download and install the latest CMake release here. 86 | https://cmake.org/download/ 87 | 88 | Building the analyzer: 89 | ``` 90 | mkdir build 91 | cd build 92 | cmake .. 93 | ``` 94 | 95 | Then, open the newly created solution file located here: `build\SENT_analyzer.sln` 96 | 97 | ## Installing the plugin: 98 | 99 | Copy the .dll/.so over to the Saleae Logic analyzer folder. You can either copy it to the "Analyzers" folder in the Saleae Logic installation directory, or specify a custom path under "Preferences --> Developer" 100 | 101 | ## Testing the installation: 102 | 103 | When installed, the plugin can be tested (in the absence of an actual SENT signal) by loading the analyzer (it should show up in the list now) and hitting the "Start simulation" button. Note that for this to work, the Saleae Logic analyzer should not be connected to the computer. 104 | 105 | ![sent_simulation_screenshot.PNG](docs/images/sent_simulation_screenshot.PNG "SENT simulation screenshot") 106 | 107 | ## Configuring the plugin: 108 | 109 | The plugin can be configured in a number of ways to support various SENT configurations. 110 | 111 | ![sent_analyzer_settings.PNG](docs/images/sent_analyzer_settings.PNG "Analyzer configuration window") 112 | 113 | - Serial: Used to select which input channel contains the SENT signal 114 | - tick time (half us): The tick time of the SENT signal. Due to some limitations of the saleae plugin framework, decimal numbers are not supported. # 115 | Therefore, the unit used here is "half us", i.e. for a 1.5us tick time the value entered here should be 3 116 | - Pause pulse: Select whether or not the SENT frame contains a pause pulse or not 117 | - Number of data nibbles: Well, the number of data nibbles 118 | - Legacy CRC: Select whether the CRC algorithm used is the legacy algorithm or the newer, more secure one. 119 | 120 | ## Export format: 121 | 122 | The plugin supports exporting the SENT data in csv format for further processing (slow message) or for automation purposes. 123 | 124 | At the moment, the output format looks like this: 125 | 126 | ``` 127 | 0.000656750000000, 0x38, SYNC_PULSE 128 | 0.000740750000000, 0x00, STATUS_NIBBLE 129 | 0.000758750000000, 0x0F, FC_NIBBLE 130 | 0.000799250000000, 0x05, FC_NIBBLE 131 | 0.000824750000000, 0x0A, FC_NIBBLE 132 | 0.000857750000000, 0x02, FC_NIBBLE 133 | 0.000878750000000, 0x08, FC_NIBBLE 134 | 0.000908750000000, 0x00, FC_NIBBLE 135 | 0.000926750000000, 0x09, CRC_NIBBLE 136 | 0.000958250000000, 0x64, PAUSE_PULSE 137 | ------, ------, ----- 138 | 0.001108250000000, 0x38, SYNC_PULSE 139 | 0.001192250000000, 0x00, STATUS_NIBBLE 140 | 0.001210250000000, 0x0F, FC_NIBBLE 141 | 0.001250750000000, 0x05, FC_NIBBLE 142 | 0.001276250000000, 0x0A, FC_NIBBLE 143 | 0.001309250000000, 0x02, FC_NIBBLE 144 | 0.001330250000000, 0x08, FC_NIBBLE 145 | 0.001360250000000, 0x00, FC_NIBBLE 146 | 0.001378250000000, 0x09, CRC_NIBBLE 147 | 0.001409750000000, 0x38, PAUSE_PULSE 148 | ------, ------, ----- 149 | 0.001493750000000, 0x38, SYNC_PULSE 150 | 0.001577750000000, 0x00, STATUS_NIBBLE 151 | 0.001595750000000, 0x0F, FC_NIBBLE 152 | 0.001636250000000, 0x05, FC_NIBBLE 153 | 0.001661750000000, 0x0A, FC_NIBBLE 154 | 0.001694750000000, 0x02, FC_NIBBLE 155 | 0.001715750000000, 0x08, FC_NIBBLE 156 | 0.001745750000000, 0x00, FC_NIBBLE 157 | 0.001763750000000, 0x09, CRC_NIBBLE 158 | 0.001795250000000, 0x64, PAUSE_PULSE 159 | ``` 160 | 161 | Note that more formats will likely be added, as the format shown above does not allow for the fastest data processing. We will likely add a format that groups the 162 | for a single SENT frame on a single line (with a timestamp for the beginning of the SENT message) 163 | -------------------------------------------------------------------------------- /src/SENTAnalyzer.cpp: -------------------------------------------------------------------------------- 1 | #include "SENTAnalyzer.h" 2 | #include "SENTAnalyzerSettings.h" 3 | #include 4 | #include 5 | 6 | #define STATUS_NIBBLE_NUMBER (1) 7 | #define PAUSE_PULSE_NUMBER (crc_nibble_number + 1) 8 | 9 | SENTAnalyzer::SENTAnalyzer() 10 | : Analyzer2(), 11 | mSettings( new SENTAnalyzerSettings() ), 12 | mSimulationInitilized( false ), 13 | nibble_counter(0), 14 | framelist(), 15 | corrected_samples_per_tick(0) 16 | { 17 | SetAnalyzerSettings( mSettings.get() ); 18 | } 19 | 20 | SENTAnalyzer::~SENTAnalyzer() 21 | { 22 | KillThread(); 23 | } 24 | 25 | void SENTAnalyzer::SetupResults() 26 | { 27 | mResults.reset( new SENTAnalyzerResults( this, mSettings.get() ) ); 28 | SetAnalyzerResults( mResults.get() ); 29 | mResults->AddChannelBubblesWillAppearOn( mSettings->mInputChannel ); 30 | crc_nibble_number = STATUS_NIBBLE_NUMBER + mSettings->numberOfDataNibbles + 1; 31 | if (mSettings->pausePulseEnabled) 32 | { 33 | number_of_nibbles = PAUSE_PULSE_NUMBER + 1; 34 | } 35 | else 36 | { 37 | number_of_nibbles = crc_nibble_number + 1; 38 | } 39 | } 40 | 41 | /** Function for calculation the SENT CRC4 42 | * 43 | * @returns U8 the calculated CRC4 on the data of the previous SENT frame. 44 | */ 45 | U8 SENTAnalyzer::CalculateCRC() 46 | { 47 | U8 crc4_table [16] = {0, 13, 7, 10, 14, 3, 9, 4, 1, 12, 6, 11, 15, 2, 8, 5}; 48 | U8 CheckSum16 = 5; 49 | 50 | /* We increment the start pointer by 2 to skip sync and status nibbles. 51 | * In the end condition we decrement the end pointer by 1 to omit the CRC nibble */ 52 | for(std::vector::iterator it = framelist.begin() + 2; it != framelist.end() - (number_of_nibbles - crc_nibble_number); it++) 53 | { 54 | CheckSum16 = it->mData1 ^ crc4_table[CheckSum16]; 55 | } 56 | if(!mSettings->legacyCRC) { 57 | CheckSum16 = 0 ^ crc4_table[CheckSum16]; 58 | } 59 | return CheckSum16; 60 | } 61 | 62 | /** This function will create a new Frame with the data, type and timing info provided and commit it to the current packet 63 | * 64 | * @param [in] data The data to be stored in the frame 65 | * @param [in] type The pulse type (sync, status, fc, ...) 66 | * @param [in] start The sample number of the start of the frame 67 | * @param [in] end The sample number of the end of the frame 68 | */ 69 | void SENTAnalyzer::addSENTPulse(U16 data, enum SENTNibbleType type, U64 start, U64 end) 70 | { 71 | Frame frame; 72 | frame.mData1 = data; 73 | frame.mFlags = 0; 74 | frame.mType = type; 75 | frame.mStartingSampleInclusive = start; 76 | frame.mEndingSampleInclusive = end; 77 | framelist.push_back(frame); 78 | } 79 | 80 | void SENTAnalyzer::addErrorFrame(U16 data, U64 start, U64 end, SENTErrorType error_type) 81 | { 82 | Frame frame; 83 | frame.mData1 = data; 84 | frame.mFlags = DISPLAY_AS_ERROR_FLAG | (1 << error_type); 85 | frame.mType = Error; 86 | frame.mStartingSampleInclusive = start; 87 | frame.mEndingSampleInclusive = end; 88 | 89 | mResults->AddFrame(frame); 90 | mResults->CommitResults(); 91 | ReportProgress(frame.mEndingSampleInclusive); 92 | } 93 | 94 | /** Callback function for detection of sync pulse 95 | * 96 | * This function will do some sanity checks on the data gathered during the 97 | * last SENT frame. It will check 98 | * 99 | * - The amount of nibbles 100 | * - The CRC 101 | * 102 | * If any of these checks fail, the SENT frame is dropped. 103 | */ 104 | void SENTAnalyzer::syncPulseDetected() 105 | { 106 | if(framelist.size() == number_of_nibbles) 107 | { 108 | U8 expected_crc = CalculateCRC(); 109 | bool crc_correct = (framelist.at(crc_nibble_number).mData1 == expected_crc); 110 | for(std::vector::iterator it = framelist.begin(); it != framelist.end(); it++) { 111 | if(!crc_correct && (it->mType == CRCNibble)) { 112 | addErrorFrame(expected_crc, it->mStartingSampleInclusive, it->mEndingSampleInclusive, CrcError); 113 | } else { 114 | mResults->AddFrame( *it ); 115 | mResults->CommitResults(); 116 | ReportProgress( it->mEndingSampleInclusive ); 117 | } 118 | } 119 | mResults->CommitPacketAndStartNewPacket(); 120 | } 121 | else if( framelist.size() > 0 ) 122 | { 123 | addErrorFrame(framelist.size(), framelist.begin()->mStartingSampleInclusive, framelist.begin()->mEndingSampleInclusive, NibbleNumberError); 124 | mResults->CommitPacketAndStartNewPacket(); 125 | } 126 | else /* Framelist is empty. This occurs when the first pulse is already a sync pulse */ 127 | { 128 | mResults->CancelPacketAndStartNewPacket(); 129 | } 130 | framelist.clear(); 131 | } 132 | 133 | /** Function for correcting the tick time 134 | * 135 | * This function should be called whenever a sync pulse is detected (given the specified clock tolerances) 136 | * Then, based on the amount of samples during that period, the amount of samples per tick is recalculated 137 | * by dividing this number by the amount of ticks per sync pulse (56). 138 | * 139 | * @param[in] number_of_samples The amount of samples taken during the sync pulse period 140 | */ 141 | void SENTAnalyzer::correctTickTime(U32 number_of_samples) 142 | { 143 | corrected_samples_per_tick = round(number_of_samples / 56.0); 144 | } 145 | 146 | /** Function for determining if the detected pulse is a sync pulse or not 147 | * 148 | * First, the function checks if the detected pulse is 56 ticks wide. 149 | * This narrows the choice down to 2 options: sync pulse and pause pulse 150 | * (the other pulses are between 12 and 27 ticks wide) 151 | * 152 | * Then, in order to determine whether it's a pause pulse or not, we check 153 | * whether we were expecting a pause pulse to begin with. If so, we take the 154 | * naive approach and assume it's a pause pulse. If not, we say it's a valid 155 | * sync pulse. 156 | * 157 | * @retval true The detected pulse is a sync pulse 158 | * @retval false The detected pulse is not a sync pulse 159 | */ 160 | bool SENTAnalyzer::isPulseSyncPulse(U16 number_of_ticks) 161 | { 162 | bool retval = false; 163 | /* Sync pulse should be 56 ticks. Given a 20% margin, it should fall in range [45:67] */ 164 | if(number_of_ticks >= 45 && number_of_ticks <= 67) 165 | { 166 | if ((mSettings->pausePulseEnabled) && (nibble_counter == PAUSE_PULSE_NUMBER)) 167 | { 168 | retval = false; 169 | } 170 | else 171 | { 172 | retval = true; 173 | } 174 | } 175 | return retval; 176 | } 177 | 178 | /** Main signal processing function 179 | * 180 | * This function will actually attempt to decode the SENT frames. 181 | * When successful, a single SENT frame (sync + status + fc data + crc + pause) 182 | * will be stored as a single Packet containing multiple frames (1 frame per "nibble") 183 | * 184 | * - As the sync and pause pulse don't actually convey any data, the frames for these pulses 185 | * contain the total amount of ticks they consume 186 | * - For status, FC and CRC nibbles, the actual encoded value is stored. This means the 187 | * total amount of ticks minus 12.\ 188 | * 189 | * TODO: Serial messaging 190 | */ 191 | void SENTAnalyzer::WorkerThread() 192 | { 193 | mSampleRateHz = GetSampleRate(); 194 | 195 | /* Based on the configured tick time and the sampling rate, determine the amount of samples per tick */ 196 | U32 theoretical_samples_per_ticks = mSampleRateHz * (mSettings->tick_time_half_us / 2.0) / 1000000; 197 | 198 | /* This is initialized to the theoretical samples per tick, and is adjusted on every 199 | * received sync pulse */ 200 | corrected_samples_per_tick = theoretical_samples_per_ticks; 201 | 202 | /* Request the channel we are using for the analysis */ 203 | mSerial = GetAnalyzerChannelData( mSettings->mInputChannel ); 204 | 205 | /* Advance the "cursor" to the first falling edge */ 206 | if( mSerial->GetBitState() == BIT_LOW ) 207 | mSerial->AdvanceToNextEdge(); 208 | mSerial->AdvanceToNextEdge(); 209 | 210 | U64 starting_sample; 211 | 212 | framelist = std::vector(); 213 | nibble_counter = 0; 214 | 215 | for( ; ; ) 216 | { 217 | enum SENTNibbleType nibble_type = Unknown; 218 | 219 | /* We capture the sample number on the falling edge, for reference */ 220 | starting_sample = mSerial->GetSampleNumber(); 221 | /* Then, we advance 2 edges, so we end up on the next falling edge */ 222 | mSerial->AdvanceToNextEdge(); 223 | mSerial->AdvanceToNextEdge(); 224 | 225 | /* Calculate the number of samples in this period */ 226 | U32 number_of_samples = mSerial->GetSampleNumber() - starting_sample; 227 | /* Now, based on the difference in amount of samples between the current falling edge 228 | and the reference one, we can determine the amount of ticks that have passed */ 229 | U16 theoretical_number_of_ticks = round((float)number_of_samples / theoretical_samples_per_ticks); 230 | U16 corrected_number_of_ticks = round((float)number_of_samples / corrected_samples_per_tick); 231 | 232 | /* Based on the amount of ticks and a nibble counter, we can attempt to determine 233 | what type of pulse was encountered */ 234 | 235 | /* First check if the detected pulse is a sync pulse 236 | As a sync pulse indicates the start of a new SENT frame, the previous 237 | Packet is closed and committed and a new Packet is started. 238 | */ 239 | if(isPulseSyncPulse(theoretical_number_of_ticks)) 240 | { 241 | /* If it's a valid sync pulse, calculate the corrected tick time */ 242 | correctTickTime(number_of_samples); 243 | /* Then close the previous frame and check if it was valid */ 244 | syncPulseDetected(); 245 | nibble_type = SyncPulse; 246 | corrected_number_of_ticks = 56; 247 | nibble_counter = 0; 248 | } 249 | /* Then we check if the nibble counter indicates that we're expecting a pause pulse. 250 | The pause pulse can take a larger range of sizes than any of the other pulse types, 251 | so no sense in checking for the amount of ticks */ 252 | else if (nibble_counter == PAUSE_PULSE_NUMBER) 253 | { 254 | nibble_type = PausePulse; 255 | } 256 | /* If not a pause pulse of sync pulse, it must be a data-carrying nibble. 257 | The size range for these pulses is limited, so we check that first 258 | Then, we check the nibble counter to see which type of nibble is expected */ 259 | else if (corrected_number_of_ticks > 11 && corrected_number_of_ticks < 28) 260 | { 261 | if(nibble_counter == STATUS_NIBBLE_NUMBER) 262 | { 263 | nibble_type = StatusNibble; 264 | /* We extract the actual data by subtracting the number of ticks by 12 */ 265 | corrected_number_of_ticks -= 12; 266 | } 267 | else if (nibble_counter > STATUS_NIBBLE_NUMBER && nibble_counter < crc_nibble_number) 268 | { 269 | nibble_type = FCNibble; 270 | /* We extract the actual data by subtracting the number of ticks by 12 */ 271 | corrected_number_of_ticks -= 12; 272 | } 273 | else if(nibble_counter == crc_nibble_number) 274 | { 275 | nibble_type = CRCNibble; 276 | /* We extract the actual data by subtracting the number of ticks by 12 */ 277 | corrected_number_of_ticks -= 12; 278 | } 279 | } 280 | /* If none of the above conditions are met, the frame is marked as "unknown" */ 281 | else { 282 | nibble_counter = 0; 283 | } /* Do nothing. No valid frame was detected */ 284 | 285 | nibble_counter++; 286 | 287 | /* Commit the frame to the database and to the current packet */ 288 | addSENTPulse(corrected_number_of_ticks, nibble_type, starting_sample + 1, mSerial->GetSampleNumber()); 289 | } 290 | } 291 | 292 | bool SENTAnalyzer::NeedsRerun() 293 | { 294 | return false; 295 | } 296 | 297 | U32 SENTAnalyzer::GenerateSimulationData( U64 minimum_sample_index, U32 device_sample_rate, SimulationChannelDescriptor** simulation_channels ) 298 | { 299 | if( mSimulationInitilized == false ) 300 | { 301 | mSimulationDataGenerator.Initialize( GetSimulationSampleRate(), mSettings.get() ); 302 | mSimulationInitilized = true; 303 | } 304 | 305 | return mSimulationDataGenerator.GenerateSimulationData( minimum_sample_index, device_sample_rate, simulation_channels ); 306 | } 307 | 308 | U32 SENTAnalyzer::GetMinimumSampleRateHz() 309 | { 310 | return 2000000 / (mSettings->tick_time_half_us / 2.0); 311 | } 312 | 313 | const char* SENTAnalyzer::GetAnalyzerName() const 314 | { 315 | return "SENT (SAE J2716)"; 316 | } 317 | 318 | const char* GetAnalyzerName() 319 | { 320 | return "SENT (SAE J2716)"; 321 | } 322 | 323 | Analyzer* CreateAnalyzer() 324 | { 325 | return new SENTAnalyzer(); 326 | } 327 | 328 | void DestroyAnalyzer( Analyzer* analyzer ) 329 | { 330 | delete analyzer; 331 | } -------------------------------------------------------------------------------- /src/SENTAnalyzer.h: -------------------------------------------------------------------------------- 1 | #ifndef SENT_ANALYZER_H 2 | #define SENT_ANALYZER_H 3 | 4 | #include 5 | #include "SENTAnalyzerResults.h" 6 | #include "SENTSimulationDataGenerator.h" 7 | 8 | class SENTAnalyzerSettings; 9 | class ANALYZER_EXPORT SENTAnalyzer : public Analyzer2 10 | { 11 | public: 12 | SENTAnalyzer(); 13 | virtual ~SENTAnalyzer(); 14 | 15 | virtual void SetupResults(); 16 | virtual void WorkerThread(); 17 | 18 | virtual U32 GenerateSimulationData( U64 newest_sample_requested, U32 sample_rate, SimulationChannelDescriptor** simulation_channels ); 19 | virtual U32 GetMinimumSampleRateHz(); 20 | 21 | virtual const char* GetAnalyzerName() const; 22 | virtual bool NeedsRerun(); 23 | 24 | protected: //vars 25 | std::auto_ptr< SENTAnalyzerSettings > mSettings; 26 | std::auto_ptr< SENTAnalyzerResults > mResults; 27 | AnalyzerChannelData* mSerial; 28 | 29 | SENTSimulationDataGenerator mSimulationDataGenerator; 30 | bool mSimulationInitilized; 31 | 32 | //Serial analysis vars: 33 | U32 mSampleRateHz; 34 | U32 mStartOfStopBitOffset; 35 | U32 mEndOfStopBitOffset; 36 | U8 nibble_counter; 37 | U16 crc_nibble_number; 38 | U16 number_of_nibbles; 39 | std::vector framelist; 40 | U32 corrected_samples_per_tick; 41 | 42 | void syncPulseDetected(); 43 | void correctTickTime(U32 number_of_samples); 44 | U8 CalculateCRC(); 45 | bool isPulseSyncPulse(U16 number_of_ticks); 46 | private: 47 | void addSENTPulse(U16 ticks, enum SENTNibbleType type, U64 start, U64 end); 48 | void addErrorFrame(U16 data, U64 start, U64 end, SENTErrorType error_type); 49 | }; 50 | 51 | extern "C" ANALYZER_EXPORT const char* __cdecl GetAnalyzerName(); 52 | extern "C" ANALYZER_EXPORT Analyzer* __cdecl CreateAnalyzer( ); 53 | extern "C" ANALYZER_EXPORT void __cdecl DestroyAnalyzer( Analyzer* analyzer ); 54 | 55 | #endif //SENT_ANALYZER_H 56 | -------------------------------------------------------------------------------- /src/SENTAnalyzerResults.cpp: -------------------------------------------------------------------------------- 1 | #include "SENTAnalyzerResults.h" 2 | #include 3 | #include "SENTAnalyzer.h" 4 | #include "SENTAnalyzerSettings.h" 5 | #include 6 | #include 7 | #include 8 | #include 9 | 10 | std::map TypeMap; 11 | 12 | SENTAnalyzerResults::SENTAnalyzerResults( SENTAnalyzer* analyzer, SENTAnalyzerSettings* settings ) 13 | : AnalyzerResults(), 14 | mSettings( settings ), 15 | mAnalyzer( analyzer ) 16 | { 17 | InitializeTypeMap(); 18 | } 19 | 20 | SENTAnalyzerResults::~SENTAnalyzerResults() 21 | { 22 | } 23 | 24 | void SENTAnalyzerResults::InitializeTypeMap(void) 25 | { 26 | TypeMap[SyncPulse] = "SYNC_PULSE"; 27 | TypeMap[StatusNibble] = "STATUS_NIBBLE"; 28 | TypeMap[FCNibble] = "FC_NIBBLE"; 29 | TypeMap[CRCNibble] = "CRC_NIBBLE"; 30 | TypeMap[PausePulse] = "PAUSE_PULSE"; 31 | TypeMap[Unknown] = "UNKNOWN"; 32 | TypeMap[Error] = "Error"; 33 | } 34 | 35 | std::string SENTAnalyzerResults::FrameToString(Frame frame, DisplayBase display_base) 36 | { 37 | std::string retval = ""; 38 | std::stringstream ss; 39 | char number_str[128]; 40 | switch( frame.mType ) 41 | { 42 | case SyncPulse: 43 | ss << "Sync pulse: "; 44 | break; 45 | case StatusNibble: 46 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 47 | ss << "Status nibble: " << number_str; 48 | break; 49 | case FCNibble: 50 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 51 | ss << "Fast channel data: " << number_str; 52 | break; 53 | case CRCNibble: 54 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 55 | ss << "CRC data: " << number_str; 56 | break; 57 | case PausePulse: 58 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 59 | ss << "Pause pulse length: " << number_str; 60 | break; 61 | case Unknown: 62 | ss << "Unknown"; 63 | break; 64 | case Error: 65 | { 66 | if((frame.mFlags & (1 << NibbleNumberError)) != 0u){ 67 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 68 | ss << "Error. Number of nibbles detected: " << number_str; 69 | } else if((frame.mFlags & (1 << CrcError)) != 0u){ 70 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 4, number_str, 128 ); 71 | ss << "Error. Wrong CRC: expected: " << number_str; 72 | } 73 | break; 74 | } 75 | } 76 | return ss.str(); 77 | } 78 | 79 | void SENTAnalyzerResults::GenerateBubbleText( U64 frame_index, Channel& channel, DisplayBase display_base ) 80 | { 81 | //we only need to pay attention to 'channel' if we're making bubbles for more than one channel (as set by AddChannelBubblesWillAppearOn) 82 | ClearResultStrings(); 83 | Frame frame = GetFrame( frame_index ); 84 | 85 | AddResultString(FrameToString(frame, display_base).c_str()); 86 | } 87 | 88 | void SENTAnalyzerResults::GenerateExportFile( const char* file, DisplayBase display_base, U32 export_type_user_id ) 89 | { 90 | U32 number_of_packets = GetNumPackets(); 91 | U64 trigger_sample = mAnalyzer->GetTriggerSample(); 92 | U32 sample_rate = mAnalyzer->GetSampleRate(); 93 | 94 | std::ofstream file_stream( file, std::ios::out ); 95 | 96 | file_stream << "Time [s],Value" << std::endl; 97 | 98 | for( U32 i=0; i < number_of_packets; i++ ) 99 | { 100 | U64 frameid; 101 | U64 frameid_end; 102 | 103 | GetFramesContainedInPacket(i, &frameid, &frameid_end); 104 | 105 | while (frameid <= frameid_end) 106 | { 107 | Frame frame = GetFrame(frameid); 108 | char time_str[128]; 109 | AnalyzerHelpers::GetTimeString( frame.mStartingSampleInclusive, trigger_sample, sample_rate, time_str, 128 ); 110 | 111 | char number_str[128]; 112 | AnalyzerHelpers::GetNumberString( frame.mData1, display_base, 8, number_str, 128 ); 113 | 114 | file_stream << time_str << ", " << number_str << ", " << TypeMap[(enum SENTNibbleType)frame.mType] << std::endl; 115 | 116 | frameid++; 117 | } 118 | 119 | if( UpdateExportProgressAndCheckForCancel( i, number_of_packets ) == true ) 120 | { 121 | file_stream.close(); 122 | return; 123 | } 124 | file_stream << "------, ------, -----" << std::endl; 125 | } 126 | 127 | file_stream.close(); 128 | } 129 | 130 | void SENTAnalyzerResults::GenerateFrameTabularText( U64 frame_index, DisplayBase display_base ) 131 | { 132 | ClearTabularText(); 133 | 134 | Frame frame = GetFrame( frame_index ); 135 | 136 | AddTabularText(FrameToString(frame, display_base).c_str()); 137 | } 138 | 139 | void SENTAnalyzerResults::GeneratePacketTabularText( U64 packet_id, DisplayBase display_base ) 140 | { 141 | //not supported 142 | 143 | } 144 | 145 | void SENTAnalyzerResults::GenerateTransactionTabularText( U64 transaction_id, DisplayBase display_base ) 146 | { 147 | //not supported 148 | } -------------------------------------------------------------------------------- /src/SENTAnalyzerResults.h: -------------------------------------------------------------------------------- 1 | #ifndef SENT_ANALYZER_RESULTS 2 | #define SENT_ANALYZER_RESULTS 3 | 4 | #include 5 | 6 | class SENTAnalyzer; 7 | class SENTAnalyzerSettings; 8 | 9 | enum SENTNibbleType { SyncPulse, StatusNibble, FCNibble, CRCNibble, PausePulse, Unknown, Error}; 10 | enum SENTErrorType { NibbleNumberError, CrcError}; 11 | 12 | class SENTAnalyzerResults : public AnalyzerResults 13 | { 14 | public: 15 | SENTAnalyzerResults( SENTAnalyzer* analyzer, SENTAnalyzerSettings* settings ); 16 | virtual ~SENTAnalyzerResults(); 17 | 18 | virtual void GenerateBubbleText( U64 frame_index, Channel& channel, DisplayBase display_base ); 19 | virtual void GenerateExportFile( const char* file, DisplayBase display_base, U32 export_type_user_id ); 20 | 21 | virtual void GenerateFrameTabularText(U64 frame_index, DisplayBase display_base ); 22 | virtual void GeneratePacketTabularText( U64 packet_id, DisplayBase display_base ); 23 | virtual void GenerateTransactionTabularText( U64 transaction_id, DisplayBase display_base ); 24 | 25 | protected: //functions 26 | 27 | protected: //vars 28 | SENTAnalyzerSettings* mSettings; 29 | SENTAnalyzer* mAnalyzer; 30 | std::string FrameToString(Frame frame, DisplayBase display_base); 31 | void InitializeTypeMap(void); 32 | }; 33 | 34 | #endif //SENT_ANALYZER_RESULTS 35 | -------------------------------------------------------------------------------- /src/SENTAnalyzerSettings.cpp: -------------------------------------------------------------------------------- 1 | #include "SENTAnalyzerSettings.h" 2 | #include 3 | 4 | 5 | SENTAnalyzerSettings::SENTAnalyzerSettings() 6 | : mInputChannel( UNDEFINED_CHANNEL ), 7 | tick_time_half_us(3), 8 | pausePulseEnabled(true), 9 | legacyCRC(false), 10 | numberOfDataNibbles(6) 11 | { 12 | mInputChannelInterface.reset( new AnalyzerSettingInterfaceChannel() ); 13 | mInputChannelInterface->SetTitleAndTooltip( "Serial", "Standard SENT (SAE J2716)" ); 14 | mInputChannelInterface->SetChannel( mInputChannel ); 15 | 16 | tickTimeInterface.reset( new AnalyzerSettingInterfaceInteger() ); 17 | tickTimeInterface->SetTitleAndTooltip( "tick time (half us)", "Specify the SENT tick time in half microseconds" ); 18 | tickTimeInterface->SetMax( 100 ); 19 | tickTimeInterface->SetMin( 1); 20 | tickTimeInterface->SetInteger( tick_time_half_us ); 21 | 22 | pausePulseInterface.reset( new AnalyzerSettingInterfaceBool() ); 23 | pausePulseInterface->SetTitleAndTooltip( "Pause pulse", "Specify whether pause pulse is enabled or not" ); 24 | pausePulseInterface->SetValue(pausePulseEnabled); 25 | 26 | dataNibblesInterface.reset( new AnalyzerSettingInterfaceInteger() ); 27 | dataNibblesInterface->SetTitleAndTooltip( "Number of data nibbles", "Specify the total number of fast channel data nibbles" ); 28 | dataNibblesInterface->SetMax( 6 ); 29 | dataNibblesInterface->SetMin( 0); 30 | dataNibblesInterface->SetInteger( numberOfDataNibbles ); 31 | 32 | legacyCRCInterface.reset( new AnalyzerSettingInterfaceBool() ); 33 | legacyCRCInterface->SetTitleAndTooltip( "Legacy CRC", "Specify whether the legacy crc calculation should be used or not" ); 34 | legacyCRCInterface->SetValue(legacyCRC); 35 | 36 | AddInterface( mInputChannelInterface.get() ); 37 | AddInterface( tickTimeInterface.get() ); 38 | AddInterface( pausePulseInterface.get() ); 39 | AddInterface( dataNibblesInterface.get() ); 40 | AddInterface( legacyCRCInterface.get() ); 41 | 42 | AddExportOption( 0, "Export as text/csv file" ); 43 | AddExportExtension( 0, "text", "txt" ); 44 | AddExportExtension( 0, "csv", "csv" ); 45 | 46 | ClearChannels(); 47 | AddChannel( mInputChannel, "Serial", false ); 48 | } 49 | 50 | SENTAnalyzerSettings::~SENTAnalyzerSettings() 51 | { 52 | } 53 | 54 | bool SENTAnalyzerSettings::SetSettingsFromInterfaces() 55 | { 56 | mInputChannel = mInputChannelInterface->GetChannel(); 57 | tick_time_half_us = tickTimeInterface->GetInteger(); 58 | pausePulseEnabled = pausePulseInterface->GetValue(); 59 | numberOfDataNibbles = dataNibblesInterface->GetInteger(); 60 | legacyCRC = legacyCRCInterface->GetValue(); 61 | 62 | ClearChannels(); 63 | AddChannel( mInputChannel, "SENT (SAE J2716)", true ); 64 | 65 | return true; 66 | } 67 | 68 | void SENTAnalyzerSettings::UpdateInterfacesFromSettings() 69 | { 70 | mInputChannelInterface->SetChannel(mInputChannel); 71 | tickTimeInterface->SetInteger(tick_time_half_us); 72 | pausePulseInterface->SetValue(pausePulseEnabled); 73 | dataNibblesInterface->SetInteger(numberOfDataNibbles); 74 | legacyCRCInterface->SetValue(legacyCRC); 75 | } 76 | 77 | void SENTAnalyzerSettings::LoadSettings( const char* settings ) 78 | { 79 | SimpleArchive text_archive; 80 | text_archive.SetString( settings ); 81 | 82 | text_archive >> mInputChannel; 83 | text_archive >> tick_time_half_us; 84 | text_archive >> pausePulseEnabled; 85 | text_archive >> numberOfDataNibbles; 86 | text_archive >> legacyCRC; 87 | 88 | ClearChannels(); 89 | AddChannel( mInputChannel, "SENT (SAE J2716)", true ); 90 | 91 | UpdateInterfacesFromSettings(); 92 | } 93 | 94 | const char* SENTAnalyzerSettings::SaveSettings() 95 | { 96 | SimpleArchive text_archive; 97 | 98 | text_archive << mInputChannel; 99 | text_archive << tick_time_half_us; 100 | text_archive << pausePulseEnabled; 101 | text_archive << numberOfDataNibbles; 102 | text_archive << legacyCRC; 103 | 104 | return SetReturnString( text_archive.GetString() ); 105 | } 106 | -------------------------------------------------------------------------------- /src/SENTAnalyzerSettings.h: -------------------------------------------------------------------------------- 1 | #ifndef SENT_ANALYZER_SETTINGS 2 | #define SENT_ANALYZER_SETTINGS 3 | 4 | #include 5 | #include 6 | 7 | class SENTAnalyzerSettings : public AnalyzerSettings 8 | { 9 | public: 10 | SENTAnalyzerSettings(); 11 | virtual ~SENTAnalyzerSettings(); 12 | 13 | virtual bool SetSettingsFromInterfaces(); 14 | void UpdateInterfacesFromSettings(); 15 | virtual void LoadSettings( const char* settings ); 16 | virtual const char* SaveSettings(); 17 | 18 | 19 | Channel mInputChannel; 20 | U32 tick_time_half_us; 21 | bool pausePulseEnabled; 22 | U32 numberOfDataNibbles; 23 | bool legacyCRC; 24 | 25 | protected: 26 | std::auto_ptr< AnalyzerSettingInterfaceChannel > mInputChannelInterface; 27 | std::auto_ptr< AnalyzerSettingInterfaceInteger > tickTimeInterface; 28 | std::auto_ptr< AnalyzerSettingInterfaceBool > pausePulseInterface; 29 | std::auto_ptr< AnalyzerSettingInterfaceInteger > dataNibblesInterface; 30 | std::auto_ptr< AnalyzerSettingInterfaceBool > legacyCRCInterface; 31 | }; 32 | 33 | #endif //SENT_ANALYZER_SETTINGS 34 | -------------------------------------------------------------------------------- /src/SENTSimulationDataGenerator.cpp: -------------------------------------------------------------------------------- 1 | #include "SENTSimulationDataGenerator.h" 2 | #include "SENTAnalyzerSettings.h" 3 | 4 | #include 5 | 6 | int fc_data [6] = {27, 17, 22, 14, 20, 12}; 7 | 8 | SENTSimulationDataGenerator::SENTSimulationDataGenerator() 9 | { 10 | } 11 | 12 | SENTSimulationDataGenerator::~SENTSimulationDataGenerator() 13 | { 14 | } 15 | 16 | void SENTSimulationDataGenerator::Initialize( U32 simulation_sample_rate, SENTAnalyzerSettings* settings ) 17 | { 18 | mSimulationSampleRateHz = simulation_sample_rate; 19 | mSettings = settings; 20 | 21 | mSerialSimulationData.SetChannel( settings->mInputChannel ); 22 | mSerialSimulationData.SetSampleRate( simulation_sample_rate ); 23 | mSerialSimulationData.SetInitialBitState( BIT_HIGH ); 24 | } 25 | 26 | U32 SENTSimulationDataGenerator::GenerateSimulationData( U64 largest_sample_requested, U32 sample_rate, SimulationChannelDescriptor** simulation_channel ) 27 | { 28 | U64 adjusted_largest_sample_requested = AnalyzerHelpers::AdjustSimulationTargetSample( largest_sample_requested, sample_rate, mSimulationSampleRateHz ); 29 | 30 | while( mSerialSimulationData.GetCurrentSampleNumber() < adjusted_largest_sample_requested ) 31 | { 32 | CreateSerialByte(); 33 | } 34 | 35 | *simulation_channel = &mSerialSimulationData; 36 | return 1; 37 | } 38 | 39 | void SENTSimulationDataGenerator::AddNibble(U16 number_of_ticks, U16 samples_per_tick) 40 | { 41 | U16 number_of_high_ticks = number_of_ticks - 5; 42 | mSerialSimulationData.Transition(); 43 | mSerialSimulationData.Advance( samples_per_tick * 5); 44 | mSerialSimulationData.Transition(); 45 | mSerialSimulationData.Advance( samples_per_tick * number_of_high_ticks); 46 | } 47 | 48 | void SENTSimulationDataGenerator::CreateSerialByte() 49 | { 50 | U32 samples_per_tick = mSimulationSampleRateHz * ((float)mSettings->tick_time_half_us / 2.0) / 1000000; 51 | 52 | if ( mSettings->pausePulseEnabled ) 53 | { 54 | /* First, a normal SENT frame */ 55 | 56 | /* Calibration pulse */ 57 | AddNibble(56, samples_per_tick); 58 | /* Status nibble */ 59 | AddNibble(12, samples_per_tick); 60 | /* Fast channel nibbles */ 61 | for (U8 counter = 0; counter < mSettings->numberOfDataNibbles; counter++) { 62 | AddNibble(fc_data[counter], samples_per_tick); 63 | } 64 | /* CRC */ 65 | AddNibble(21, samples_per_tick); 66 | /* Pause pulse */ 67 | AddNibble(100, samples_per_tick); 68 | 69 | /* Then, another valid SENT frame, but with a pause pulse the size of a sync pulse. Muhahahahaa */ 70 | 71 | /* Calibration pulse */ 72 | AddNibble(56, samples_per_tick); 73 | /* Status nibble */ 74 | AddNibble(12, samples_per_tick); 75 | /* Fast channel nibbles */ 76 | for (U8 counter = 0; counter < mSettings->numberOfDataNibbles; counter++) { 77 | AddNibble(fc_data[counter], samples_per_tick); 78 | } 79 | /* CRC */ 80 | AddNibble(21, samples_per_tick); 81 | /* Pause pulse */ 82 | AddNibble(56, samples_per_tick); 83 | } 84 | else 85 | { 86 | /* Then, a valid SENT frame without a pause pulse at the end. 87 | /* Calibration pulse */ 88 | AddNibble(56, samples_per_tick); 89 | /* Status nibble */ 90 | AddNibble(12, samples_per_tick); 91 | /* Fast channel nibbles */ 92 | for (U8 counter = 0; counter < mSettings->numberOfDataNibbles; counter++) { 93 | AddNibble(fc_data[counter], samples_per_tick); 94 | } 95 | /* CRC */ 96 | AddNibble(21, samples_per_tick); 97 | // /* Pause pulse */ 98 | // AddNibble(100, samples_per_tick); 99 | } 100 | } 101 | 102 | 103 | -------------------------------------------------------------------------------- /src/SENTSimulationDataGenerator.h: -------------------------------------------------------------------------------- 1 | #ifndef SENT_SIMULATION_DATA_GENERATOR 2 | #define SENT_SIMULATION_DATA_GENERATOR 3 | 4 | #include 5 | #include 6 | class SENTAnalyzerSettings; 7 | 8 | class SENTSimulationDataGenerator 9 | { 10 | public: 11 | SENTSimulationDataGenerator(); 12 | ~SENTSimulationDataGenerator(); 13 | 14 | void Initialize( U32 simulation_sample_rate, SENTAnalyzerSettings* settings ); 15 | U32 GenerateSimulationData( U64 newest_sample_requested, U32 sample_rate, SimulationChannelDescriptor** simulation_channel ); 16 | 17 | protected: 18 | SENTAnalyzerSettings* mSettings; 19 | U32 mSimulationSampleRateHz; 20 | 21 | protected: 22 | void CreateSerialByte(); 23 | void AddNibble(U16 number_of_ticks, U16 samples_per_tick); 24 | 25 | SimulationChannelDescriptor mSerialSimulationData; 26 | 27 | }; 28 | #endif //SENT_SIMULATION_DATA_GENERATOR --------------------------------------------------------------------------------