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

21. High-level API Reference
YRangeFinder rangefinder
→
describe()
Returns a short text that describes unambiguously the instance of the range finder in the form
TYPE(NAME)=SERIAL.FUNCTIONID
.
js
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 string that describes the range finder (ex:
Relay(MyCustomName.relay1)=RELAYLO1-
123456.relay1 )
240 www.yoctopuce.com