Difference between revisions of "Control Studio"

From SoftMC-Wiki
Jump to: navigation, search
(→‎tools: IP configurator)
(Removed unnecessary commands)
 
(82 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{Languages}}
+
{{Languages|Control_Studio}}
−
= ControlStudio =  
+
<div id="BackToTop"  class="noprint" style="background-color:; position:fixed; bottom:32px; left:95%; z-index:9999; padding:0; margin:0;">
−
 
+
<span style="color:blue; font-size:8pt; font-face:verdana,sans-serif; border:0.2em outset:#ceebf7; padding:0.1em; font-weight:bolder; -moz-border-radius:8px; ">
 +
[[Image:TOP2.png|50px|link=#top]] </span></div>
  
 +
= ControlStudio Overview =
 
ControlStudio software is a development tool for motion applications. It contains a programming editor, data recorder, debugger and monitoring tools.
 
ControlStudio software is a development tool for motion applications. It contains a programming editor, data recorder, debugger and monitoring tools.
 
* ControlStudio is the integrated development environment (IDE) for the softMC.
 
* ControlStudio is the integrated development environment (IDE) for the softMC.
Line 11: Line 13:
 
[[File:ControlStudio_gui_components.png|800px]]
 
[[File:ControlStudio_gui_components.png|800px]]
  
−
==tools==
+
=IP Configurator=
−
===IP Configurator===
+
==IP Configurator Intro==
−
===SSH Terminal===
+
The '''IP Configurator''' tool helps you define a new (static) IP address, or determine an unknown IP address of the softMC.<br><br />
−
Description
+
To use the IP Configurator, the following are required:
 +
* Computer running ControlStudio
 +
* sofMC 3 | softMC 7 | softMC 703
 +
* Ethernet cable for connection between your network and the softMC 
 +
* Serial cable for connection between the softMC and the host computer
 +
* DC power supply for the softMC
 +
<br>
 +
{{Note|The host PC’s IP address must be in the same subnet as the addresses in the ControlStudio IP pool. }}
 +
<br>
 +
{{Note|To change the IP address:<br />
 +
* The softMC 703 must be connected to the host computer by means of a USB-RS485 converter cable.
 +
* Other softMC 3 and softMC 7 models must be connected to the host computer by means of a USB-RS232 converter cable.}}
 +
<br>
 +
 
 +
==IP Configuration Procedure==  
 +
 
 +
To configure a static IP address for the softMC, perform the following procedure.<br><br />
 +
#Make sure the softMC is connected to the power supply, to the network (Ethernet cable), and to the computer COM port (serial cable from softMC COM1 port).<br><br />
 +
#Activate ControlStudio.<br><br />
 +
#In ControlStudio, open the '''Controller Monitor''' pane at the right side of the screen.
 +
#:The pane displays a list of devices connected to your network and their IP addresses. 
 +
#:0.0.0.0 in the '''IP Address''' column indicates that the IP address of the softMC is not configured, or cannot be detected.<br><br />
 +
#:[[image: IP_1.png|800px]]<br><br />
 +
#Determine a suitable IP address in your network for the softMC configuration.
 +
#:Check with the network manager of your site for a usable IP address.
 +
#:Also get the details for '''Subnet Mask''' and '''Default Geteway'''.<br><br />
 +
#In ControlStudio, open the '''Tools''' menu, and select '''IP Configurator'''.<br><br />
 +
#:[[image: IP_2.png|800px]] <br><br />
 +
#:The IP Configurator prompt appears.<br><br />
 +
#:[[image: IP_6.png|250px]] <br><br />
 +
#If you know the IP address of the softMC, press '''Yes'''.
 +
#:(If you do not know the IP address, skip to Step 7.)<br><br />
 +
#:The '''Connect via Network''' dialog box opens.
 +
#:Enter the required information in all 3 fields, and press '''Connect'''. <br><br />
 +
#:[[image: IP_7.png|250px]] <br><br />
 +
#:The softMC will now appear in the Controller Monitor pane with the new IP address, ready for connection.
 +
#:Continue at Step 8 - '''Set IP''' dialog box. <br><br />
 +
#If you do not know the IP address of the softMC, press '''No'''. <br><br />
 +
#:The '''Connect via COM''' dialog box opens, and prompts you to connect the softMC COM1 port to the computer.<br><br />
 +
#:[[image: IP_8.png|250px]] <br><br />
 +
#:If you cannot identify the COM1 port, press '''Where is my COM port'''?  The software will display image to help you locate the correct port.<br><br />
 +
#:[[image: IP_9.png|250px]] <br><br />
 +
#:If the softMC is connected properly, press '''Connect'''.<br><br />
 +
#:The '''Select COM Device''' dialog box opens, and prompts you to select the serial port on your PC that is connected to the softMC.
 +
#:Select the correct serial port, and press Connect.<br><br />
 +
#:[[image: IP_10.png|250px]] <br><br />
 +
#The '''Set IP''' dialog box opens.<br><br />
 +
#:[[image: IP_11.png|250px]] <br><br />
 +
#Chose either one of the options: <br><br />
 +
#:(A) Select the option '''Obtain an IP address automatically''' to connect to an IP address that the network provides, and press '''Apply'''.
 +
#:You can press Show Config to view the IP address details.<br><br />
 +
#:[[image: IP_12.png|250px]] <br><br />
 +
#:(B) Select the option '''Static IP address''' to configure a user-defined address (defined in Step 4), enter the required  info in the fields, and press '''Apply'''.<br><br />
 +
#:[[image: IP_14.png|250px]] <br><br />
 +
#Once the IP address has been configured, the IP Configurator prompts you to reboot the softMC so that the changes will take effect.
 +
#:Press Yes to confirm.<br><br />
 +
#:[[image: IP_15.png|250px]]<br><br />
 +
#:After the reboot, you can close the IP Configurator.<br><br />
 +
#In the Controller Monitor pane, you can now see and connect to the softMC that uses this IP address.<br><br />
 +
#:[[image: IP_16.png|800px]]<br><br />
 +
 
  
−
====Getting started====
+
<!--
 +
OLDER VERSION - TO BE DELETED
 +
—————————————————————————————
 +
 
 +
'''Step 1''' - Connect your softMC to the power supply, the network - with the Ethernet cable, and to the computer - from COM1 (as shown), with the serial cable. <br>
 +
::[[image: IP_9.png|300px]]
 +
run '''ControlStudio''' and turn on your softMC.
 +
 
 +
 
 +
'''Step 2''' - In the ControlStudio, go to '''controller Monitor''' menu at the right side of the screen. There you will see the devices which connect to your network, without any information about your new unknown softMC or with device that doesn't have IP address:  <br>
 +
::[[image: IP_1.png|900px]] <br>
 +
 
 +
 
 +
'''Step 3''' - According to your network properties - choose an IP address or get one from your network manager.<br>
 +
You can check the address availability by using ''windows command'' tool (CMD), with '''ping''' command as shown here in yellow:
 +
::[[image: IP_3.png|600px]] <br>
 +
 
 +
Additional information about your address will be found in the same window, using the '''ipconfig''' command:
 +
::[[image: IP_4.png|600px]] <br>
 +
The information that required to us is the '''Subnet Mask''' and the '''default Geteway''':
 +
::[[image: IP_5.png|600px]] <br>
 +
 
 +
'''Step 4''' - In the ControlStudio, at the menu bar - choose '''Tools''' <big><big>→</big></big> '''IP Configurator'''. <br>
 +
::[[image: IP_2.png|900px]] <br>
 +
 
 +
'''Step 5''' - New window will open.<br>
 +
::[[image: IP_6.png|250px]] <br>
 +
 
 +
* In case you already '''know''' the device IP address - choose ''Yes'' button. A '''Connect Via Network''' window will pop-up - fill the blank spaces with the correct information and press the ''Connect'' button. <br>
 +
:::[[image: IP_7.png|250px]] <br>
 +
You will find your sofMC, with the known IP address, at the '''controller Monitor''' menu ready to connect. 
 +
 
 +
* In case you '''don't know''' softMC IP address - choose ''No'' button. A '''Connect Via COM''' window will pop-up. In this window you will be asked about the connection between the softMC and your PC - the COM1 port. If you don't sure how to locate it - press ''Where is my COM port?'' link or go back to '''Step 1''' for the picture. If the softMC connected properly - choose the ''Connect'' button.  <br>
 +
:::[[image: IP_8.png|250px]] <br>
 +
 
 +
 
 +
'''Step 6''' - New window will open - '''Select COM Device'''. In this window you'll have to choose the serial port in your PC that attached to the softMC<br>
 +
::[[image: IP_10.png|250px]] <br>
 +
After the right port as been selected - press the ''Connect'' button. <br>
 +
 
 +
 
 +
'''step 7''' - The '''Set IP''' window will open. <br>
 +
::[[image: IP_11.png|250px]] <br>
 +
 
 +
 
 +
* In case you '''know''' that your softMC has modified and already have an IP address - you can choose '''Obtain an IP address automatically''' option to use the former address, and press the '''Apply''' button. The details of the IP address will show up when you press the '''Show Config''' button. <br>
 +
::[[image: IP_12.png|250px]] <br>
 +
Now you can find and connect to the softMC with the same IP address in the '''controller Monitor''' menu at the right, and close the '''IP Configurator'''.  <br>
 +
::[[image: IP_13.png|900px]] <br>
 +
 
 +
* In case you '''don't know''' any former information about the IP address, you should choose '''Static IP address''' option, and fill the blank spaces with the information you gain  at '''Step 3''' - the ''IP address'' you choose, '''subnet mask''' and '''default geteway''' - now choose '''Apply''' button.
 +
::[[image: IP_14.png|250px]] <br>
 +
 
 +
You can find and connect to the softMC with the new IP address in the '''controller Monitor''' on the right, and close the '''IP Configurator'''.  <br>
 +
::[[image: IP_16.png|900px]] <br>
 +
 
 +
{{Note| After setting the new data about the IP address, the IP Configurator will ask you to reboot the softMC - approve that to ratify the new setting 
 +
}} <br>
 +
::[[image: IP_15.png|350px]]
 +
-->
 +
 
 +
=SSH Terminal=
 +
==Description==
 +
 
 +
==Getting Started==
 
{{Note| This manual is under the assumption that the ControlStudio already connected to a robot or a simulator.}} <br>  
 
{{Note| This manual is under the assumption that the ControlStudio already connected to a robot or a simulator.}} <br>  
  
Line 40: Line 166:
 
::[[image: SSH_4.png |800px]] <br>
 
::[[image: SSH_4.png |800px]] <br>
  
−
 
+
==Example==
−
 
 
−
====Example====
 
 
In this example we use the '''ls''' command - that provide list of files in the current working directory.  
 
In this example we use the '''ls''' command - that provide list of files in the current working directory.  
 
{{Note|The SSH Terminal operated by '''Linux''' commands.}}
 
{{Note|The SSH Terminal operated by '''Linux''' commands.}}
Line 54: Line 178:
 
'''Step 2''' - In the same window, you will get the information you asked for. <br>  
 
'''Step 2''' - In the same window, you will get the information you asked for. <br>  
 
::[[image: SSH_6.png | 800px]] <br>
 
::[[image: SSH_6.png | 800px]] <br>
 +
 +
 +
=MC Authentication=
 +
==Description==
 +
softMC Authentication provide you a security and safety tool, which define password to working softMC. This system prevent situation that while working with system controlled by softMC and ControlStudio, someone else connect to your system and move it. Duplicate connection can cause in some scenario serious accident or injury, and can prevent using this manual.
 +
 +
==Authentication Set-Up==
 +
To activate Authentication system you should import '''"C"''' subroutine called '''USER_ES_PASSW''' as shown bellow. <br>
 +
After import the subroutine you can define password for your softMC by using - '''?USER_ES_PASSW("*****")'''.<br>
 +
Replace '''*****''' with your own password, in '''String''' format.
 +
 +
'''Step to set-up:''' <br>
 +
At your ControlStudio terminal send the following commands:
 +
 +
<syntaxhighlight lang="VB">
 +
-->IMPORT_C USER_ES_PASSW(ByVal as String) as long  'activated the subroutine
 +
-->?USER_ES_PASSW("Hello")                          'define new password
 +
</syntaxhighlight>
 +
 +
{{Note| If you receive back '''"0"''' from softMC (at terminal) - new password definition complete. In case of an error you will receive an error message.}}
 +
 +
 +
In this case we define new password ("Hello") for our softMC. Now it's necessary to define the chosen password to ControlStudio: <br>
 +
# At ControlStudio open '''Settings''' window.
 +
# Under '''Controller Monitor''' label you will find '''MC Authent. pwd.'''. Put your new password at the right side of the parameter. Step out of the setting window <br> [[image:Authen 1.png|700px]]
 +
# At the bar menu go to: '''Tools <big>→</big> MC Authentication''', and press the button. <br> [[image:Authen 2.png|700px]]
 +
# Now your softMC protected with a password which you choose.
 +
 +
 +
From now on users which connect to your softMC and want to send any commands to your system using ControlStudio, needs to put the right password the way explained to make any change.
 +
 +
==Not Allowed Users==
 +
Not allowed users will receive the following message:
 +
<syntaxhighlight lang="VB">
 +
DEV Err 0x00030027: Error:  5053, "Password authentication required", Task: ,tEthernInp0, Line: none, Module: Entry_Station
 +
</syntaxhighlight>
 +
 +
In this situation the user will be able to get information about the system like positions, velocities, system parameters etc. But won't be able to rewrite any system parameter. <br>
 +
For example: <br>
 +
[[image: Authen 3.PNG]]
 +
 +
 +
In this example user get information about axis status, but can't change this status.

Latest revision as of 14:50, 14 May 2018

Language: English  • 中文（简体）‎

TOP2.png

ControlStudio Overview

ControlStudio software is a development tool for motion applications. It contains a programming editor, data recorder, debugger and monitoring tools.

  • ControlStudio is the integrated development environment (IDE) for the softMC.
  • Used to write programs (tasks), debug tasks, record data.
  • Graphical user interface.
  • Provides a command line interface (terminal) to the softMC

ControlStudio gui components.png

IP Configurator

IP Configurator Intro

The IP Configurator tool helps you define a new (static) IP address, or determine an unknown IP address of the softMC.

To use the IP Configurator, the following are required:

  • Computer running ControlStudio
  • sofMC 3 | softMC 7 | softMC 703
  • Ethernet cable for connection between your network and the softMC
  • Serial cable for connection between the softMC and the host computer
  • DC power supply for the softMC


NOTE-Info.svgNOTE
The host PC’s IP address must be in the same subnet as the addresses in the ControlStudio IP pool.


NOTE-Info.svgNOTE
To change the IP address:
  • The softMC 703 must be connected to the host computer by means of a USB-RS485 converter cable.
  • Other softMC 3 and softMC 7 models must be connected to the host computer by means of a USB-RS232 converter cable.


IP Configuration Procedure

To configure a static IP address for the softMC, perform the following procedure.

  1. Make sure the softMC is connected to the power supply, to the network (Ethernet cable), and to the computer COM port (serial cable from softMC COM1 port).

  2. Activate ControlStudio.

  3. In ControlStudio, open the Controller Monitor pane at the right side of the screen.
    The pane displays a list of devices connected to your network and their IP addresses.
    0.0.0.0 in the IP Address column indicates that the IP address of the softMC is not configured, or cannot be detected.

    IP 1.png

  4. Determine a suitable IP address in your network for the softMC configuration.
    Check with the network manager of your site for a usable IP address.
    Also get the details for Subnet Mask and Default Geteway.

  5. In ControlStudio, open the Tools menu, and select IP Configurator.

    IP 2.png

    The IP Configurator prompt appears.

    IP 6.png

  6. If you know the IP address of the softMC, press Yes.
    (If you do not know the IP address, skip to Step 7.)

    The Connect via Network dialog box opens.
    Enter the required information in all 3 fields, and press Connect.

    IP 7.png

    The softMC will now appear in the Controller Monitor pane with the new IP address, ready for connection.
    Continue at Step 8 - Set IP dialog box.

  7. If you do not know the IP address of the softMC, press No.

    The Connect via COM dialog box opens, and prompts you to connect the softMC COM1 port to the computer.

    IP 8.png

    If you cannot identify the COM1 port, press Where is my COM port? The software will display image to help you locate the correct port.

    IP 9.png

    If the softMC is connected properly, press Connect.

    The Select COM Device dialog box opens, and prompts you to select the serial port on your PC that is connected to the softMC.
    Select the correct serial port, and press Connect.

    IP 10.png

  8. The Set IP dialog box opens.

    IP 11.png

  9. Chose either one of the options:

    (A) Select the option Obtain an IP address automatically to connect to an IP address that the network provides, and press Apply.
    You can press Show Config to view the IP address details.

    IP 12.png

    (B) Select the option Static IP address to configure a user-defined address (defined in Step 4), enter the required info in the fields, and press Apply.

    IP 14.png

  10. Once the IP address has been configured, the IP Configurator prompts you to reboot the softMC so that the changes will take effect.
    Press Yes to confirm.

    IP 15.png

    After the reboot, you can close the IP Configurator.

  11. In the Controller Monitor pane, you can now see and connect to the softMC that uses this IP address.

    IP 16.png


SSH Terminal

Description

Getting Started

NOTE-Info.svgNOTE
This manual is under the assumption that the ControlStudio already connected to a robot or a simulator.

step 1 - At the menu bar, under the Tools tab - choose the SSH Terminal button.

SSH 1.png


step 2 - A new window will be opened. In this window you need to confirm the folowing:

  • IP address that belong to your robot/simulator.
  • Your username and password to access your robot/simulator.
SSH 2.png


step 3 - Back to the menu bar, under the view tab - choose the SSH Terminal button.

SSH 3.png



step 4 - The SSH Terminal interface will be opend, ready for yout commands.

SSH 4.png

Example

In this example we use the ls command - that provide list of files in the current working directory.

NOTE-Info.svgNOTE
The SSH Terminal operated by Linux commands.


Step 1 - In the SSH terminal window add the command you want to activated, and press the enter button.

SSH 5.png


Step 2 - In the same window, you will get the information you asked for.

SSH 6.png


MC Authentication

Description

softMC Authentication provide you a security and safety tool, which define password to working softMC. This system prevent situation that while working with system controlled by softMC and ControlStudio, someone else connect to your system and move it. Duplicate connection can cause in some scenario serious accident or injury, and can prevent using this manual.

Authentication Set-Up

To activate Authentication system you should import "C" subroutine called USER_ES_PASSW as shown bellow.
After import the subroutine you can define password for your softMC by using - ?USER_ES_PASSW("*****").
Replace ***** with your own password, in String format.

Step to set-up:
At your ControlStudio terminal send the following commands: 

-->IMPORT_C USER_ES_PASSW(ByVal as String) as long  'activated the subroutine
-->?USER_ES_PASSW("Hello")                          'define new password
NOTE-Info.svgNOTE
If you receive back "0" from softMC (at terminal) - new password definition complete. In case of an error you will receive an error message.


In this case we define new password ("Hello") for our softMC. Now it's necessary to define the chosen password to ControlStudio:

  1. At ControlStudio open Settings window.
  2. Under Controller Monitor label you will find MC Authent. pwd.. Put your new password at the right side of the parameter. Step out of the setting window
    Authen 1.png
  3. At the bar menu go to: Tools → MC Authentication, and press the button.
    Authen 2.png
  4. Now your softMC protected with a password which you choose.


From now on users which connect to your softMC and want to send any commands to your system using ControlStudio, needs to put the right password the way explained to make any change.

Not Allowed Users

Not allowed users will receive the following message: 

DEV Err 0x00030027: Error:  5053, "Password authentication required", Task: ,tEthernInp0, Line: none, Module: Entry_Station

In this situation the user will be able to get information about the system like positions, velocities, system parameters etc. But won't be able to rewrite any system parameter.
For example:
Authen 3.PNG


In this example user get information about axis status, but can't change this status.

Retrieved from "http://softmc.servotronix.com/index.php?title=Control_Studio&oldid=132678"