SDK reference

SDK version: 0.1.2

Client

• Client.close — Shut down the param thread pool, close the transport, mark closed.
• Client.connect — Authenticate with the CloudSprite API.
• Client.datasets — Datasets in the default project (requires set_project).
• Client.instruments — Instruments in the default team (requires set_team).
• Client.is_connected — True when authenticated and not closed.
• Client.manufacturers — List all instrument manufacturers in the catalog.
• Client.orbs — Orbs in the default team (requires set_team).
• Client.org_slug — Default org (tenant) slug for scoped requests, or None if unset.
• Client.parameter_keys — Parameter key definitions for the default team.
• Client.parameter_templates — Parameter templates for the default team.
• Client.project_slug — Default project slug for scoped requests, or None if unset.
• Client.projects — Projects in the default team (requires set_team).
• Client.publish — Publish computed traces as a new dataset.
• Client.report_run — Post the active track_script() run report immediately.
• Client.scripts — Scripts in the default project (beta; requires set_project).
• Client.search — Search resources globally (projects, datasets, notebooks, …).
• Client.search_traces — Search traces with filters; returns raw result dicts.
• Client.set_org — Set the default org (tenant) for subsequent queries and WebSockets.
• Client.set_project — Set the default project for subsequent queries.
• Client.set_team — Set the default team for subsequent queries.
• Client.supported_models — List all supported instrument models in the catalog.
• Client.team_slug — Default team slug for scoped requests, or None if unset.
• Client.teams — Collection of teams visible to the authenticated user.
• Client.track_script — Enable lineage tracking and SDK run reporting on this client.
• Client.workflow_run — Fetch a workflow run by id (beta).
• Client.workflows — Workflows in the default project (beta; requires set_project).

Dataset

• Dataset.add_note — Add a text note to this dataset.
• Dataset.add_tag — Attach an existing tag to this dataset.
• Dataset.delete — Permanently delete dataset. This cannot be undone.
• Dataset.delete_param — Delete a parameter value by its ID.
• Dataset.description — Free-text description, or empty string if unset.
• Dataset.id — Stable UUID of this resource.
• Dataset.name — Display name (title if present, else name).
• Dataset.params — Parameter values as a {key: value} dict.
• Dataset.remove_tag — Remove a tag from this dataset.
• Dataset.restore — Restore dataset from trash.
• Dataset.set_param — Set a parameter value on this dataset.
• Dataset.slug — URL-safe identifier, unique within the parent project.
• Dataset.traces — Access traces (datafiles) in this dataset.
• Dataset.trash — Move dataset to trash (soft delete). Can be restored later.
• Dataset.update — Update dataset fields.
• Dataset.upload — Upload a file from disk to this dataset.
• Dataset.upload_bytes — Upload file content from memory.
• Dataset.upload_large — Upload a large file using chunked multipart upload.
• Dataset.upload_screenshot — Upload an image as the dataset's screenshot/thumbnail.

FieldProxy

• FieldProxy.matches — Match field against a regex/glob-style pattern.

Instrument

• Instrument.capture — Trigger a capture on this instrument and wait for completion.
• Instrument.delete — Delete this instrument registration.
• Instrument.id — Stable UUID of this resource.
• Instrument.mode — Operating mode: 'auto', 'real', or 'simulated'.
• Instrument.model_number — Instrument model number (e.g. 'MSOX3104G', 'N9042B').
• Instrument.name — Display name (title if present, else name).
• Instrument.orb_id — UUID of the orb this instrument is associated with, or None.
• Instrument.serial_number — Hardware serial number.
• Instrument.status — Connection status: 'connected', 'disconnected', or 'unknown'.
• Instrument.update — Update instrument fields (name, visa_address, mode, etc.).
• Instrument.visa_address — VISA address string (e.g. 'TCPIP::192.168.1.100::INSTR').

Notebook

• Notebook.add_equation — Add an equation to this notebook.
• Notebook.add_measurement — Add a measurement annotation to this notebook.
• Notebook.add_note — Add a note to this notebook.
• Notebook.add_traces — Add dataset traces to this notebook.
• Notebook.datasets — Datasets linked to this notebook.
• Notebook.delete — Permanently delete a trashed notebook.
• Notebook.export — Export this notebook.
• Notebook.id — Stable UUID of this resource.
• Notebook.name — Display name (title if present, else name).
• Notebook.restore — Restore notebook from trash.
• Notebook.snapshot — Save a point-in-time snapshot of this notebook.
• Notebook.traces — Fan-out: all traces across all datasets referenced by this notebook.
• Notebook.trash — Move notebook to trash (soft delete). Can be restored later.
• Notebook.update — Update notebook fields (title, description).

Orb

• Orb.connected_instruments — List of instrument connection status dicts.
• Orb.id — Stable UUID of this resource.
• Orb.instruments — Instruments associated with this orb.
• Orb.last_heartbeat — ISO timestamp of the last heartbeat, or None if never seen.
• Orb.name — Display name (title if present, else name).
• Orb.reload_instruments — Ask this orb to reload its instrument list from the backend.
• Orb.serial_number — Hardware serial number.
• Orb.status — Online status: 'online', 'offline', or 'unknown'.

Package

• connect — Connect the process-default client to CloudSprite.
• params — Proxy for building parameter filter expressions — not a normal value type.
• publish — Publish computed traces as a new dataset.
• regex — Create a regex pattern for use in bracket notation.
• report_run — Post the active track_script() run report immediately.
• search — Search across all CloudSprite resources (projects, datasets, notebooks).
• search_traces — Search for traces across all datasets.
• set_org — Set the default org (tenant) for subsequent queries and WebSockets.
• set_project — Set the default project for subsequent queries.
• set_team — Set the default team for subsequent queries.
• track_script — Enable lineage tracking and SDK run reporting on the default client.

Parameter

• Parameter.id — Stable UUID of this parameter value, if present.
• Parameter.key — Parameter key title (human-readable name).
• Parameter.value — Parameter value as a string.

ParameterKey

• ParameterKey.delete — Delete this parameter key.
• ParameterKey.id — Stable UUID of this resource.
• ParameterKey.name — Display name (title if present, else name).
• ParameterKey.unit — Unit string for values of this key, or empty if unitless.
• ParameterKey.update — Update parameter key fields.

ParameterTemplate

• ParameterTemplate.delete — Delete this template.
• ParameterTemplate.id — Stable UUID of this resource.
• ParameterTemplate.keys — Key definitions included in this template.
• ParameterTemplate.name — Display name (title if present, else name).
• ParameterTemplate.update — Update template fields.

Project

• Project.add_tag — Attach an existing tag to this project.
• Project.create_dataset — Create a dataset in this project.
• Project.create_notebook — Create a notebook in this project.
• Project.datasets — Datasets belonging to this project.
• Project.delete — Permanently delete a trashed project.
• Project.id — Stable UUID of this resource.
• Project.name — Display name (title if present, else name).
• Project.notebooks — Notebooks belonging to this project.
• Project.remove_tag — Detach a tag from this project.
• Project.restore — Restore project from trash, including cascade-trashed datasets.
• Project.scripts — Scripts belonging to this project (beta).
• Project.slug — URL-safe project identifier within its team.
• Project.trash — Move project to trash (soft delete). Cascades to datasets.
• Project.update — Update project fields (title, description, etc.).
• Project.workflows — Workflows belonging to this project (beta).

Resource

• Resource.id — Stable UUID of this resource.
• Resource.name — Display name (title if present, else name).

ResourceCollection

• ResourceCollection.count — Number of items in the collection (fetches all pages).
• ResourceCollection.create — Create a new resource in this collection.
• ResourceCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• ResourceCollection.first — Return the first item in the collection, or None if empty.

ResultSet

• ResultSet.count — Number of items in this result set.
• ResultSet.filter — Further filter the ResultSet by a parameter expression.
• ResultSet.first — Return the first item, or None if empty.
• ResultSet.to_dataframe — Convert ResultSet to a pandas DataFrame.

Script

• Script.archive — Soft-archive this script.
• Script.id — Stable UUID of this resource.
• Script.is_archived — True when the script has been soft-archived.
• Script.name — Display name (title if present, else name).
• Script.project_id — Owning project UUID.
• Script.run — Queue a server-side run (HTTP 202).
• Script.upload_version — Upload a new version from a local file (multipart).
• Script.versions — Versions on this script (fetched from detail).

ScriptCollection

• ScriptCollection.count — Number of items in the collection (fetches all pages).
• ScriptCollection.create — Create a script + version 1 from a local file.
• ScriptCollection.filter — Explicit filter — equivalent to bracket notation for patterns.
• ScriptCollection.first — Return the first item in the collection, or None if empty.

ScriptVersion

• ScriptVersion.content_hash — Content hash of the stored file.
• ScriptVersion.content_url — Presigned GET URL for this version's source.
• ScriptVersion.id — Stable UUID of this resource.
• ScriptVersion.name — Display name (title if present, else name).
• ScriptVersion.version — Monotonic version number (1-based).

SearchResult

• SearchResult.data — Raw response data for this result.
• SearchResult.id — Unique identifier of the matched resource.
• SearchResult.name — Display name/title of the matched resource.
• SearchResult.score — Relevance score (higher = better match).
• SearchResult.type — Resource type: 'project', 'dataset', 'notebook', 'trace', etc.

Tag

• Tag.color — Color hex/name for UI display, or empty if unset.
• Tag.delete — Delete this tag.
• Tag.id — Stable UUID of this resource.
• Tag.name — Display name (title if present, else name).
• Tag.update — Update tag fields (name, color).

Team

• Team.id — Stable UUID of this resource.
• Team.instruments — List instruments associated with this team.
• Team.invite — Invite a user to this team.
• Team.members — List team members.
• Team.name — Display name (title if present, else name).
• Team.orbs — List orbs associated with this team.
• Team.projects — Projects belonging to this team.
• Team.slug — URL-safe team identifier.
• Team.update — Update team fields (name, etc.).

Trace

• Trace.to_network — Convert trace to a scikit-rf Network object.

TraceRef

• TraceRef.dataset — Parent dataset when attached during traversal, else None.
• TraceRef.id — Stable UUID of this resource.
• TraceRef.name — Trace name or source file name.
• TraceRef.to_trace — Materialize this TraceRef into a concrete Trace object.
• TraceRef.x — Independent-axis samples (loads remote data on first access).
• TraceRef.x_unit — Unit of the independent (x) axis.
• TraceRef.y — Dependent-axis samples (loads remote data on first access).
• TraceRef.y_unit — Unit of the dependent (y) axis.

Workflow

• Workflow.id — Stable UUID of this resource.
• Workflow.is_enabled — True when triggers may fire.
• Workflow.name — Display name (title if present, else name).
• Workflow.project_id — Owning project UUID.
• Workflow.runs — Runs of this workflow.

WorkflowRun

• WorkflowRun.id — Stable UUID of this resource.
• WorkflowRun.name — Display name (title if present, else name).
• WorkflowRun.status — Run status (queued, running, succeeded, failed, …).
• WorkflowRun.workflow_id — Owning workflow UUID.

cloudsprite

• cloudsprite.datasets — Datasets in the default project (requires set_project).
• cloudsprite.instruments — Instruments in the default team (requires set_team).
• cloudsprite.manufacturers — List all instrument manufacturers in the catalog.
• cloudsprite.orbs — Orbs in the default team (requires set_team).
• cloudsprite.parameter_keys — Parameter key definitions for the default team.
• cloudsprite.parameter_templates — Parameter templates for the default team.
• cloudsprite.projects — Projects in the default team (requires set_team).
• cloudsprite.supported_models — List all supported instrument models in the catalog.
• cloudsprite.teams — Collection of teams visible to the authenticated user.