Yoctopuce Yocto-GPS, User Manual

Page: 459 / 572

20. High-level API Reference
YGroundSpeed groundspeed
→
get_friendlyName()
groundspeed
→
friendlyName()
R e t u r n s a g l o b a l i d e n t i f i e r o f t h e g r o u n d s p e e d s e n s o r i n t h e f o r m a t
M O D U L E _ N A M E . F U N C T I O N _ N A M E
.
js
function get_friendlyName( )
nodejs
function get_friendlyName( )
cpp
string get_friendlyName( )
m
-(NSString*) friendlyName
cs
string get_friendlyName( )
java
String get_friendlyName( )
py
def get_friendlyName( )
php
function get_friendlyName( )
es
function get_friendlyName( )
The returned string uses the logical names of the module and of the ground speed sensor if they are
defined, otherwise the serial number of the module and the hardware identifier of the ground speed
sensor (for example:
MyCustomName.relay1
)
Returns :
a string that uniquely identifies the ground speed sensor using logical names (ex:
MyCustomName.relay1
)
On failure, throws an exception or returns
Y_FRIENDLYNAME_INVALID
.
www.yoctopuce.com 453