Yoctopuce Yocto-GPS, User Manual

Page: 453 / 572

20. High-level API Reference
YGroundSpeed groundspeed
→
describe()
Returns a short text that describes unambiguously the instance of the ground speed sensor in the
form
TYPE(NAME)=SERIAL.FUNCTIONID
.
js
function describe( )
nodejs
function describe( )
cpp
string describe( )
m
-(NSString*) describe
pas
function describe( ): string
vb
function describe( ) As String
cs
string describe( )
java
String describe( )
py
def describe( )
php
function describe( )
es
function describe( )
More precisely,
TYPE
is the type of the function,
NAME
it the name used for the first access to the
function,
SERIAL
is the serial number of the module if the module is connected or
"unresolved"
,
and FUNCTIONID is the hardware identifier of the function if the module is connected. For example,
this method returns
Relay(MyCustomName.relay1)=RELAYLO1-123456.relay1
if the
module is already connected or Relay(BadCustomeName.relay1)=unresolved if the module
has not yet been connected. This method does not trigger any USB or TCP transaction and can
therefore be used in a debugger.
Returns :
a s t r i n g t h a t d e s c r i b e s t h e g r o u n d s p e e d s e n s o r ( e x :
R e l a y ( M y C u s t o m N a m e . r e l a y 1 ) = R E L A Y L O 1 - 1 2 3 4 5 6 . r e l a y 1 )
www.yoctopuce.com 447