SDK Device Templates
Jan 1 2022 at 12:00 AM
The Raptor™ SDK comes with a number of useful device driver templates. These templates can be used to rapidly generate a barebones microservice with all the boilerplate code required to get telemetry into the Raptor™ in as little time as possible. The various templates are designed to address common use-cases.
Driver Characteristics
Depending on the device driver template, the following characteristics will be present.
| Charactestic | Description |
|---|---|
| Pull device | The device driver initiates communication with the device |
| Push device | The device initiates communication with the driver |
| Runs on Schedule | Executes periodically rather than maintaining a stateful connection |
| Configured Property Mappings | Properties are defined through configuration |
| One External Telemetry Source per Device | One-two-one relationship between configuration and physical device |
| Meta requests sent automatically | Registration is done on startup using the configured properties |
| Telemetry requests sent automatically | Telemetry is sent automatically with each scheduled execution |
| Multiple External Telemetry Sources per Device | Multiple physical devices connect to the same device interface |
| Meta requests sent manually | Developer responsible for updating device registrations as needed |
| Telemetry requests sent manually | Developer responsible for creating and sending telemetry information |
Choosing the correct template
Choosing the correct template is the first step to creating a new device driver. The exact template that is best suited to your use case is influenced by several factors including:
- The communication direction (inbound vs outbound)
- The number of telemetry sources
- How registration and authorisation should be handled
Available templates
At present, the following templates are available.
More detailed information for each device template is provided on each template’s page.