Yoctopuce Yocto-GPS, User Manual

Page: 447 / 572

20. High-level API Reference
YGroundSpeed YGroundSpeed.FindGroundSpeed()
yFindGroundSpeed()
Retrieves a ground speed sensor for a given identifier.
js
function yFindGroundSpeed( func )
nodejs
function FindGroundSpeed( func )
cpp
YGroundSpeed* yFindGroundSpeed( string func )
m
+(YGroundSpeed*) FindGroundSpeed : (NSString*) func
pas
function yFindGroundSpeed( func : string): TYGroundSpeed
vb
function yFindGroundSpeed( ByVal func As String) As YGroundSpeed
cs
YGroundSpeed FindGroundSpeed( string func )
java
YGroundSpeed FindGroundSpeed( String func )
uwp
YGroundSpeed FindGroundSpeed( string func )
py
def FindGroundSpeed( func )
php
function yFindGroundSpeed( $func )
es
function FindGroundSpeed( func )
The identifier can be specified using several formats:
FunctionLogicalName
●
ModuleSerialNumber.FunctionIdentifier
●
ModuleSerialNumber.FunctionLogicalName
●
ModuleLogicalName.FunctionIdentifier
●
ModuleLogicalName.FunctionLogicalName
●
This function does not require that the ground speed sensor is online at the time it is invoked. The
returned object is nevertheless valid. Use the method YGroundSpeed.isOnline() to test if the
ground speed sensor is indeed online at a given time. In case of ambiguity when looking for a ground
speed sensor by logical name, no error is notified: the first instance found is returned. The search is
performed first by hardware name, then by logical name.
Parameters :
func a string that uniquely characterizes the ground speed sensor
Returns :
a YGroundSpeed object allowing you to drive the ground speed sensor.
www.yoctopuce.com 441