Automating it#
Course step 9 of 9 · about 10 minutes
If you are used to scripting your analysis, you can do the same here. ATLAS has several APIs, each for a different job. The important decision is which one, and the table below makes it for you.
Which API?#
| I want to… | Use | Notes |
|---|---|---|
| Read, write or search session data from my own code | SQL Race API | The most direct and performant route to the data. Works with SQL Race databases, SSN2 and SSN files. C# on .NET. |
| Drive Viewer itself: load sessions, build workbooks, set display properties | Automation API | Controls the running application. Also provides data access, though SQL Race is more direct. |
| Add a new kind of display to Viewer | Display API | Plug-ins that run natively inside Viewer. |
| Read or publish live data on a broker | Stream API and Support Library | Open Streaming. The Support Library wraps the Stream API and is recommended for most services. |
| Configure ECUs from code | Configuration API | Cross-platform gRPC interface. |
| Connect to my own database | RTA | Write a data adapter, and ATLAS can read your existing store. |
If you are not sure between SQL Race API and Automation API, ask: do I need to control Viewer? If not, use the SQL Race API.
Common jobs#
"I want my analysis in MATLAB"#
Two routes. Export sessions from Viewer with the Export Manager (MATLAB 1D and 2D formats), or write MATLAB or C# functions that Viewer runs directly, so results appear as parameters. See Channels and calculated parameters.
"I want to batch-process many sessions"#
Use the SQL Race API to search for sessions, read their data and laps, and calculate statistics. The SQL Race code samples include searching and loading sessions, reading and writing data, and calculating lap statistics.
"I want to bring my own data in"#
Use the SQL Race API to read your files and create sessions, then open them in Viewer like any other. See Getting your data in.
"I want to automate Viewer"#
Use the Automation API to load sessions, generate workbooks and set display and parameter properties. See the code samples.
"I want to mark regions of interest automatically"#
Add markers from code with the SQL Race API, for example from a script that finds events. They show up on the Timeline in Viewer.
Where to go next#
- Developer Resources: all the API areas in one place.
- NuGet packages: how to get the libraries.
- Developer community: community examples and projects.
You have finished the course#
You now know the vocabulary, the model, and how to find your way around. For anything specific, use search, or go to the section you need from the navigation:
- Viewer user guide for every display, option and shortcut.
- Glossary for any term that is still unfamiliar.
- Choosing components for decisions about storage, distribution and calculation.