MCAP Support

# Import dependencies
from encord import EncordUserClient
from encord.storage import StorageFolder

# User input
SSH_PATH = "/Users/chris-encord/ssh-private-key.txt"  # Replace with the file path to your SSH private key
FOLDER_ID = "00000000-0000-0000-0000-000000000000"  # Replace with the unique ID for the folder in Files & Folders
MCAP_FILE_PATH = "/Users/chris-encord/recording.mcap"  # Replace with the file path to your MCAP recording
SCENE_TITLE = "Robot recording"  # Replace with the title for the Scene

# Create user client using ssh key
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    # For US platform users use "https://api.us.encord.com"
    domain="https://api.encord.com",
)

# Get the folder
folder: StorageFolder = user_client.get_storage_folder(FOLDER_ID)

# Upload the MCAP recording as a Scene
scene_uuid = folder.upload_scene_file(file_path=MCAP_FILE_PATH, title=SCENE_TITLE)
print(f"Uploaded Scene item {scene_uuid}")

# Import dependencies
from encord import EncordUserClient
from encord.orm.storage import DataUploadItems, DataUploadScene
from encord.storage import StorageFolder

# User input
SSH_PATH = "/Users/chris-encord/ssh-private-key.txt"  # Replace with the file path to your SSH private key
FOLDER_ID = "00000000-0000-0000-0000-000000000000"  # Replace with the unique ID for the folder in Files & Folders
INTEGRATION_ID = "00000000-0000-0000-0000-000000000000"  # Replace with the unique ID for the cloud storage integration
MCAP_URI = "s3://my-bucket/recording.mcap"  # Replace with the URI of the MCAP recording in your cloud storage
SCENE_TITLE = "Robot recording"  # Replace with the title for the Scene

# Create user client using ssh key
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    # For US platform users use "https://api.us.encord.com"
    domain="https://api.encord.com",
)

# Get the folder
folder: StorageFolder = user_client.get_storage_folder(FOLDER_ID)

# Register the MCAP recording as a Scene
upload_job_id = folder.add_private_data_to_folder_start(
    integration_id=INTEGRATION_ID,
    private_files=DataUploadItems(
        scenes=[
            DataUploadScene(
                title=SCENE_TITLE,
                scene={"url": MCAP_URI, "format": "mcap"},
            ),
        ],
    ),
)

# Wait for the registration to finish
result = folder.add_private_data_to_folder_get_result(upload_job_id)
print(result)

# Import dependencies
from encord import EncordUserClient
from encord.beta.scene import (
    SceneImageTile,
    SceneLayout,
    SceneTileLayout,
    SceneTileLayoutDirection,
    SceneTimeSeriesTile,
)
from encord.orm.storage import (
    TimeSeriesLineChannelViewSettings,
    TimeSeriesPointsChannelViewSettings,
    TimeSeriesViewSettings,
)
from encord.storage import StorageItem

# User input
SSH_PATH = "/Users/chris-encord/ssh-private-key.txt"  # Replace with the file path to your SSH private key
SCENE_ITEM_ID = "00000000-0000-0000-0000-000000000000"  # Replace with the unique ID for the MCAP Scene item

# Create user client using ssh key
user_client: EncordUserClient = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path=SSH_PATH,
    # For US platform users use "https://api.us.encord.com"
    domain="https://api.encord.com",
)

# Get the MCAP Scene item
item: StorageItem = user_client.get_storage_item(SCENE_ITEM_ID)

# Define the tiles, using the exact camera topics and numeric sub-channel paths in your MCAP
layout = SceneLayout(
    tiles={
        "front": SceneImageTile(stream_name="/spot/camera/frontleft/image_downsampled"),
        "back": SceneImageTile(stream_name="/spot/camera/back/image_downsampled"),
        "angular": SceneTimeSeriesTile(
            stream_name="/spot/cmd_vel.angular.x",
            timeseries_settings=TimeSeriesViewSettings(channels={
                "/spot/cmd_vel.angular.x": TimeSeriesLineChannelViewSettings(
                    label="Angular X", color="#D33115", line_width=4,
                ),
            }),
        ),
        "linear": SceneTimeSeriesTile(
            stream_name="/spot/cmd_vel.linear.x",
            timeseries_settings=TimeSeriesViewSettings(channels={
                "/spot/cmd_vel.linear.x": TimeSeriesPointsChannelViewSettings(
                    label="Linear X", color="#0062FF", point_radius=5,
                ),
            }),
        ),
    },
    # Arrange the tiles: cameras stacked on the left, plots stacked on the right
    layout=SceneTileLayout(
        direction=SceneTileLayoutDirection.ROW,
        first=SceneTileLayout(
            direction=SceneTileLayoutDirection.COLUMN,
            first="front",
            second="back",
        ),
        second=SceneTileLayout(
            direction=SceneTileLayoutDirection.COLUMN,
            first="angular",
            second="linear",
        ),
        split_percentage=50,
    ),
    # Optional: list time-series tile IDs to show them in the timeline
    # timeline=["<time_series_tile_id>"],
)

# Apply the layout to the MCAP Scene item
item.update(scene_layout=layout)