{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"6df2df06-2c0f-43dc-babe-407b9d58159a"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"04b283cf-314f-48f4-bb89-0ccac0532742"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Revisions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/03/14: Initial 2.0 API documentation; motion and setup commands.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/03/21: Preset name argument added to Move and Combined move. Collision checking against DSM has been moved to an explicit new argument in Move command. Combined move structure row clarifications.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/03/30: GetTCPPose description added (formerly duplicated GetJointAngles). DSM command descriptions added. Additional desctiption added to SetAlternateLocation’s “mode” argument. Moved SetServos location for better organization.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/04/08: SetResponseType and SetUnits can now be stored per IP address rather than per client. Example CSV responses added to DSM commands. Robot Presets and Object states are now stored to disk so project reload will have the last set values. SetInterruptBehavior timeout value is now used as the timeout for the alternate location mode: 0 with complete_move: 1, and mode: 1. UpdateTarget can now optionally re-generate the autoconnects associated with that target.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/04/14: AddBox description updated to include box origin and offset argument. AddFrame description updated to note that frames are not saved to disk.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/04/21: API specs for enabling a subset of a project added (Activate, Deactivate, UpdateInactiveRobotSettings).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/05/04: SetUnits and SetResponseType descriptions updated to make it clear that only new connections will be affected by set_ip_default.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/05/12: GetTCPPose YAML response corrected, the key is pose, not tcp_pose. CreateTarget CSV response delayed response corrected from CreateTarget to CreateTargetResult. Added a note to the SetRobotPreset description that ReleaseControl must be called first, if the number of axes on the robot is changing. Added to the UpdateTarget description to indicate that auto connect constraints will be maintained at the targets new location. Updated CancelMove description to note that it is only accepted in OPERATION mode.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/05/31: Preset argument description updated in Move and CombinedMove. GetJointAngles is being renamed to GetJointConfiguration, but both are supported currently.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/06/01: Added acceptable string characters to the formation rules section.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/06/08: Added SetMaxLinearSpeed and SetMaxLinearAcceleration descriptions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/06/14: More SetAlternateLocation examples added. Clarified the behavior of the reset flag for SetMaxLinearSpeeds and SetMaxLinearAcceleration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/06/17: Corrected SetMaxLinearAcceleration’s max value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/07/01: Updated Move with supported move type and goal combinations.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/08/08: Clarified the effect CancelMove has on queued Move and CombinedMove commands.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/08/30: Added OverrideInspectError, ToggleMonitorFaults, Calibrate descriptions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/08/31: Updated Queuing Moves when a robot preset changes. Updated Queuing Moves with smoothing support. Updated Move spec that supports robot preset changes. Updated SetRobotPreset spec.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/10/03: Updated DeactivateRobots.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated CreateTarget to add a new target without connections.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added RenameTarget command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added RemoveTarget command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added AddConnection command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added RemoveConnection command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated Move with support for external axes and triggers.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated CombinedMove with support for external axes and triggers.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated CancelMove with ramp-down speed at a fixed 80%.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated SetDefaultProject to clear the default project if project name input is not specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added GetLoadedProject command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Added GetRobotPresets command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/03: (2.2)Updated UserLog with allowed characters in a user log.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/04: (2.2)Danger/risk of interleaving RTR with non-RTR move commands is documented in the Move command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/05: (2.2)GetJointAngles command is deprecated and replaced by GetJointConfiguration.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/05: (2.2)Added move type and target type support matrix.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/05: (2.2)Added two cautionary statements regarding mixing RTR with non-RTR moves and robot off-roadmap behaviors for Move command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2022/12/09: (2.2)Added a cautionary statement regarding mixing RTR-controlled moves with non-RTR stop commands.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/01/04: (2.2)SetServos command is removed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/01/13: (2.2)Move command and queued move smoothing behavior description is updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/01/18: (2.2)API command string size limit is specified.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/01/30: (2.2)Move command trigger behavior description is updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/06: SetRobotPreset command description is updated","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/22: Move Type and Target Type(joint configuration) Support is updated.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: Added API Command Determinism section.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Added GetFrames command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Added GetObjectStates command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated SetDefaultProject command to allow ","type":"text"},{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":" to be optional.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated GetJointConfiguration command with a new argument ","type":"text"},{"text":"native","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated Move command to support joint configuration target types.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated Move command to support relative moves including external axes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated SetAlternateLocation command with a new argument ","type":"text"},{"text":"timeout","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated SetInterruptBehavior command default values.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated DeactivateRobot command to allow different key values for ","type":"text"},{"text":"treat_as_obstacle","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated ActivateRobot command with a new argument ","type":"text"},{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated CancelMove command with a new argument ","type":"text"},{"text":"acceleration_factor","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated UpdateTarget command with new arguments ","type":"text"},{"text":"object_states","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/24: (2.3)Updated ClearFaults command with new argument ","type":"text"},{"text":"reset_connection","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/27: (2.3)Updated Move command with new argument ","type":"text"},{"text":"costs","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/28: Updated Shutdown command fault codes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/30: (2.3)Removed UpdateInactiveRobotSettings command due to redundant functionality as DeactivateRobot.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/03/30: Updated the list of commands that are stored on disk and added the list of commands that are not persistent, under Commands Stored on Disk section.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/04/03: Updated LoadProject command with argument ","type":"text"},{"text":"upgrade","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Updated accepted formats for a Boolean value.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Updated Move command with a new argument ","type":"text"},{"text":"shortest_path_only","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Added SetWorkcellState Command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Updated EnterOperationMode command with argument ","type":"text"},{"text":"connect","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Updated UpdateTarget command with arguments ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":"and ","type":"text"},{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/12: (2.4) Updated GetJointConfiguration command with argument ","type":"text"},{"text":"with_joint_names","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/13: (2.4) Move command can use ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" to specify a relative direct pose move.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/13: (2.4) Added GetTargets command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/13: (2.4) Added GetStatefulObjects command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/13: (2.4) Added GetUnits command.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2023/06/16: (2.4) Updated description of the system responses to null values.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Goal","type":"text"}]},{"type":"paragraph","content":[{"text":"The ASCII API is a fundamental component of how a user interacts with the Realtime Controller and ultimately controls a robot. In order to effectively complete a task, the user must be able to retrieve information from the Rapidplan Create project, set behavioral characteristics of the robots, and move the robots either following the offline motion plans or with conventional move types.","type":"text"}]},{"type":"paragraph","content":[{"text":"The 2.0 ASCII API re-implements commands from the 1.x.x version with simplifications, renaming, and overall improvements. Most importantly, the request syntax changed to inline YAML, so that in future 2.x.x versions more functionality can be added while maintaining backwards compatibility. The key value structure will also make messages more readable, and easier to format. Requests can be returned in the same inline YAML format, or the same CSV response type as 1.x.x. versions.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Format","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Syntax (Inline YAML 1.2 Spec)","type":"text"}]},{"type":"paragraph","content":[{"text":"The ASCII strings received by the Realtime Controller will be formatted to adhere to the inline YAML format, for robust parsing. Inline YAML allows the API to use key-value pairs (KVPs). KVPs will be comma delimited, much like the current API, but attaching keys to the values will allow parameters to come in any order. Additionally, there can be multiple optional parameters and any combination of them. If the optional parameters aren’t used, they can simply be omitted and a default value will be used. Another benefit is readability, since now the values in the requests can be identified based on their key.","type":"text"}]},{"type":"paragraph","content":[{"text":"Command strings will be terminated with ","type":"text"},{"text":"CR","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"LF","type":"text","marks":[{"type":"code"}]},{"text":" ASCII characters. The length of the command strings should be less then 2KB. Commands that exceed the 2KB size limit are not forwarded out of the networking layer. They’re simply discarded and the connection is closed.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Requests","type":"text"}]},{"type":"paragraph","content":[{"text":"Requests sent to the Realtime controller will be formatted according to the inline YAML spec. The function type is set by the ","type":"text"},{"text":"topic","type":"text","marks":[{"type":"code"}]},{"text":" key and then arguments are passed as key value pairs. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Inline YAML allows the API to be more easily backwards compatible. When arguments are added in the future, they will have a default value, so that existing code will remain functional on newer software versions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: , type: , id: , data: {key1: value1,...,keyN: valueN}}","type":"text"}]},{"type":"paragraph","content":[{"text":"topic","type":"text","marks":[{"type":"code"}]},{"text":": The name of the function being requested. Topic values are case insensitive. Eg. ","type":"text"},{"text":"GetMode","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"data","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"f1472667-13c5-455a-bc49-1cc497e535b6"}},{"text":" The arguments for the specific topic if required. See the detailed topic descriptions below for more information.","type":"text"}]},{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"5d003f5a-87f2-4500-9f1f-7663712105b9"}},{"text":" The type of request being sent. The default value is ","type":"text"},{"text":"Command","type":"text","marks":[{"type":"code"}]},{"text":" and currently that is the only request type.","type":"text"}]},{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"057cf818-bef9-42e9-a53a-1c893e463f2a"}},{"text":" A client can provide an ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" for the message in order to easily match responses to requests. Any ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" provided in the request, will be returned in the matching responses. The value can be either a ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"int","type":"text","marks":[{"type":"code"}]},{"text":". Note: CSV response types omit this field since it is optional.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Formation Rules","type":"text"}]},{"type":"paragraph","content":[{"text":"All requests made to the Realtime Controller adhere to the following formation rules:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The topic values are case insensitive.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any required key must be 100% correct and contain a valid value, otherwise the request is rejected. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If an optional key is not specified (either because it was not provided or because the key was malformed) the default value for the key is used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Any optional key that is provided must contain a correct and valid value, otherwise the request is rejected. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If irrelevant keys are passed (including malformed optional keys), they are ignored.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If a value is valid but out of a range that we specify, the request is rejected.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Strings may only contain: numbers, letters, hyphens, and underscores","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Boolean Values","type":"text"}]},{"type":"paragraph","content":[{"text":"When an argument expects a boolean type, the acceptable values are integers or case insensitive strings.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following are evaluated as True:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"y|Y|yes|Yes|YES|true|True|TRUE|on|On|ON","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The following are evaluated as False:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"n|N|no|No|NO|false|False|FALSE|off|Off|OFF","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Responses","type":"text"}]},{"type":"paragraph","content":[{"text":"Responses can be returned in CSV format for easy parsing, or in YAML format for human readability and programming languages that support it. The CSV responses will follow a fixed order with no optional returns, and therefore are more limited than the YAML response type. For any complex types returned in YAML (like an array), the values will be broken out in the CSV response. See ","type":"text"},{"text":"GetJointConfiguration","type":"text","marks":[{"type":"code"}]},{"text":" for an example.","type":"text"}]},{"type":"paragraph","content":[{"text":"The default response type is YAML, but upon establishing a connection, a client can immediately specify CSV response type with the ","type":"text"},{"text":"SetResponseType","type":"text","marks":[{"type":"code"}]},{"text":" command and never needs to parse YAML.","type":"text"}]},{"type":"paragraph","content":[{"text":"Responses will include an optional ","type":"text"},{"text":"error","type":"text","marks":[{"type":"code"}]},{"text":" key if a problem has occurred preventing completion of the request. This key data is a dictionary containing ","type":"text"},{"text":"code","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"msg","type":"text","marks":[{"type":"code"}]},{"text":" keys, which provide the numeric code and a text description of the error. Note: CSV responses will always contain the error code, with code ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" indicating success. Subsequent result key value pairs depend on the request command that was received.","type":"text"}]},{"type":"paragraph","content":[{"text":"Commands can have multiple response types. The types are: ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":",","type":"text"},{"text":"Feedback","type":"text","marks":[{"type":"code"}]},{"text":", and ","type":"text"},{"text":"DelayedResponse","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":" is always returned and it indicates if the request has executed successfully or not. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Null values, such as null, ~, '' (empty string), Null, and NULL are interpreted as normal strings. If a user sets an API command argument with a null value, the value will be checked for validity against the target RapidPlan project or RapidPlan settings. If not found, these null values will be rejected by RapidPlan with a “xxxx_NOT_FOUND” error.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"DelayedResponse","type":"text","marks":[{"type":"code"}]},{"text":" is returned for commands that take time to execute, like a ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"LoadProject","type":"text","marks":[{"type":"code"}]},{"text":". When a ","type":"text"},{"text":"Response","type":"text","marks":[{"type":"code"}]},{"text":" includes a ","type":"text"},{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" key, that indicates that a ","type":"text"},{"text":"DelayedResponse","type":"text","marks":[{"type":"code"}]},{"text":" will be returned for that command. Both the immediate and delayed responses will have a globally unique sequence number (referred to as ","type":"text"},{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":") so that the delayed response can be matched to the command it is for.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"Feedback","type":"text","marks":[{"type":"code"}]},{"text":" response is returned when an intermediate event occurs before the completion of the command. For example, each move segment in a ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" command returns a ","type":"text"},{"text":"Feedback","type":"text","marks":[{"type":"code"}]},{"text":" response to indicate its completion before the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" completes and returns its ","type":"text"},{"text":"DelayedResponse","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Immediate Responses:","type":"text"}]},{"type":"codeBlock","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"{topic: , type: Response, id: , error: {code: , msg: }, data: {result1: ,...,resultN: }}\nor in the CSV response,\nTopicName,code,result1,...,resultN","type":"text"}]},{"type":"paragraph","content":[{"text":"Feedback Responses:","type":"text"}]},{"type":"codeBlock","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"{topic: ,type: Feedback, id: , error: {code: , msg: }, data: {result1: ,...,resultN: }}\nor in the CSV response,\nTopicNameFeedback,code,result1,...,resultN","type":"text"}]},{"type":"paragraph","content":[{"text":"Delayed Responses:","type":"text"}]},{"type":"codeBlock","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"text":"{topic: ,type: DelayedResponse, id: , error: {code: , msg: }, data: {result1: ,...,resultN: }}\nor in the CSV response,\nTopicNameResult,code,result1,...,resultN","type":"text"}]},{"type":"paragraph","content":[{"text":"topic","type":"text","marks":[{"type":"code"}]},{"text":": The name of the message type. Eg. ","type":"text"},{"text":"GetMode","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":": The type of response being provided; either ","type":"text"},{"text":"Feedback Responses","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"Delayed Responses","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"data","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"d973b8e6-a88c-4d62-a28c-67aaf9009641"}},{"text":" The return arguments for the specific topic. If an error occurs, data will not be returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"error:","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"e180c555-e1ef-4c88-a9b4-f31ba1725d4d"}},{"text":" If an error occurs, the error code and text description will be returned in the YAML format. In the CSV response the code will be returned in every response.","type":"text"}]},{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"49f4fc2e-49d8-48db-9647-ae13039f8f4b"}},{"text":" A client can provide an ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" for the message in order to easily match responses to requests. If a client provided an ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":", the same ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" will be returned in the responses. Note: if the response type is CSV and a ","type":"text"},{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" is provided in the request, it will be omitted in all responses due to the no optional returns rule.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Stateful Commands","type":"text"}]},{"type":"paragraph","content":[{"text":"Commands can now be stateful. Before, a workstate had to be passed in every MOVE command, but now the workcell and robot presets are set, and then subsequent move commands use the active preset.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Commands Stored on Disk","type":"text"}]},{"type":"paragraph","content":[{"text":"Certain commands are now stored on disk, so when the project is unloaded and reloaded, they hold their previous state. This will reduce the amount of repetitive commands during integration and testing, while also resulting in more predictable behavior.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetDefaultProject","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DeactivateRobot","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetRobotPreset","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetObjectState","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CreateTarget","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UpdateTarget","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RenameTarget","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RemoveTarget","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AddConnection","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RemoveConnection","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The following API commands are not persistent after a RTR controller is rebooted. These commands must be reissued to ensure the project settings are restored after the project is reloaded.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetMaxLinearAcceleration","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetMaxLinearSpeed","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetAlternateLocation","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetInterruptBehavior","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetResponseType","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SetUnits","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scene Modeling commands","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Command Determinism","type":"text"}]},{"type":"paragraph","content":[{"text":"When API commands come from the same source, e.g. a single TCP socket, the API commands are processed in the order of when they are received. In a multi-robot cell, the execution of the API commands for each robot is ordered and deterministic when the response code is confirmed by the source before the next API command is sent.","type":"text"}]},{"type":"paragraph","content":[{"text":"When API commands come from multiple sources, the API commands are processed by a RTR controller without considering the order of the command execution between robots. As a result, the execution of the API commands between robots may become out of order, due to the timing of when each API command arrives from different sources. Therefore, if consistent API command ordering is required from multi sources, it is necessary for the command sources to synchronize with each other. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Default Units","type":"text"}]},{"type":"paragraph","content":[{"text":"Unless set by the ","type":"text"},{"text":"SetUnits","type":"text","marks":[{"type":"code"}]},{"text":" command, all requests and responses with the Realtime Controller assume ","type":"text"},{"text":"millimeters","type":"text","marks":[{"type":"code"}]},{"text":" for lengths and ","type":"text"},{"text":"degrees","type":"text","marks":[{"type":"code"}]},{"text":" for angles.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Move Type and Target Type Support","type":"text"}]},{"type":"paragraph","content":[{"text":"API support for moves without using ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" argument:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9869d4c8-ef2b-4f33-ac07-ad9bf61371f9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"direct","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"roadmap","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"planning","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"target","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.0","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"config","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.3","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"Not supported","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"pose","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.0","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.2","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"API support for moves using ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" argument:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"443eff44-1340-4ec5-b224-3025dfe8d274"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"direct","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"roadmap","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"planning","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"target","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"config","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"N/A*","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":"pose","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.2","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[190.0]},"content":[{"type":"paragraph","content":[{"text":">=2.2","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"*In Rapidplan Create, targets and robot configurations are defined by full joint configuration of the robot, including external axes values. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Endpoints - Project","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetResponseType","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"aa4dce9d-41fc-4580-a43f-a27e614edb6d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetResponseType,data: {response_type: , set_ip_default: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"response_type","type":"text","marks":[{"type":"code"}]},{"text":": This indicates which format the Realtime Controller will use when sending responses; either CSV or yaml. The default response type is yaml. The argument can be either case insensitive text or its numeric equivalent.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"csv","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"yaml","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"set_ip_default","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"2e745624-656e-4592-afd6-b520f073fa0e"}},{"text":" This optional boolean argument will store the response type based on the devices IP address rather than for the current socket. All new connections from the IP address will use this response type.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command is used to set the response format of the TCP/IP communication with the Realtime Controller. The Realtime controller stores this response type for each client that is connected to it. This command should be called at the beginning of a program to indicate the format in which the responses should be sent. If this command is not sent, the default response type is yaml.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"set_ip_default","type":"text","marks":[{"type":"code"}]},{"text":" argument is enabled, then all new connections from the IP address will use the specified response type. Existing sockets will be unaffected by this change, until they re-establish a connection.","type":"text"}]},{"type":"paragraph","content":[{"text":"As long as the IP address has at least one open connection, the settings will persist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetResponseType,data: {response_type: csv}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetResponseType,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"SetResponseType,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetUnits","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"549cfe64-f46c-471c-8986-c635d62f98fa"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetUnits}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"length","type":"text","marks":[{"type":"code"}]},{"text":": This specifies the unit of measure for length. The unit can be specified with a case insensitive string or its corresponding integer value. For example, when a pose is specified this length unit will be used.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"meters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"centimeters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"millimeters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"feet","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"inches","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"angle","type":"text","marks":[{"type":"code"}]},{"text":": This specifies the unit of measure for angles. The unit can be specified with a case insensitive string or its corresponding integer value. For example, when a robot’s joint angles are set or when a frame’s rotation is specified, this angle unit will be used.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"radians","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"degrees","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"GetUnits","type":"text","marks":[{"type":"code"}]},{"text":" command returns both units set for the current connection:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Length (millimeters, centimeters, meters, feet, inches)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Angle (degrees, radians)","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to show the units used by the loaded project.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetUnits}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetUnits, data: {length: inches, angle: degrees}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"GetUnits,0,inches,degrees","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetUnits","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"ef2784a8-c001-4c4b-b34d-c637a3bdaf1b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetUnits,data: {length: ,angle: , set_ip_default: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"length","type":"text","marks":[{"type":"code"}]},{"text":": This specifies the unit of measure for length. The unit can be specified with a case insensitive string or its corresponding integer value. For example, when a pose is specified this length unit will be used.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"m,meter,meters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"cm,centimeter,centimeters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"mm,millimeter,millimeters","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"3","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"ft,foot,feet,'","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"4","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"in,inch,inches,”","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"angle","type":"text","marks":[{"type":"code"}]},{"text":": This specifies the unit of measure for angles. The unit can be specified with a case insensitive string or its corresponding integer value. For example, when a robot’s joint angles are set or when a frame’s rotation is specified, this angle unit will be used.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"rad,rads,radian,radians","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"deg,degs,degree,degrees,°","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"set_ip_default","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"6880c0ba-841d-4d08-8cc1-e45231ed1480"}},{"text":" This optional boolean argument will store the unit change based on the devices IP address rather than for the current socket. All new connections from the IP address will use these unit preferences.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command is used to set the unit convention for API calls made to the Realtime controller. On first project load, the default units of ","type":"text"},{"text":"millimeters","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"degrees","type":"text","marks":[{"type":"code"}]},{"text":" will be used, and if this command is called, the units will be stored for that specific client. Subsequent loads for that project will use require the client to reinitialize their unit convention.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the ","type":"text"},{"text":"set_ip_default","type":"text","marks":[{"type":"code"}]},{"text":" argument is enabled, then all new connections from the IP address will use these unit preferences. Existing sockets will be unaffected by this change, until they re-establish a connection.","type":"text"}]},{"type":"paragraph","content":[{"text":"As long as the IP address has at least one open connection, the settings will persist.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetUnits,data: {length: in, angle: deg}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetUnits,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"SetUnits,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetMode","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"146a4b5a-9cea-4994-bd67-cb2912415251"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetMode}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the current mode of the Realtime Controller.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by the current state of the system. The states of the system are: Config mode, Operation mode, Calibration mode and Fault mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetMode}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetMode,type: Response,data: {mode: CONFIG}}\n{topic: GetMode,type: Response,data: {mode: OPERATION}}\n{topic: GetMode,type: Response,data: {mode: CALIBRATION}}\n{topic: GetMode,type: Response,data: {mode: FAULT}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"GetMode,0,CONFIG\nGetMode,0,OPERATION\nGetMode,0,CALIBRATION\nGetMode,0,FAULT","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ClearFaults","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"a9094347-f468-4aa1-9eeb-2b6490cf16cf"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ClearFaults, data: {reset_connection: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"reset_connection","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This indicates whether a ClearFaults command will reconnect to the robot controller after the command is issued. The default value is true.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"If a robot error/fault state occurs for one of the robots in the currently loaded deconfliction group, the Realtime Controller will enter a fault state. Examples of reasons may be: lost connection to a robot due to an E-stop, or the robot entering a fault state due to excessive speed or force. The ClearFaults command will attempt to recover any faults that the OEM controller allows allows to be cleared programmatically, and transition the Controller back into Config mode if possible. It will fail if there are still active, unresolvable faults.","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"reset_connection","type":"text","marks":[{"type":"code"}]},{"text":" is true(default value), the Realtime Controller will attempt to reconnect to the robot controller after recovering from a fault state. If ","type":"text"},{"text":"reset_connection","type":"text","marks":[{"type":"code"}]},{"text":" is false, an explicit Connect ASCII call would be required prior to entering Operation mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a single response code as a result value.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ClearFaults}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ClearFaults,type: Response}\n{topic: ClearFaults,type: Response,error: {code:1004,msg:FAILED_TO_CLEAR_FAULTS}}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"LoadProject","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"33079990-fcd6-45cf-99f5-4fa164b8a060"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: LoadProject,data: {project_name: , upgrade: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the project installed on the control panel that you want to load.","type":"text"}]},{"type":"paragraph","content":[{"text":"upgrade","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" A boolean value that decides if the installed RPC project is from an earlier release version, it will be upgraded for compatibility. Default value is True.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"This function loads an RPC project. A load result will be returned once the process has finished and then RapidPlan will be in configuration mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code to acknowledge the command has been received.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: LoadProject,type: Response,data: {seq: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"Once the load is completed, the system will send a delayed response to indicate the project has finished loading. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: LoadProject,type: DelayedResponse,data: {seq: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: LoadProject,data: {project_name: DemoProject}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: LoadProject,type: Response,data: {seq: 128}}\n… load executes … \n{topic: LoadProject,type: DelayedResponse,data: {seq: 128}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"LoadProject,0,128\n… load executes … \nLoadProjectResult,0,128","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetLoadedProject","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"5239e202-48d9-445d-952f-1ec2e95eb54f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetLoadedProject}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the currently loaded project on the Realtime Controller.","type":"text"}]},{"type":"paragraph","content":[{"text":"If a project is not currently loaded, an error code will be returned ","type":"text"},{"text":"{code: 3009,msg: PROJECT_NOT_LOADED}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by the currently loaded project or an appropriate error code.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetLoadedProject}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"// Response when a project is loaded\n{topic: GetLoadedProject,type: Response,data: {project_name: WeldCell}}\n// Response with no project loaded\n{topic: GetLoadedProject,type: Response,error: {code: 3009,msg: PROJECT_NOT_LOADED}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"// Response when a project is loaded\nGetLoadedProject,0,WeldCell\n// Response with no project loaded\nGetLoadedProject,3009","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"UnloadProject","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"7371aa9d-322b-4a02-b2a6-97bbe77a735e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UnloadProject}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command brings the Realtime Controller out of operation mode and unloads the project. Current motions will be cancelled, and no new motion requests will be accepted. Duplicate calls have no effect. Connection to robot controllers will be terminated.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: UnloadProject,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UnloadProject}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UnloadProject,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"UnloadProject,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetDefaultProject","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"c1a16dee-0d38-4a61-ae11-267b174a0d35"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetDefaultProject,data: {project_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This indicates which project will be made the default project. If this argument is omitted, any previous setting will be cleared and no project will be the default.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command is used to define which project is the Default project that will automatically be loaded when RapidPlan powers on or is otherwise not in Operation Mode.","type":"text"}]},{"type":"paragraph","content":[{"text":"Sending a SetDefaultProject command without specifying the ","type":"text"},{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":" parameter will clear any previous setting.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetDefaultProject,data: {project_name: DemoProject}}","type":"text"}]},{"type":"paragraph","content":[{"text":"or","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: SetDefaultProject}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetDefaultProject,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"SetDefaultProject,0","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"EnterOperationMode","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"9d1512c0-a049-4154-b950-20b1b71d5892"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterOperationMode, data:{connect: true}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"connect","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":": this boolean argument, if true, will connect all robots upon entering Operation mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command indicates that the project is ready to begin operation. This call is blocking, until all active robots have been connected. Once all participating robots have indicated readiness, return messages will be sent, and subsequent Move calls will be accepted. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterOperationMode}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterOperationMode,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"EnterOperationMode,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"EnterConfigurationMode","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"64f1f17d-606f-45b4-9ab6-49c10d3e3829"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterConfigurationMode}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command brings the Realtime Controller out of operation mode back into Config Mode. Current motions will be cancelled, and no new motion requests will be accepted. Duplicate calls have no effect. Connection to robot controllers will be maintained when returning to ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterConfigurationMode}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: EnterConfigurationMode,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"EnterConfigurationMode,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Shutdown","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"50186adb-0434-4b3d-9fb3-9837f1320af8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Shutdown}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command issues an asynchronous system call, ","type":"text"},{"text":"systemctl poweroff -i","type":"text","marks":[{"type":"code"}]},{"text":", which shuts the appliance down, if in Fault or Configuration Mode.","type":"text"},{"type":"hardBreak"},{"text":"Should the appliance be in operation or in calibration mode, this command will be rejected.","type":"text"}]},{"type":"paragraph","content":[{"text":"Between this call and the system shutting down, the appliance will be in a “Shutdown” state and refuse any further ASCII commands. ","type":"text"},{"type":"hardBreak"},{"text":"If this system call results in an error, rather than shutting down the following will occur:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An additional delayed response will be returned, with the command and error status ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The controller will enter Fault mode","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and queued for execution. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"If the shutdown command fails during execution, a delayed response will be sent with the command’s error status.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Shutdown}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Shutdown,type: Response,data: {seq: 162}}\nAnd if the shutdown fails...\n{topic: Shutdown,type: DelayedResponse,error: {code: 2019,INVALID_SHUTDOWN_STATE}}\nor\n{topic: Shutdown,type: DelayedResponse,error: {code: 2020,APPLIANCE_SHUTDOWN_FAILED}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"Shutdown,0,162\nAnd if the shutdown fails...\nShutdownResult,1001,162","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"UserLog","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"2066a68a-031a-4bb7-b2b3-32dacbfac636"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UserLog,data: {message: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"message","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"A string to be written to the RapidPlan logs. Must be less than 500 characters and may only contain letters, numbers, ","type":"text"},{"text":"-","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":".","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This function allows the user to write a simple string to the RapidPlan logs.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return immediately with a response indicating whether or not the string could be written to the log.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UserLog,data: {message: CYCLE_START}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UserLog,type: Response","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"UserLog,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"BeginInterlockRecording","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"dd6b68d0-ee54-463b-8cc4-0c61c512eaa7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: BeginInterlockRecording}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command indicates to RTR that for the upcoming cycle, RTR should record motion data for interlock calculations. This command is only accepted in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode. To generate an interlock report, issue ","type":"text"},{"text":"BeginInerlockRecording","type":"text","marks":[{"type":"code"}]},{"text":", execute all the robot motions, call ","type":"text"},{"text":"EnterConfigMode","type":"text","marks":[{"type":"code"}]},{"text":", and then call ","type":"text"},{"text":"GenerateInterlockData","type":"text","marks":[{"type":"code"}]},{"text":" to retrieve the result.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: BeginInterlockRecording}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: BeginInterlockRecording,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"BeginInterlockRecording,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GenerateInterlockData","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"6c854f4a-5740-4b9d-bb10-0c701828c81e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GenerateInterlockData}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command indicates to RTR to that the simulation tool wishes to retrieve the interlock data for the preceding cycle. This command is only accepted in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"The response is a report of interlock data for each edge taken by a robot while interlock recording was active in YAML format. The report contains keys for each robot, and for each robot there is a key for every motion it takes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Each motion taken by the robot is represented as a ","type":"text"},{"text":"sequence_number","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For each ","type":"text"},{"text":"sequence_number","type":"text","marks":[{"type":"code"}]},{"text":", a ","type":"text"},{"text":"path","type":"text","marks":[{"type":"code"}]},{"text":" is provided which contains a list of waypoints.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The first waypoint is always the starting position of the robot during the move.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The last waypoint is always the position the robot when the move finishes.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For each ","type":"text"},{"text":"sequence_number","type":"text","marks":[{"type":"code"}]},{"text":" an interlock list is provided.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Each interlock is given a unique name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An empty list indicates that no interlocks are required for that motion.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"begin_interlock","type":"text","marks":[{"type":"code"}]},{"text":" key indicates the furthest point the robot can proceed to before it is required to obtain the specific interlock.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"end_interlock","type":"text","marks":[{"type":"code"}]},{"text":" key indicates which point the robot must reach in order to release the interlock.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It is possible for the ","type":"text"},{"text":"end_interlock","type":"text","marks":[{"type":"code"}]},{"text":" key to be achieved through a different move.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sometimes, the interlocks starting position is the first waypoint of the move which means the robot cannot move at all until the interlock is obtained.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Interlocks are not robot specific, so the same interlock can appear for multiple robots motions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":" value for ","type":"text"},{"text":"end_interlock","type":"text","marks":[{"type":"code"}]},{"text":" indicates that the robot was still in a position that required an interlock when the recording was terminated.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GenerateInterlockData}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"For each robot, the information of the robot motion and interlock is returned. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\ntopic: GenerateInterlockData,\ntype: Response,\ndata: {\n rtr_interlock_report: {\n version: 0.0.1,\n robots: {\n Robot1: [\n {sequence_number: 1, path: [[0, 0, 0, 0, 0, 0], [0.866353, 0.676527, 0.235204, 1.375235, -0.889543, -1.26606]], interlocks: [{interlock_id: 0, begin_interlock: {sequence_number: 1, waypoint_index: 0}, end_interlock: \"null\"}, {interlock_id: 1, begin_interlock: {sequence_number: 1, waypoint_index: 0}, end_interlock: \"null\"}]},\n {sequence_number: 4, path: [[0.866353, 0.676527, 0.235204, 1.375235, -0.889543, -1.26606], [0, 0, 0, 0, 0, 0]], interlocks: [{interlock_id: 2, begin_interlock: {sequence_number: 4, waypoint_index: 0}, end_interlock: \"null\"}, {interlock_id: 3, begin_interlock: {sequence_number: 4, waypoint_index: 0}, end_interlock: \"null\"}]}],\n Robot2: [\n {sequence_number: 3, path: [[0, 0, 0, 0, 0, 0], [-0.790681, 0.486338, 0.122411, 1.691136, 0.798099, -1.742254]], interlocks: [{interlock_id: 0, begin_interlock: {sequence_number: 3, waypoint_index: 0}, end_interlock: \"null\"}, {interlock_id: 2, begin_interlock: {sequence_number: 3, waypoint_index: 0}, end_interlock: \"null\"}]},\n {sequence_number: 5, path: [[-0.790681, 0.486338, 0.122411, 1.691136, 0.798099, -1.742254], [0, 0, 0, 0, 0, 0]], interlocks: [{interlock_id: 1, begin_interlock: {sequence_number: 5, waypoint_index: 0}, end_interlock: \"null\"}, {interlock_id: 3, begin_interlock: {sequence_number: 5, waypoint_index: 0}, end_interlock: \"null\"}]}]\n }\n }\n }\n}","type":"text"}]},{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"#ffffff","rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"None","type":"text","marks":[{"type":"code"}]},{"text":", only the YAML response type is supported for interlock generation. ","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Endpoints - Robot","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ActivateRobots","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"ebf93458-df6e-4ec8-9ad2-1fd104a3ee41"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ActivateRobots,data: {robot_names: , project_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"robot_names","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" An array specifying which robots should be activated. If not passed, all inactive robots in the project will be activated.","type":"text"}]},{"type":"paragraph","content":[{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" The name of the project you’d like to activate the robot in. This is required if the robot you want to deactivate is not in the loaded project.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will re-activate a robot. After this command, when Connect is called, the activated robot will be connected to, and when in OPERATION mode this robot will be controlled by RTR.","type":"text"},{"type":"hardBreak"},{"text":"This command must be called when the controller is in CONFIG mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ActivateRobots}\n{topic: ActivateRobots, data: {project_name: Proj1, robot_names: [Robot2]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ActivateRobots,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"ActivateRobots,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"DeactivateRobot","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"554bbfff-8755-45f6-8ff1-085bdb3dc61e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: DeactivateRobot,data: {robot_name: , treat_as_obstacle: ,joint_config: ,target_name: ,preset_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot should be deactivated.","type":"text"},{"type":"hardBreak"},{"text":"project_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" The name of the project you’d like to deactivate the robot in. This is required if the robot you want to deactivate is not in the loaded project. If the project is not loaded ","type":"text"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":" is the only other valid key.","type":"text"},{"type":"hardBreak"},{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" A string specifying the preset of the robot to be used in the inactive state. The preset will determine the collision geometry as well as the number of joints. If not specified, the active preset will be used.","type":"text"}]},{"type":"paragraph","content":[{"text":"treat_as_obstacle","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" A boolean value that specifies if the deactivated robot should be treated for collisions by the other robots in the work cell. Default value is true.","type":"text"},{"type":"hardBreak"},{"text":"If ","type":"text"},{"text":"treat_as_obstacle","type":"text","marks":[{"type":"code"}]},{"text":" is enabled, then the following keys are mutually exclusive to specify the behavior of the deactivated robot:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":": An array of floats specifying the angle for each joint of the robot. If the robot’s preset includes user defined joints, they must be provided as well, sorted by the driver index.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"target_name","type":"text","marks":[{"type":"code"}]},{"text":": A string specifying the name of the target that the robot will be positioned at. A user is also able to update a deactivated robot position using DeactivateRobot command with a new target specified by ","type":"text"},{"text":"target_name: ","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"treat_as_obstacle: True","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"use_last_known_config","type":"text","marks":[{"type":"code"}]},{"text":": Default option. A boolean flag that specifies the last known joint configuration of the robot should be used. A robot must have been Connected at least once for there to be known joint angles. These values are saved to disk, so on project reload, this option can still be used.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command ‘deactivates’ a robot which means the RTR controller will ignore it when connecting to the robots within a project. Subsequent ","type":"text"},{"text":"Connect","type":"text","marks":[{"type":"code"}]},{"text":" commands will only connect to activated robots, and when in Operation mode, only the activated robots will be controlled by RTR. In order to prevent collisions, the deactivated robots can be configured for collision checking by setting the appropriate preset and joint angles. Optionally, the robot can be ignored during collision checking if it is not present in the workcell.","type":"text"},{"type":"hardBreak"},{"text":"This command must be called when the controller is in CONFIG mode.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: DeactivateRobot, data: {robot_name: Robot2}}\n{topic: DeactivateRobot, data: {robot_name: Robot2, preset_name: gripper_open, treat_as_obstacle: true, use_last_known_config: true}}\n{topic: DeactivateRobot, data: {robot_name: Robot2, project_name: Project1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: DeactivateRobot,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"DeactivateRobot,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Connect","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"e7860851-d1b5-43ae-9be7-949ef50f0609"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Connect,data: {robot_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"2047862a-53bc-4fd7-89ff-399c885123f4"}},{"text":" Specify which robot should be connected to. If not passed, all active robots in the project will be connected.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command connects to all active robots in the loaded project, or optionally a single robot. After this command executes, the Realtime Controller will begin monitoring the position of the robot/s.","type":"text"}]},{"type":"paragraph","content":[{"text":"This command should normally be called near the beginning of a robot program, before attempting to make any Move commands. If the robot/s have already been connected, this command will return successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Connect}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Connect,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"Connect,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Disconnect","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"3ba6e235-c769-4174-b847-fda8b20c35a8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Disconnect,data: {robot_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"749f0593-3b7a-4e47-988f-30db0917d3fd"}},{"text":" The specific robot to disconnect from.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command disconnects from all robots in the project (unless a robot is specified) and returns them to the ","type":"text"},{"text":"Initialized","type":"text","marks":[{"type":"code"}]},{"text":" status. Disconnect can only be called successfully when in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"},{"type":"hardBreak"},{"text":"This command is useful for saving time by keeping the project loaded on the controller while allowing the robots to perform tasks independent of Realtime control like rebooting.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Disconnect}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Disconnect,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"Disconnect,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AcquireControl","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"228e3b82-6a18-483c-bcf1-5d7534a249f6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AcquireControl,data: {robot_name: ,preset_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot to acquire control of.","type":"text"},{"type":"hardBreak"},{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"ec65dd3a-adba-453a-8557-831961c7f029"}},{"text":" Switches the active robot preset when acquiring control.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command allows the user to signal that they are done with an operation that required RTR to release external control of the robot, and the Realtime Controller should resume control, with the last active robot preset or a specified preset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AcquireControl,data: {robot_name: robot_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AcquireControl,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"AcquireControl,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ReleaseControl","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"c90f1bd9-58e9-4889-8e2e-2ef28e5a4687"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ReleaseControl,data: {robot_name: ,preset_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot to release control of.","type":"text"},{"type":"hardBreak"},{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"638975e5-0abd-453a-a3df-560edd49a530"}},{"text":" Switches the active robot preset when releasing control.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command is intended to enable the user to take temporary control of the robot to get/set IOs, or execute a portion of their robot program that is not suitable for RTR control at this point. This may be gluing, welding, or some other time-dependent, sensitive process. ","type":"text"},{"type":"hardBreak"},{"text":"While a robot is in ","type":"text"},{"text":"Released","type":"text","marks":[{"type":"strong"}]},{"text":" mode, the rest of the Realtime Controller system will use the last known joint state of the paused robot as an obstacle, and will use the robot preset that was active (or optionally set) when that call was made. ","type":"text"},{"type":"hardBreak"},{"text":"After completing the desired operation, the user should call ","type":"text"},{"text":"AcquireControl","type":"text","marks":[{"type":"strong"}]},{"text":". Until that call, the robot will not accept any Move commands from this API.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ReleaseControl,data: {robot_name: robot_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: ReleaseControl,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"ReleaseControl,0","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetMaxLinearAcceleration","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"12065634-1d90-4b6c-b601-418f10d03ade"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearAcceleration,data: {robot_name: ,max_accel: }}\n{topic: SetMaxLinearAcceleration,data: {robot_name: ,reset: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot this command is for.","type":"text"},{"type":"hardBreak"},{"text":"max_accel","type":"text","marks":[{"type":"code"}]},{"text":": A value from 1mm/s^2 to 10,000,000mm/s^2 that defines the maximum acceleration allowed for the specified robot. The clients active units will be used, or the default units of mm/s^2.","type":"text"}]},{"type":"paragraph","content":[{"text":"reset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"9cbee1c0-70bc-4e18-a0a2-44997c86fa5f"}},{"text":" A boolean flag that indicates the Linear Acceleration limits should be reset to the default values. The only accepted value for this flag is one that evaluates to True. Note: if ","type":"text"},{"text":"max_accel","type":"text","marks":[{"type":"code"}]},{"text":" is also provided, its value will be ignored, and the acceleration limits will be reset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"paragraph","content":[{"text":"This command limits the linear acceleration of a robots TCP. A user can specify the max acceleration allowed for a robot using this command, or reset to the default value using the ","type":"text"},{"text":"reset","type":"text","marks":[{"type":"code"}]},{"text":" flag. This command can only be sent when the specified robot is stationary, and all subsequent motions will adhere to the provided limit.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearAcceleration,data: {robot_name: robot_1,max_accel: 10000}}\n{topic: SetMaxLinearAcceleration,data: {robot_name: robot_1,reset: True}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearAcceleration,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[820.0]},"content":[{"type":"codeBlock","content":[{"text":"SetMaxLinearAcceleration,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetMaxLinearSpeed","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"b2d47747-fc2c-4251-a796-f1cd9237333a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearSpeed,data: {robot_name: ,max_speed: }}\n{topic: SetMaxLinearSpeed,data: {robot_name: ,reset: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot this command is for.","type":"text"},{"type":"hardBreak"},{"text":"max_speed","type":"text","marks":[{"type":"code"}]},{"text":": A value from 0.1mm/s to 100,000mm/s that defines the max linear speed allowed for a specified robots TCP. The clients active units will be used, or the default units of mm/s.","type":"text"}]},{"type":"paragraph","content":[{"text":"reset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"5993fcf7-795f-4633-a5a4-450d6ab33721"}},{"text":" A boolean flag that indicates the Linear Acceleration limits should be reset to the default values. The only accepted value for this flag is one that evaluates to True. Note: if ","type":"text"},{"text":"max_accel","type":"text","marks":[{"type":"code"}]},{"text":" is also provided, its value will be ignored, and the acceleration limits will be reset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"paragraph","content":[{"text":"This command limits the max linear speed of a specified robot. In following move commands, the speed parameter will move the robot at a percent of this specified speed. For example, if this command is called and ","type":"text"},{"text":"500","type":"text","marks":[{"type":"code"}]},{"text":" (in mm/s) is passed for the ","type":"text"},{"text":"max_speed","type":"text","marks":[{"type":"code"}]},{"text":" parameter, a move command with a ","type":"text"},{"text":"speed","type":"text","marks":[{"type":"code"}]},{"text":" parameter of ","type":"text"},{"text":"0.5","type":"text","marks":[{"type":"code"}]},{"text":" will move the robot at up to 250mm/s.","type":"text"}]},{"type":"paragraph","content":[{"text":"A user can specify the max linear speed allowed for a robot using this command, or reset to the default value using the ","type":"text"},{"text":"reset","type":"text","marks":[{"type":"code"}]},{"text":" flag. ","type":"text"}]},{"type":"paragraph","content":[{"text":"This command can only be sent when the specified robot is stationary, and all subsequent motions will adhere to the provided limit.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearSpeed,data: {robot_name: robot_1,max_speed: 500}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetMaxLinearSpeed,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[138.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[822.0]},"content":[{"type":"codeBlock","content":[{"text":"SetMaxLinearSpeed,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetAlternateLocation","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"fc1ef17c-a33a-4a81-8d0c-27d2b5a3bf4b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetAlternateLocation,data: {robot_name: ,enabled: ,target_name: ,complete_move: , timeout: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": This indicates which robot this call pertains to .","type":"text"},{"type":"hardBreak"},{"text":"enabled","type":"text","marks":[{"type":"code"}]},{"text":": Accepts 0 to disable alternate behavior or 1 to enable alternate behavior at the specified goal. If ","type":"text"},{"text":"enabled","type":"text","marks":[{"type":"code"}]},{"text":" is being set to ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":", no other arguments are required.","type":"text"}]},{"type":"paragraph","content":[{"text":"complete_move","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" Default value is ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":". This Boolean specifies if the robot should continuously try to plan a motion to the original goal after it has successfully moved to the alternate location. If true, a robot for which a move timed out will first move to the alternate location. If this alternate move is successful it will continuously try to plan a motion from the alternate location to the original move request location. If False, a robot for which a move timed out will move to the alternate location and wait there for the next command.","type":"text"}]},{"type":"paragraph","content":[{"text":"mode","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" Specifies what the robot should do if the original motion fails.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0: Default behavior. Move to a different, specified, position. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1: Partial Execution. If this option is selected, the robot will move along its path as far as it can before a robot-based obstruction is present. If the obstruction is removed before deceleration, the robot will not stop at this point and continue smoothly towards the goal. If the obstruction is still present, the robot will come to a stop and automatically resume motion when the robot-based obstruction is removed. This behavior does not trigger for static-obstacle obstructions. When Partial Execution is enabled, ","type":"text"},{"text":"complete_move","type":"text","marks":[{"type":"code"}]},{"text":" is always set to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"goal","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" If ","type":"text"},{"text":"mode","type":"text","marks":[{"type":"code"}]},{"text":" is set to 0, this argument specifies the position that will act as the alternate position for the specified robot. Goal is a placeholder, and the actual key value pair would correspond to the acceptable positions which are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"target_name: ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pose: [x,y,z,r,p,y]","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"timeout","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" -1 or 0.05 to 1000. Default value is -1. A value of -1 indicates infinite time. Otherwise, this value specifies the time a robot waits for the next move.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command is used to enable and set the behavior of a robot in case its original move has timed out. With this feature enabled, in the event a Move command fails or is interrupted, the Realtime Controller will not return a response code immediately, and will instead automatically plan to the specified alternate position. Depending on the behavior of complete move the Realtime Controller will either return a response Error code indicating the robot reached the alternate location, or continue to plan to the location that was first specified in the move command.","type":"text"},{"type":"hardBreak"},{"text":"Only one target can be set as the alternate location, so if that target does not exist in all of the robots presets, when a preset it changed, the alternate location should be updated.","type":"text"},{"type":"hardBreak"},{"text":"Enabling the alternate location behavior changes the way a robot will execute a move, therefore a ","type":"text"},{"text":"SetAlternateLocation","type":"text","marks":[{"type":"code"}]},{"text":" command can only be sent while a robot is stationary and while the Realtime Controller is in either ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"OPERATION","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"},{"type":"hardBreak"},{"text":"When this behavior is enabled, the robot will execute motions using the same parameters as the original move. For example, if a move is sent using ","type":"text"},{"text":"move_type: roadmap","type":"text","marks":[{"type":"code"}]},{"text":" then the robot will make a roadmap move to the alternate location. If the original move is a ","type":"text"},{"text":"move_type: direct","type":"text","marks":[{"type":"code"}]},{"text":" then a direct move will be made to the alternate location.","type":"text"},{"type":"hardBreak"},{"text":"When partial execution is enabled (","type":"text"},{"text":"mode: 1","type":"text","marks":[{"type":"code"}]},{"text":") or the default behavior (","type":"text"},{"text":"mode: 0","type":"text","marks":[{"type":"code"}]},{"text":") with complete move enabled, the timeout value is used.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"// To enable an alternate position for the robot to move to in the event the original move fails\n{topic: SetAlternateLocation,data: {robot_name: robot_1,enabled: 1,target_name: pounce, complete_move: 1}}\n\n// To enable the partial move behavior where a robot will move as far as it can and then wait until the path is free\n{topic: SetAlternateLocation,data: {robot_name: robot_1,enabled: 1,mode: 1}}\n\n// To disable any alternate location behavior\n{topic: SetAlternateLocation,data: {robot_name: robot_1,enabled: 0}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetAlternateLocation,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"SetAlternateLocation,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetInterruptBehavior","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"92c62abb-3530-44b6-89ed-e3ec58880c59"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetInterruptBehavior,data: {robot_name: , timeout: , max_replans: }","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": This indicates which robot this call pertains to. ","type":"text"}]},{"type":"paragraph","content":[{"text":"timeout","type":"text","marks":[{"type":"code"}]},{"text":": -1 or 0.05 to 1000.0. This indicates how long the Realtime Controller should continue trying to find a path if one cannot currently be found. A value of -1 indicates an infinite timeout. Otherwise, any non-zero floating point value specifies the time (in seconds) before a timeout response is sent. ","type":"text"},{"type":"hardBreak"},{"text":"max_replans","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"OPTIONAL","localId":"60676ac9-c588-448f-b18c-a2d0cf0fcb2e"}},{"text":" -1 or 0 to 1000. Default value of -1. This parameter specifies how many times a robot will attempt to find a path to the goal if it is blocked or interrupted during its motion. A value of 0 indicates the robot should not attempt to replan if blocked, a value of N indicates that the robot should attempt to replan a maximum of N times before returning failure, and -1 indicates an infinite number of replan attempts.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This function should be invoked towards the beginning of a robot program. It sets the behavior for the robot with respect to replanning and timeout behavior. This function must be called when a project is already loaded. If this function is not called, the default behavior for a project will be: ","type":"text"},{"text":"timeout","type":"text","marks":[{"type":"code"}]},{"text":" = 0 and ","type":"text"},{"text":"max_replans","type":"text","marks":[{"type":"code"}]},{"text":"=-1. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetInterruptBehavior,data: {robot_name: robot_1,timeout: 5}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetInterruptBehavior,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"SetInterruptBehavior,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetRobotPreset","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"f27d2335-f7b2-4b2b-b42a-654d1ac4a7b3"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetRobotPreset,data: {robot_name: ,preset_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot this command is for.","type":"text"},{"type":"hardBreak"},{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which preset to switch to as defined in RPC.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command changes the active robot preset for a specific robot. When a preset is changed, current robot motions are not re-validated, but new Move commands will respect the new active preset. ","type":"text"}]},{"type":"paragraph","content":[{"text":"A robot must be stationary in order to call this command explicitly. SetRobotPreset commands will be rejected if sent between a user issuing move request to the RTR controller, and the final response being sent from the RTR controller to the user for a given bot . If a preset change is needed, it can be accomplished using the preset_name key within a queued move or combined move request. In the case of switching presets using the preset_name key, there is a requirement that changes in preset during queued moves or CombinedMoves must not change the TCP or the controllable axes. This requirement is in effect if there are any current motions that the user has issued to RTR, that RTR has not yet returned the final API response to the user.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the new preset has a different number of controlled axes than the current preset, ReleaseControl must be called for that robot prior to the SetRobotPreset command. Once the preset change has succeeded, AcquireControl can be called again.","type":"text"}]},{"type":"paragraph","content":[{"text":"When called, the selected preset is stored to disk so upon project reload, the last active preset will be used.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetRobotPreset,data: {robot_name: robot_1,preset_name: open_gripper}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetRobotPreset,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"SetRobotPreset,0","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetRobotPresets","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"8d962193-6694-46c1-8b72-228a82e7edc2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetRobotPresets, data: {robot_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the name of the robot to return the presets for.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response with a comma separated array of the robot preset names (","type":"text"},{"text":"preset_names","type":"text","marks":[{"type":"code"}]},{"text":") and the active preset name (","type":"text"},{"text":"active_preset","type":"text","marks":[{"type":"code"}]},{"text":"). ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"active_preset","type":"text","marks":[{"type":"code"}]},{"text":": This response will return the name of the active robot preset.","type":"text"}]},{"type":"paragraph","content":[{"text":"robot_presets","type":"text","marks":[{"type":"code"}]},{"text":": This response will return the names of all presets from the same robot.","type":"text"}]},{"type":"paragraph","content":[{"text":"For CSV responses, after the acknowledgement codes, i.e., ","type":"text"},{"text":"GetRobotPresets, 0","type":"text","marks":[{"type":"code"}]},{"text":", the response code will return with the name of the active preset, followed by the number of the robot presets, and then followed by the name of each robot preset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetRobotPresetsdata: {robot_name: Robot1}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetRobotPresets,type: Response,data: {active_preset: preset1, robot_presets:[preset1, preset2]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"GetRobotPresets,0, preset1, 2, preset1, preset2","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Queueing Moves","type":"text"}]},{"type":"paragraph","content":[{"text":"Move commands can be sent to a robot before its current motion has finished. The new ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" request will be added to the queue for the specified robot to be executed as soon as its current motion finishes.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only ","type":"text"},{"text":"Direct","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"Roadmap","type":"text","marks":[{"type":"code"}]},{"text":" move types can be added to the queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A maximum of 100 moves can be added to the queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If received in time, the robot will smooth its current motion into the next in the queue using its smoothing argument.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The move queue for a given robot is cleared when:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A Move fails","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A Move is cancelled","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"While a robot is executing a motion, the next move in the queue is planned","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A robot reserves the swept volume of its current motion and the next move in the queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A Move is only added to the queue, if a path could be found.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Initial responses will be sent for move requests when planning has finished.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delayed responses will be sent when queued move segments terminate (due to completion, cancelling, or interruption).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Canceling a robot’s motion with ","type":"text"},{"text":"CancelMove","type":"text","marks":[{"type":"code"}]},{"text":" will clear the move queue and cancel all moves simultaneously. The delayed responses of these moves are not guaranteed to be in queue order.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Queued motions will use the interrupt settings when planning in the background.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Queued motions will use the alternate location, if enabled.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A robot’s preset can be changed when Moves are queued. The number of controlled axes shall stay the same. The robot TCP could change when a robot’s preset switches in the queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It is highly recommended to include ","type":"text"},{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":" in every queued Move command in case a robot’s preset switches in the queue.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Smoothing is supported in queued moves. If the new motion is received in time, the robot will use the current motions smoothing value to blend into the new motion.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Move","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"5dc45aa7-bd8b-46eb-9e0e-286b886bb626"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Move,data: {robot_name: ,goal: ,speed: ,move_type: ,smoothing: ,interp: ,collision_check: ,collision_check_dsm: ,timeout: ,relative: ,ref_frame: ,preset_name: , trigger: {name: , output: , time: }, external_axes: {: active, : }, costs: {external_axis: , path_length: , via_points: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot controlled by the ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"goal","type":"text","marks":[{"type":"code"}]},{"text":": Where the robot will move to, either a target or pose or joint configuration. Goal is a placeholder key, and the acceptable keys are either ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"target","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":". The ","type":"text"},{"text":"target","type":"text","marks":[{"type":"code"}]},{"text":" value can be a named target. The goal may include external axes that are specified as part of a named target or a joint configuration, or as ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" of a pose move. Unless the external axes value is provided as an argument in ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":", external axes will either remain fixed during a move, or switch to different setpoint values defined by roadmap moves. Valid key values are as following, ","type":"text"},{"text":"pose: [x,y,z,r,p,y]","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"target: target_name","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"joint_config: [j1, j2, j3, j4, j5, j6] ","type":"text","marks":[{"type":"code"}]},{"text":" to move robot native joints, or ","type":"text"},{"text":"[j1, j2, j3, j4, j5, j6, j7, j8...]","type":"text","marks":[{"type":"code"}]},{"text":" to move robot pose + external joints. ","type":"text"}]},{"type":"paragraph","content":[{"text":"speed","type":"text","marks":[{"type":"code"}]},{"text":": The speed at which the robot will move on a scale from 0.01 to 1.0. This scales max velocity but not acceleration or jerk. ","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"move_type","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" The type of move the robot will make. Either direct, roadmap, or planning. Default move type is a roadmap move. The arguments are case insensitive or can use the assigned numeric value.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"direct","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"roadmap","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"planning","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"smoothing","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" A value from 0.0 mm to 500 mm indicating how far from a node the robot should attempt to begin smoothing its trajectory. Default value is 0.0 mm.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"interp","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" Specifies the interpolation type for the robot when making a direct move, or any time it must leave the roadmap. Use the case insensitive string, or its integer equivalent to specify joint or linear interpolation. This parameter does not apply to a planning move. Default is joint space interpolation.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"J","type":"text","marks":[{"type":"code"}]},{"text":" (default)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"L","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"collision_check","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This flag overrides collision checking against the static scene for ","type":"text"},{"text":"Direct","type":"text","marks":[{"type":"code"}]},{"text":" move types. Robot to robot collisions will always be checked regardless of this flag, but robot self collisions will not be checked. A value of ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" specifies collisions should be checked, and a value of ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" specifies collisions will not be checked. Default value is ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"collision_check_dsm","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This flag overrides collision checking against the dynamic scene model for ","type":"text"},{"text":"Direct","type":"text","marks":[{"type":"code"}]},{"text":" move types. A value of ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" specifies collisions should be checked, and a value of ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" specifies collisions will not be checked. Default value is ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"timeout","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This timeout only applies to ","type":"text"},{"text":"planning","type":"text","marks":[{"type":"code"}]},{"text":" move types when the interrupt behavior is not applicable. This value is the amount of time given to plan a path to the specified goal, in seconds. If not provided, the default value is 10 seconds. The minimum value is 0.01 seconds and the maximum value is 120.0 seconds.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"relative","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" A boolean flag indicating that a ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":" move should be performed relative to the last commanded robot pose or joint configuration. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". All move types are supported when using the relative flag. A reference frame name, ","type":"text"},{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":", can be specified as well for the pose to be in. ","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"relative","type":"text","marks":[{"type":"code"}]},{"text":" move can be performed on all robot joints and external axes if it’s a ","type":"text"},{"text":"direct","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":" or a ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" move. A full joint configuration including external axes, e.g., ","type":"text"},{"text":"[j1, j2, j3, j4, j5, j6, j7, j8...]","type":"text","marks":[{"type":"code"}]},{"text":", or, a full pose including external axes, e.g., ","type":"text"},{"text":"pose: [0,0,0,0,0,0], external_axes: {rail: 50}}","type":"text","marks":[{"type":"code"}]},{"text":", should be given to specify a relative direct move. Multi-axis relatives are supported.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" The name of a frame in the RPC project that should be used as a reference for ","type":"text"},{"text":"relative","type":"text","marks":[{"type":"code"}]},{"text":" moves. The default reference frame is ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument specifies which preset the robot should switch to before executing the motion. Including this argument has the same effect as calling ","type":"text"},{"text":"SetRobotPreset","type":"text","marks":[{"type":"code"}]},{"text":" before the ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command. If included, the robot cannot have any moves in its queue with a different TCP or number of controlled axes.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument, including all the related parameters that are defined within this argument, specifies the names of the external axes, the external axes position values for a ","type":"text"},{"text":"direct","type":"text","marks":[{"type":"code"}]},{"text":" move or a ","type":"text"},{"text":"roadmap","type":"text","marks":[{"type":"code"}]},{"text":" move to a goal ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If a robot's external axes remain fixed during a move, or switch to different setpoint values defined by a target, ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" should be left unspecified. ","type":"text"}]},{"type":"paragraph","content":[{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" argument is not used when the ","type":"text"},{"text":"goal","type":"text","marks":[{"type":"code"}]},{"text":" type is ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":", because ","type":"text"},{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":" could include all robot native joints and external axes values. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Robot pose value plus ","type":"text"},{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" can be used for relative direct pose moves.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"external_axes","type":"text","marks":[{"type":"code"}]},{"text":" is defined as {: ","type":"text"},{"text":"active","type":"text","marks":[{"type":"code"}]},{"text":"} or {: }. The names of the external axes must match what is already defined in the RapidPlan Create project.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"use {: ","type":"text"},{"text":"active","type":"text","marks":[{"type":"code"}]},{"text":"} if an external axis is used by RapidPlan software when solving a move to a goal pose.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"use {: } if an external axis is used for a move to a goal pose with a specific external axis position value.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"shortest_path_only","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" for roadmap moves only, this optional argument only allows the robot use what would be the shortest path through the roadmap. If that path isn’t available, robot would wait, or use partial moves settings if that option is specified.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"costs","type":"text","marks":[{"type":"code"}]},{"text":" : ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" for planning moves only, this argument defines the cost penalty values of the individual cost terms. At least one cost term is required for the ","type":"text"},{"text":"costs","type":"text","marks":[{"type":"code"}]},{"text":" argument.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The combined value of ","type":"text"},{"text":"external_axis","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"paths_cost","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"waypoints_cost","type":"text","marks":[{"type":"code"}]},{"text":"should be = 1.0.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"external_axis","type":"text","marks":[{"type":"code"}]},{"text":" : ","type":"text"},{"text":"[ OPTIONAL ] ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"how much external axes motions are penalized. The default value is 0.0, which puts no penalty on using the external axes. The range of this float-point value is between 0.0 and 1.0.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"path_length","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ] ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"this argument defines the cost penalty value for a planning move using the shortest path. The range of the value is between 0.0 and 1.0.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"via_points","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ] ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"this argument defines the cost penalty value for a planning move using the fewest via points (waypoints). The range of the value is between 0.0 and 1.0.","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"trigger","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument, including all the related parameters that are defined within this object, specifies an output based on the timing of a move or a move segment of a combined move. ","type":"text"},{"text":"trigger","type":"text","marks":[{"type":"code"}]},{"text":" is an object with 3 fields: ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"code"}]},{"text":": Only one trigger can be included for each move command, or each move segment of a combined move command. The trigger should have a user defined, stateless, globally unique name, to identify the signal for the receiver of the trigger.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"output","type":"text","marks":[{"type":"code"}]},{"text":": The trigger output should be configured during runtime as part of a move command, to turn on or off the output signal as an 1-shot event, until the signal is overridden by either another API command. If the output key is not specified, this trigger is disabled and trigger ","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":" is ignored. If ","type":"text"},{"text":"output","type":"text","marks":[{"type":"code"}]},{"text":" is specified, trigger ","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":" must be defined and cannot be omitted.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"false:","type":"text","marks":[{"type":"code"}]},{"text":" output is off","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"true:","type":"text","marks":[{"type":"code"}]},{"text":" output is on","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the timing of the output, i.e. the time before the target position is reached, or after the move has started. The unit is in seconds and whose absolute value must be greater than ","type":"text"},{"text":"0.1","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":" must be a none-zero value, and should always be >= 0.1 or <= -0.1. The move command will return an error code if 0.1 < ","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":" < 0.1.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A positive value ( ","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":">=0.1) indicates the time after the move starts, ie., a \"time-after trigger\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A negative value (","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":"<=-0.1) indicates the time before reaching the goal, ie., a “time-before trigger”.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"time","type":"text","marks":[{"type":"code"}]},{"text":" is longer than the actual move time, a time-after trigger will turn on when reaching the goal, a time-before trigger will turn on when the move starts. The MoveFeedback response message for the trigger will arrive before the MoveResult message for the move.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If alternate location is used(","type":"text"},{"text":"mode","type":"text","marks":[{"type":"code"}]},{"text":"=0 in ","type":"text"},{"text":"SetAlternateLocation","type":"text","marks":[{"type":"code"}]},{"text":"), and if ","type":"text"},{"text":"complete_move","type":"text","marks":[{"type":"code"}]},{"text":" = true:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only time-after triggers will apply to the move to the alternate location, time-before triggers will take no effect.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only time-before triggers will apply to the move to the goal, time-after triggers will take no effect.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If alternate location is used(","type":"text"},{"text":"mode","type":"text","marks":[{"type":"code"}]},{"text":"=0 in ","type":"text"},{"text":"SetAlternateLocation","type":"text","marks":[{"type":"code"}]},{"text":"), and if ","type":"text"},{"text":"complete_move","type":"text","marks":[{"type":"code"}]},{"text":" = false:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Only time-after triggers will apply to the move to the alternate location, time-before triggers will take no effect.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A trigger will not be re-activated if a Move command is issued when the robot is already at the goal position.","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"With this new generic ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command and the key value syntax, you can specify any of the former Blind Moves, MoveToXXX, and OffroadtoXXX commands with this one command.","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"direct","type":"text","marks":[{"type":"code"}]},{"text":" move moves the robot directly from its current position to its goal position with a given interpolation type. This command is efficient, but can easily be blocked by other robots. It is very useful for final motions, especially if collision checking needs to be disabled.","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"roadmap","type":"text","marks":[{"type":"code"}]},{"text":" move will follow the edges defined in the RPC project. This is expected to be the most common move type since the robots will use the roadmap to dynamically avoid obstacles. If pose is specified, and there is no target in the roadmap as that pose, the robot will leave the roadmap to reach the actual pose. The offroadmap portion will be collision checked, and will use the interpolation type specified (or joint interpolation by default).","type":"text"}]},{"type":"paragraph","content":[{"text":"A ","type":"text"},{"text":"planning","type":"text","marks":[{"type":"code"}]},{"text":" move calculates a path for the robot at runtime to reach the goal. This is primarily used to put a robot on the roadmap in the beginning of a task. When called, the requested robot must not be executing any current requests, otherwise it will immediately return an error. If any other robots are currently executing move requests when a planning move request is called, the robot attempting the planning move will be blocked with an Error code. If no collision free path to the goal can be found, the server will return an error by the end of the given timeout period.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"When a Move request is received, path planning occurs before a response is sent. If a path is found, this command will return a response code to acknowledge the command has been received, the name of the robot that this move is for, and a unique sequence ID for this specific move. If planning fails, an appropriate error code will be returned, and no delayed response will be sent.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: Move,type: Response,data: {robot_name: ,seq: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"If a path was found, the system will send a ","type":"text"},{"text":"MoveResult","type":"text","marks":[{"type":"code"}]},{"text":" message along with a response code to indicate when the move completes. The name of the robot that the move was for, and the unique sequence ID for that move will be returned in the message. If the move is interrupted, the delayed response will contain an appropriate error code.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: Move,type: DelayedResponse,data: {robot_name: ,seq: }}","type":"text"}]},{"type":"paragraph","content":[{"text":"or, for a ","type":"text"},{"text":"trigger","type":"text","marks":[{"type":"code"}]},{"text":" a feedback response will be sent to indicate that trigger ","type":"text"},{"text":"output","type":"text","marks":[{"type":"code"}]},{"text":" is activated to on, or off. The trigger feedback responses will include the same ","type":"text"},{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" as the ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" it is a part of.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: Move,type: Feedback, data: {robot_name: ,seq: , trigger: {name: , output: }}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Move,data: {robot_name: robot_1,move_type: roadmap,target: pre_pick,speed: 1.0,smoothing: 1, trigger: {name: output_1, output: 1, time: -0.5}}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Move,type: Response,data: {robot_name: robot_1,seq: 312}}\n... move executes ...\n{topic: Move, type: Feedback, data: {robot_name: robot_1, seq: 312, trigger: {name: output_1, output: 1}}\n... 0.5s\n{topic: Move,type: DelayedResponse,data: {robot_name: robot_1, seq: 312}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"Move,0,robot_1,312\n... move executes ...\nMoveFeedback,0,robot_1,312,Output_1,1\n... 0.5s\nMoveResult,0,robot_1,312","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CombinedMove","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"3c6af5b1-6020-4700-9076-9c6810c0eae0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CombinedMove, data: {robot_name: , preset_name: , moves: [{move_type: , goal: , speed: ...},{move_type: , goal: , speed: ...}, ... ,{move_type: , goal: , speed: ...},...]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The robot that this combined move is for. A combined move, can only included motions for one robot, and therefoer the ","type":"text"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":" key from the individual move commands can be omitted. If the ","type":"text"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":" is included in the individual ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" commands, it will be ignored.","type":"text"}]},{"type":"paragraph","content":[{"text":"moves","type":"text","marks":[{"type":"code"}]},{"text":": An array of up to 10 Move commands to be concatenated together. The move commands can only be ","type":"text"},{"text":"direct","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"roadmap","type":"text","marks":[{"type":"code"}]},{"text":" move types, and must adhere to the ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command specification. However, redundant keys from the ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command can optionally be omitted, since they are arguments of the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"f49d1855-92ce-45ec-ad1e-10130eae6b2e"}},{"text":" This optional argument specifies which preset the robot should switch to before executing the combined move. All moves will then execute using this preset. Including this argument acts exactly like calling ","type":"text"},{"text":"SetRobotPreset","type":"text","marks":[{"type":"code"}]},{"text":" before the combined move. This argument provides the default preset which is used for all move segments. If this argument is not included, then each move segment in the move array must specify the preset that should be used for that move segment. Each move can use a different preset provided the TCP or number of controlled axes do not change.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" allows multiple move commands to be executed as if it was one motion, and the individual segments can optionally be blended together to maintain a higher velocity.","type":"text"}]},{"type":"paragraph","content":[{"text":"The smoothing argument of each individual move command will specify if it will blend into the next move in the list, and at what distance from the end of the current move.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the event a ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" is interrupted, an error will be returned in the delayed response. In order to resume the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" from its current position, it is expected that the user maintains a list of the completed individual moves and then send a new ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" with the moves that didn’t complete.","type":"text"}]},{"type":"paragraph","content":[{"text":"If move queuing is being used, a ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" can be added to the queue just like any other move.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return an initial response to indicate that the command has been processed and a collision free path has been found for all moves, smoothing included. A unique sequence number will be included to identify the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" responses. When a move in the sequence is completed, a Feedback response will be returned, and upon completion of the full move sequence, additionally a DelayedResponse will be send.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: CombinedMove,type: Response,data: {robot_name: , seq: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"For every ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" in the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" a feedback response will be sent to indicate that segment has completed. The feedback responses will include the same ","type":"text"},{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" as the ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" they are a part of, as well as a zero index ","type":"text"},{"text":"index","type":"text","marks":[{"type":"code"}]},{"text":" key to identify which segment the move result is for.","type":"text"}]},{"type":"paragraph","content":[{"text":"If a trigger output is specified for a move segment, a feedback message will be sent as soon as the trigger output is activated to on or off. Different segments of the same ","type":"text"},{"text":"CombinedMove","type":"text","marks":[{"type":"code"}]},{"text":" command are allowed to re-use the same trigger name, if the same trigger needs to be updated for each move segment. The feedback message contains the ","type":"text"},{"text":"seq","type":"text","marks":[{"type":"code"}]},{"text":" value but no ","type":"text"},{"text":"index","type":"text","marks":[{"type":"code"}]},{"text":" value.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{topic: CombinedMove,type: Feedback,data: {robot_name: , seq: , index: }}\n... additional Move DelayedResults ...\n{topic: CombinedMove,type: DelayedResponse,data: {robot_name: , seq: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{\n topic: CombinedMove,\n data: {\n robot_name: robot_1,\n moves: [\n {move_type: roadmap,target: staging,speed: 1.0,smoothing: 0.25, trigger: {name: output_1, output: 1, time: -0.5}},\n {move_type: roadmap,target: pre_pick,speed: 1.0,smoothing: 0.1, trigger: {name: output_1, output: 0, time: -0.5}},\n {move_type: direct,pose: [0,0.5,0,0,180,0],speed: 1.0,smoothing: 0.0}\n ]\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"Note: the new line (\\n) and tab (\\t) characters have been added for readability, the actual request format does not include them.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CombinedMove, type: Response, data: {robot_name: robot_1, seq: 61}}\n{topic: CombinedMove, type: Feedback, data: {robot_name: robot_1, seq: 61, index: 0}}\n{topic: Move, type: Feedback, data: {robot_name: robot_1, seq: 61, trigger: {name: output_1, output: 1}}\n{topic: CombinedMove, type: Feedback, data: {robot_name: robot_1, seq: 61, index: 1}}\n{topic: Move, type: Feedback, data: {robot_name: robot_1, seq: 61, trigger: {name: output_1, output: 0}}\n{topic: CombinedMove, type: Feedback, data: {robot_name: robot_1, seq: 61, index: 2}}\n{topic: CombinedMove, type: DelayedResponse, data: {robot_name: robot_1, seq: 61}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"CombinedMove,0,Robot1,61\nCombinedMoveFeedback,0,Robot1,61,0\nCombinedMoveFeedback,0,robot_1,61,output_1,1\nCombinedMoveFeedback,0,Robot1,61,1\nCombinedMoveFeedback,0,robot_1,61,output_1,0\nCombinedMoveFeedback,0,Robot1,61,2\nCombinedMoveResult,0,Robot1,61","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CancelMove","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"71f6fbde-da3c-48b3-b163-5cd2d37ab0b4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CancelMove,data: {robot_name: , acceleration_factor: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the robot for which a move is being canceled.","type":"text"},{"type":"hardBreak"},{"text":"acceleration_factor","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" : The acceleration factor at which the robot will move on a scale from 0.5(50%) to 1.0(100%), when the move is being canceled. The default value is 0.8.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This function tells the Realtime Controller to abort planning and motion for the specified robot. After calling this, a robot may be left in an off roadmap location and will require a planning move command.","type":"text"},{"type":"hardBreak"},{"text":"This command is only accepted when the RTR Controller is in ","type":"text"},{"text":"OPERATION","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"},{"type":"hardBreak"},{"text":"If a series of ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" commands are queued for the robot in question, they will all be canceled simultaneously. The delayed responses of these commands are not guaranteed to be in queue order.","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"CancelMove","type":"text","marks":[{"type":"code"}]},{"text":" is called before planning is finished for a ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command, robot preset of the canceled move will still be applied because the preset had changed before planning started. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If a move is canceled mid-motion after a ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" command which also sets the robot preset, the robot preset will be maintained.|","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CancelMove,data: {robot_name: robot_1, acceleration_factor: 0.9}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CancelMove,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"CancelMove,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetTargets","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"43a4209f-f00c-4e32-801b-aa498335db40"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTargets,data: {robot_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot’s targets will be returned.","type":"text"}]},{"type":"paragraph","content":[{"text":"preset_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"d79f72df-2733-4dc6-8535-03a025678c2b"}},{"text":" Specifies which preset’s targets to return. Default is the active robot preset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the targets for a given robot in a specific preset in the loaded project. The default behavior is to return the targets in the active robot preset, but a different preset can be specified.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by a comma separated array of the target names.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTargets,data: {robot_name: robot_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTargets,type: Response,data: {targets:[weld_1,weld_2,weld_3]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"GetTargets,0,3,weld_1,weld_2,weld_3","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"CreateTarget","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"e0c8f6a8-1fdc-4fc0-acec-4af681a56921"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CreateTarget,data: {target_name: ,robot_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"target_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the name of the new target to be created.","type":"text"},{"type":"hardBreak"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": This indicates which robot will be assigned to the new target.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command creates a target in the active robot preset for the specified robot. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The target is created using the robot’s current joint angles. To ensure consistent joint angle readings, the robot must stay stationary while the target is created. Therefore, the controller must be in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode and the robot state must be connected.","type":"text"}]},{"type":"paragraph","content":[{"text":"No connections will be created automatically for the new target.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return an acknowledgement with a status code indicating the command was received and executed. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CreateTarget,data: {target_name: weld5,robot_name: robot_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: CreateTarget,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"CreateTarget,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"UpdateTarget","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"1751909b-98b0-4784-8766-5871553bf5c7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateTarget,data: {target_name: , robot_name: , retrigger_autoconnect: , object_states: , pose: [x,y,z,rx,ry,rz]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"target_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which target will have its position updated.","type":"text"},{"type":"hardBreak"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": This specifies which robots TCP will be used at the new target location.","type":"text"},{"type":"hardBreak"},{"text":"retrigger_autoconnect","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This boolean argument specifies if the auto-connect should be regenerated when updating the targets position. If the target is not part of an auto-connect, then this argument will have no effect. The default value is False.","type":"text"}]},{"type":"paragraph","content":[{"text":"object_states:","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument specifies whether the validation of the updated target position should take consideration of all object states or only the active objects. This argument can be set to either ","type":"text"},{"text":"all","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"active","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"object_states","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"all","type":"text","marks":[{"type":"code"}]},{"text":", path validation will check all object states when updating a target. This is the default setting. If ","type":"text"},{"text":"object_states","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"active","type":"text","marks":[{"type":"code"}]},{"text":", path validation of will check active object states when updating a target.","type":"text"}]},{"type":"paragraph","content":[{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" , if ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" values [x, y, z, r, p, y] are specified, the pose values will be used to update the target position, instead of the specified robot TCP location.","type":"text"}]},{"type":"paragraph","content":[{"text":"joint_config","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" , the joint configuration values will be used to update the target position instead of the specified robot TCP location, even if the robot is disconnected. The joint configuration values should include all robot links and external axes.","type":"text"}]},{"type":"paragraph","content":[{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" , if specified, this frame is used as a reference for the ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" value. ","type":"text"},{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":" can be either a frame defined in RPC or a DSM frame.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"This command updates the specified targets position to be at the specified robot TCP location in its current preset, or using an optional pose value. The target’s new position will be used for all assigned robots.","type":"text"},{"type":"hardBreak"},{"text":"The target is created using the robot’s current joint angles which means the controller must be in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode and the robot state must be ","type":"text"},{"text":"connected","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"A target’s position will only be updated, if all of its connections remain valid, otherwise the command fails and returns an error code ","type":"text"},{"text":"EDGE_INVALIDATED","type":"text","marks":[{"type":"code"}]},{"text":". This could result from the new position being unreachable, the new position being in collision, or one of the motions to the new position resulting in a collision.","type":"text"}]},{"type":"paragraph","content":[{"text":"Only one target can be updated at a time. While a target is updating, any subsequent UpdateTarget commands will be rejected.","type":"text"}]},{"type":"paragraph","content":[{"text":"With the ","type":"text"},{"text":"retrigger_autoconnect","type":"text","marks":[{"type":"code"}]},{"text":" argument set to true, the targets position will be updated, and then the auto-connect will be re-run using the same parameters as set in RapidPlan Create. With ","type":"text"},{"text":"retrigger_autoconnect","type":"text","marks":[{"type":"code"}]},{"text":" set to false, just the target’s position will change, and all via point locations will remain the same. The edges leading to the new target location will be validated against the constraints of the auto-connect, and the UpdateTarget command will fail if all constraints are not met. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return an acknowledgement with a status code indicating the command was received and is being executed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"This command will also return a delayed response when the update has completed or failed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateTarget,data: {target_name: weld5, robot_name: robot1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateTarget,type: Response,data: {seq: 154}}\nAfter the target position has been updated and the roadmap has been regenerated...\n{topic: UpdateTarget,type: DelayedResponse,data: {seq: 154}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"UpdateTarget,0,154\nAfter the target position has been updated and the roadmap has been regenerated...\nUpdateTargetResult,0,154","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RenameTarget","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"c673e828-20d7-491a-8c50-7f3f54e98899"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RenameTarget,data: {target_name: , new_target_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"target_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the name of the target to be renamed.","type":"text"}]},{"type":"paragraph","content":[{"text":"new_target_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the new name of the target.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command renames a target. To rename a target, the Realtime Controller must be in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode.","type":"text"}]},{"type":"paragraph","content":[{"text":"RapidPlan Create naming conventions must be followed. Duplicate names are not allowed. Any invalid names will be rejected by the command.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return an acknowledgement with a status code indicating the command was received and executed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RenameTarget,data: {target_name: weld5, new_target_name: newweld6}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RenameTarget,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"RenameTarget,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RemoveTarget","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"746d57fa-5175-4b3e-bd46-1e90ee7823e2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveTarget,data: {target_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"target_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the name of the target to be removed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"This command removes a target in the active robot preset for the specified robot. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To remove the target, Realtime Controller must be in ","type":"text"},{"text":"CONFIG","type":"text","marks":[{"type":"code"}]},{"text":" mode. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Removing the target will remove any manually created connections , and any connections created by auto-connect, between this target and other targets.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return an acknowledgement with a status code indicating the command was received and executed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveTarget,data: {target_name: weld5}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveTarget,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[128.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[832.0]},"content":[{"type":"codeBlock","content":[{"text":"RemoveTarget,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AddConnection","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"fec391b0-cea8-4907-bf49-ed8d6a85be6e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddConnection,data: {robot_name: , preset: , targets: , type: , autoconnect_name: , validation: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot to add the connection to.","type":"text"}]},{"type":"paragraph","content":[{"text":"preset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"f35038f6-a444-4b4e-92b9-66b60f17ff88"}},{"text":" The name of the robot preset to add connections to. If empty, the active preset is used.","type":"text"}]},{"type":"paragraph","content":[{"text":"targets","type":"text","marks":[{"type":"code"}]},{"text":": A list of targets to connect. At least 2 targets must be included. If the type is ","type":"text"},{"text":"joint","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"cartesian","type":"text","marks":[{"type":"code"}]},{"text":" then only 2 targets are allowed.","type":"text"}]},{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the type of connection to create. Acceptable values are ","type":"text"},{"text":"joint","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":"), ","type":"text"},{"text":"cartesian","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":"), or ","type":"text"},{"text":"auto","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]},{"type":"paragraph","content":[{"text":"autoconnect_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"792fcddb-cc53-4e18-9421-42690348b04a"}},{"text":" If ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"auto","type":"text","marks":[{"type":"code"}]},{"text":" (","type":"text"},{"text":"2","type":"text","marks":[{"type":"code"}]},{"text":"), ","type":"text"},{"text":"autoconnect_name","type":"text","marks":[{"type":"code"}]},{"text":" can be specified by the user. If unspecified, a default autoconnect name will be assigned.","type":"text"}]},{"type":"paragraph","content":[{"text":"validation","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"38862dab-eba8-4014-a520-570f251915c5"}},{"text":" This argument can be set to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"require_valid","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"0","type":"text","marks":[{"type":"code"}]},{"text":": Run validation and require it to succeed, otherwise the change would be rolled back and an error code returned. This is the default option if ","type":"text"},{"text":"validation","type":"text","marks":[{"type":"code"}]},{"text":" option is unspecified for a manual connection or an autoconnect.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"allow_invalid","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"1","type":"text","marks":[{"type":"code"}]},{"text":": Run validation but allow it to fail, with no error code.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command creates new connections within a given roadmap. It can be used to create manual connections or auto-connects.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Delayed Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will also return a delayed response only if ","type":"text"},{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"auto","type":"text","marks":[{"type":"code"}]},{"text":" and when ","type":"text"},{"text":"validation","type":"text","marks":[{"type":"code"}]},{"text":" is set to ","type":"text"},{"text":"require_valid","type":"text","marks":[{"type":"code"}]},{"text":", or ","type":"text"},{"text":"allow_invalid","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddConnection,data: {robot_name: robot_1, presets: [preset_1], targets: [target_1, target_2], type: cartesian, validation: allow_invalid}}\n{topic: AddConnection,data: {robot_name: robot_1, presets: [preset_1], targets: [target_1, target_2], type: auto, autoconnect_name: autoconnect_1, validation: require_valid}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddConnection,type: Response,data: {seq: 154}}\nAfter the connection is created and the roadmap has been regenerated and validated...\n{topic: AddConnection,type: DelayedResponse,data: {seq: 154}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph"}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"AddConnection,0,154\nAfter the connection is created and the roadmap has been regenerated and validated...\nAddConnectionResult,0,154","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RemoveConnection","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"31d06bcf-30a0-4bdf-86d1-d724a4337aef"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveConnection,data: {autoconnect_name: }}\nor\n{topic: RemoveConnection,data: {robot_name: , preset: , targets: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"autoconnect_name","type":"text","marks":[{"type":"code"}]},{"text":": this argument is used to specify the name of the auto-connect to remove. ","type":"text"}]},{"type":"paragraph","content":[{"text":"autoconnect_name","type":"text","marks":[{"type":"code"}]},{"text":" is mutually exclusive with the following options:","type":"text"}]},{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":" : Specifies which robot to remove the connection from. ","type":"text"}]},{"type":"paragraph","content":[{"text":"targets","type":"text","marks":[{"type":"code"}]},{"text":" : A list of two targets to remove the manual connection between. ","type":"text"},{"type":"status","attrs":{"color":"red","style":"bold","text":"REQUIRED","localId":"35714ef2-5661-481a-bb7a-908421dc726f"}},{"text":" if ","type":"text"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":" is used.","type":"text"}]},{"type":"paragraph","content":[{"text":"preset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"e5928e28-6494-423c-bf9d-8670121aad74"}},{"text":" Name of the robot preset to remove a manual connection from. If empty, the active preset is used. If an auto-connect is removed, ","type":"text"},{"text":"preset","type":"text","marks":[{"type":"code"}]},{"text":" is ignored and not checked for validity.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command removes connections in the roadmap. It can remove manual connections between two targets or an auto-connect by name. It can only be run in CONFIG mode. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveConnection,data: {autoconnect_name: autoconnect_1}}\nor\n{topic: RemoveConnection,data: {robot_name: robot_1, preset: preset_1, targets: [target_1, target_2]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveConnection,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"RemoveConnection,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetJointConfiguration","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"68f8860c-1942-465e-9fde-1d179561fe07"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetJointConfiguration,data: {robot_name: , native: false}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies the name of the robot to return the joint angles for.","type":"text"}]},{"type":"paragraph","content":[{"text":"native","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument, if ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", returns only robot native joint configuration. If ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":", full robot joint configuration including external axes is returned. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"with_joint_names","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"text":"[ OPTIONAL ]","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" This argument, if ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", specifies the returned names of the robot joints and external joints in the current active robot preset. The returned names are also based on the status of ","type":"text"},{"text":"native","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the current joint angles of a specified robot. If the robot has additional axes, they will be included sorted by their driver index. The values will be returned in the client’s units for both revolute and prismatic joints.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by the current joint angles in a comma separated array. This command will always include the robot axes, and by default will include the position of external axes if present.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetJointConfiguration,data: {robot_name: robot_1, with_joint_names: true}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetJointConfiguration,type: Response,data: {joint_configuration: [j1,j2,j3,j4,j5,j6...jN], joint_names: [,,,...]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[136.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[824.0]},"content":[{"type":"codeBlock","content":[{"text":"GetJointConfiguration,0,j1,j2,j3,j4,j5,j6...jN,joint1name,joint2name,...,jointNname","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetTCPPose","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"1823c76c-be82-43f1-aaaf-aad6a3d9a0cb"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTCPPose,data: {robot_name: ,ref_frame: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot’s TCP pose will be returned. The TCP of the active robot preset will be used.","type":"text"}]},{"type":"paragraph","content":[{"text":"ref_frame","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"36546a05-bdd6-4297-8a13-212ef1c28d52"}},{"text":" The reference frame in which to return the TCP coordinates. Default is ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":". The acceptable frames are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"_base","type":"text","marks":[{"type":"code"}]},{"text":": the base frame of the robot as defined in the robot model. This is a reserved frame name in RPC.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"_default_tcp","type":"text","marks":[{"type":"code"}]},{"text":": the default tcp as defined in the robot model. This is a reserved frame name in RPC.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"any user created frame in the RPC project","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command returns the specified robot’s TCP coordinates in the world or user specified frame for the active robot preset. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The coordinates are returned in the client’s unit and rotation convention.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully along with the position and rotation of the specified robot’s TCP.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTCPPose,data: {robot_name: robot_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetTCPPose,type: Response,data: {pose:[1.0,0.5,0.375,90.0,0.0,0.0]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"GetTCPPose,0,1.0,0.5,0.375,90.0,0.0,0.0","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Endpoints - Scene Modeling","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition to Static Scene Model command SetObjectState, there are Dynamic Scene Model (DSM) commands that allow a user to add obstacles at runtime. A user may need DSM feature if the size or location of the obstacles is unknown offline, and therefore cannot be modeled. A user may also use the DSM object if the number of obstacle variations is unrealistic to model (e.g. in palletizing there may be thousands of obstacle sizes and possible object states).","type":"text"}]},{"type":"paragraph","content":[{"text":"Any possible DSM obstacle can be modeled with either a Box or CAD Object.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CAD objects must be configured in RapidPlan Create ahead of time to reference at runtime.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The DSM objects cannot be attached to stateful objects.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetObjectStates","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"c5c6e2cf-5ef6-4b2c-bb24-70c6547206d0"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetObjectStates, data: {object_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":": the name of the object","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"This command returns information about an object’s state for a loaded project.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response with the object’s active state and a list of possible object states.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetObjectStates, data: {object_name: object1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetObjectStates,type: Response,data: {states: [state1, state2], active_state: state2}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[825.0]},"content":[{"type":"codeBlock","content":[{"text":"GetObjectStates,0,state2,2,state1,state2","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetStatefulObjects","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"f6f951f1-72ce-46a2-9807-c075e85f0e6f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetStatefulObjects}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"paragraph","content":[{"text":"None.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the stateful object names for the loaded project. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by a comma separated array of the object names.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetStatefulObjects}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetStatefulObjects,type: Response,data: {objects:[Object_1,Object_2,Object_3]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[135.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[823.0]},"content":[{"type":"codeBlock","content":[{"text":"GetStatefulObjects,0,3,Object_1,Object_2,Object_3","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetObjectState","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"f783c591-c0d3-47fb-a24f-4d91cb331ede"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetObjectState,data: {object_name: ,state_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which object this call pertains to.","type":"text"},{"type":"hardBreak"},{"text":"state_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which state of the object should be used as defined in RPC.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command changes the active state of a stateful mate. An object is specified as a function argument, and the direct parent’s mate state will be set based on the specified ","type":"text"},{"text":"state_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"},{"type":"hardBreak"},{"text":"When an object state is changed, current robot motions are not re-validated, but new move commands will respect the new active state.","type":"text"}]},{"type":"paragraph","content":[{"text":"When called, the selected object state is stored to disk so upon project reload, the last active state will be used.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetObjectState,data: {object_name: jig,state_name: open}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetObjectState,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"SetObjectState,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"GetFrames","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"0b655386-79b5-46f4-9c38-7e4a33a3cf58"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetFrames}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command retrieves the frames added in RPC and the frames added by DSM commands for a loaded project that can be used as reference frames in ","type":"text"},{"text":"Move","type":"text","marks":[{"type":"code"}]},{"text":" commands as well as calculating any transforms.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response code, followed by a comma separated array of the frame names.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetFrames}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: GetFrames,type: Response,data: {frames:[car,jig,tip_dress]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"GetFrames,0,car,jig,tip_dress","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AddFrame","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"03c4b880-9afc-453e-bbb9-12bc1bf2813d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddFrame,data: {frame_name: ,offset: , parent_frame: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"frame_name","type":"text","marks":[{"type":"code"}]},{"text":": A name that will be associated with the frame being created. The name must be unique.","type":"text"}]},{"type":"paragraph","content":[{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"eeb5fa64-10cb-437a-8ce0-0a7bb0cbf293"}},{"text":" An array of 6 floats that specifies the offset between the parent frame and this frame. The offset uses the clients active units and rotation convention, or the default of millimeters, degrees, roll pitch yaw. The default offset is [0,0,0,0,0,0]","type":"text"}]},{"type":"paragraph","content":[{"text":"parent_frame","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"374a251e-3206-40e4-b0a6-2c78d7e6926a"}},{"text":" Specifies the parent reference frame. Default value is the ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":" frame. A parent frame must be static and not on a stateful object. Eg. a parent frame cannot be attached to a robot, or an object who’s parent mate has multiple states.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command adds a frame to the project. The frame is stored to disk, so when the project is unloaded, the frame will be saved. If the project is downloaded from the control panel and opened in RapidPlan Create, the frame will show up and be editable.","type":"text"}]},{"type":"paragraph","content":[{"text":"The frame can be used as a reference/parent frame for:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Dynamic Scene Model boxes and objects","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Other frames","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddFrame,data: {frame_name: pallet_origin,offset: [0.5,0.25,0.35,0.0,180.0,0.0]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddFrame,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"AddFrame,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"UpdateFrame","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"66da9be3-35ee-4a41-bcc5-5e3406cab09f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateFrame,data: {frame_name: ,offset: ,reference_frame: }}\n{topic: UpdateFrame,data: {frame_name: ,pose: ,reference_frame: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"frame_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the frame who’s position will be updated.","type":"text"}]},{"type":"paragraph","content":[{"text":"Mutually exclusive keys:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":": An array of 6 floats that specifies an offset that will be applied to the frame relative to its current position. The clients active units and rotation convention are used, or the default of millimeters, degrees, and roll pitch yaw.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":": An array of 6 floats that specifies the new position for the frame. The clients active units and rotation convention are used, or the default of millimeters, degrees, and roll pitch yaw.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"reference_frame","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"505b9c00-045e-495a-90dd-104b1c6ccd4e"}},{"text":" The name of the frame to be used as the reference frame for the ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":" argument. The default value is ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":" frame for a ","type":"text"},{"text":"pose","type":"text","marks":[{"type":"code"}]},{"text":" update. When offsetting a frame, the default is to reference itself.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command updates the position of a frame and all of its children. A frame can be updated by applying an offset from its current position with the offset argument. A frame can also be relocated to a new position in a given frame. It is important to note that this cannot re-parent the frame.","type":"text"}]},{"type":"paragraph","content":[{"text":"Frames can only be updated if they:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Are static (eg. they are not attached to a robot)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Are not attached to stateful objects (eg. none of the parent mates can have more than one state)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Have no children aside from:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DSM Boxes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DSM Objects","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Other frames","type":"text"}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateFrame,data: {frame_name: pallet_origin,offset: [0.5,0.25,0.35,0.0,0.0,0.0]}}\n{topic: UpdateFrame,data: {frame_name: pallet_origin,pose: [0.5,0.25,0.35,0.0,0.0,0.0]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: UpdateFrame,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"UpdateFrame,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RemoveFrames","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"b8ee05e5-498e-471e-8c5b-80231dc18137"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveFrames}\n{topic: RemoveFrames,data: {frame_names: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"frame_names","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"ac7a9b78-e1d4-4eb5-8437-a7a67beef9e0"}},{"text":" An array of the names of the frames that will be removed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command removes a specified frame/s added to the scene. When a frame is removed, any DSM boxes or objects with that frame as a parent will also be removed. If no arguments are passed, all frames will be removed, or an array of the frame names can be passed to selectively remove.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveFrames,data: {frame_name: [pallet_origin,layer_one_offset]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveFrames,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"RemoveFrames,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AddBox","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"7e60fa91-0b4c-4b5f-a47b-848931a69c7e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddBox,data: {box_name: ,size: , parent_frame: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"box_name","type":"text","marks":[{"type":"code"}]},{"text":": A name that will be associated with the object being created. The name must be unique.","type":"text"}]},{"type":"paragraph","content":[{"text":"size","type":"text","marks":[{"type":"code"}]},{"text":": An array of 3 floats that specifies the XYZ size of the box relative to its origin which is at the corner of the box. The size uses the clients active units, or the default of millimeters. Values can be either positive or negative.","type":"text"}]},{"type":"paragraph","content":[{"text":"parent_frame","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"43f86c82-aa77-49ff-b981-3918aa06a441"}},{"text":" Specifies the parent reference frame. Default value is the ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":" frame. A parent frame must be static and not on a stateful object. Eg. a parent frame cannot be attached to a robot, or an object who’s parent mate has multiple states.","type":"text"}]},{"type":"paragraph","content":[{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"18556fbf-2c0d-4900-ad56-b2a26f656eec"}},{"text":" An array of 6 floats that specifies the offset between the parent frame and this box. Once added, the offset is fixed between the box and the parent frame. The offset uses the clients active units and rotation convention, or the default of millimetres, degrees, roll pitch yaw. The default offset is [0,0,0,0,0,0].","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command adds a box into the Dynamic Scene Model. Once added, all robots in all robot presets will avoid it. Additionally, current robot motions will avoid the box when added.","type":"text"}]},{"type":"paragraph","content":[{"text":"The box origin is at the corner which the size and offset arguments are relative to. The box has a fixed offset relative to the parent frame, and if the parent frame’s position is updated, the position of the box will be as well.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Dynamic Scene Model is not stored to disk, so when the Project is unloaded, the Dynamic Scene Model is reset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddBox,data: {box_name: case_1,size: [0.5,0.5,0.5], parent_frame: pallet_origin}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddBox,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[133.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[827.0]},"content":[{"type":"codeBlock","content":[{"text":"AddBox,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AddObject","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"3bf2df9c-8aad-4caa-bdca-1fcad40edc19"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddObject,data: {object_name: ,object_type: , parent_frame: , offset: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":": A name that will be associated with the object being created. The name must be unique.","type":"text"}]},{"type":"paragraph","content":[{"text":"object_type","type":"text","marks":[{"type":"code"}]},{"text":": The name of the object type as defined in RPC.","type":"text"}]},{"type":"paragraph","content":[{"text":"parent_frame","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"42291c8a-6c7b-4cf1-9e82-3e99b0ecf9fc"}},{"text":" Specifies the parent reference frame. Default value is the ","type":"text"},{"text":"world","type":"text","marks":[{"type":"code"}]},{"text":" frame. A parent frame must be static and not on a stateful object. Eg. a parent frame cannot be attached to a robot, or an object who’s parent mate has multiple states.","type":"text"}]},{"type":"paragraph","content":[{"text":"offset","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"05d6267e-8e14-4878-95ea-1d99c3f9bb89"}},{"text":" An array of 6 floats that specifies the offset between the parent frame and this object. Once added, the offset is fixed between the object and the parent frame. The offset uses the clients active units and rotation convention, or the default of millimetres, degrees, roll pitch yaw. The default offset is [0,0,0,0,0,0].","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command adds a CAD object from the RPC project into the Dynamic Scene Model. Once added, all robots in all robot presets will avoid it. Additionally, current robot motions will avoid the box when added.","type":"text"}]},{"type":"paragraph","content":[{"text":"The object has a fixed offset relative to the parent frame, and if the parent frame’s position is updated, the position of the object will be as well.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Dynamic Scene Model is not stored to disk, so when the Project is unloaded, the Dynamic Scene Model is reset.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddObject,data: {object_name: case_1,object_type: case_model, parent_frame: conveyor_origin}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: AddObject,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"AddObject,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RemoveBoxes","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"fddeada7-9859-4f38-9def-92ba2dad6737"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveBoxes}\n{topic: RemoveBoxes,data: {box_names: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"box_names","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"f2ced46d-e705-4764-bba1-f1f2c4ada89e"}},{"text":" An array specifying the name/s of the boxes that will be removed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command removes a specified box/es from the Dynamic Scene Model. If no arguments are passed, all boxes will be removed, or an array of the box names can be passed to selectively remove.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveBoxes,data: {box_name: [case_1,case_2]}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveBoxes,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[826.0]},"content":[{"type":"codeBlock","content":[{"text":"RemoveBoxes,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"RemoveObjects","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"2ed106ea-7ba3-449f-8656-951923178373"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveObject,data: {object_name: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":": ","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"1989404a-b7cf-4351-ba2f-dcb24d22c0cc"}},{"text":" The name of the ","type":"text"},{"text":"object","type":"text","marks":[{"type":"code"}]},{"text":" that will be removed.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command removes a specified object from the Dynamic Scene Model. If no arguments are passed, all objects will be removed, or an array of the box names can be passed to selectively remove.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveObject,data: {object_name: case_1}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: RemoveObject,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"RemoveObject,0","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Reparent","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"06da260c-9012-48bf-9df6-f46f55b66bdc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Reparent,data: {box_name: , parent_frame: }}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"box_name","type":"text","marks":[{"type":"code"}]},{"text":": The name of the box that will have its parent frame updated.","type":"text"}]},{"type":"paragraph","content":[{"text":"parent_frame","type":"text","marks":[{"type":"code"}]},{"text":": This argument specifies the new parent frame for the box. The frame must be a dynamic frame added with the AddFrame command, or a robot’s default TCP addressed as {robot_name}_default_tcp.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will re-assign the parent frame for a specified DSM box. After this command executes, the box will have a new parent frame with an offset such that it remains in its current position. If the box’s new parent frame is moved, the box will move with it with that offset. ","type":"text"}]},{"type":"paragraph","content":[{"text":"A box’s parent frame can also be the TCP of a robot, and as the robot moves, the box moves with it maintaining the initial offset. A robot’s default TCP should be used that way it is independent of presets. A robot’s default TCP can be specified as {robot_name}_default_tcp. In order to assign a robot’s tcp as the parent of a box, the robot must be stationary.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has been received and executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Reparent,data: {box_name: case_1, parent_frame: Robot1_default_tcp}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: Reparent,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[132.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Response","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[828.0]},"content":[{"type":"codeBlock","content":[{"text":"Reparent,0","type":"text"}]}]}]}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"API Endpoints - Robot + Scene Modeling","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":3},"content":[{"text":"SetWorkcellState","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"80505988-6954-4fbf-b4a8-33e3fe28d885"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Structure","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"{topic: SetWorkcellState, data: { objects: {: }, robots: {: }}}","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Argument Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"robots","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"1e16dfa1-cb0c-4f0d-bb25-7dc0cacb4ed4"}},{"text":" this argument contains 2 sub-keys that specifies a robot preset.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot to switch presets.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"robot_preset","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which robot preset to switch to. The preset name is required for a given ","type":"text"},{"text":"robot_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"objects","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"},{"type":"status","attrs":{"color":"yellow","style":"bold","text":"optional","localId":"ff25ab7b-6965-4886-aa0a-178803c1da88"}},{"text":" this argument contains 2 sub-keys that specifies a object state.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which (stateful) object to switch states.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"object_state","type":"text","marks":[{"type":"code"}]},{"text":": Specifies which object state to switch to. The object state name is required for a given ","type":"text"},{"text":"object_name","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Function Description","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"This command changes the entire workcell preset for the loaded project with a combination of robot presets and object states. The combination can contain all robot presets and object states or a partial list.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Response Details","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"paragraph","content":[{"text":"This command will return a response to acknowledge the command has executed successfully.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Example Request","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetWorkcellState, data: { objects: {object_1: object_state_1, object_2: object_state_2}, robots: {robot_1: robot_preset1, robot_2: robot_preset2}}}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Example YAML Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"codeBlock","content":[{"text":"{topic: SetWorkcellState,type: Response}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[84.0]},"content":[{"type":"paragraph","content":[{"text":"Example CSV Responses","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[633.0]},"content":[{"type":"codeBlock","content":[{"text":"SetWorkcellState,0","type":"text"}]}]}]}]}],"version":1}

Browser not supported