Yoctopuce Yocto-GPS User Manual Download Page 219

Page: 219 / 572

20. High-level API Reference

YModule

module

→

nextModule()

Continues the module enumeration started using

yFirstModule()

function nextModule( )

nodejs

function nextModule( )

cpp

YModule * nextModule( )

-(YModule*) nextModule

pas

function nextModule( ): TYModule

function nextModule( ) As YModule

YModule nextModule( )

java

YModule nextModule( )

uwp

YModule nextModule( )

def nextModule( )

php

function nextModule( )

Returns :

a pointer to a

YModule

object, corresponding to the next module found, or a

null

pointer if there are no

more modules to enumerate.

www.yoctopuce.com

213

Summary of Contents for Yocto-GPS

Page 1: ...Yocto GPS User s guide...

Page 2: ......

Page 3: ...ming general concepts 17 5 1 Programming paradigm 17 5 2 The Yocto GPS module 19 5 3 Module control interface 21 5 4 GPS function interface 22 5 5 Latitude function interface 23 5 6 Longitude function...

Page 4: ...e C Yoctopuce library 64 10 Using Yocto GPS with Objective C 67 10 1 Control of the Latitude function 67 10 2 Control of the module part 69 10 3 Error handling 71 11 Using Yocto GPS with Visual Basic...

Page 5: ...to Firmware 127 18 4 Updating the firmware with the programming library 128 18 5 The update mode 130 19 Using with unsupported languages 131 19 1 Command line 131 19 2 VirtualHub and HTTP GET 131 19 3...

Page 6: ...22 Characteristics 557 Blueprint 559 Index 561...

Page 7: ...ules are driven the same way Therefore user s guides for all the modules of the range are very similar If you have already carefully read through the user s guide of another Yoctopuce module you can j...

Page 8: ...zes the standard size that you probably use to connect your printer the very common mini size to connect small devices and finally the micro size often used to connect mobile phones as long as they do...

Page 9: ...mmx36mm on which you can directly solder a USB cable instead of using a USB plug For more details see the micro USB hub information sheet YoctoHub Ethernet YoctoHub Wireless and YoctoHub GSM You can a...

Page 10: ...4 www yoctopuce com...

Page 11: ...acts as a lever In this case if the tracks stayed in position the connector can be soldered back with a good iron and using flux to avoid bridges Alternatively you can solder a USB cable directly in t...

Page 12: ...r to the serial number it is a supposedly unique character string which allows you to reference your module by software However in the opposite of the serial number the logical name can be modified at...

Page 13: ...a scenario use a small U FL to SMA female cable and an antenna equipped with an SMA connector Being active you can deport the antenna several meters away without changing the quality of the reception...

Page 14: ...8 www yoctopuce com...

Page 15: ...RL http 127 0 0 1 4444 The list of the Yoctopuce modules connected to your computer is displayed Module list as displayed in your web bowser 3 1 Localization You can then physically localize each of t...

Page 16: ...tined for Yoctopuce modules are available as byn files and can be downloaded from the Yoctopuce web site To update a firmware simply click on the upgrade button on the configuration window and follow...

Page 17: ...functions of the Yocto GPS by clicking on the corresponding rename button The GPS function The gps function groups all the measures computed by the module position ground speed travel direction time a...

Page 18: ...12 www yoctopuce com...

Page 19: ...mm or they will damage the module circuits Make sure that the lower surface of the module is not in contact with the support We recommend using spacers but other methods are possible Nothing prevents...

Page 20: ...le You can use any active GPS antenna directly with the Yocto GPS as long as it can work when powered in 3 3V its gain does not go above 35db 4 3 USB power distribution Although USB means Universal Se...

Page 21: ...attention to provide as much current as possible on the USB ports and to detect overloads before they lead to problems or to hardware damages When modules are not provided enough current they may work...

Page 22: ...16 www yoctopuce com...

Page 23: ...it is unlikely that this will be a hinderance for using Yoctopuce products Note that you will never need to allocate or deallocate an object linked to the Yoctopuce API it is automatically managed Th...

Page 24: ...c enumeration functions FirstXxx and nextXxxx available for each YXxx class Access by hardware name Each module function has a hardware name assigned at the factory and which cannot be modified The fu...

Page 25: ...mA read only rebootCountdown Integer modifiable userVar Integer modifiable gps Gps attribute type modifiable logicalName String modifiable advertisedValue String modifiable isFixed Boolean read only...

Page 26: ...y modifiable reportFrequency Frequency modifiable calibrationParam Calibration parameters modifiable resolution Fixed point number modifiable sensorState Integer read only qnh Fixed point number modif...

Page 27: ...logical name The logical name is limited to 19 characters among A Z a z 0 9 _ and productId USB device identifier of the module preprogrammed to 83 at the factory productRelease Release number of the...

Page 28: ...the same project there is no way to determine which one answers when one tries accessing by logical name The logical name is limited to 19 characters among A Z a z 0 9 _ and advertisedValue Short cha...

Page 29: ...o 19 characters among A Z a z 0 9 _ and advertisedValue Short character string summarizing the current state of the latitude sensor that is automatically advertised up to the parent hub For a latitude...

Page 30: ...cters among A Z a z 0 9 _ and advertisedValue Short character string summarizing the current state of the longitude sensor that is automatically advertised up to the parent hub For a longitude sensor...

Page 31: ...by logical name The logical name is limited to 19 characters among A Z a z 0 9 _ and advertisedValue Short character string summarizing the current state of the altimeter that is automatically adverti...

Page 32: ...gical name are used in the same project there is no way to determine which one answers when one tries accessing by logical name The logical name is limited to 19 characters among A Z a z 0 9 _ and adv...

Page 33: ...e et YLongitude classes logicalName Character string containing the logical name of the GPS initially empty This attribute can be modified at will by the user Once initialized to an non empty value it...

Page 34: ...way to determine which one answers when one tries accessing by logical name The logical name is limited to 19 characters among A Z a z 0 9 _ and advertisedValue Short character string summarizing the...

Page 35: ...user The end user then only needs to plug the USB cable and run your software for everything to work Unfortunately this method is not always available or even possible The application uses the native...

Page 36: ...cess to the module The service control method comes with a non negligible advantage the application does not need to run on the machine on which the modules are connected The application can very well...

Page 37: ...all 5 12 Programming where to start At this point of the user s guide you should know the main theoretical points of your Yocto GPS It is now time to practice You must download the Yoctopuce library f...

Page 38: ...32 www yoctopuce com...

Page 39: ...re all set you only need to connect your Yocto GPS open a shell and start working by typing for example C YGps any get_latitude To use the command API on Linux you need either have root privileges or...

Page 40: ...he 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 seria...

Page 41: ...limited When this limit is reached nothing guaranties that the saving process is performed correctly This limit linked to the technology employed by the module micro processor is located at about 100...

Page 42: ...36 www yoctopuce com...

Page 43: ...transpilation is needed no Babel no jspm just plain Javascript Here is your favorite engines minimum version needed to run this code All of them are officially released at the time we write this docum...

Page 44: ...hout breaking the code flow It is almost like multi threaded execution except that control switch between pending tasks only happens at places where the await keyword appears We have therefore chosen...

Page 45: ...gs simply use npm instal g babel cli npm instal babel preset env You would typically ask Babel to put the transpiled files in another directory named compat for instance Your files and all files of th...

Page 46: ...be read using regular synchronous function calls For instance instead of writing async function logInfo module console log Name await module get_logicalName console log Beacon await module get_beacon...

Page 47: ...YGNSSMK1 123456 latitude latitude YLatitude FindLatitude YGNSSMK1 123456 MaFonction latitude YLatitude FindLatitude MonModule latitude latitude YLatitude FindLatitude MonModule MaFonction latitude YL...

Page 48: ...stalled to try this example When done you can type the following two commands to automatically download and install the dependencies for building this example npm install jspm install You can the star...

Page 49: ...o World title script src jspm_packages system js script script src jspm browser js script script src jspm config js script script System import app helloworld js script When going in production you ca...

Page 50: ...beacon import YAPI YErrorMsg YModule from yoctolib es async function startDemo args await YAPI LogUnhandledPromiseRejections Setup the API to use the VirtualHub on local machine let errmsg new YErrorM...

Page 51: ...Module args 0 if await module isOnline if args length 1 var newname args 1 if await YAPI CheckLogicalName newname console log Invalid name newname process exit 1 await module set_logicalName newname a...

Page 52: ...that it will stay so during the fraction of a second necessary for the following code lines to run This method is not perfect but it can be sufficient in some cases You must however be aware that you...

Page 53: ...worst if you display the value without testing it it will be outside the expected bounds for the returned value In the case of functions which do not normally return information the return value is YA...

Page 54: ...48 www yoctopuce com...

Page 55: ...preferably locally on you machine If you wish to use the PHP server of your internet provider it is possible but you will probably need to configure your ADSL router for it to accept and forward TCP r...

Page 56: ...which you have given the latitude function the name MyFunction The following five calls are strictly equivalent as long as MyFunction is defined only once latitude yFindLatitude YGNSSMK1 123456 latitu...

Page 57: ...f gps get_isFixed Y_ISFIXED_TRUE Print Gps fixing br else Printf Gps s s br gps get_latitude gps get_longitude yFreeAPI trigger auto refresh after one second Print script language javascript1 5 type t...

Page 58: ...yFreeAPI input type submit value refresh FORM BODY HTML Each property xxx of the module can be read thanks to a method of type get_xxxx and properties which are not read only can be modified with the...

Page 59: ...mited When this limit is reached nothing guaranties that the saving process is performed correctly This limit linked to the technology employed by the module micro processor is located at about 100000...

Page 60: ...here is only one official phone number that of the switchboard itself You cannot reach the internal extensions from the outside Typical DSL configuration LAN machines are isolated from the outside by...

Page 61: ...SL router configuration The module control script is located on an external site and it is the VirtualHub which is in charge of calling it a regular intervals The HTTP callback API uses the VirtualHub...

Page 62: ...equivalent include yocto_api php yRegisterHub callback The remainder of the code stays strictly identical On the VirtualHub interface at the bottom of the configuration window for the HTTP callback A...

Page 63: ...and then hope that it will stay so during the fraction of a second necessary for the following code lines to run This method is not perfect but it can be sufficient in some cases You must however be...

Page 64: ...n case of failure When you work without exceptions you can obtain an error code and an error message explaining the source of the error You can request them from the object which returned the error ca...

Page 65: ...the simplest possible interaction from C The library is naturally also available as binary files so that you can link it directly if you prefer You will soon notice that the C API defines many functio...

Page 66: ...Function is defined only once YLatitude latitude yFindLatitude YGNSSMK1 123456 latitude YLatitude latitude yFindLatitude YGNSSMK1 123456 MyFunction YLatitude latitude yFindLatitude MyModule latitude Y...

Page 67: ...le endl return 1 else gps yFindGps target gps while 1 if gps isOnline cout Module not connected check identification and USB cable break if gps get_isFixed cout Fixing endl else cout gps get_latitude...

Page 68: ...hod of type get_xxxx and properties which are not read only can be modified with the help of the set_xxx method For more details regarding the used functions refer to the API chapters Changing the mod...

Page 69: ...ocated at about 100000 cycles In short you can use the saveToFlash function only 100000 times in the life of the module Make sure you do not call this function within a loop Listing the modules Obtain...

Page 70: ...ction to commute the library to a mode where exceptions for all the functions are systematically replaced by specific return values which can be tested by the caller when necessary For each function t...

Page 71: ...libusb1 0 and libstdc Note under Linux if you wish to compile in command line with GCC it is generally advisable to link system libraries as dynamic libraries rather than as static ones To mix static...

Page 72: ...66 www yoctopuce com...

Page 73: ...tive C API defines many functions which return objects You do not need to deallocate these objects yourself the API does it automatically at the end of the application In order to keep them simple all...

Page 74: ...as Yocto GPS YAPI RegisterHub The YAPI RegisterHub function initializes the Yoctopuce API and indicates where the modules should be looked for When used with the parameter usb it will use the modules...

Page 75: ...Foundation h import yocto_api h static void usage const char exe NSLog usage s serial or logical name ON OFF n exe exit 1 int main int argc const char argv NSError error autoreleasepool Setup the API...

Page 76: ...int main int argc const char argv NSError error autoreleasepool Setup the API to use local USB devices if YAPI RegisterHub usb error YAPI_SUCCESS NSLog RegisterHub error error localizedDescription re...

Page 77: ...a second necessary for the following code lines to run This method is not perfect but it can be sufficient in some cases You must however be aware that you cannot completely exclude an error which wou...

Page 78: ...nctions which do not normally return information the return value is YAPI_SUCCESS if everything went well and a different error code in case of failure When you work without exceptions you can obtain...

Page 79: ...th the modules3 The source files in Visual Basic manage the high level part of the API Therefore your need both this DLL and the vb files of the sources directory to create a project managing Yoctopuc...

Page 80: ...computer running the library If the initialization does not succeed this function returns a value different from YAPI_SUCCESS and errmsg contains the error message yFindLatitude The yFindLatitude func...

Page 81: ...et As String Dim gps As YGps If argv Length 2 Then Usage target argv 1 REM Setup the API to use local USB devices If yRegisterHub usb errmsg YAPI_SUCCESS Then Console WriteLine RegisterHub error errms...

Page 82: ...astLogs Else Console WriteLine argv 1 not connected check identification and USB cable End If yFreeAPI End Sub End Module Each property xxx of the module can be read thanks to a method of type get_xxx...

Page 83: ...s is performed correctly This limit linked to the technology employed by the module micro processor is located at about 100000 cycles In short you can use the saveToFlash function only 100000 times in...

Page 84: ...can relatively easily determine where the problem happened and view the explanatory message linked to the exception Otherwise the exception makes your program crash bang As this latest situation is n...

Page 85: ...e modules3 The source files in Visual C manage the high level part of the API Therefore your need both this DLL and the cs files of the sources directory to create a project managing Yoctopuce modules...

Page 86: ...it will use the modules locally connected to the computer running the library If the initialization does not succeed this function returns a value different from YAPI SUCCESS and errmsg contains the e...

Page 87: ...pDomain CurrentDomain FriendlyName Console WriteLine Usage Console WriteLine execname serial_number Console WriteLine execname logical_name Console WriteLine execname any System Threading Thread Sleep...

Page 88: ...b ref errmsg YAPI SUCCESS Console WriteLine RegisterHub error errmsg Environment Exit 0 if args Length 1 usage m YModule FindModule args 0 use serial or logical name if m isOnline if args Length 2 if...

Page 89: ...ppDomain CurrentDomain FriendlyName Console WriteLine Usage Console WriteLine usage demo serial or logical name new logical name System Threading Thread Sleep 2500 Environment Exit 0 static void Main...

Page 90: ...n this chapter before accessing a module check that it is online with the isOnline function and then hope that it will stay so during the fraction of a second necessary for the following code lines to...

Page 91: ...rogram At worst if you display the value without testing it it will be outside the expected bounds for the returned value In the case of functions which do not normally return information the return v...

Page 92: ...86 www yoctopuce com...

Page 93: ...o the Yoctopuce web site and download the Yoctopuce Delphi libraries3 Uncompress everything in a directory of your choice add the subdirectory sources in the list of directories of Delphi libraries 4...

Page 94: ...ommande line gps YFindGps paramstr 1 temperature let s poll done false repeat if gps isOnline then begin if gps get_isFixed Y_ISFIXED_TRUE then Writeln fixing else writeln gps get_latitude gps get_lon...

Page 95: ...de sensor isOnline The isOnline method of the object returned by yFindLatitude allows you to know if the corresponding module is present and in working order get_latitude The get_latitude method of th...

Page 96: ...to modify the settings of a module you only need to call the corresponding set_xxx function However this modification is performed only in the random access memory RAM of the module if the module is...

Page 97: ...rst module found Then you only need to call the nextModule function of this object to find the following modules and this as long as the returned value is not nil Below a short example listing the con...

Page 98: ...octopuce library offers another possibility for error handling allowing you to create a robust program without needing to catch exceptions at every line of code You simply need to call the YAPI Disabl...

Page 99: ...ry A section of the low level library is written in C but you should not need to interact directly with it it is provided as a DLL under Windows as a so files under UNIX and as a dylib file under Mac...

Page 100: ...ctly equivalent as long as MyFunction is defined only once latitude YLatitude FindLatitude YGNSSMK1 123456 latitude latitude YLatitude FindLatitude YGNSSMK1 123456 MyFunction latitude YLatitude FindLa...

Page 101: ...RUE print Fixing else print gps get_latitude gps get_longitude YAPI Sleep 1000 YAPI FreeAPI 14 4 Control of the module part Each module can be controlled in a similar manner you can find below a simpl...

Page 102: ...odule revertFromFlash method The short example below allows you to modify the logical name of a module usr bin python coding utf 8 import os sys from yocto_api import def usage sys exit usage demo ser...

Page 103: ...s the use of exceptions By default it is the behavior of the Yoctopuce library If an error happens while you try to access a module the library throws an exception In this case there are three possibi...

Page 104: ...errType and errMessage methods Their returned values contain the same information as in the exceptions when they are active 14 Using the Yocto GPS with Python 98 www yoctopuce com...

Page 105: ...he library files in a folder of your choice connect your modules run the VirtualHub software and you are ready to start your first tests You do not need to install any driver In order to keep them sim...

Page 106: ...de returns an object which you can then use at will to control the latitude sensor isOnline The isOnline method of the object returned by YLatitude FindLatitude allows you to know if the corresponding...

Page 107: ...on beacon import com yoctopuce YoctoAPI import java util logging Level import java util logging Logger public class Demo public static void main String args try setup the API to use local VirtualHub Y...

Page 108: ...rize them persistently it is necessary to ask the module to save its current configuration in its permanent memory To do so use the YModule saveToFlash method Inversely it is possible to force the mod...

Page 109: ...out println Ensure that the VirtualHub application is running System exit 1 System out println Device list YModule module YModule FirstModule while module null try System out println module get_serial...

Page 110: ...nted with exceptions Therefore you must catch and handle correctly all exceptions that might be thrown by the API if you do not want your software to crash as soon as you unplug a device 15 Using the...

Page 111: ...nnect itself to a VirtualHub running on another OS 16 2 Getting ready Go to the Yoctopuce web site and download the Java for Android programming library1 The library is available as source files and a...

Page 112: ...ndroid machine works with Yoctopuce modules consists in trying Supported hardware The library is tested and validated on the following machines Samsung Galaxy S3 Samsung Galaxy Note 2 Google Nexus 5 G...

Page 113: ...TACHED in the section intent filter of the main activity The section activity must have a pointer to an XML file containing the list of USB modules which can run the application manifest xmlns android...

Page 114: ...ndLatitude The YLatitude FindLatitude function allows you to find a latitude sensor from the serial number of the module on which it resides and from its function name You can use logical names as wel...

Page 115: ...erature public class GettingStarted_Yocto_GPS extends Activity implements OnItemSelectedListener private ArrayAdapter String aa private String serial private Handler handler null Override public void...

Page 116: ...module and enabling you to activate the localization beacon package com yoctopuce doc_examples import android app Activity import android os Bundle import android view View import android widget Adap...

Page 117: ...Text String format d module getLuminosity field TextView findViewById R id uptimefield field setText module getUpTime 1000 sec field TextView findViewById R id usbcurrentfield field setText module get...

Page 118: ...le package com yoctopuce doc_examples import android app Activity import android os Bundle import android view View import android widget AdapterView import android widget AdapterView OnItemSelectedLi...

Page 119: ...ew if module null return EditText edit EditText findViewById R id newname String newname edit getText toString try if YAPI CheckLogicalName newname Toast makeText getApplicationContext Invalid name ne...

Page 120: ...e public class Inventory extends Activity Override public void onCreate Bundle savedInstanceState super onCreate savedInstanceState setContentView R layout inventory public void refreshInventory View...

Page 121: ...t examples provided in this chapter before accessing a module check that it is online with the isOnline function and then hope that it will stay so during the fraction of a second necessary for the fo...

Page 122: ...116 www yoctopuce com...

Page 123: ...del This technique consists in asking the API to signal by itself the important changes as soon as they are detected Each time a key parameter is modified the API calls a callback function which you h...

Page 124: ...of the corresponding library Be aware that in most programming languages callbacks must be global procedures and not methods If you wish for the callback to call the method of an object define your c...

Page 125: ...encies going from hundred calls per seconds down to one call per hour The callback takes as parameter the relevant function and the measured value as an YMeasure object Contrarily to the value change...

Page 126: ...can store about 500 000 instant measures or 125 000 averaged measures When the memory is about to be saturated the oldest measures are automatically erased Make sure not to leave the data logger runni...

Page 127: ...tion Instead this function will return an YDataSet object that can be used to retrieve immediately an overview of the measured data summary and then to load progressively the details when desired Here...

Page 128: ...n Android mobile device it will get the time from the mobile device as long as an app using the Yoctopuce library is launched When none of these conditions applies for instance if the module is simply...

Page 129: ...ue read on the sensor is a the latitude function returns b Measure correction with 1 calibration point here 5 10 The application is very simple you only need to call the calibrateFromPoints method of...

Page 130: ...sorted in a strictly ascending order otherwise they are simply ignored 3 to 5 point correction 3 to 5 point corrections are only a generalization of the 2 point method allowing you to create up to 4 c...

Page 131: ...lic static double CustomInterpolation3Points double rawValue int calibType int parameters double beforeValues double afterValues double result the value to be corrected is rawValue calibration points...

Page 132: ...126 www yoctopuce com...

Page 133: ...te command The module selection mechanism works like for a traditional command The target is the name of the module that you want to update You can also use the any or all aliases or even a name list...

Page 134: ...lSettings method byte default_config loadFile default bin YModule m YModule FirstModule while m null if m get_productName YoctoHub Wireless m set_allSettings default_config m m next Finding the correc...

Page 135: ...you must obtain an instance of the YFirmwareUdpate class with the updateFirmware method of a YModule object The only parameter of this method is the path of the firmware that you want to install This...

Page 136: ...rectly anymore you can install a firmware from the update mode To force the module to work in update mode disconnect it wait a few seconds and reconnect it while maintaining the Yocto button down This...

Page 137: ...call the executable must initialize its own API and make an inventory of USB connected modules This requires about one second per call 19 2 VirtualHub and HTTP GET The VirtualHub is available on almos...

Page 138: ...44 bySerial YGNSSMK1 12345 api module luminosity 100 Driving the module functions through the REST interface The module functions can be manipulated in the same way To know the state of the latitude f...

Page 139: ...connected Yoctopuce modules It must be called at least once To manage hot plug and detect potential newly connected modules this function must be called at regular intervals The forceupdate parameter...

Page 140: ...the module luminosity if yapiHTTPRequest serial getValue data sizeof dataBuffer fullsize errmsg 0 then begin writeln errmsg halt end searches for the HTTP header end p pos 13 10 13 10 data displays t...

Page 141: ...sage Here is a sample program written in pascal using the yapi dll DLL to list the connected modules device description structure type yDeviceSt packed record vendorid word deviceid word devrelease wo...

Page 142: ...and one Visual Basic 6 compatible version prefixed with vb6_ 19 4 Porting the high level library As all the sources of the Yoctopuce API are fully provided you can very well port the whole API in the...

Page 143: ...ne the function interfaces For languages which support exceptions all of these functions throw exceptions in case of error by default rather than returning the documented error value for each function...

Page 144: ...o_api js Global functions yCheckLogicalName name Checks if a given string is valid as logical name for a module or a function yDisableExceptions Disables the use of exceptions to report runtime errors...

Page 145: ...on after a given timeout ySetUSBPacketAckMs pktAckDelay Enables the acknowledge of every USB packet received by the Yoctopuce library ySleep ms_duration errmsg Pauses the execution flow for a specifie...

Page 146: ...CheckLogicalName ByVal name As String As Boolean cs bool CheckLogicalName string name java boolean CheckLogicalName String name uwp bool CheckLogicalName string name py def CheckLogicalName name php f...

Page 147: ...void yDisableExceptions m void DisableExceptions pas procedure yDisableExceptions vb procedure yDisableExceptions cs void DisableExceptions py def DisableExceptions php function yDisableExceptions es...

Page 148: ...rocedure yEnableExceptions vb procedure yEnableExceptions cs void EnableExceptions py def EnableExceptions php function yEnableExceptions es function EnableExceptions Be aware than when exceptions are...

Page 149: ...e calling yRegisterHub usb you need to activate the USB host port of the system This function takes as argument an object of class android content Context or any subclass It is not necessary to call t...

Page 150: ...yFreeAPI vb procedure yFreeAPI cs void FreeAPI java void FreeAPI uwp void FreeAPI py def FreeAPI php function yFreeAPI es function FreeAPI It is generally not required to call this function unless yo...

Page 151: ...function GetAPIVersion The version is a string in the form Major Minor Build for instance 1 01 5535 For languages using an external DLL for instance C VisualBasic or Delphi the character string inclu...

Page 152: ...TickCount pas function yGetTickCount u64 vb function yGetTickCount As Long cs ulong GetTickCount java long GetTickCount uwp ulong GetTickCount py def GetTickCount php function yGetTickCount es functio...

Page 153: ...s errmsg None php function yHandleEvents errmsg es function HandleEvents errmsg If your program includes significant loops you may want to include a call to this function to make sure that the library...

Page 154: ...php function yInitAPI mode errmsg es function InitAPI mode errmsg It is not strictly needed to call yInitAPI as the library is automatically initialized when calling yRegisterHub for the first time W...

Page 155: ...t PreregisterHub string url py def PreregisterHub url errmsg None php function yPreregisterHub url errmsg es function PreregisterHub url errmsg This function has the same purpose and same arguments as...

Page 156: ...ceUpdateFunc vb procedure yRegisterDeviceArrivalCallback ByVal arrivalCallback As yDeviceUpdateFunc cs void RegisterDeviceArrivalCallback yDeviceUpdateFunc arrivalCallback java void RegisterDeviceArri...

Page 157: ...iceUpdateFunc vb procedure yRegisterDeviceRemovalCallback ByVal removalCallback As yDeviceUpdateFunc cs void RegisterDeviceRemovalCallback yDeviceUpdateFunc removalCallback java void RegisterDeviceRem...

Page 158: ...regular computer running a VirtualHub or a networked YoctoHub such as YoctoHub Ethernet or YoctoHub Wireless If you want to use the VirtualHub running on you local computer use the IP address 127 0 0...

Page 159: ...20 High level API Reference On failure throws an exception or returns a negative error code www yoctopuce com 153...

Page 160: ...veryCallback cs void RegisterHubDiscoveryCallback YHubDiscoveryCallback hubDiscoveryCallback java void RegisterHubDiscoveryCallback HubDiscoveryCallback hubDiscoveryCallback uwp async Task RegisterHub...

Page 161: ...ction logfun yLogFunc vb procedure yRegisterLogFunction ByVal logfun As yLogFunc cs void RegisterLogFunction yLogFunc logfun java void RegisterLogFunction LogCallback logfun uwp void RegisterLogFuncti...

Page 162: ...However for Linux ARM it not possible to reliably distinguish between a Hard Float armhf and a Soft Float armel install For in this case it is therefore recommended to manually select the proper archi...

Page 163: ...low the protocol YDeviceHotPlug m void SetDelegate id object The methods yDeviceArrival and yDeviceRemoval will be invoked while yUpdateDeviceList is running You will have to call this function on a r...

Page 164: ...nd yUpdateDeviceList periodically in order to keep the API up to date with current devices Parameters callback the function to call after the timeout occurs On Microsoft Internet Explorer the callback...

Page 165: ...is disabled because it doubles the number of packets sent and slows down the API considerably Therefore the acknowledge of incoming USB packets should only be enabled on phones or tablets that loose U...

Page 166: ...e php function ySleep ms_duration errmsg es function Sleep ms_duration errmsg This function implements a passive waiting loop meaning that it does not consume CPU cycles significantly The processor is...

Page 167: ...t py def TestHub url mstimeout errmsg None php function yTestHub url mstimeout errmsg es function TestHub url mstimeout This method do not register the hub it only test if the hub is usable The url pa...

Page 168: ...m YRETCODE TriggerHubDiscovery NSError errmsg pas function yTriggerHubDiscovery var errmsg string integer vb function yTriggerHubDiscovery ByRef errmsg As String As Integer cs int TriggerHubDiscovery...

Page 169: ...b url cpp void yUnregisterHub const string url m void UnregisterHub NSString url pas procedure yUnregisterHub url string vb procedure yUnregisterHub ByVal url As String cs void UnregisterHub string ur...

Page 170: ...st uwp async Task int UpdateDeviceList py def UpdateDeviceList errmsg None php function yUpdateDeviceList errmsg es function UpdateDeviceList errmsg The library searches the machines or USB ports prev...

Page 171: ...to refresh the device list and to make the application aware of hot plug events This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid block...

Page 172: ...er or from its logical name yFindModuleInContext yctx func Retrieves a module for a given identifier in a YAPI context yFirstModule Starts the enumeration of modules currently accessible YModule metho...

Page 173: ...t_luminosity Returns the luminosity of the module informative leds from 0 to 100 module get_parentHub Returns the serial number of the YoctoHub on which this module is connected module get_persistentS...

Page 174: ...he given number of seconds module registerLogCallback callback Registers a device log callback function module revertFromFlash Reloads the settings stored in the nonvolatile memory as when the module...

Page 175: ...erence Prepares a firmware update of the module module wait_async callback context Waits for all pending asynchronous commands on the module to complete and invoke the user provided callback function...

Page 176: ...dule func php function yFindModule func es function FindModule func This function does not require that the module is online at the time it is invoked The returned object is nevertheless valid Use the...

Page 177: ...ogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the module is online at the time it is invoked The returned object is neverthe...

Page 178: ...pas function yFirstModule TYModule vb function yFirstModule As YModule cs YModule FirstModule java YModule FirstModule uwp YModule FirstModule py def FirstModule php function yFirstModule es function...

Page 179: ...onlynew php function checkFirmware path onlynew es function checkFirmware path onlynew cmd YModule target checkFirmware path onlynew This method is useful to test if the module needs to be updated It...

Page 180: ...clearCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the c...

Page 181: ...ibe 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 descri...

Page 182: ...ction download pathname string TByteArray vb function download As Byte cs byte download string pathname java byte download String pathname uwp async Task byte download string pathname py def download...

Page 183: ...nteger As String cs string functionBaseType int functionIndex java String functionBaseType int functionIndex py def functionBaseType functionIndex php function functionBaseType functionIndex es functi...

Page 184: ...on functionCount cpp int functionCount m int functionCount pas function functionCount integer vb function functionCount As Integer cs int functionCount java int functionCount py def functionCount php...

Page 185: ...unctionId ByVal functionIndex As Integer As String cs string functionId int functionIndex java String functionId int functionIndex py def functionId functionIndex php function functionId functionIndex...

Page 186: ...tion functionName ByVal functionIndex As Integer As String cs string functionName int functionIndex java String functionName int functionIndex py def functionName functionIndex php function functionNa...

Page 187: ...nType ByVal functionIndex As Integer As String cs string functionType int functionIndex java String functionType int functionIndex py def functionType functionIndex php function functionType functionI...

Page 188: ...nValue ByVal functionIndex As Integer As String cs string functionValue int functionIndex java String functionValue int functionIndex py def functionValue functionIndex php function functionValue func...

Page 189: ...TByteArray vb function get_allSettings As Byte cs byte get_allSettings java byte get_allSettings uwp async Task byte get_allSettings py def get_allSettings php function get_allSettings es function ge...

Page 190: ...eacon pas function get_beacon Integer vb function get_beacon As Integer cs int get_beacon java int get_beacon uwp async Task int get_beacon py def get_beacon php function get_beacon es function get_be...

Page 191: ...tring errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorMes...

Page 192: ...errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_err...

Page 193: ...on get_firmwareRelease string vb function get_firmwareRelease As String cs string get_firmwareRelease java String get_firmwareRelease uwp async Task string get_firmwareRelease py def get_firmwareRelea...

Page 194: ...ype pas function get_functionIds funType string TStringArray vb function get_functionIds As List cs List string get_functionIds string funType java ArrayList String get_functionIds String funType uwp...

Page 195: ...Id cpp string get_hardwareId m NSString hardwareId vb function get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es functio...

Page 196: ..._icon2d TByteArray vb function get_icon2d As Byte cs byte get_icon2d java byte get_icon2d uwp async Task byte get_icon2d py def get_icon2d php function get_icon2d es function get_icon2d cmd YModule ta...

Page 197: ...get_lastLogs string vb function get_lastLogs As String cs string get_lastLogs java String get_lastLogs uwp async Task string get_lastLogs py def get_lastLogs php function get_lastLogs es function get_...

Page 198: ...s function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php function...

Page 199: ...s function get_luminosity LongInt vb function get_luminosity As Integer cs int get_luminosity java int get_luminosity uwp async Task int get_luminosity py def get_luminosity php function get_luminosit...

Page 200: ...ntHub m NSString parentHub pas function get_parentHub string vb function get_parentHub As String cs string get_parentHub java String get_parentHub py def get_parentHub php function get_parentHub cmd Y...

Page 201: ...r vb function get_persistentSettings As Integer cs int get_persistentSettings java int get_persistentSettings uwp async Task int get_persistentSettings py def get_persistentSettings php function get_p...

Page 202: ...pas function get_productId LongInt vb function get_productId As Integer cs int get_productId java int get_productId uwp async Task int get_productId py def get_productId php function get_productId es...

Page 203: ...s function get_productName string vb function get_productName As String cs string get_productName java String get_productName uwp async Task string get_productName py def get_productName php function...

Page 204: ...on get_productRelease LongInt vb function get_productRelease As Integer cs int get_productRelease java int get_productRelease uwp async Task int get_productRelease py def get_productRelease php functi...

Page 205: ...get_rebootCountdown LongInt vb function get_rebootCountdown As Integer cs int get_rebootCountdown java int get_rebootCountdown uwp async Task int get_rebootCountdown py def get_rebootCountdown php fu...

Page 206: ...function get_serialNumber string vb function get_serialNumber As String cs string get_serialNumber java String get_serialNumber uwp async Task string get_serialNumber py def get_serialNumber php funct...

Page 207: ...m NSMutableArray subDevices pas function get_subDevices TStringArray vb function get_subDevices As List cs List string get_subDevices java ArrayList String get_subDevices py def get_subDevices php fu...

Page 208: ...upTime pas function get_upTime int64 vb function get_upTime As Long cs long get_upTime java long get_upTime uwp async Task long get_upTime py def get_upTime php function get_upTime es function get_upT...

Page 209: ...ction get_url cpp string get_url m NSString url pas function get_url string vb function get_url As String cs string get_url java String get_url py def get_url php function get_url cmd YModule target g...

Page 210: ...s function get_usbCurrent LongInt vb function get_usbCurrent As Integer cs int get_usbCurrent java int get_usbCurrent uwp async Task int get_usbCurrent py def get_usbCurrent php function get_usbCurren...

Page 211: ...serData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function get_us...

Page 212: ...t vb function get_userVar As Integer cs int get_userVar java int get_userVar uwp async Task int get_userVar py def get_userVar php function get_userVar es function get_userVar cmd YModule target get_u...

Page 213: ...boolean vb function hasFunction As Boolean cs bool hasFunction string funcId java boolean hasFunction String funcId uwp async Task bool hasFunction string funcId py def hasFunction funcId php function...

Page 214: ...e boolean vb function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there are valid cached values for the module that have no...

Page 215: ...e requested module This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking Firefox Javascript VM that does not implement context swi...

Page 216: ...ng msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all module attributes are kept in cache for the standard duration 5...

Page 217: ...ascript It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section...

Page 218: ...nt log String text uwp async Task int log string text py def log text php function log text es function log text cmd YModule target log text This function is useful in particular to trace the executio...

Page 219: ...le m YModule nextModule pas function nextModule TYModule vb function nextModule As YModule cs YModule nextModule java YModule nextModule uwp YModule nextModule py def nextModule php function nextModul...

Page 220: ...ongInt LongInt vb function reboot As Integer cs int reboot int secBeforeReboot java int reboot int secBeforeReboot uwp async Task int reboot int secBeforeReboot py def reboot secBeforeReboot php funct...

Page 221: ...nteger cs int registerLogCallback LogCallback callback java void registerLogCallback LogCallback callback py def registerLogCallback callback This callback will be called each time that a module sends...

Page 222: ...h m int revertFromFlash pas function revertFromFlash LongInt vb function revertFromFlash As Integer cs int revertFromFlash java int revertFromFlash uwp async Task int revertFromFlash py def revertFrom...

Page 223: ...ToFlash As Integer cs int saveToFlash java int saveToFlash uwp async Task int saveToFlash py def saveToFlash php function saveToFlash es function saveToFlash cmd YModule target saveToFlash Warning the...

Page 224: ...int set_allSettings byte settings uwp async Task int set_allSettings py def set_allSettings settings php function set_allSettings settings es function set_allSettings settings cmd YModule target set_a...

Page 225: ...java int set_allSettingsAndFiles byte settings uwp async Task int set_allSettingsAndFiles py def set_allSettingsAndFiles settings php function set_allSettingsAndFiles settings es function set_allSetti...

Page 226: ...ewval Integer integer vb function set_beacon ByVal newval As Integer As Integer cs int set_beacon int newval java int set_beacon int newval uwp async Task int set_beacon int newval py def set_beacon n...

Page 227: ...newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval cmd...

Page 228: ...t_luminosity int newval java int set_luminosity int newval uwp async Task int set_luminosity int newval py def set_luminosity newval php function set_luminosity newval es function set_luminosity newva...

Page 229: ...a void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data py def...

Page 230: ...r cs int set_userVar int newval java int set_userVar int newval uwp async Task int set_userVar int newval py def set_userVar newval php function set_userVar newval es function set_userVar newval cmd Y...

Page 231: ...function triggerFirmwareUpdate As Integer cs int triggerFirmwareUpdate int secBeforeReboot java int triggerFirmwareUpdate int secBeforeReboot uwp async Task int triggerFirmwareUpdate int secBeforeRebo...

Page 232: ...on updateFirmware As YFirmwareUpdate cs YFirmwareUpdate updateFirmware string path java YFirmwareUpdate updateFirmware String path uwp async Task YFirmwareUpdate updateFirmware string path py def upda...

Page 233: ...pdate updateFirmwareEx string path bool force java YFirmwareUpdate updateFirmwareEx String path boolean force uwp async Task YFirmwareUpdate updateFirmwareEx string path bool force py def updateFirmwa...

Page 234: ...llback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoked wh...

Page 235: ...yocto_gps js Global functions yFindGps func Retrieves a GPS for a given identifier yFindGpsInContext yctx func Retrieves a GPS for a given identifier in a YAPI context yFirstGps Starts the enumeration...

Page 236: ...or the device on which the function is located gps get_module_async callback context Gets the YModule object for the device on which the function is located asynchronous version gps get_satCount Retur...

Page 237: ...tem used for positioning data gps set_logicalName newval Changes the logical name of the GPS gps set_userData data Stores a user context provided as argument in the userData attribute of the function...

Page 238: ...formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does n...

Page 239: ...lName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the GPS is online at the time it is invoked The returned object is nevertheless val...

Page 240: ...Gps FirstGps pas function yFirstGps TYGps vb function yFirstGps As YGps cs YGps FirstGps java YGps FirstGps uwp YGps FirstGps py def FirstGps php function yFirstGps es function FirstGps Use the method...

Page 241: ...FirstGpsInContext YAPIContext yctx uwp YGps FirstGpsInContext YAPIContext yctx es function FirstGpsInContext yctx Use the method YGps nextGps to iterate on next GPS Parameters yctx a YAPI context Retu...

Page 242: ...learCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the ca...

Page 243: ...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...

Page 244: ...get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertisedValue...

Page 245: ...nction get_altitude As Double cs double get_altitude java double get_altitude uwp async Task double get_altitude py def get_altitude php function get_altitude es function get_altitude cmd YGps target...

Page 246: ...m Integer vb function get_coordSystem As Integer cs int get_coordSystem java int get_coordSystem uwp async Task int get_coordSystem py def get_coordSystem php function get_coordSystem es function get_...

Page 247: ...pas function get_dateTime string vb function get_dateTime As String cs string get_dateTime java String get_dateTime uwp async Task string get_dateTime py def get_dateTime php function get_dateTime es...

Page 248: ...tion get_dilution double vb function get_dilution As Double cs double get_dilution java double get_dilution uwp async Task double get_dilution py def get_dilution php function get_dilution es function...

Page 249: ...on get_direction double vb function get_direction As Double cs double get_direction java double get_direction uwp async Task double get_direction py def get_direction php function get_direction es fun...

Page 250: ...rorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorMessage es...

Page 251: ...e pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_errorType T...

Page 252: ...a 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 GPS if they are defined...

Page 253: ...vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor es function...

Page 254: ...get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function get_function...

Page 255: ...et_groundSpeed double vb function get_groundSpeed As Double cs double get_groundSpeed java double get_groundSpeed uwp async Task double get_groundSpeed py def get_groundSpeed php function get_groundSp...

Page 256: ...get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is composed of...

Page 257: ...as function get_isFixed Integer vb function get_isFixed As Integer cs int get_isFixed java int get_isFixed uwp async Task int get_isFixed py def get_isFixed php function get_isFixed es function get_is...

Page 258: ...pas function get_latitude string vb function get_latitude As String cs string get_latitude java String get_latitude uwp async Task string get_latitude py def get_latitude php function get_latitude es...

Page 259: ...unction get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php function get...

Page 260: ...as function get_longitude string vb function get_longitude As String cs string get_longitude java String get_longitude uwp async Task string get_longitude py def get_longitude php function get_longitu...

Page 261: ...le cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function get_module es...

Page 262: ...uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section on asynchro...

Page 263: ...pas function get_satCount int64 vb function get_satCount As Long cs long get_satCount java long get_satCount uwp async Task long get_satCount py def get_satCount php function get_satCount es function...

Page 264: ...pas function get_unixTime int64 vb function get_unixTime As Long cs long get_unixTime java long get_unixTime uwp async Task long get_unixTime py def get_unixTime php function get_unixTime es function...

Page 265: ...ata cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function get_userDa...

Page 266: ...function get_utcOffset LongInt vb function get_utcOffset As Integer cs int get_utcOffset java int get_utcOffset uwp async Task int get_utcOffset py def get_utcOffset php function get_utcOffset es fun...

Page 267: ...lean vb function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the GPS in cache that has not yet...

Page 268: ...ile trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascri...

Page 269: ...lidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard duration 5 ms T...

Page 270: ...String attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp async Task s...

Page 271: ...rafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters msValidity an i...

Page 272: ...s java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YGps target muteValueCallbacks You can...

Page 273: ...cpp YGps nextGps m YGps nextGps pas function nextGps TYGps vb function nextGps As YGps cs YGps nextGps java YGps nextGps uwp YGps nextGps py def nextGps php function nextGps es function nextGps Return...

Page 274: ...UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es function registerValueCallb...

Page 275: ...Val newval As Integer As Integer cs int set_coordSystem int newval java int set_coordSystem int newval uwp async Task int set_coordSystem int newval py def set_coordSystem newval php function set_coor...

Page 276: ...val java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval cmd YGp...

Page 277: ...d data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data py def set_...

Page 278: ...set_utcOffset int newval uwp async Task int set_utcOffset int newval py def set_utcOffset newval php function set_utcOffset newval es function set_utcOffset newval cmd YGps target set_utcOffset newval...

Page 279: ...As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueCallb...

Page 280: ...ack context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoked when...

Page 281: ...ntifier yFindLatitudeInContext yctx func Retrieves a latitude sensor for a given identifier in a YAPI context yFirstLatitude Starts the enumeration of latitude sensors currently accessible yFirstLatit...

Page 282: ...callback context Gets the YModule object for the device on which the function is located asynchronous version latitude get_recordedData startTime endTime Retrieves a DataSet object holding historical...

Page 283: ...n every change of advertised value latitude set_highestValue newval Changes the recorded maximal value observed latitude set_logFrequency newval Changes the datalogger recording frequency for this fun...

Page 284: ...be specified using several formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogi...

Page 285: ...ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the latitude sensor is online at the time it is invoked The returned object is neverthele...

Page 286: ...tion yFirstLatitude TYLatitude vb function yFirstLatitude As YLatitude cs YLatitude FirstLatitude java YLatitude FirstLatitude uwp YLatitude FirstLatitude py def FirstLatitude php function yFirstLatit...

Page 287: ...deInContext YAPIContext yctx uwp YLatitude FirstLatitudeInContext YAPIContext yctx es function FirstLatitudeInContext yctx Use the method YLatitude nextLatitude to iterate on next latitude sensors Par...

Page 288: ...rateFromPoints rawValues refValues php function calibrateFromPoints rawValues refValues es function calibrateFromPoints rawValues refValues cmd YLatitude target calibrateFromPoints rawValues refValues...

Page 289: ...earCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the cac...

Page 290: ...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...

Page 291: ...tion get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertisedV...

Page 292: ...currentRawValue double vb function get_currentRawValue As Double cs double get_currentRawValue java double get_currentRawValue uwp async Task double get_currentRawValue py def get_currentRawValue php...

Page 293: ...n get_currentValue double vb function get_currentValue As Double cs double get_currentValue java double get_currentValue uwp async Task double get_currentValue py def get_currentValue php function get...

Page 294: ...ring errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorMess...

Page 295: ...errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_err...

Page 296: ...ring 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 latitude sensor if they are...

Page 297: ...UN_DESCR vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor es f...

Page 298: ...unction get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function get_f...

Page 299: ...on get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is composed...

Page 300: ...n get_highestValue double vb function get_highestValue As Double cs double get_highestValue java double get_highestValue uwp async Task double get_highestValue py def get_highestValue php function get...

Page 301: ...s function get_logFrequency string vb function get_logFrequency As String cs string get_logFrequency java String get_logFrequency uwp async Task string get_logFrequency py def get_logFrequency php fun...

Page 302: ...pas function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php functio...

Page 303: ...ion get_lowestValue double vb function get_lowestValue As Double cs double get_lowestValue java double get_lowestValue uwp async Task double get_lowestValue py def get_lowestValue php function get_low...

Page 304: ...et_module cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function get_mo...

Page 305: ...ipt It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section on a...

Page 306: ...t_recordedData startTime endTime The measures will be retrieved from the data logger which must have been turned on at the desired time See the documentation of the DataSet class for information on ho...

Page 307: ...tion get_reportFrequency string vb function get_reportFrequency As String cs string get_reportFrequency java String get_reportFrequency uwp async Task string get_reportFrequency py def get_reportFrequ...

Page 308: ...double get_resolution java double get_resolution uwp async Task double get_resolution py def get_resolution php function get_resolution es function get_resolution cmd YLatitude target get_resolution T...

Page 309: ...s function get_sensorState LongInt vb function get_sensorState As Integer cs int get_sensorState java int get_sensorState uwp async Task int get_sensorState py def get_sensorState php function get_sen...

Page 310: ...NSString unit pas function get_unit string vb function get_unit As String cs string get_unit java String get_unit uwp async Task string get_unit py def get_unit php function get_unit es function get_u...

Page 311: ...t_userData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function get...

Page 312: ...function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the latitude sensor in cache that has not...

Page 313: ...re is an error while trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid bloc...

Page 314: ...YLatitude target isSensorReady Returns false if the device is unreachable or if the sensor does not have a current measure to transmit No exception is raised if there is an error while trying to conta...

Page 315: ...d long msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard dura...

Page 316: ...te NSString attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp async T...

Page 317: ...s List double refValues java int loadCalibrationPoints ArrayList Double rawValues ArrayList Double refValues uwp async Task int loadCalibrationPoints List double rawValues List double refValues py def...

Page 318: ...e network trafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters msVa...

Page 319: ...acks java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YLatitude target muteValueCallbacks...

Page 320: ...de nextLatitude pas function nextLatitude TYLatitude vb function nextLatitude As YLatitude cs YLatitude nextLatitude java YLatitude nextLatitude uwp YLatitude nextLatitude py def nextLatitude php func...

Page 321: ...va int registerTimedReportCallback TimedReportCallback callback uwp async Task int registerTimedReportCallback TimedReportCallback callback py def registerTimedReportCallback callback php function reg...

Page 322: ...lueCallback UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es function regist...

Page 323: ...et_highestValue ByVal newval As Double As Integer cs int set_highestValue double newval java int set_highestValue double newval uwp async Task int set_highestValue double newval py def set_highestValu...

Page 324: ...ng newval java int set_logFrequency String newval uwp async Task int set_logFrequency string newval py def set_logFrequency newval php function set_logFrequency newval es function set_logFrequency new...

Page 325: ...g newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval cm...

Page 326: ...et_lowestValue ByVal newval As Double As Integer cs int set_lowestValue double newval java int set_lowestValue double newval uwp async Task int set_lowestValue double newval py def set_lowestValue new...

Page 327: ...ewval java int set_reportFrequency String newval uwp async Task int set_reportFrequency string newval py def set_reportFrequency newval php function set_reportFrequency newval es function set_reportFr...

Page 328: ...tion double newval java int set_resolution double newval uwp async Task int set_resolution double newval py def set_resolution newval php function set_resolution newval es function set_resolution newv...

Page 329: ...Data void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data py...

Page 330: ...taLogger LongInt vb function startDataLogger As Integer cs int startDataLogger java int startDataLogger uwp async Task int startDataLogger py def startDataLogger php function startDataLogger es functi...

Page 331: ...opDataLogger m int stopDataLogger pas function stopDataLogger LongInt vb function stopDataLogger As Integer cs int stopDataLogger java int stopDataLogger uwp async Task int stopDataLogger py def stopD...

Page 332: ...cks As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueCa...

Page 333: ...callback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoked...

Page 334: ...fier yFindLongitudeInContext yctx func Retrieves a longitude sensor for a given identifier in a YAPI context yFirstLongitude Starts the enumeration of longitude sensors currently accessible yFirstLong...

Page 335: ...callback context Gets the YModule object for the device on which the function is located asynchronous version longitude get_recordedData startTime endTime Retrieves a DataSet object holding historica...

Page 336: ...every change of advertised value longitude set_highestValue newval Changes the recorded maximal value observed longitude set_logFrequency newval Changes the datalogger recording frequency for this fu...

Page 337: ...ifier can be specified using several formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName Fun...

Page 338: ...ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the longitude sensor is online at the time it is invoked The returned object is neverthe...

Page 339: ...yFirstLongitude TYLongitude vb function yFirstLongitude As YLongitude cs YLongitude FirstLongitude java YLongitude FirstLongitude uwp YLongitude FirstLongitude py def FirstLongitude php function yFir...

Page 340: ...eInContext YAPIContext yctx uwp YLongitude FirstLongitudeInContext YAPIContext yctx es function FirstLongitudeInContext yctx Use the method YLongitude nextLongitude to iterate on next longitude sensor...

Page 341: ...rateFromPoints rawValues refValues php function calibrateFromPoints rawValues refValues es function calibrateFromPoints rawValues refValues cmd YLongitude target calibrateFromPoints rawValues refValue...

Page 342: ...earCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the cac...

Page 343: ...f 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 o...

Page 344: ...ction get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertised...

Page 345: ..._currentRawValue double vb function get_currentRawValue As Double cs double get_currentRawValue java double get_currentRawValue uwp async Task double get_currentRawValue py def get_currentRawValue php...

Page 346: ...on get_currentValue double vb function get_currentValue As Double cs double get_currentValue java double get_currentValue uwp async Task double get_currentValue py def get_currentValue php function ge...

Page 347: ...String errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorMe...

Page 348: ..._errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_er...

Page 349: ...ring 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 longitude sensor if they ar...

Page 350: ...FUN_DESCR vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor es...

Page 351: ...function get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function get...

Page 352: ...ion get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is composed...

Page 353: ...on get_highestValue double vb function get_highestValue As Double cs double get_highestValue java double get_highestValue uwp async Task double get_highestValue py def get_highestValue php function ge...

Page 354: ...as function get_logFrequency string vb function get_logFrequency As String cs string get_logFrequency java String get_logFrequency uwp async Task string get_logFrequency py def get_logFrequency php fu...

Page 355: ...pas function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php functi...

Page 356: ...tion get_lowestValue double vb function get_lowestValue As Double cs double get_lowestValue java double get_lowestValue uwp async Task double get_lowestValue py def get_lowestValue php function get_lo...

Page 357: ...get_module cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function get_...

Page 358: ...cript It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section on...

Page 359: ...get_recordedData startTime endTime The measures will be retrieved from the data logger which must have been turned on at the desired time See the documentation of the DataSet class for information on...

Page 360: ...ction get_reportFrequency string vb function get_reportFrequency As String cs string get_reportFrequency java String get_reportFrequency uwp async Task string get_reportFrequency py def get_reportFreq...

Page 361: ...double get_resolution java double get_resolution uwp async Task double get_resolution py def get_resolution php function get_resolution es function get_resolution cmd YLongitude target get_resolution...

Page 362: ...as function get_sensorState LongInt vb function get_sensorState As Integer cs int get_sensorState java int get_sensorState uwp async Task int get_sensorState py def get_sensorState php function get_se...

Page 363: ...NSString unit pas function get_unit string vb function get_unit As String cs string get_unit java String get_unit uwp async Task string get_unit py def get_unit php function get_unit es function get_...

Page 364: ...get_userData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function g...

Page 365: ...function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the longitude sensor in cache that has no...

Page 366: ...here is an error while trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid bl...

Page 367: ...YLongitude target isSensorReady Returns false if the device is unreachable or if the sensor does not have a current measure to transmit No exception is raised if there is an error while trying to con...

Page 368: ...oad long msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard du...

Page 369: ...ute NSString attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp async...

Page 370: ...es List double refValues java int loadCalibrationPoints ArrayList Double rawValues ArrayList Double refValues uwp async Task int loadCalibrationPoints List double rawValues List double refValues py de...

Page 371: ...uce network trafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters ms...

Page 372: ...acks java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YLongitude target muteValueCallbacks...

Page 373: ...extLongitude pas function nextLongitude TYLongitude vb function nextLongitude As YLongitude cs YLongitude nextLongitude java YLongitude nextLongitude uwp YLongitude nextLongitude py def nextLongitude...

Page 374: ...java int registerTimedReportCallback TimedReportCallback callback uwp async Task int registerTimedReportCallback TimedReportCallback callback py def registerTimedReportCallback callback php function...

Page 375: ...rValueCallback UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es function reg...

Page 376: ...set_highestValue ByVal newval As Double As Integer cs int set_highestValue double newval java int set_highestValue double newval uwp async Task int set_highestValue double newval py def set_highestVal...

Page 377: ...ing newval java int set_logFrequency String newval uwp async Task int set_logFrequency string newval py def set_logFrequency newval php function set_logFrequency newval es function set_logFrequency ne...

Page 378: ...ng newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval c...

Page 379: ...set_lowestValue ByVal newval As Double As Integer cs int set_lowestValue double newval java int set_lowestValue double newval uwp async Task int set_lowestValue double newval py def set_lowestValue ne...

Page 380: ...newval java int set_reportFrequency String newval uwp async Task int set_reportFrequency string newval py def set_reportFrequency newval php function set_reportFrequency newval es function set_reportF...

Page 381: ...ution double newval java int set_resolution double newval uwp async Task int set_resolution double newval py def set_resolution newval php function set_resolution newval es function set_resolution new...

Page 382: ...rData void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data py...

Page 383: ...taLogger LongInt vb function startDataLogger As Integer cs int startDataLogger java int startDataLogger uwp async Task int startDataLogger py def startDataLogger php function startDataLogger es functi...

Page 384: ...topDataLogger m int stopDataLogger pas function stopDataLogger LongInt vb function stopDataLogger As Integer cs int stopDataLogger java int stopDataLogger uwp async Task int stopDataLogger py def stop...

Page 385: ...cks As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueCa...

Page 386: ...callback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoked...

Page 387: ...de js Global functions yFindAltitude func Retrieves an altimeter for a given identifier yFindAltitudeInContext yctx func Retrieves an altimeter for a given identifier in a YAPI context yFirstAltitude...

Page 388: ..._async callback context Gets the YModule object for the device on which the function is located asynchronous version altitude get_qnh Returns the barometric pressure adjusted to sea level used to comp...

Page 389: ...on every change of advertised value altitude set_currentValue newval Changes the current estimated altitude altitude set_highestValue newval Changes the recorded maximal value observed altitude set_l...

Page 390: ...entifier can be specified using several formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName...

Page 391: ...LogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the altimeter is online at the time it is invoked The returned object is neve...

Page 392: ...unction yFirstAltitude TYAltitude vb function yFirstAltitude As YAltitude cs YAltitude FirstAltitude java YAltitude FirstAltitude uwp YAltitude FirstAltitude py def FirstAltitude php function yFirstAl...

Page 393: ...itudeInContext YAPIContext yctx uwp YAltitude FirstAltitudeInContext YAPIContext yctx es function FirstAltitudeInContext yctx Use the method YAltitude nextAltitude to iterate on next altimeters Parame...

Page 394: ...rateFromPoints rawValues refValues php function calibrateFromPoints rawValues refValues es function calibrateFromPoints rawValues refValues cmd YAltitude target calibrateFromPoints rawValues refValues...

Page 395: ...clearCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the...

Page 396: ...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...

Page 397: ...tion get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertisedV...

Page 398: ...currentRawValue double vb function get_currentRawValue As Double cs double get_currentRawValue java double get_currentRawValue uwp async Task double get_currentRawValue py def get_currentRawValue php...

Page 399: ...n get_currentValue double vb function get_currentValue As Double cs double get_currentValue java double get_currentValue uwp async Task double get_currentValue py def get_currentValue php function get...

Page 400: ...ring errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorMess...

Page 401: ...errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_err...

Page 402: ...ava 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 altimeter if they are...

Page 403: ...UN_DESCR vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor es f...

Page 404: ...unction get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function get_f...

Page 405: ...ction get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is compos...

Page 406: ...n get_highestValue double vb function get_highestValue As Double cs double get_highestValue java double get_highestValue uwp async Task double get_highestValue py def get_highestValue php function get...

Page 407: ...s function get_logFrequency string vb function get_logFrequency As String cs string get_logFrequency java String get_logFrequency uwp async Task string get_logFrequency py def get_logFrequency php fun...

Page 408: ...pas function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php functio...

Page 409: ...ion get_lowestValue double vb function get_lowestValue As Double cs double get_lowestValue java double get_lowestValue uwp async Task double get_lowestValue py def get_lowestValue php function get_low...

Page 410: ...et_module cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function get_mo...

Page 411: ...ipt It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section on a...

Page 412: ...le qnh pas function get_qnh double vb function get_qnh As Double cs double get_qnh java double get_qnh uwp async Task double get_qnh py def get_qnh php function get_qnh es function get_qnh cmd YAltitu...

Page 413: ...t_recordedData startTime endTime The measures will be retrieved from the data logger which must have been turned on at the desired time See the documentation of the DataSet class for information on ho...

Page 414: ...tion get_reportFrequency string vb function get_reportFrequency As String cs string get_reportFrequency java String get_reportFrequency uwp async Task string get_reportFrequency py def get_reportFrequ...

Page 415: ...double get_resolution java double get_resolution uwp async Task double get_resolution py def get_resolution php function get_resolution es function get_resolution cmd YAltitude target get_resolution T...

Page 416: ...s function get_sensorState LongInt vb function get_sensorState As Integer cs int get_sensorState java int get_sensorState uwp async Task int get_sensorState py def get_sensorState php function get_sen...

Page 417: ...echnology string vb function get_technology As String cs string get_technology java String get_technology uwp async Task string get_technology py def get_technology php function get_technology es func...

Page 418: ...NSString unit pas function get_unit string vb function get_unit As String cs string get_unit java String get_unit uwp async Task string get_unit py def get_unit php function get_unit es function get_u...

Page 419: ...t_userData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function get...

Page 420: ...ean vb function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the altimeter in cache that has not...

Page 421: ...an error while trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking t...

Page 422: ...YAltitude target isSensorReady Returns false if the device is unreachable or if the sensor does not have a current measure to transmit No exception is raised if there is an error while trying to conta...

Page 423: ...ong msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard duratio...

Page 424: ...te NSString attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp async T...

Page 425: ...s List double refValues java int loadCalibrationPoints ArrayList Double rawValues ArrayList Double refValues uwp async Task int loadCalibrationPoints List double rawValues List double refValues py def...

Page 426: ...etwork trafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters msValid...

Page 427: ...acks java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YAltitude target muteValueCallbacks...

Page 428: ...tude nextAltitude pas function nextAltitude TYAltitude vb function nextAltitude As YAltitude cs YAltitude nextAltitude java YAltitude nextAltitude uwp YAltitude nextAltitude py def nextAltitude php fu...

Page 429: ...va int registerTimedReportCallback TimedReportCallback callback uwp async Task int registerTimedReportCallback TimedReportCallback callback py def registerTimedReportCallback callback php function reg...

Page 430: ...lueCallback UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es function regist...

Page 431: ...teger cs int set_currentValue double newval java int set_currentValue double newval uwp async Task int set_currentValue double newval py def set_currentValue newval php function set_currentValue newva...

Page 432: ...et_highestValue ByVal newval As Double As Integer cs int set_highestValue double newval java int set_highestValue double newval uwp async Task int set_highestValue double newval py def set_highestValu...

Page 433: ...ng newval java int set_logFrequency String newval uwp async Task int set_logFrequency string newval py def set_logFrequency newval php function set_logFrequency newval es function set_logFrequency new...

Page 434: ...g newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval cm...

Page 435: ...et_lowestValue ByVal newval As Double As Integer cs int set_lowestValue double newval java int set_lowestValue double newval uwp async Task int set_lowestValue double newval py def set_lowestValue new...

Page 436: ...cs int set_qnh double newval java int set_qnh double newval uwp async Task int set_qnh double newval py def set_qnh newval php function set_qnh newval es function set_qnh newval cmd YAltitude target s...

Page 437: ...ewval java int set_reportFrequency String newval uwp async Task int set_reportFrequency string newval py def set_reportFrequency newval php function set_reportFrequency newval es function set_reportFr...

Page 438: ...tion double newval java int set_resolution double newval uwp async Task int set_resolution double newval py def set_resolution newval php function set_resolution newval es function set_resolution newv...

Page 439: ...Data void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data py...

Page 440: ...taLogger LongInt vb function startDataLogger As Integer cs int startDataLogger java int startDataLogger uwp async Task int startDataLogger py def startDataLogger php function startDataLogger es functi...

Page 441: ...opDataLogger m int stopDataLogger pas function stopDataLogger LongInt vb function stopDataLogger As Integer cs int stopDataLogger java int stopDataLogger uwp async Task int stopDataLogger py def stopD...

Page 442: ...cks As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueCa...

Page 443: ...callback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoked...

Page 444: ...ifier yFindGroundSpeedInContext yctx func Retrieves a ground speed sensor for a given identifier in a YAPI context yFirstGroundSpeed Starts the enumeration of ground speed sensors currently accessible...

Page 445: ...ync callback context Gets the YModule object for the device on which the function is located asynchronous version groundspeed get_recordedData startTime endTime Retrieves a DataSet object holding hist...

Page 446: ...every change of advertised value groundspeed set_highestValue newval Changes the recorded maximal value observed groundspeed set_logFrequency newval Changes the datalogger recording frequency for this...

Page 447: ...func The identifier can be specified using several formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier Module...

Page 448: ...e 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 neve...

Page 449: ...GroundSpeed TYGroundSpeed vb function yFirstGroundSpeed As YGroundSpeed cs YGroundSpeed FirstGroundSpeed java YGroundSpeed FirstGroundSpeed uwp YGroundSpeed FirstGroundSpeed py def FirstGroundSpeed ph...

Page 450: ...InContext YAPIContext yctx uwp YGroundSpeed FirstGroundSpeedInContext YAPIContext yctx es function FirstGroundSpeedInContext yctx Use the method YGroundSpeed nextGroundSpeed to iterate on next ground...

Page 451: ...brateFromPoints rawValues refValues php function calibrateFromPoints rawValues refValues es function calibrateFromPoints rawValues refValues cmd YGroundSpeed target calibrateFromPoints rawValues refVa...

Page 452: ...learCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the ca...

Page 453: ...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...

Page 454: ...unction get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertis...

Page 455: ...et_currentRawValue double vb function get_currentRawValue As Double cs double get_currentRawValue java double get_currentRawValue uwp async Task double get_currentRawValue py def get_currentRawValue p...

Page 456: ...tion get_currentValue double vb function get_currentValue As Double cs double get_currentValue java double get_currentValue uwp async Task double get_currentValue py def get_currentValue php function...

Page 457: ...NSString errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_erro...

Page 458: ...get_errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get...

Page 459: ...ring 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...

Page 460: ...r YFUN_DESCR vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor...

Page 461: ...ejs function get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function...

Page 462: ...tion get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is compose...

Page 463: ...tion get_highestValue double vb function get_highestValue As Double cs double get_highestValue java double get_highestValue uwp async Task double get_highestValue py def get_highestValue php function...

Page 464: ...pas function get_logFrequency string vb function get_logFrequency As String cs string get_logFrequency java String get_logFrequency uwp async Task string get_logFrequency py def get_logFrequency php...

Page 465: ...me pas function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php func...

Page 466: ...nction get_lowestValue double vb function get_lowestValue As Double cs double get_lowestValue java double get_lowestValue uwp async Task double get_lowestValue py def get_lowestValue php function get_...

Page 467: ...ion get_module cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function g...

Page 468: ...vascript It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section...

Page 469: ...get get_recordedData startTime endTime The measures will be retrieved from the data logger which must have been turned on at the desired time See the documentation of the DataSet class for information...

Page 470: ...unction get_reportFrequency string vb function get_reportFrequency As String cs string get_reportFrequency java String get_reportFrequency uwp async Task string get_reportFrequency py def get_reportFr...

Page 471: ...cs double get_resolution java double get_resolution uwp async Task double get_resolution py def get_resolution php function get_resolution es function get_resolution cmd YGroundSpeed target get_resolu...

Page 472: ...pas function get_sensorState LongInt vb function get_sensorState As Integer cs int get_sensorState java int get_sensorState uwp async Task int get_sensorState py def get_sensorState php function get_...

Page 473: ...m NSString unit pas function get_unit string vb function get_unit As String cs string get_unit java String get_unit uwp async Task string get_unit py def get_unit php function get_unit es function ge...

Page 474: ...on get_userData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php functio...

Page 475: ...function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the ground speed sensor in cache that has...

Page 476: ...if there is an error while trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avo...

Page 477: ...d YGroundSpeed target isSensorReady Returns false if the device is unreachable or if the sensor does not have a current measure to transmit No exception is raised if there is an error while trying to...

Page 478: ...t load long msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard...

Page 479: ...ibute NSString attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp asyn...

Page 480: ...ues List double refValues java int loadCalibrationPoints ArrayList Double rawValues ArrayList Double refValues uwp async Task int loadCalibrationPoints List double rawValues List double refValues py d...

Page 481: ...reduce network trafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters...

Page 482: ...backs java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YGroundSpeed target muteValueCallba...

Page 483: ...ndSpeed pas function nextGroundSpeed TYGroundSpeed vb function nextGroundSpeed As YGroundSpeed cs YGroundSpeed nextGroundSpeed java YGroundSpeed nextGroundSpeed uwp YGroundSpeed nextGroundSpeed py def...

Page 484: ...lback java int registerTimedReportCallback TimedReportCallback callback uwp async Task int registerTimedReportCallback TimedReportCallback callback py def registerTimedReportCallback callback php func...

Page 485: ...gisterValueCallback UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es functio...

Page 486: ...n set_highestValue ByVal newval As Double As Integer cs int set_highestValue double newval java int set_highestValue double newval uwp async Task int set_highestValue double newval py def set_highestV...

Page 487: ...tring newval java int set_logFrequency String newval uwp async Task int set_logFrequency string newval py def set_logFrequency newval php function set_logFrequency newval es function set_logFrequency...

Page 488: ...ring newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval...

Page 489: ...n set_lowestValue ByVal newval As Double As Integer cs int set_lowestValue double newval java int set_lowestValue double newval uwp async Task int set_lowestValue double newval py def set_lowestValue...

Page 490: ...g newval java int set_reportFrequency String newval uwp async Task int set_reportFrequency string newval py def set_reportFrequency newval php function set_reportFrequency newval es function set_repor...

Page 491: ...olution double newval java int set_resolution double newval uwp async Task int set_resolution double newval py def set_resolution newval php function set_resolution newval es function set_resolution n...

Page 492: ...userData void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data...

Page 493: ...ataLogger LongInt vb function startDataLogger As Integer cs int startDataLogger java int startDataLogger uwp async Task int startDataLogger py def startDataLogger php function startDataLogger es funct...

Page 494: ...stopDataLogger m int stopDataLogger pas function stopDataLogger LongInt vb function stopDataLogger As Integer cs int stopDataLogger java int stopDataLogger uwp async Task int stopDataLogger py def sto...

Page 495: ...acks As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueC...

Page 496: ...nc callback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invok...

Page 497: ...func Retrieves a data logger for a given identifier yFindDataLoggerInContext yctx func Retrieves a data logger for a given identifier in a YAPI context yFirstDataLogger Starts the enumeration of data...

Page 498: ...the function is located asynchronous version datalogger get_recording Returns the current activation state of the data logger datalogger get_timeUTC Returns the Unix timestamp for current UTC time if...

Page 499: ...data logger to start stop recording data datalogger set_timeUTC newval Changes the current UTC time reference used for recorded data datalogger set_userData data Stores a user context provided as argu...

Page 500: ...ogger func The identifier can be specified using several formats FunctionLogicalName ModuleSerialNumber FunctionIdentifier ModuleSerialNumber FunctionLogicalName ModuleLogicalName FunctionIdentifier M...

Page 501: ...ionLogicalName ModuleLogicalName FunctionIdentifier ModuleLogicalName FunctionLogicalName This function does not require that the data logger is online at the time it is invoked The returned object is...

Page 502: ...yFirstDataLogger TYDataLogger vb function yFirstDataLogger As YDataLogger cs YDataLogger FirstDataLogger java YDataLogger FirstDataLogger uwp YDataLogger FirstDataLogger py def FirstDataLogger php fu...

Page 503: ...ggerInContext YAPIContext yctx uwp YDataLogger FirstDataLoggerInContext YAPIContext yctx es function FirstDataLoggerInContext yctx Use the method YDataLogger nextDataLogger to iterate on next data log...

Page 504: ...d clearCache m void clearCache pas procedure clearCache vb procedure clearCache cs void clearCache java void clearCache py def clearCache php function clearCache es function clearCache Invalidates the...

Page 505: ...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...

Page 506: ...AllDataStreams LongInt vb function forgetAllDataStreams As Integer cs int forgetAllDataStreams java int forgetAllDataStreams uwp async Task int forgetAllDataStreams py def forgetAllDataStreams php fun...

Page 507: ...nction get_advertisedValue string vb function get_advertisedValue As String cs string get_advertisedValue java String get_advertisedValue uwp async Task string get_advertisedValue py def get_advertise...

Page 508: ...art pas function get_autoStart Integer vb function get_autoStart As Integer cs int get_autoStart java int get_autoStart uwp async Task int get_autoStart py def get_autoStart php function get_autoStart...

Page 509: ...s function get_beaconDriven Integer vb function get_beaconDriven As Integer cs int get_beaconDriven java int get_beaconDriven uwp async Task int get_beaconDriven py def get_beaconDriven php function g...

Page 510: ...tion get_currentRunIndex LongInt vb function get_currentRunIndex As Integer cs int get_currentRunIndex java int get_currentRunIndex uwp async Task int get_currentRunIndex py def get_currentRunIndex ph...

Page 511: ...aSets TYDataSetArray vb function get_dataSets As List cs List YDataSet get_dataSets java ArrayList YDataSet get_dataSets uwp async Task List YDataSet get_dataSets py def get_dataSets php function get_...

Page 512: ...eams ArrayList YDataStream v py def get_dataStreams v php function get_dataStreams v es function get_dataStreams v The caller must pass by reference an empty array to hold YDataStream objects and the...

Page 513: ...SString errorMessage pas function get_errorMessage string vb function get_errorMessage As String cs string get_errorMessage java String get_errorMessage py def get_errorMessage php function get_errorM...

Page 514: ...et_errorType pas function get_errorType YRETCODE vb function get_errorType As YRETCODE cs YRETCODE get_errorType java int get_errorType py def get_errorType php function get_errorType es function get_...

Page 515: ...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 data logger if they...

Page 516: ...YFUN_DESCR vb function get_functionDescriptor As YFUN_DESCR cs YFUN_DESCR get_functionDescriptor java String get_functionDescriptor py def get_functionDescriptor php function get_functionDescriptor e...

Page 517: ...s function get_functionId cpp string get_functionId m NSString functionId vb function get_functionId As String cs string get_functionId java String get_functionId py def get_functionId php function ge...

Page 518: ...unction get_hardwareId As String cs string get_hardwareId java String get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareId The unique hardware identifier is comp...

Page 519: ...e pas function get_logicalName string vb function get_logicalName As String cs string get_logicalName java String get_logicalName uwp async Task string get_logicalName py def get_logicalName php funct...

Page 520: ...n get_module cpp YModule get_module m YModule module pas function get_module TYModule vb function get_module As YModule cs YModule get_module java YModule get_module py def get_module php function get...

Page 521: ...script It uses a callback instead of a return value in order to avoid blocking Firefox javascript VM that does not implement context switching during blocking I O calls See the documentation section o...

Page 522: ...get_recording Integer vb function get_recording As Integer cs int get_recording java int get_recording uwp async Task int get_recording py def get_recording php function get_recording es function get...

Page 523: ...timeUTC pas function get_timeUTC int64 vb function get_timeUTC As Long cs long get_timeUTC java long get_timeUTC uwp async Task long get_timeUTC py def get_timeUTC php function get_timeUTC es functio...

Page 524: ...get_userData cpp void get_userData m id userData pas function get_userData Tobject vb function get_userData As Object cs object get_userData java Object get_userData py def get_userData php function...

Page 525: ...ean vb function isOnline As Boolean cs bool isOnline java boolean isOnline py def isOnline php function isOnline es function isOnline If there is a cached value for the data logger in cache that has n...

Page 526: ...is an error while trying to contact the device hosting the requested function This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocki...

Page 527: ...d long msValidity py def load msValidity php function load msValidity es function load msValidity By default whenever accessing a device all function attributes are kept in cache for the standard dura...

Page 528: ...bute NSString attrName pas function loadAttribute attrName string string vb function loadAttribute As String cs string loadAttribute string attrName java String loadAttribute String attrName uwp async...

Page 529: ...e network trafic for instance This asynchronous version exists only in Javascript It uses a callback instead of a return value in order to avoid blocking the Javascript virtual machine Parameters msVa...

Page 530: ...backs java int muteValueCallbacks uwp async Task int muteValueCallbacks py def muteValueCallbacks php function muteValueCallbacks es function muteValueCallbacks cmd YDataLogger target muteValueCallbac...

Page 531: ...extDataLogger pas function nextDataLogger TYDataLogger vb function nextDataLogger As YDataLogger cs YDataLogger nextDataLogger java YDataLogger nextDataLogger uwp YDataLogger nextDataLogger py def nex...

Page 532: ...terValueCallback UpdateCallback callback uwp async Task int registerValueCallback ValueCallback callback py def registerValueCallback callback php function registerValueCallback callback es function r...

Page 533: ...eger As Integer cs int set_autoStart int newval java int set_autoStart int newval uwp async Task int set_autoStart int newval py def set_autoStart newval php function set_autoStart newval es function...

Page 534: ...teger As Integer cs int set_beaconDriven int newval java int set_beaconDriven int newval uwp async Task int set_beaconDriven int newval py def set_beaconDriven newval php function set_beaconDriven new...

Page 535: ...ing newval java int set_logicalName String newval uwp async Task int set_logicalName string newval py def set_logicalName newval php function set_logicalName newval es function set_logicalName newval...

Page 536: ...ng ByVal newval As Integer As Integer cs int set_recording int newval java int set_recording int newval uwp async Task int set_recording int newval py def set_recording newval php function set_recordi...

Page 537: ...function set_timeUTC ByVal newval As Long As Integer cs int set_timeUTC long newval java int set_timeUTC long newval uwp async Task int set_timeUTC long newval py def set_timeUTC newval php function...

Page 538: ...serData void data m void setUserData id data pas procedure set_userData data Tobject vb procedure set_userData ByVal data As Object cs void set_userData object data java void set_userData Object data...

Page 539: ...acks As Integer cs int unmuteValueCallbacks java int unmuteValueCallbacks uwp async Task int unmuteValueCallbacks py def unmuteValueCallbacks php function unmuteValueCallbacks es function unmuteValueC...

Page 540: ...c callback context The callback function can therefore freely issue synchronous or asynchronous commands without risking to block the Javascript VM Parameters callback callback function that is invoke...

Page 541: ...h m import yocto_api h pas uses yocto_api vb yocto_api vb cs yocto_api cs java import com yoctopuce YoctoAPI YModule uwp import com yoctopuce YoctoAPI YModule py from yocto_api import php require_onc...

Page 542: ...ich summarizes the whole DataSet dataset get_unit Returns the measuring unit for the measured value dataset loadMore Loads the the next block of measures from the dataLogger and updates the progress i...

Page 543: ...nc Task long get_endTimeUTC py def get_endTimeUTC php function get_endTimeUTC es function get_endTimeUTC When the YDataSet is created the end time is the value passed in parameter to the get_dataSet f...

Page 544: ...function get_functionId cpp string get_functionId m NSString functionId pas function get_functionId string vb function get_functionId As String cs string get_functionId java String get_functionId uwp...

Page 545: ...b function get_hardwareId As String cs string get_hardwareId java String get_hardwareId uwp async Task string get_hardwareId py def get_hardwareId php function get_hardwareId es function get_hardwareI...

Page 546: ...e interval the minimal value observed during the time interval the average value observed during the time interval the maximal value observed during the time interval Before calling this method you sh...

Page 547: ...e TYMeasureArray vb function get_measuresAt As List cs List YMeasure get_measuresAt YMeasure measure java ArrayList YMeasure get_measuresAt YMeasure measure uwp async Task List YMeasure get_measuresAt...

Page 548: ...sure get_preview uwp async Task List YMeasure get_preview py def get_preview php function get_preview es function get_preview Each item includes the start of a time interval the end of a time interval...

Page 549: ...n get_progress LongInt vb function get_progress As Integer cs int get_progress java int get_progress uwp async Task int get_progress py def get_progress php function get_progress es function get_progr...

Page 550: ...ync Task long get_startTimeUTC py def get_startTimeUTC php function get_startTimeUTC es function get_startTimeUTC When the YDataSet is created the start time is the value passed in parameter to the ge...

Page 551: ...summary java YMeasure get_summary uwp async Task YMeasure get_summary py def get_summary php function get_summary es function get_summary In includes the following information the start of a time inte...

Page 552: ...unit cpp string get_unit m NSString unit pas function get_unit string vb function get_unit As String cs string get_unit java String get_unit uwp async Task string get_unit py def get_unit php function...

Page 553: ...oadMore m int loadMore pas function loadMore LongInt vb function loadMore As Integer cs int loadMore java int loadMore uwp async Task int loadMore py def loadMore php function loadMore es function loa...

Page 554: ...context Parameters callback callback function that is invoked when the w The callback function receives three arguments the user specific context object the YDataSet object whose loadMore_async was i...

Page 555: ...wp import com yoctopuce YoctoAPI YModule py from yocto_api import php require_once yocto_api php es in HTML script src lib yocto_api js script in node js require yoctolib es2017 yocto_api js YMeasure...

Page 556: ...n get_averageValue cpp double get_averageValue m double averageValue pas function get_averageValue double vb function get_averageValue As Double cs double get_averageValue java double get_averageValue...

Page 557: ...unction get_endTimeUTC double vb function get_endTimeUTC As Double cs double get_endTimeUTC java double get_endTimeUTC uwp double get_endTimeUTC py def get_endTimeUTC php function get_endTimeUTC es fu...

Page 558: ...e nodejs function get_maxValue cpp double get_maxValue m double maxValue pas function get_maxValue double vb function get_maxValue As Double cs double get_maxValue java double get_maxValue uwp double...

Page 559: ...e nodejs function get_minValue cpp double get_minValue m double minValue pas function get_minValue double vb function get_minValue As Double cs double get_minValue java double get_minValue uwp double...

Page 560: ...ion get_startTimeUTC double vb function get_startTimeUTC As Double cs double get_startTimeUTC java double get_startTimeUTC uwp double get_startTimeUTC py def get_startTimeUTC php function get_startTim...

Page 561: ...fault behavior you therefore need to create a file with a name that starts with a number larger than 50 that will override the system default rules Note that to add a rule you need a root access on th...

Page 562: ...nnot see the module check that you are using a true USB cable with data wires and not a charging cable Charging cables have only power wires 21 4 Another process named xxx is already using yAPI If whe...

Page 563: ...Refresh rate 10 Hz Accuracy 1 5 m Supported Operating Systems Windows Linux Intel ARM Mac OS X Android Drivers no driver needed API SDK Libraries USB TCP C Objective C C VB NET Delphi Python Java Andr...

Page 564: ...22 Characteristics 558 www yoctopuce com...

Page 565: ......

Page 566: ......

Page 567: ...I 140 Disconnections 556 Distribution 14 download YModule 175 Dynamic 93 133 E EcmaScript 37 38 Elements 5 6 EnableExceptions YAPI 141 EnableUSBHost YAPI 142 Erratic 556 Error 46 57 64 71 78 84 91 97...

Page 568: ...s 245 get_friendlyName YGroundSpeed 452 get_friendlyName YLatitude 289 get_friendlyName YLongitude 342 get_functionDescriptor YAltitude 396 get_functionDescriptor YDataLogger 509 get_functionDescripto...

Page 569: ...get_unit YLatitude 303 get_unit YLongitude 356 get_unixTime YGps 257 get_upTime YModule 201 get_url YModule 202 get_usbCurrent YModule 203 get_userData YAltitude 412 get_userData YDataLogger 517 get_...

Page 570: ...ess 556 Programming 17 31 117 128 Project 73 79 Python 93 R reboot YModule 213 Recorded 535 Reference 137 RegisterDeviceArrivalCallback YAPI 149 RegisterDeviceRemovalCallback YAPI 150 RegisterHub YAPI...

Page 571: ...HubDiscovery YAPI 161 Troubleshooting 555 U unmuteValueCallbacks YAltitude 435 unmuteValueCallbacks YDataLogger 532 unmuteValueCallbacks YGps 272 unmuteValueCallbacks YGroundSpeed 488 unmuteValueCallb...

Page 572: ...Firmware 127 Yocto GPS 19 33 37 49 59 67 73 79 87 93 99 105 YoctoHub 127 yPreregisterHub 148 yRegisterDeviceArrivalCallback 149 yRegisterDeviceRemovalCallback 150 yRegisterHub 151 yRegisterHubDiscover...

Search results

Summary of Contents for Yocto-GPS

Reviews:

Brands by name

Popular brands

Yoctopuce Yocto-GPS, User Manual

Search results

Summary of Contents for Yocto-GPS

Reviews:

Brands by name

Popular brands