Skip to main content

Official core data types and serialization utilities package for the Telekinesis SDK and APIs.

Project description

GitHub  •  LinkedIn  •  X  •  Discord

Telekinesis Datatypes

Telekinesis Datatypes is a core library providing canonical, strongly typed data structures for robotics and computer vision applications within the Telekinesis ecosystem.

Features

It includes:

  • 3D data types: point clouds, meshes, transforms, and geometric primitives
  • 2D data types: images, bounding boxes, masks, and pixel-space geometry
  • Standardized representations for common perception and geometry formats
  • Efficient serialization and deserialization for reliable data exchange

Requirements

Current support for Python versions - 3.11, 3.12.

Note

  • Telekinesis Datatypes is currently in its early development phase (pre-1.0).
  • There will be continuous version updates which introduces new datatypes and optimization. To have the latest features, please always install or upgrade to the latest version of the package.

Installation

  1. Create an isolated environment so that there is no dependency conflicts. We recommend installing Miniconda environment by following instructions from here.

  2. Create a new conda environment called telekinesis-datatypes:

    conda create -n telekinesis-datatypes python=3.11
    
  3. Activate the environment:

    conda activate telekinesis-datatypes
    
  4. Install the core SDK using pip:

    pip install telekinesis-datatypes
    

    Note: The Python module is called datatypes, while the package published on PyPI is telekinesis-datatypes.

Example

Run a sample python code to quickly test your installation.

  1. Create a Python file named datatypes_example.py in a directory of your choice in your system, and copy paste the below:

    import numpy as np
    from datatypes import datatypes
    
    # Create Rgba32 colors for R, G, B
    red = datatypes.Rgba32([255, 0, 0, 255])
    green = datatypes.Rgba32([0, 255, 0, 255])
    blue = datatypes.Rgba32([0, 0, 255, 255])
    
    print(f"Red color (packed uint32): {red.rgba}")
    print(f"Green color (packed uint32): {green.rgba}")
    print(f"Blue color (packed uint32): {blue.rgba}")
    
    # Use __int__() to convert to integer
    red_int = int(red)
    
    print(f"Red as int: {red_int}")
    print(f"Direct comparison: int(red) == red.rgba: {red_int == red.rgba}" )
    
  2. On a terminal, navigate to the directory where the above file named datatypes_example.py has been created, run the below command:

    python datatypes_example.py
    

    Expected output:

    Red color (packed uint32): 4278190335
    Green color (packed uint32): 16711935
    Blue color (packed uint32): 65535
    Red as int: 4278190335
    Direct comparison: int(red) == red.rgba: True
    

You are now set up with Telekinesis Datatypes.

Resources

Support

For issues and questions:

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

telekinesis_datatypes-0.2.4.tar.gz (51.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telekinesis_datatypes-0.2.4-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

Details for the file telekinesis_datatypes-0.2.4.tar.gz.

File metadata

  • Download URL: telekinesis_datatypes-0.2.4.tar.gz
  • Upload date:
  • Size: 51.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for telekinesis_datatypes-0.2.4.tar.gz
Algorithm Hash digest
SHA256 afd5e554b8898f5d6e31e3be56d8ad5ff1568c06cc57af6c9addc3453a80077b
MD5 06253ded06efd4661dfb85abbe169d5b
BLAKE2b-256 688b48eb526092df893ea42eee99d5bfd5d1752fc4b6226fecac998047b80983

See more details on using hashes here.

File details

Details for the file telekinesis_datatypes-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for telekinesis_datatypes-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7045e2ed13de064c968da32c0250a4ddf065906b18595ec3103ec30883feb3b
MD5 eba176b1b7d0412af031d8cd6a50374a
BLAKE2b-256 53928e2dc5fec99eb83d2bf1304e8d7d63009c7fad5cee550b6d9243ef038de8

See more details on using hashes here.

Supported by

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