22. High-level API Reference
www.yoctopuce.com
171
Returns the value of the userData attribute, as previously stored using method
set_userData
.
module
→
get_userVar()
Returns the value previously stored in this attribute.
module
→
hasFunction(
funcId
)
Tests if the device includes a specific function.
module
→
isOnline()
Checks if the module is currently reachable, without raising any error.
module
→
isOnline_async(
callback
,
context
)
Checks if the module is currently reachable, without raising any error.
module
→
load(
msValidity
)
Preloads the module cache with a specified validity duration.
module
→
load_async(
msValidity
,
callback
,
context
)
Preloads the module cache with a specified validity duration (asynchronous version).
module
→
log(
text
)
Adds a text message to the device logs.
module
→
nextModule()
Continues the module enumeration started using
yFirstModule()
.
module
→
reboot(
secBeforeReboot
)
Schedules a simple module reboot after the given number of seconds.
module
→
registerBeaconCallback(
callback
)
Register a callback function, to be called when the localization beacon of the module has been changed.
module
→
registerConfigChangeCallback(
callback
)
Register a callback function, to be called when a persistent settings in a device configuration has been
changed (e.g.
module
→
registerLogCallback(
callback
)
Registers a device log callback function.
module
→
revertFromFlash()
Reloads the settings stored in the nonvolatile memory, as when the module is powered on.
module
→
saveToFlash()
Saves current settings in the nonvolatile memory of the module.
module
→
set_allSettings(
settings
)
Restores all the settings of the device.
module
→
set_allSettingsAndFiles(
settings
)
Restores all the settings and uploaded files to the module.
module
→
set_beacon(
newval
)
Turns on or off the module localization beacon.
module
→
set_logicalName(
newval
)
Changes the logical name of the module.
module
→
set_luminosity(
newval
)
Changes the luminosity of the module informative leds.
module
→
set_userData(
data
)
Stores a user context provided as argument in the userData attribute of the function.
module
→
set_userVar(
newval
)
Stores a 32 bit value in the device RAM.
module
→
triggerConfigChangeCallback()
Summary of Contents for Yocto-Display
Page 1: ...Yocto Display User Manual...
Page 2: ......
Page 40: ...34 www yoctopuce com...
Page 52: ...46 www yoctopuce com...
Page 84: ...78 www yoctopuce com...
Page 92: ...86 www yoctopuce com...
Page 130: ...124 www yoctopuce com...
Page 422: ...416 www yoctopuce com...
