Capture for developers
HEAT Capture is the Windows application that records data from simulators, sensors and wearables and streams it to HEAT. This section documents its interfaces. It is for people who build a simulator integration, or who author a session template that reads captured data.
Capture sends its data to the HEAT v2 API as Protocol Buffers messages. The message types are defined by HEAT ProtoLib. A session template reads them with the capture node templates described in Capture session templates.
Installing, configuring and operating Capture is an operator task. Those pages, and one section for each capture module, are under HEAT Capture in the Administrators tab.
Sections
| Section | Read it to |
|---|---|
| HEAT Capture interfaces | Learn the interface control document of the Capture application and its local web API |
| Capture plugins | Publish frames to Capture from inside a simulator such as MACE, Unreal Engine or VBS4 |
| HEAT ProtoLib | Find the schemas, the message reference and the published language packages of the simulation data model |
| Data dictionary | Look up a captured field |
| ICD conventions | Read an interface control document |
Each capture module also has a data page and an interface control document. They sit beside the module’s operator pages, under Capture modules.
To bring a new simulator or sensor into HEAT, start with Connecting a simulator or sensor. It compares every path, including a custom publisher built on ProtoLib.
Source of these pages
The pages in this section are maintained by the HEAT Capture team in their own repository and brought into this site by a build step. They follow that team’s writing conventions, so their layout differs slightly from the rest of the HEAT documentation.
Related
- HEAT Capture for operators
- Capture session templates
- APIs