Time-series Data

from encord import EncordUserClient
from encord.orm.storage import (
    TimeSeriesLineChannelViewSettings,
    TimeSeriesPointsChannelViewSettings,
    TimeSeriesViewSettings,
)

# --- Configuration ---
SSH_PATH = "/Users/user-encord/ssh-private-key.txt"  # Replace with the path to your SSH private key
FOLDER_ID = "00000000-0000-0000-0000-000000000000"   # Replace with your storage folder ID
CSV_PATH = "/path/to/sensor_readings.csv"             # Replace with the path to your time-series CSV

# --- Connect to Encord ---
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",
)

folder = user_client.get_storage_folder(FOLDER_ID)

# --- Build channel view settings ---
# Channel keys are CSV header names. As of SDK v0.1.205, `label` and `color` are optional:
# omit them and the channel falls back to the CSV header name and the editor's palette.
# Omitting the style renders the channel as a line.
settings = TimeSeriesViewSettings(
    channels={
        # Fully specified line channel.
        "speed": TimeSeriesLineChannelViewSettings(
            label="Speed (km/h)",
            color="#3366FF",
            line_width=2.0,
        ),
        # Minimal line channel: no label or color, so the CSV header and palette are used.
        "rpm": TimeSeriesLineChannelViewSettings(),
        # Render a channel as points instead of a line.
        "gear": TimeSeriesPointsChannelViewSettings(
            point_radius=3,
        ),
        # Keep a channel out of the default view.
        "debug_flag": TimeSeriesLineChannelViewSettings(hidden=True),
    },
)

# --- Upload a time-series file with initial view settings ---
item_uuid = folder.upload_time_series(
    file_path=CSV_PATH,
    title="sensor_readings",
    settings=settings,
)

item = user_client.get_storage_item(item_uuid)

# --- Read the current settings ---
print(f"Current time-series settings: {item.timeseries_settings}")

# --- Update the settings on an existing item ---
item.update(
    timeseries_settings=TimeSeriesViewSettings(
        channels={
            "speed": TimeSeriesLineChannelViewSettings(color="#FF8A00"),
        },
    ),
)