Make an ARC Skill

Example: ControlCommand() Binding

Overview
The ControlCommand() is a scripting function which enables users to send commands and parameters to supporting controls from another control. It is how controls communicate. Each control broadcasts a list of commands it supports. These commands are displayed in the Cheat Sheet while users are editing scripts (JavasScript or EZ-Script). When a ControlCommand() is executed that has a destination name matching your plugin, an event is triggered in which you will respond.

User-inserted image



An Example
An example of a popular ControlCommand() is starting the video feed in the camera control. Users will add Script Control to their program which instructs the Camera Control to begin streaming video from the specified video source.

Code:


# JavaScript example to start the video feed on a camera control
controlCommand("Camera Control", "CameraStart");


You may notice that some ControlCommand() will accept optional parameters. The CameraStart also has an optional parameter, which is the device name.

Code:


# JavaScript example to start the video feed on a camera control specifying device name
controlCommand("Camera Control", "CameraStart", "EZB://192.168.1.1:24");



Bind To ControlCommand()
Now that the user is aware of the supported options available in your Cheat Sheet, we will bind to the script engine for any calls directed to your control. This is done through an override method which will be raised in the event that a ControlCommand() matches your control.

Some facts to note in this example code...

1) Comparison is case insensitive. We have no idea what case the text will be entered by the user.

2) If no commands match your syntax, the Base() method will notify the script engine.

3) If expected parameters are missing or incorrect, you may throw an exception which will be caught by the parent script engine.

4) To avoid cross-threading exceptions, there is a fancy helper class ARC.Invokers which contains methods to manipulate user controls from different threads. The SendCommand() event will always be called from a background thread. This is because the script engine will never execute threads on a GUI thread.

Code:


public override void SendCommand(string windowCommand, params string[] values) {

if (windowCommand.Equals("PauseOn", StringComparison.InvariantCultureIgnoreCase)) {

ARC.Invokers.SetChecked(checkbox1, true);

if (values.Length == 1)
ARC.Invokers.SetText(checkbox1, values[0]);
else if (values.Length > 1)
throw new Exception(string.Format("Only 0 or 1 parameters expected. You passed {0}", values.Length));

} else if (windowCommand.Equals("PauseOff", StringComparison.InvariantCultureIgnoreCase)) {

ARC.Invokers.SetChecked(checkbox1, false);

if (values.Length == 1)
ARC.Invokers.SetText(checkbox1, values[0]);
else if (values.Length > 1)
throw new Exception(string.Format("Only 0 or 1 parameters expected. You passed {0}", values.Length));

} else {

base.SendCommand(windowCommand, values);
}
}



Conclusion
By using the ControlCommand(), users can send commands to your plugin or configure settings, all from scripts. This gives your plugin the ability to be better customized for the users needs programmatically.


Blockly
ControlCommand() are usable in Blockly UI, with one exception. Because the Blockly UI does not contain the ability for user defined parameters of the ControlCommand() feature, they are limited to commands with no user parameters. This means that a ControlCommand() with parameters will not display in the Blockly UI.

The ControlCommand() for Blockly is found in the Utility category.
User-inserted image


Viewing the available ControlCommand()'s within blockly, you will see that commands accepting user parameters are not displayed..
User-inserted image


To further the example, here are two control commands in which one will be displayed, and one will not be

Code:


// This will be displayed in blockly
controlCommand("My Control", "SetColorRed");
controlCommand("My Control", "SetColorGreen");

// These will not be displayed in Blockly because it accepts a user parameter
controlCommand("My Control", "SetColor", "Red");
controlCommand("My Control", "SetColor", "Green");

#11  
User-inserted image


User-inserted image


User-inserted image


User-inserted image
Sorry but can I ask you something why I didn't see the ARC library when I added visual studio even though I set up the C ++. DLL library and there's another way to execute it and send / receive console in out but I don't know how to do it with EZ_builder?
PRO
Synthiam
#12   — Edited
Please follow the tutorial. It’s impossible to know why you’re plug-in isn’t showing up without asking you if you followed each step of the tutorial :). Reviewing your screenshots, it doesn’t appear as if any of the tutorial steps have been followed.
#13   — Edited
Hi i fixed it. thanks

Hello, I am trying the tutorial to get the robot to speak. I am using Visual studio. Currently, the sound is output from the pc instead of the robot. Is there a code I can attach so that the sound comes from the robot speakers instead of the pc?
PRO
Synthiam
#14   — Edited
Look in this tutorial for the step labeled "output audio from ezb". It’s lower down in the list. There’s instruction examples
for either playing audio (ie mp3) or text to speech.
#15  
Error: the referenced component" EZ_builder,EZ_B" could not be found, DJ Sure i hope you can help me !
PRO
Synthiam
#16   — Edited
User-inserted image
Joinny, you have to add the referencing by following the instructions in this tutorial. They are outlined with step by step to easily follow. Click add references, and browse to the appropriate files as directed in the tutorial. I can’t write anything clearer in response. The step to add references is incredibly clear but you’re skipping it.
#17  
The error cannot read the COM file, I downloaded it and when I follow the instructions, I get an error, while other files read normally.
.User-inserted image
#18   — Edited
sorry for me but i tried many different ways but still show the error,I couldn't find EZ_B.dll file even though I downloaded it
PRO
Synthiam
#19  
None of the required references are in your list. Please follow the tutorial. It explains exactly how to click the browse button and navigate to the folder and select the files.
#20  
Sorry, but the reason I can't reference is because there is no file in the EZ_B folder and there is an error : this folder is empty , I am trying to solve it. I would like to thank DJ sure for answering my superfluous questions and I'm sorry for bothering you
Australia
#21   — Edited
I need to playback 5 Serial Bus servos in sequence.
PRO
Synthiam
#22   — Edited
What protocol is it? A "serial bus" is a generic term for anything using a UART that's chained together sharing the same RX line. Also, why did you add a photo with the question text added in your response?

Are you planning on making a skill control to do this? You wrote the question in the skill control thread in a comment - I'd like to make sure your question is in the right place to help you out.

To begin, I would recommend starting with servo Script control so you can make the serial bus protocol work - then consider making a skill control only if you're planning on distributing the effort to others: https://synthiam.com/Products/Controls/Scripting/Servo-Script-19068
#23  
He seems rather demanding as well.  I guess he needs the benefit of the doubt as English may not be his native language....
#24   — Edited
I have installed all the software dependencies and still ARC does not detect that I have Visual Studio installed.
OS is Windows 10, .NET 4.8 or newer, Visual Studio Community 2019.
PRO
Synthiam
#25  
When the popup says it doesn’t detect visual studio, you can still skip and continue. I wonder why it’s not detecting it? We had a hard time trying to find a proper way of detecting - even Microsoft’s suggestion didn’t actually work *eye roll*

ill look into it a bit further and see if we can find a better way of detecting
PRO
USA
#26  
@DJ:
It's easy to find the Visual Studio 2017 and up:
Microsoft:
https://github.com/Microsoft/vswhere/wiki/Find-MSBuild

Some quick c# code to use with .NET:
https://github.com/ppedro74/Utils/blob/master/FindVisualStudio/Program.cs

Code:

using System;
using System.Diagnostics;
using System.IO;

namespace FindVisualStudio
{
internal class Program
{
static string ProcessStart(string fileName, string args)
{
var processStartInfo = new ProcessStartInfo
{
Arguments = args,
CreateNoWindow = true,
FileName = fileName,
RedirectStandardOutput = true,
UseShellExecute = false,
WindowStyle = ProcessWindowStyle.Hidden,
WorkingDirectory = Path.GetDirectoryName(fileName),
};

using (var process = Process.Start(processStartInfo))
{
process.WaitForExit();
return process.StandardOutput.ReadToEnd().Trim();
}
}

private static string GetInstallationPath(string vsWhere)
{
var installationPath = ProcessStart(vsWhere, "-latest -products * -requires Microsoft.Component.MSBuild -property installationPath");
return installationPath;
}

private static string GetProductLineVersion(string vsWhere)
{
var version = ProcessStart(vsWhere, "-latest -property catalog_productLineVersion");
return version;
}


private static void Main(string[] args)
{
var programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86);
var vsWhere = Path.Combine(programFiles, "Microsoft Visual Studio", "Installer", "vswhere.exe");
if (!File.Exists(vsWhere))
{
throw new FileNotFoundException("Cannot find Microsoft Visual Studio's vswhere.exe utility.", vsWhere);
}

var version = GetProductLineVersion(vsWhere);
Console.WriteLine($"Visual Studio Version: {version}");

var installationPath = GetInstallationPath(vsWhere);
if (!Directory.Exists(installationPath))
{
throw new DirectoryNotFoundException(installationPath);
}

Console.WriteLine($"Visual Studio installation Path: {installationPath}");

}
}
}
PRO
USA
#27   — Edited

Quote:

With Visual Studio 2017 Update 2 or newer installed, you can find vswhere at %ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe, or to make sure it's always available in your repo see Installing for an option using NuGet.
Because is only available with "Visual Studio 2017 Update 2", you can add the vswhere package to your ARC project, and use your version (nuget) to detect older 2017 or legacy Visual Studio Versions (although does not make sense for ARC).
https://devblogs.microsoft.com/setup/vswhere-now-searches-older-versions-of-visual-studio/
PRO
Synthiam
#28   — Edited
We went this route and it didn’t work on my computer - because I had a preview of visual studio installed which isn’t in that directory path. Microsoft had numerous suggestions of detecting visual studio. The one which worked for our various installations was a registry check. 

apparently with the above individual, the registry didn’t work either. I’ll have to combine a few methods.

everything looks simple from the outside - until you have a hundred thousand+ installations of your software. That’s when you run into things like this lol
PRO
USA
#29   — Edited
@DJ:
I agree sometimes the things go out of script easily.

I avoid going through the registry keys, unless is recommended by the vendor.
A lot of people blame the changes (keys,  entries are renamed etc), but, that is normal if I own my product is my business and is part of the software evolution. Some products you can break the support contract agreement if you query directly the database, or if you look elsewhere outside of the public API.

Is true story some years ago a "rogue" developer on my team released a Sharepoint integration using a mix of APIs and database queries, everything worked well with multiple clients, until one day the Microsoft Black suits visit one of the customers to follow up on an unrelated support ticket, and they basically used "unsupported" card and left the client hanging, and we had problems too, unfortunately the Rogue developer went to another galaxy ... and the team suffered the consequences.   

That does not mean I'm not tempted to do it...:) 

I used the vswhere before and I would say is almost 99% bulletproof, is used with Xamarin, NVIDIA, Intel setups. If you add vswhere.exe to your project (nuget package) you cover scenarios where the tool is not present or have been deleted (broken uninstalls). 

The other fallback could be ask the user the visual studio version.

The other reason to avoid registry is due to Visual Studio uses a private exclusive registry keys to store more stuff: 
http://www.visualstudioextensibility.com/2017/07/15/about-the-new-privateregistry-bin-file-of-visual-studio-2017/

So the things are getting more complex.

The above post is only part of the "Full solution" for example I have one setup with visual studio 2017 c# installed and Visual studio 2019 with Python and C++, vswhere will return 2019 version,  but my c# is done with VS2017.

If you are generating customized vs version project files, maybe a fallback (ask the VS version) will cover more bases.
PRO
Synthiam
#30  
Yes - Microsoft has a few pages on how to identify visual studio and we tried them all during testing - the one we went with was with registry. I'm going to combine the two as using only one method apparently doesn't work for all cases.