Toolbox

Custom Toolbox utility tool documentation. This page describes all available commands and their parameters for the Toolbox utility functions.

Table of Contents

1. Overview
2. Configuration
3. Commands
   1. Timer
   2. UserMessage
   3. RunScript
   4. User Form
   5. Stop Run
   6. Pause Run
   7. Note
   8. Go To
   9. Variable Assignment

---

Overview

Device Information

Manufacturer:	Custom
Category:	Utility Tool
Package:	com.science.foundry.tools.grpc_interfaces.toolbox

Configuration

Configuration Parameters

No configuration parameters required

Commands

Timer

Creates a timer for a specified duration.

Parameters

Parameter	Type	Required	Description
time_seconds	int32	Yes	Duration in seconds
message	string	No	Optional message to display

UserMessage

Displays a message to the user.

Parameters

Parameter	Type	Description
message	string	Message content
title	string	Message title
message_type	string	Type of message (info, warning, error)

RunScript

Executes a custom script.

Parameters

Parameter	Type	Description
script_content	string	Script content to execute

User Form

Displays User Form.

Parameters

Parameter	Type	Description
name	string	The name of the form

Stop Run

Stop Run Confirmation Modal.

Parameters

Parameter	Type	Description
custom message	string	Message to show in the modal

Pause Run

Pauses the Run

Parameters

Parameter	Type	Description
custom message	string	Message to show in the modal

Note

Reference Notes within protocols (comments, tips, etc.).

Parameters

Parameter	Type	Description
message	string	Message to show in the note and logs

Go To

Go back/forward to a command by index.

Parameters

Parameter	Type	Description
target index	number	Zero based index of the command to go to.

Variable Assignment

Assign a value to a variable. Can do basic string, number manipulation (Javascript)

Parameters

Parameter	Type	Description
Name	string	Name of variable to assign value to.
Value	string	Value to be assigned or to be eval'ed in javascript code.