Skip to main content

Open source package for extracting and parsing telemetry associated with video streams and converting to common formats.

Project description

Open Telemetry Kit

Image of Open Telemetry Kit

The Open Telemetry Kit (OTK) is an open source package for extracting and parsing telemetry associated with video streams and converting to common formats. It comes out of a need for a singular API that can be used for multiple different video telemetry formats.

Telemetry that can be parsed includes: GPS, time, camera information, speed

Features:

  • Automatically detect telemetry format
  • Manipulate telemetry with ease
  • Write telemetry to a new format

Getting Started

Dependencies

Python version: >=3.6

ffmpeg and ffprobe.

On Debian systems these can be installed with:

$ sudo apt install ffmpeg

dateutil

On Debian systems this can be installed with:

$ pip3 install python-dateutil

Installation

$ pip3 install open-telemetry-kit

Importing

The OTK package can be imported into your python3 project with:

import open_telemetry_kit as otk

Quick Start

Download the OTK Quickstart package with sample data

Download the OTK quickstart package (~90 MB). (Mac users can install wget using these instructions)

$ wget https://hivemapper-sample-videos.s3-us-west-2.amazonaws.com/OTK/OTK_quickstart.tgz

This includes a sample .csv, .srt, and .mov with embedded telemetry. It also contains quickstart.py which you can use to extract the telemetry from the sample files.

Extract the package:

$ tar xzvf OTK_quickstart.tgz

This will extract everything into a new directory called OTK_quickstart/

The quickstart.py script accepts a standalone .csv or .srt or a video file with an embedded .srt. It will read in the data, convert it to JSON, and write it to the provided destination.

Telemetry extraction and conversion example

In your terminal go to the new OTK_quickstart directory.

Extract telemetry from the sample video:

$ python3 quickstart.py embedded_srt_example.mov embedded_srt_example.json

Extract telemetry from the sample srt or csv files respectively:

$ python3 quickstart.py srt_example.srt srt_example.json

$ python3 quickstart.py csv_example.csv csv_example.json

Note: This process will create a new JSON file containing the telemetry extracted from the sample file. The data is organized into an array of objects (or, in python terminology, a list of dictionaries)

Data manipulation example

For an example of simple data manipulation, open quickstart.py and uncomment the lines:

# gps = Telemetry()
# for packet in telemetry:
#   gps.append({ k:v for k, v in packet.items() if k in ['latitude', 'longitude', 'altitude']})

# write.telemetryToJson(gps, dest)

Rerun the script with one of the provided commands above.

Current Functionality

Input Formats

The OTK currently supports the following forms of telemetry:

  • .csv files
  • .srt files
  • Most videos file with embedded telemetry encoded as a .srt (e.g. video taken with some DJI drone models)
  • .gpx files
  • .kml files
  • KLV/MISB embedded data
  • Open Camera .srt

Output Formats

  • JSON
  • CSV

Future Releases

Planned expansions and updates for the OTK include:

Input Formats

Output Formats

  • geoJSON

Other

  • Unit Tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_telemetry_kit-0.2.6.4.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

open_telemetry_kit-0.2.6.4-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file open_telemetry_kit-0.2.6.4.tar.gz.

File metadata

  • Download URL: open_telemetry_kit-0.2.6.4.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for open_telemetry_kit-0.2.6.4.tar.gz
Algorithm Hash digest
SHA256 57d0ffc074a76c08934e114e3af9b542b4d1e6dab216f150bd07c2c3974afcbb
MD5 7373d7bb80a602ff876ac8442006f736
BLAKE2b-256 2109d6d904a117bce649fd709bec4688cb81046b4db3438331d22ac8271f8dac

See more details on using hashes here.

File details

Details for the file open_telemetry_kit-0.2.6.4-py3-none-any.whl.

File metadata

  • Download URL: open_telemetry_kit-0.2.6.4-py3-none-any.whl
  • Upload date:
  • Size: 34.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for open_telemetry_kit-0.2.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 245ad009bac4d9ecc8bcd900609f99bbef14f8be99d9bf8d611f628ce34774c3
MD5 0e188baab34d24e2c19905c3a34b7d98
BLAKE2b-256 33c478062d8d81ec81297721ccb43139d7d6305ae3f00e0b619709c387899c6e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page