Yoctopuce Yocto-GPS, User Manual

Page: 40 / 572

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.
6.3. Control of the Latitude function
To control the Latitude function of your Yocto-GPS, you need the YLatitude executable file.
For instance, you can launch:
C:\> YGps any get_latitude
This example uses the " any " target to indicate that we want to work on the first Latitude 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-GPS module with the
YGNSSMK1-123456 serial number which you have called
" MyModule ", and its latitude 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:\> YLatitude YGNSSMK1-123456.latitude describe
C:\> YLatitude YGNSSMK1-123456.MyFunction describe
C:\> YLatitude MyModule.latitude describe
C:\> YLatitude MyModule.MyFunction describe
C:\> YLatitude MyFunction describe
To work on all the Latitude functions at the same time, use the " all " target.
C:\> YLatitude all describe
For more details on the possibilities of the
YLatitude
executable, use:
C:\> YLatitude /help
6.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
You can also use the following command to obtain an even more detailed list of the connected
modules:
6. Using the Yocto-GPS in command line
34 www.yoctopuce.com