/** * <summary> * Gets the <c>YModule</c> object for the device on which the function is located. * <para> * If the function cannot be located on any module, the returned instance of * <c>YModule</c> is not shown as on-line. * </para> * <para> * </para> * </summary> * <returns> * an instance of <c>YModule</c> * </returns> */ public YModuleProxy get_module() { if (_func == null) { string msg = "No Function connected"; throw new YoctoApiProxyException(msg); } return(YoctoProxyManager.FindModule(_serialNumber)); }
public static String GetDllArchitecture() { string check = YoctoProxyManager.CheckDllVersion(""); if (check != "") { return("ERROR: " + check); } return(YoctoProxyManager.DllArchitecture); }
public static String GetAPIVersion() { string check = YoctoProxyManager.CheckDllVersion(""); if (check != "") { return("ERROR: " + check); } return(YAPI.GetAPIVersion()); }
/** * <summary> * Retrieves a wake-up monitor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the wake-up monitor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YWakeUpMonitor.isOnline()</c> to test if the wake-up monitor is * indeed online at a given time. In case of ambiguity when looking for * a wake-up monitor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the wake-up monitor, for instance * <c>YHUBGSM5.wakeUpMonitor</c>. * </param> * <returns> * a <c>YWakeUpMonitor</c> object allowing you to drive the wake-up monitor. * </returns> */ public static YWakeUpMonitorProxy FindWakeUpMonitor(string func) { return(YoctoProxyManager.FindWakeUpMonitor(func)); }
/** * <summary> * Retrieves a PWM generator power source for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the PWM generator power source is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YPwmPowerSource.isOnline()</c> to test if the PWM generator power source is * indeed online at a given time. In case of ambiguity when looking for * a PWM generator power source by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the PWM generator power source, for instance * <c>YPWMTX01.pwmPowerSource</c>. * </param> * <returns> * a <c>YPwmPowerSource</c> object allowing you to drive the PWM generator power source. * </returns> */ public static YPwmPowerSourceProxy FindPwmPowerSource(string func) { return(YoctoProxyManager.FindPwmPowerSource(func)); }
/** * <summary> * Retrieves a digital IO port for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the digital IO port is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YDigitalIO.isOnline()</c> to test if the digital IO port is * indeed online at a given time. In case of ambiguity when looking for * a digital IO port by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the digital IO port, for instance * <c>YMINIIO0.digitalIO</c>. * </param> * <returns> * a <c>YDigitalIO</c> object allowing you to drive the digital IO port. * </returns> */ public static YDigitalIOProxy FindDigitalIO(string func) { return(YoctoProxyManager.FindDigitalIO(func)); }
/** * <summary> * Retrieves a module chain for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the module chain is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YDaisyChain.isOnline()</c> to test if the module chain is * indeed online at a given time. In case of ambiguity when looking for * a module chain by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the module chain, for instance * <c>MyDevice.daisyChain</c>. * </param> * <returns> * a <c>YDaisyChain</c> object allowing you to drive the module chain. * </returns> */ public static YDaisyChainProxy FindDaisyChain(string func) { return(YoctoProxyManager.FindDaisyChain(func)); }
/** * <summary> * Retrieves a temperature sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the temperature sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YTemperature.isOnline()</c> to test if the temperature sensor is * indeed online at a given time. In case of ambiguity when looking for * a temperature sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the temperature sensor, for instance * <c>METEOMK2.temperature</c>. * </param> * <returns> * a <c>YTemperature</c> object allowing you to drive the temperature sensor. * </returns> */ public static YTemperatureProxy FindTemperature(string func) { return(YoctoProxyManager.FindTemperature(func)); }
/** * <summary> * Retrieves an arithmetic sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the arithmetic sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YArithmeticSensor.isOnline()</c> to test if the arithmetic sensor is * indeed online at a given time. In case of ambiguity when looking for * an arithmetic sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the arithmetic sensor, for instance * <c>RXUVOLT1.arithmeticSensor1</c>. * </param> * <returns> * a <c>YArithmeticSensor</c> object allowing you to drive the arithmetic sensor. * </returns> */ public static YArithmeticSensorProxy FindArithmeticSensor(string func) { return(YoctoProxyManager.FindArithmeticSensor(func)); }
/** * <summary> * Retrieves a PWM input for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the PWM input is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YPwmInput.isOnline()</c> to test if the PWM input is * indeed online at a given time. In case of ambiguity when looking for * a PWM input by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the PWM input, for instance * <c>YPWMRX01.pwmInput1</c>. * </param> * <returns> * a <c>YPwmInput</c> object allowing you to drive the PWM input. * </returns> */ public static YPwmInputProxy FindPwmInput(string func) { return(YoctoProxyManager.FindPwmInput(func)); }
/** * <summary> * Test if the hub is reachable. * <para> * This method do not register the hub, it only test if the * hub is usable. The url parameter follow the same convention as the <c>yRegisterHub</c> * method. This method is useful to verify the authentication parameters for a hub. It * is possible to force this method to return after mstimeout milliseconds. * </para> * <para> * </para> * </summary> * <param name="url"> * a string containing either <c>"usb"</c>,<c>"callback"</c> or the * root URL of the hub to monitor * </param> * <param name="mstimeout"> * the number of millisecond available to test the connection. * </param> * <returns> * <c>0</c> when the call succeeds. * </returns> * <para> * On failure returns a negative error code. * </para> */ public static string TestHub(string url, int mstimeout) { return(YoctoProxyManager.TestHub(url, mstimeout)); }
/** * <summary> * Retrieves Yoctopuce low-level library diagnostic logs. * <para> * This method allows to progessively retrieve API logs. The interface is line-based: * it must called it within a loop until the returned value is an empty string. * Make sure to exit the loop when an empty string is returned, as feeding an empty * string into the <c>lastLogLine</c> parameter for the next call would restart * enumerating logs from the oldest message available. * </para> * </summary> * <param name="lastLogLine"> * On first call, provide an empty string. * On subsequent calls, provide the last log line returned by <c>GetLog()</c>. * </param> * <returns> * a string with the log line immediately following the one given in argument, * if such line exist. Returns an empty string otherwise, when completed. * </returns> */ public static string GetLog(string lastLogLine) { return(YoctoProxyManager.getLogLine(lastLogLine)); }
/** * <summary> * Fault-tolerant alternative to <c>yRegisterHub()</c>. * <para> * This function has the same * purpose and same arguments as <c>yRegisterHub()</c>, but does not trigger * an error when the selected hub is not available at the time of the function call. * This makes it possible to register a network hub independently of the current * connectivity, and to try to contact it only when a device is actively needed. * </para> * <para> * </para> * </summary> * <param name="url"> * a string containing either <c>"usb"</c>,<c>"callback"</c> or the * root URL of the hub to monitor * </param> * <returns> * <c>0</c> when the call succeeds. * </returns> * <para> * On failure, throws an exception or returns a negative error code. * </para> */ public static string PreregisterHub(string url) { return(YoctoProxyManager.PreRegisterHub(url)); }
/** * <summary> * Returns the system architecture for the Yoctopuce communication library in use. * <para> * On Windows, the architecture can be <c>"Win32"</c> or <c>"Win64"</c>. * On ARM machines, the architecture is <c>"Armhf32"</c> or <c>"Aarch64"</c>. * On other Linux machines, the architecture is <c>"Linux32"</c> or <c>"Linux64"</c>. * On MacOS, the architecture is <c>"MacOs32"</c> or <c>"MacOs64"</c>. * </para> * <para> * </para> * </summary> * <returns> * a character string describing the system architecture of the * low-level communication library. * </returns> */ public static string GetDllArchitecture() { return(YoctoProxyManager.GetDllArchitecture()); }
/** * <summary> * Returns the paths of the DLLs for the Yoctopuce library in use. * <para> * For architectures that require multiple DLLs, in particular when using * a .NET assembly DLL, the returned string takes the form * <c>"DotNetProxy=/...; yapi=/...;"</c>, * where the first path corresponds to the .NET assembly DLL and the * second path corresponds to the low-level communication library. * </para> * <para> * </para> * </summary> * <returns> * a character string describing the DLL path. * </returns> */ public static string GetDllPath() { return(YoctoProxyManager.GetDllPath()); }
/** * <summary> * Returns the version identifier for the Yoctopuce library in use. * <para> * The version is a string in the form <c>"Major.Minor.Build"</c>, * for instance <c>"1.01.5535"</c>. For languages using an external * DLL (for instance C#, VisualBasic or Delphi), the character string * includes as well the DLL version, for instance * <c>"1.01.5535 (1.01.5439)"</c>. * </para> * <para> * If you want to verify in your code that the library version is * compatible with the version that you have used during development, * verify that the major number is strictly equal and that the minor * number is greater or equal. The build number is not relevant * with respect to the library compatibility. * </para> * <para> * </para> * </summary> * <returns> * a character string describing the library version. * </returns> */ public static string GetAPIVersion() { return(YoctoProxyManager.GetAPIVersion()); }
/** * <summary> * Retrieves a quaternion component for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the quaternion component is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YQt.isOnline()</c> to test if the quaternion component is * indeed online at a given time. In case of ambiguity when looking for * a quaternion component by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the quaternion component, for instance * <c>Y3DMK002.qt1</c>. * </param> * <returns> * a <c>YQt</c> object allowing you to drive the quaternion component. * </returns> */ public static YQtProxy FindQt(string func) { return(YoctoProxyManager.FindQt(func)); }
/** * <summary> * Retrieves a SMS message box interface for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the SMS message box interface is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YMessageBox.isOnline()</c> to test if the SMS message box interface is * indeed online at a given time. In case of ambiguity when looking for * a SMS message box interface by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the SMS message box interface, for instance * <c>YHUBGSM1.messageBox</c>. * </param> * <returns> * a <c>YMessageBox</c> object allowing you to drive the SMS message box interface. * </returns> */ public static YMessageBoxProxy FindMessageBox(string func) { return(YoctoProxyManager.FindMessageBox(func)); }
/** * <summary> * Retrieves a multi-axis controller for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the multi-axis controller is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YMultiAxisController.isOnline()</c> to test if the multi-axis controller is * indeed online at a given time. In case of ambiguity when looking for * a multi-axis controller by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the multi-axis controller, for instance * <c>MyDevice.multiAxisController</c>. * </param> * <returns> * a <c>YMultiAxisController</c> object allowing you to drive the multi-axis controller. * </returns> */ public static YMultiAxisControllerProxy FindMultiAxisController(string func) { return(YoctoProxyManager.FindMultiAxisController(func)); }
/** * <summary> * Waits for all pending communications with Yoctopuce devices to be * completed then frees dynamically allocated resources used by * the Yoctopuce library. * <para> * </para> * <para> * From an operating system standpoint, it is generally not required to call * this function since the OS will automatically free allocated resources * once your program is completed. However there are two situations when * you may really want to use that function: * </para> * <para> * - Free all dynamically allocated memory blocks in order to * track a memory leak. * </para> * <para> * - Send commands to devices right before the end * of the program. Since commands are sent in an asynchronous way * the program could exit before all commands are effectively sent. * </para> * <para> * You should not call any other library function after calling * <c>yFreeAPI()</c>, or your program will crash. * </para> * </summary> */ public static void FreeAPI() { YoctoProxyManager.FreeAPI(); }
/** * <summary> * Retrieves a display for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the display is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YDisplay.isOnline()</c> to test if the display is * indeed online at a given time. In case of ambiguity when looking for * a display by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the display, for instance * <c>YD128X32.display</c>. * </param> * <returns> * a <c>YDisplay</c> object allowing you to drive the display. * </returns> */ public static YDisplayProxy FindDisplay(string func) { return(YoctoProxyManager.FindDisplay(func)); }
/** * <summary> * Retrieves a current sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the current sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YCurrent.isOnline()</c> to test if the current sensor is * indeed online at a given time. In case of ambiguity when looking for * a current sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the current sensor, for instance * <c>YAMPMK01.current1</c>. * </param> * <returns> * a <c>YCurrent</c> object allowing you to drive the current sensor. * </returns> */ public static YCurrentProxy FindCurrent(string func) { return(YoctoProxyManager.FindCurrent(func)); }
/** * <summary> * Retrieves a generic sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the generic sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YGenericSensor.isOnline()</c> to test if the generic sensor is * indeed online at a given time. In case of ambiguity when looking for * a generic sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the generic sensor, for instance * <c>RX010V01.genericSensor1</c>. * </param> * <returns> * a <c>YGenericSensor</c> object allowing you to drive the generic sensor. * </returns> */ public static YGenericSensorProxy FindGenericSensor(string func) { return(YoctoProxyManager.FindGenericSensor(func)); }
/** * <summary> * Retrieves a Volatile Organic Compound sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the Volatile Organic Compound sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YVoc.isOnline()</c> to test if the Volatile Organic Compound sensor is * indeed online at a given time. In case of ambiguity when looking for * a Volatile Organic Compound sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the Volatile Organic Compound sensor, for instance * <c>YVOCMK03.voc</c>. * </param> * <returns> * a <c>YVoc</c> object allowing you to drive the Volatile Organic Compound sensor. * </returns> */ public static YVocProxy FindVoc(string func) { return(YoctoProxyManager.FindVoc(func)); }
/** * <summary> * Retrieves an altimeter for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the altimeter is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YAltitude.isOnline()</c> to test if the altimeter is * indeed online at a given time. In case of ambiguity when looking for * an altimeter by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the altimeter, for instance * <c>YALTIMK2.altitude</c>. * </param> * <returns> * a <c>YAltitude</c> object allowing you to drive the altimeter. * </returns> */ public static YAltitudeProxy FindAltitude(string func) { return(YoctoProxyManager.FindAltitude(func)); }
/** * <summary> * Retrieves a pressure sensor for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the pressure sensor is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YPressure.isOnline()</c> to test if the pressure sensor is * indeed online at a given time. In case of ambiguity when looking for * a pressure sensor by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the pressure sensor, for instance * <c>YALTIMK2.pressure</c>. * </param> * <returns> * a <c>YPressure</c> object allowing you to drive the pressure sensor. * </returns> */ public static YPressureProxy FindPressure(string func) { return(YoctoProxyManager.FindPressure(func)); }
/** * <summary> * Retrieves a regulated power supply for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the regulated power supply is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YPowerSupply.isOnline()</c> to test if the regulated power supply is * indeed online at a given time. In case of ambiguity when looking for * a regulated power supply by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the regulated power supply, for instance * <c>MyDevice.powerSupply</c>. * </param> * <returns> * a <c>YPowerSupply</c> object allowing you to drive the regulated power supply. * </returns> */ public static YPowerSupplyProxy FindPowerSupply(string func) { return(YoctoProxyManager.FindPowerSupply(func)); }
/** * <summary> * Retrieves an audio output for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the audio output is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YAudioOut.isOnline()</c> to test if the audio output is * indeed online at a given time. In case of ambiguity when looking for * an audio output by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the audio output, for instance * <c>MyDevice.audioOut1</c>. * </param> * <returns> * a <c>YAudioOut</c> object allowing you to drive the audio output. * </returns> */ public static YAudioOutProxy FindAudioOut(string func) { return(YoctoProxyManager.FindAudioOut(func)); }
/** * <summary> * Retrieves an accelerometer for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the accelerometer is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YAccelerometer.isOnline()</c> to test if the accelerometer is * indeed online at a given time. In case of ambiguity when looking for * an accelerometer by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the accelerometer, for instance * <c>Y3DMK002.accelerometer</c>. * </param> * <returns> * a <c>YAccelerometer</c> object allowing you to drive the accelerometer. * </returns> */ public static YAccelerometerProxy FindAccelerometer(string func) { return(YoctoProxyManager.FindAccelerometer(func)); }
/** * <summary> * Retrieves a compass function for a given identifier. * <para> * The identifier can be specified using several formats: * </para> * <para> * </para> * <para> * - FunctionLogicalName * </para> * <para> * - ModuleSerialNumber.FunctionIdentifier * </para> * <para> * - ModuleSerialNumber.FunctionLogicalName * </para> * <para> * - ModuleLogicalName.FunctionIdentifier * </para> * <para> * - ModuleLogicalName.FunctionLogicalName * </para> * <para> * </para> * <para> * This function does not require that the compass function is online at the time * it is invoked. The returned object is nevertheless valid. * Use the method <c>YCompass.isOnline()</c> to test if the compass function is * indeed online at a given time. In case of ambiguity when looking for * a compass function by logical name, no error is notified: the first instance * found is returned. The search is performed first by hardware name, * then by logical name. * </para> * <para> * If a call to this object's is_online() method returns FALSE although * you are certain that the matching device is plugged, make sure that you did * call registerHub() at application initialization time. * </para> * <para> * </para> * </summary> * <param name="func"> * a string that uniquely characterizes the compass function, for instance * <c>Y3DMK002.compass</c>. * </param> * <returns> * a <c>YCompass</c> object allowing you to drive the compass function. * </returns> */ public static YCompassProxy FindCompass(string func) { return(YoctoProxyManager.FindCompass(func)); }