Difference between revisions of "Virtual Robot Content Organizer"

From Engineered Arts Wiki
Jump to navigation Jump to search
(Icon selection)
(25 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
{{headerthumb|File:VRScreen_layout.jpg|The Virtual Robot Interface|link=http://virtual.robothespian.co.uk}}
 
{{headerthumb|File:VRScreen_layout.jpg|The Virtual Robot Interface|link=http://virtual.robothespian.co.uk}}
 
==Introduction==
 
==Introduction==
[[Virtual Robot]] provides a simple to use web based tool for [[Content Creation|content creation]] on [https://www.engineeredarts.co.uk EA] robots like [[RoboThespian]] and [[SociBot]].
+
[[Virtual Robot]] provides a simple to use but powerful web based tool for [[Content Creation|content creation]] on [https://www.engineeredarts.co.uk Engineered Arts] robots like [[RoboThespian]] and [[SociBot]].
  
This page shows you how to organise and transfer content from Virtual Robot to any recent [[Tritium]] robot, even while the robot is switched off.
+
The Content Organizer is used to arrange [[Touchscreen|touch screen]] and [[Telepresence]] content, add button images and text labels; transfer new performances and synchronise updates to performances with your robot, even while the robot is switched off.
  
==Accessing Content Organizer==
+
==Accessing the Content Organizer==
  
Content organizer can be accessed from the [[Remote_Connection#Remote_access_via_the_Robot_Management_System|Robot Management System]]:
+
The content organizer can be accessed from the [[Remote_Connection#Remote_access_via_the_Robot_Management_System|Robot Management System]]:
  
 
[[File:content1.jpg|thumb|none|1024px|link=|Robot Management System]]
 
[[File:content1.jpg|thumb|none|1024px|link=|Robot Management System]]
Line 16: Line 16:
 
{{num|1}} Serial number of robot - when robot is ONLINE this becomes a link. Click the link to open the robot's [[Tritium GUI]]<br>
 
{{num|1}} Serial number of robot - when robot is ONLINE this becomes a link. Click the link to open the robot's [[Tritium GUI]]<br>
 
{{num|2}} Status of robot - ONLINE / OFFLINE<br>
 
{{num|2}} Status of robot - ONLINE / OFFLINE<br>
{{num|3}}  '''''Content organizer - click to open [[Virtual Robot Content Organizer]]'''''<br>
+
{{num|3}}  '''''Link to robot's content - click to open [[Virtual Robot Content Organizer]]'''''<br>
 
{{num|4}}  Tinman status - when robot has telepresence installed and is ONLINE, click here to access the [[Telepresence|Tinman Telepresence System]]
 
{{num|4}}  Tinman status - when robot has telepresence installed and is ONLINE, click here to access the [[Telepresence|Tinman Telepresence System]]
  
 
==Content Organizer Overview==
 
==Content Organizer Overview==
Content organizer is composed of 4 sections:
+
Virtual Robot Content Organizer is composed of 4 sections:
 
[[File:content2.jpg|thumb|none|1024px|link=|Content Organizer]]
 
[[File:content2.jpg|thumb|none|1024px|link=|Content Organizer]]
{{num|1}} Files: performances in your Virtual Robot account<br>
+
{{num|1}} Files panel: performances in your '''Virtual Robot''' account<br>
{{num|2}} Robot: performances already on your robot or ready to sync to your robot<br>
+
{{num|2}} Robots panel: performances already on your '''robot''' or ready to sync to your robot<br>
{{num|3}} Properties: edit the [[#Properties|Properties]] of performances and manage their appearance on the <br>
+
{{num|3}} Properties panel (hidden by default): edit the [[#Properties|Properties]] of performances and manage their appearance on the <br>
{{num|4}} File transfers and log: this is where you can view the status of transfers
+
{{num|4}} File transfers and log: status of transfers
  
  
===Files: Performances in Virtual Robot:===
+
===Files panel: Performances in Virtual Robot===
 
[[File:content3.jpg|thumb|none|600px|link=|Files]]
 
[[File:content3.jpg|thumb|none|600px|link=|Files]]
  
 
{{num|1}} Edit: open selected performance in Virtual Robot for editing.  You can also double click a performance to edit it.<br>
 
{{num|1}} Edit: open selected performance in Virtual Robot for editing.  You can also double click a performance to edit it.<br>
 
{{num|2}} Delete: delete selected performance from Virtual Robot permanently<br>
 
{{num|2}} Delete: delete selected performance from Virtual Robot permanently<br>
{{num|3}} Transfer: transfers performance to the robot archive for use with web api etc. <br>
+
{{num|3}} Transfer: transfers performance to the robot archive folder (rather than directly to the Touch screen or Telepresence interface)<br>
{{num|4}} Bulk Edit: edit properties of multiple performances in bulk <br>
+
{{num|4}} Bulk Edit: easily edit properties of multiple performances<br>
{{num|5}} Duplicate: duplicate the selected folder<br>
+
{{num|5}} Duplicate: duplicate the selected folder and its performances. Duplicates are unique copies that can be edited without affecting the originals.<br>
{{num|6}} New Folder: create folders to organise content<br>
+
{{num|6}} New Folder: create folders to organise content.<br>
* slow click folder name to rename
+
{{num|7}} Performances are listed below, clicking on Name to sort by name<br>
* double click folder to open
+
{{num|8}} Last Saved: date or time (if today) performance was last saved. Click on Last Saved to sort by Last Saved.
{{num|7}} Performances are listed here, clicking here will change the order in which they appear<br>
 
{{num|8}} Last Saved: date or time (if today) performance was last saved
 
  
  
===Robot: performances already on robot and ready to sync to robot===
+
===Robots panel: performances already on your robot or ready to sync to robot===
 
[[File:content4.jpg|thumb|none|600px|link=|Robots]]
 
[[File:content4.jpg|thumb|none|600px|link=|Robots]]
 
{{num|1}} Edit: open selected performance in Virtual Robot for editing.  You can also double click a performance to edit it.<br>
 
{{num|1}} Edit: open selected performance in Virtual Robot for editing.  You can also double click a performance to edit it.<br>
{{num|2}}  Delete: delete selected performance from robot. Performance still exist in Virtual robot until deleted from Virtual Robot.<br>
+
{{num|2}}  Delete: delete selected performance from robot. Performance still exists in Virtual robot until deleted from Virtual Robot.<br>
{{num|3}} Sync: Will sync new or altered performances  
+
{{num|3}} Sync: sync new or altered performances from Virtual Robot to the robot<br>
# & # displays robots accessible from user
+
{{num|4}}, {{num|5}} User's robots. Click the arrow next to a robot to show all the subfolders containing content on the robot. <br>
 
+
Clicking the arrow again hides the subfolders. You can also double click on the Robot to expand / hide subfolders<br>
* File transfer and Log
 
  
 +
===File Transfers and Log===
 +
Shows status of current sync requests.  Clicking on a robot to sync content to and pressing the Sync button adds a "pending" sync job to the File Transfers list.
  
[[File:content5.jpg|thumb|none|600px|link=|File transfer]]
+
[[File:content6.jpg|thumb|none|600px|link=|Sync request pending]]
 +
{{num|1}} cancel: cancel selected sync job<br>
 +
{{num|1}} clear completed: remove completed sync jobs from the list<br>
 +
{{num|2}} Status: pending / completed<br>
 +
{{num|3}} Last Activity: date and time sync job was added if pending, or date and time completed<br>
 +
{{num|4}} File: performance or folder being synced<br>
 +
{{num|5}} Robot: Name (or location) of robot
  
* File transfer (status pending)
 
[[File:content6.jpg|thumb|none|600px|link=|Pending transfer]]
 
# Cancel transfer or clear when complete: to cancel or clear when complete, highlighted performances
 
# Status: of transferring performance or folder
 
# Last Activity: Time transfer began or ended
 
# File: Name of performance or folder being transferred
 
# Robot: Name and location of robot
 
 
  
 +
Once the robot is online it will begin to synchronise.  When the content has been transferred to the robot the Status will show as "completed".
  
[[File:content7.jpg|thumb|none|600px|link=|complete transfer]]
+
[[File:content7.jpg|thumb|none|600px|link=|Sync job completed]]
# Status: completed transfer of performance or folder
+
{{num|1}} Status: completed transfer of performance or folder<br>
# Clear when complete: performances and folders can be cleared from the list once completed
+
{{num|2}} clear completed: remove completed sync jobs from the list  
  
  
*Accessing transfer log
+
Log: logs actions carried out in Virtual Robot Content Organizer
 
[[File:content8.jpg|thumb|none|600px|link=|Transfer Log]]
 
[[File:content8.jpg|thumb|none|600px|link=|Transfer Log]]
  
* Transferring content to robot library (touchscreen kiosk)
 
  
* Opening library folder
+
===Transferring content to Touch Screen kiosk - LIBRARY page===
 +
Example LIBRARY page showing on the [[Touchscreen|touch screen]]:
  
[[File:content9.jpg|thumb|none|600px|link=|library folder]]
+
[[File:RoboThespian At a Glance User Interface Library.jpg |thumb|none|600px|link=|Example LIBRARY page]]
# Select the Robot you wish to transfer performance or folder to
 
# Click to open folder 'touchscreen_ui'
 
# Click to open folder language 'en_GB'
 
# Click to open folder'Library' (this folder contains library content in the order it appears on the touch screen kiosk)
 
  
* Transferring content to robot library
 
  
[[File:content10.jpg|thumb|none|600px|link=|Transfer to library]]  
+
In the [[#Robots panel: performances already on your robot or ready to sync to robot|Robots panel]] select the Robot you wish to transfer performances to.
# Drag and drop selected performance or folder
 
# Dialog box indicates performance or folder is being dragged
 
# Green dotted line indicates which order performance or folder is being dragged to
 
  
* Syncing performance or folder with robot
+
[[File:content9.jpg|thumb|none|600px|link=|library folder]]
 
+
{{num|1}} Click the arrow next to the Robot you wish to sync content to. This shows all the subfolders containing content on the robot. (Clicking the arrow again hides the subfolders. You can also double click on the Robot to expand / hide subfolders)<br>
[[File:content11.jpg|thumb|none|600px|link=|Transfer Log]]
+
{{num|2}} Click the arrow next to 'touchscreen_ui' to show the subfolders for content in different languages on the Robot<br>
# Transferred performance in library
+
{{num|3}} Click the arrow next to 'en_GB' (for British English touch screen content) - if you have other languages installed they will appear here as well. This folder this contains all editable pages of the touch screen interface<br>
# this symbol indicates you need to sync to robot for changes to take effect
+
{{num|4}} Click the arrow next to 'Library' to show the Library content in the order it appears on the touch screen kiosk
# click here to sync for changes to take effect
 
  
==Properties==
 
Access the properties left side panel by clicking on the ">>" :
 
[[File:content12.jpg|thumb|none|1024px|link=|accessing properties]]
 
click on the arrows to open the properties slider
 
  
[[File:content13.jpg|thumb|none|1024px|link=|properties open]]
+
====Let's say you want to add a new performance to the LIBRARY page.====
properties open
 
  
[[File:content14.jpg|thumb|none|600px|link=|properties elements]]
+
Select the performance you want to add in the [[#Files panel: Performances in Virtual Robot|Files panel]] on the left and drag it into the Library folder of the Robots panel on the right.
# ID: unique ID number (can not be altered)
 
# Name:
 
# Label:
 
# Description:
 
# Icon:
 
# Limit Control:
 
# Exclusive:
 
# Loop:
 
# Robot Model: Robot model (can not be altered)
 
  
* Different icons can be slected to appear in tinman (telepresance) or on the touch screen kisok
+
[[File:content10.jpg|thumb|none|600px|link=|Transfer to library]]
 +
Drag selected performance {{num|1}} from Files panel into the Library folder {{num|3}}.<br>
 +
A dialog box {{num|2}} indicates how many performances are being dragged<br>
 +
{{num|3}} Green dotted line indicates which folder performance or folder is being dragged to
  
[[File:content15.jpg|thumb|none|600px|link=|changing performance icons]]
+
* Add any other new performances in the same way.
To change icon click on the icon button
+
* Change order of performances in the Library folder by dragging performances around
 +
* Delete any performances in Library if no longer wanted.
  
[[File:content16.jpg|thumb|none|600px|link=|icon selection box]]
+
Then sync the changes to the robot
choose suitable icon from pre-existing list
 
# click on empty bar next to 'Icon' this will open Icons list
 
# Icons list
 
# click on chosen icon
 
  
note after making any changes in properties he robot will have to be 'synced'
+
===Syncing content changes to robot===
 +
[[File:content11.jpg|thumb|none|600px|link=|Ready to sync - items that will be synced marked]]
 +
{{num|1}} Transferred performance in library from example above<br>
 +
{{num|2}} Sync symbol indicates items that will be synced (i.e. updated or transferred or re-ordered)<br>
 +
{{num|3}} Click Sync to add the sync job to the [[#File Transfers and Log|File Transfers list]] and initiate the changes<br> 
 +
Once the robot is online it will begin to synchronise. When the content has been transferred to the robot the Status will show as "completed".
  
==Transfer content to real robot==
 
  
Having created an animation and saved the file, it may be transferred to a real robot.
+
[[File:content7.jpg|thumb|none|600px|link=|Sync job completed]]
  
When the robot is connected to the internet it will download the animation and play it once to confirm.
 
  
Select "Transfer" in the drop down "File" Menu on the Menu Bar
+
To see the updated content on your touch screen, change to one of the other pages on your touch screen (e.g. LIVE or LANGUAGE) then click on LIBRARY again to reload the LIBRARY page - you should now see all your changes.
  
<div><ul>
+
==Properties==
<li style="display: inline-block;">[[File:file-transfer.png|thumb|none|800px|link=|Select "Transfer" from the drop down "File" Menu]]</li>
+
Access the properties panel by clicking on the ">>" :
</ul></div>
+
[[File:content12.jpg|thumb|none|1024px|link=|accessing properties]]
  
Highlight the animation(s) you wish to transfer by clicking on them
 
  
<div><ul>
+
This opens the Properties panel
<li style="display: inline-block;">[[File:select-action.png|thumb|none|800px|link=|Select animations to transfer]]</li>
+
[[File:content13.jpg|thumb|none|1024px|link=|Properties panel open]]
</ul></div>
 
  
Click on the robot you wish to transfer the animation(s) to
 
  
<div><ul>
+
Select a sequence in Files that you wish to change the properties of.  The following properties are availabnle
<li style="display: inline-block;">[[File:select-robot.png|thumb|none|800px|link=|Click on your robot]]</li>
+
[[File:content14.jpg|thumb|none|600px|link=|Properties elements]]
</ul></div>
+
{{num|1}}  ID: unique ID number (For info - can not be altered)<br>
 +
{{num|2}}  Name: Sequence name<br>
 +
{{num|3}}  Label: Button label that appears on the Touch Screen interface<br>
 +
{{num|4}}  Description: Use to describe your content if desired (does not appear on touch screen)<br>
 +
{{num|5}}  Icon: Select an icon to use on the Button on the Touch Screen or in the Telepresence interface<br>
 +
{{num|6}}  Limit Control: Limit the sequence in [[Tritium Arbitration]] to only control certain parts of the robot (no need to change if unfamiliar with Arbitration)<br>
 +
{{num|7}}  Exclusive: Arbitration related, no need to change if unfamiliar with Arbitration<br>
 +
{{num|8}}  Loop: For Telepresence loops - sequences that will loop until told to stop<br>
 +
{{num|9}}  Robot Model: For info - robot model the sequence was created for.<br>
  
Click on "transfer" on the transfer window Menu Bar
+
===Icon selection===
 +
[[File:content15.jpg|thumb|none|600px|link=|icon selection box]]
 +
Click in the empty box {{num|2}} next to Icon {{num|1}} this will open Icons window<br>
 +
Here you can select an existing icon e.g. humphrey {{num|3}}, or scroll to the bottom of the icons and click "+ Upload" to upload your own.
  
<div><ul>
 
<li style="display: inline-block;">[[File:transfer-action.png|thumb|none|800px|link=|Click on "Transfer"]]</li>
 
</ul></div>
 
  
You can close the window at any time after clicking transfer.
+
The icon property will update to the selected icon:
 +
[[File:content16.jpg|thumb|none|600px|link=|changing performance icons]]
  
Reopen the "Transfer" window at any time to check progress.
 
  
After the animation transfers to the robot, a tick will appear in the File Transfer box to confirm transfer
+
After making any changes in properties hit sync again to sync the changes to the robot.
  
<div><ul>
+
Clicking the "<<" symbol closes the properties panel
<li style="display: inline-block;">[[File:completed.png|thumb|none|800px|link=|Tick mark confirms transfer]]</li>
 
</ul></div>
 
  
== Finding Your Sequences on the Robot ==
+
==Some useful shortcuts==
Files are transferred to the robot as Sequences under the Asset directory '/sequences/user/<username>/'. Which can be accessed through the Asset Manager's UI under Sequences > user > your username. But the details of this interface are out of the scope of this page. You can find more information here [[Tritium_GUI_Assets]]
+
* slow click folder or performance name to rename
 
+
* double click folder to open
Audio assets can be found in the same way. However the names of these assets can be unrecognisable, and you usually needn't worry about them.
+
* double click performance to edit
 +
* click an arrow next to a folder to show / hide subfolders
 +
* double click on a folder to show / hide subfolders
  
 
==Troubleshooting==
 
==Troubleshooting==
 
If you experience issues transferring content or with Virtual Robot in general please see [[Virtual Robot Troubleshooting]]
 
If you experience issues transferring content or with Virtual Robot in general please see [[Virtual Robot Troubleshooting]]

Revision as of 16:11, 22 September 2017

Virtual Robot > Virtual Robot Content Organizer
This page applies to 2017 onwards Tritium robots, for earlier Tritium robots please see Virtual Robot - Transferring Content, for IOServe based robots please see Virtual Robot - Transferring Content (IOServe)

The Virtual Robot Interface

Introduction

Virtual Robot provides a simple to use but powerful web based tool for content creation on Engineered Arts robots like RoboThespian and SociBot.

The Content Organizer is used to arrange touch screen and Telepresence content, add button images and text labels; transfer new performances and synchronise updates to performances with your robot, even while the robot is switched off.

Accessing the Content Organizer

The content organizer can be accessed from the Robot Management System:

Robot Management System

Serial number of robot - when robot is ONLINE this becomes a link. Click the link to open the robot's Tritium GUI
Status of robot - ONLINE / OFFLINE
Link to robot's content - click to open Virtual Robot Content Organizer
Tinman status - when robot has telepresence installed and is ONLINE, click here to access the Tinman Telepresence System

Content Organizer Overview

Virtual Robot Content Organizer is composed of 4 sections:

Content Organizer

Files panel: performances in your Virtual Robot account
Robots panel: performances already on your robot or ready to sync to your robot
Properties panel (hidden by default): edit the Properties of performances and manage their appearance on the
File transfers and log: status of transfers


Files panel: Performances in Virtual Robot

Files

Edit: open selected performance in Virtual Robot for editing. You can also double click a performance to edit it.
Delete: delete selected performance from Virtual Robot permanently
Transfer: transfers performance to the robot archive folder (rather than directly to the Touch screen or Telepresence interface)
Bulk Edit: easily edit properties of multiple performances
Duplicate: duplicate the selected folder and its performances. Duplicates are unique copies that can be edited without affecting the originals.
New Folder: create folders to organise content.
Performances are listed below, clicking on Name to sort by name
Last Saved: date or time (if today) performance was last saved. Click on Last Saved to sort by Last Saved.


Robots panel: performances already on your robot or ready to sync to robot

Robots

Edit: open selected performance in Virtual Robot for editing. You can also double click a performance to edit it.
Delete: delete selected performance from robot. Performance still exists in Virtual robot until deleted from Virtual Robot.
Sync: sync new or altered performances from Virtual Robot to the robot
, User's robots. Click the arrow next to a robot to show all the subfolders containing content on the robot.
Clicking the arrow again hides the subfolders. You can also double click on the Robot to expand / hide subfolders

File Transfers and Log

Shows status of current sync requests. Clicking on a robot to sync content to and pressing the Sync button adds a "pending" sync job to the File Transfers list.

Sync request pending

cancel: cancel selected sync job
clear completed: remove completed sync jobs from the list
Status: pending / completed
Last Activity: date and time sync job was added if pending, or date and time completed
File: performance or folder being synced
Robot: Name (or location) of robot


Once the robot is online it will begin to synchronise. When the content has been transferred to the robot the Status will show as "completed".

Sync job completed

Status: completed transfer of performance or folder
clear completed: remove completed sync jobs from the list


Log: logs actions carried out in Virtual Robot Content Organizer

Transfer Log


Transferring content to Touch Screen kiosk - LIBRARY page

Example LIBRARY page showing on the touch screen:

Example LIBRARY page


In the Robots panel select the Robot you wish to transfer performances to.

library folder

Click the arrow next to the Robot you wish to sync content to. This shows all the subfolders containing content on the robot. (Clicking the arrow again hides the subfolders. You can also double click on the Robot to expand / hide subfolders)
Click the arrow next to 'touchscreen_ui' to show the subfolders for content in different languages on the Robot
Click the arrow next to 'en_GB' (for British English touch screen content) - if you have other languages installed they will appear here as well. This folder this contains all editable pages of the touch screen interface
Click the arrow next to 'Library' to show the Library content in the order it appears on the touch screen kiosk


Let's say you want to add a new performance to the LIBRARY page.

Select the performance you want to add in the Files panel on the left and drag it into the Library folder of the Robots panel on the right.

Transfer to library

Drag selected performance from Files panel into the Library folder .
A dialog box indicates how many performances are being dragged
Green dotted line indicates which folder performance or folder is being dragged to

  • Add any other new performances in the same way.
  • Change order of performances in the Library folder by dragging performances around
  • Delete any performances in Library if no longer wanted.

Then sync the changes to the robot

Syncing content changes to robot

Ready to sync - items that will be synced marked

Transferred performance in library from example above
Sync symbol indicates items that will be synced (i.e. updated or transferred or re-ordered)
Click Sync to add the sync job to the File Transfers list and initiate the changes
Once the robot is online it will begin to synchronise. When the content has been transferred to the robot the Status will show as "completed".


Sync job completed


To see the updated content on your touch screen, change to one of the other pages on your touch screen (e.g. LIVE or LANGUAGE) then click on LIBRARY again to reload the LIBRARY page - you should now see all your changes.

Properties

Access the properties panel by clicking on the ">>" :

accessing properties


This opens the Properties panel

Properties panel open


Select a sequence in Files that you wish to change the properties of. The following properties are availabnle

Properties elements

ID: unique ID number (For info - can not be altered)
Name: Sequence name
Label: Button label that appears on the Touch Screen interface
Description: Use to describe your content if desired (does not appear on touch screen)
Icon: Select an icon to use on the Button on the Touch Screen or in the Telepresence interface
Limit Control: Limit the sequence in Tritium Arbitration to only control certain parts of the robot (no need to change if unfamiliar with Arbitration)
Exclusive: Arbitration related, no need to change if unfamiliar with Arbitration
Loop: For Telepresence loops - sequences that will loop until told to stop
Robot Model: For info - robot model the sequence was created for.

Icon selection

icon selection box

Click in the empty box next to Icon this will open Icons window
Here you can select an existing icon e.g. humphrey , or scroll to the bottom of the icons and click "+ Upload" to upload your own.


The icon property will update to the selected icon:

changing performance icons


After making any changes in properties hit sync again to sync the changes to the robot.

Clicking the "<<" symbol closes the properties panel

Some useful shortcuts

  • slow click folder or performance name to rename
  • double click folder to open
  • double click performance to edit
  • click an arrow next to a folder to show / hide subfolders
  • double click on a folder to show / hide subfolders

Troubleshooting

If you experience issues transferring content or with Virtual Robot in general please see Virtual Robot Troubleshooting