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 within the Telekinesis ecosystem. 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

This library is used internally by the Telekinesis SDK as the foundation for data exchange across perception, planning, and learning components.

Telekinesis Datatypes is currently in its early development phase (pre-1.0). There will be continuous minor version updates that may introduce new data models and improvements. To ensure compatibility and 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 datatypes:

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

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

    We currently support Python versions - 3.11, 3.12. Ensure your environment is in the specified Python version.

    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.2.tar.gz (53.0 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.2-py3-none-any.whl (52.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: telekinesis_datatypes-0.2.2.tar.gz
  • Upload date:
  • Size: 53.0 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.2.tar.gz
Algorithm Hash digest
SHA256 1675912ea2efb00a10f6325f311abaffddd70fea808182710cf06fa8d441ca5e
MD5 be311e03359a62b1bba8d155699cd915
BLAKE2b-256 949aa73e421013444fa1e581d86b30c7229dbe2ebea56ed3ad7157f4e1f92c88

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for telekinesis_datatypes-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b859c3a8040737ee005377b3429f5cfe4e78e1168d0b4505ebb4b9ab72bcd854
MD5 14efc2634e7e78e7357670310d2d9b7c
BLAKE2b-256 dc9f34d8073ee7a6d38be9a9e81e4783d37dad89d867354b6f8ad9c6dc7e1270

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