The TelemetryJet CLI, jet, is a command-line tool for defining, monitoring, and controlling embedded telemetry systems.
It's part of the TelemetryJet platform, which makes it easier to collect, analyze and share data from hardware systems.
Use jet to stream data between a number of data sources, including serial devices, files, and the TelemetryJet server. Jet uses declarative configuration: You specify your data sources in JSON configuration files, and jet handles the details of streaming data between the sources.
Jet is an extremely versatile tool. Here are some examples of how you can use it:
Stream data to a CSV file: Use jet to stream hardware telemetry data straight into a CSV file, without any programming required.
Stream data to a TelemetryJet Server: Stream data to a TelemetryJet Server, and build live dashboards and visualizations that are viewable from anywhere.
Network multiple microcontrollers: Use a Raspberry Pi as a central telemetry hub, building a network of microcontrollers which can communicate with each other bidirectionally.
Monitor existing embedded platforms: Subscribe to data from ROS or other standard platforms and stream into a TelemetryJet Server.
Set up declarative configuration for embedded devices: Define throttle curves, PID control terms, or other parameters centrally, and distribute new values without requiring code changes.
Jet is available on a variety of Linux platforms, macOS and Windows 10. The CLI is distributed using platform-specific methods; see the platform-specific pages on the TelemetryJet Documentation for individual instructions.
The CLI binaries are also available as static files for manual installation from the TelemetryJet Download Server.
Jet uses declarative configuration: You specify the data source settings in a JSON file, and jet builds a network that connects all data sources in a file together.
To stream data, use the jet stream command. The command takes one or more JSON files as inputs:
jet stream device.json # One configuration
jet stream device1.json device2.json # Multiple configurations
jet stream devices/*.json # All JSON files in a folder
You can specify JSON files with relative paths, absolute paths, or Glob syntax to select files using a pattern.
Jet is completely stateless -- All the configuration is set using the files and parameters you pass to the program. This means you can put your configuration in a git repository, flash drive, or other sharing mechanism.
A configuration file defines a network of multiple data sources. All the data sources in a file can communicate with each other bidirectionally. Some data sources only transmit data, others only receive data, and many do both. For more details about which data sources transmit and receive data, see the Data Source Types on the TelemetryJet Documentation site.
A configuration file contains an array of data source definitions:
[
{
"id": "arduino1",
"type": "<data source type>",
"options": {
<options for the data source>
}
},
{
"id": "arduino2",
"type": "<data source type>",
"options": {
<options for the data source>
}
}
]
Jet can interface with many data source types, including files, serial devices, and software protocols.
| Type | Read/Write/Both | Description |
|---|---|---|
| console | Write | Write data to the console output. |
| key-value-file | Write | Write data into a text file in Key-Value (key=value) format. |
| key-value-serial | Both | Read and write data as Key-Value lines over a serial stream. |
See the Data Source Types for a full list and individual guides.
This list will expand over time. We're currently working on core data source types, including CSV files and streams. Need a data source type that is not listed? Open an Issue on the CLI Github suggesting it should be officially supported.