Yoctopuce Yocto-RangeFinder, User Manual, Page: 40 / 497

command
is the command you want to run. Almost all the functions available in the classic
programming APIs are available as commands. You need to respect neither the case nor the
underlined characters in the command name.
[parameters]
logically are the parameters needed by the command.
At any time, the command line API executables can provide a rather detailed help. Use for instance:
C:\> executable /help
to know the list of available commands for a given command line API executable, or even:
C:\> executable command /help
to obtain a detailed description of the parameters of a command.
7.3. Control of the RangeFinder function
To control the RangeFinder function of your Yocto-RangeFinder, you need the YRangeFinder
executable file.
For instance, you can launch:
C:\> YRangeFinder any get_currentValue
This example uses the " any " target to indicate that we want to work on the first RangeFinder function
found among all those available on the connected Yoctopuce modules when running. This prevents
you from having to know the exact names of your function and of your module.
But you can use logical names as well, as long as you have configured them beforehand. Let us
imagine a Yocto-RangeFinder module with the
YRNGFND1-123456 serial number which you have
called " MyModule ", and its rangeFinder function which you have renamed " MyFunction ". The five
following calls are strictly equivalent (as long as MyFunction is defined only once, to avoid any
ambiguity).
C:\> YRangeFinder YRNGFND1-123456.rangeFinder describe
C:\> YRangeFinder YRNGFND1-123456.MyFunction describe
C:\> YRangeFinder MyModule.rangeFinder describe
C:\> YRangeFinder MyModule.MyFunction describe
C:\> YRangeFinder MyFunction describe
To work on all the RangeFinder functions at the same time, use the " all " target.
C:\> YRangeFinder all describe
For more details on the possibilities of the
YRangeFinder
executable, use:
C:\> YRangeFinder /help
7.4. Control of the module part
Each module can be controlled in a similar way with the help of the
YModule
executable. For
example, to obtain the list of all the connected modules, use:
C:\> YModule inventory
7. Using the Yocto-RangeFinder in command line
34 www.yoctopuce.com