// link the instance to a real YoctoAPI object
internal override void linkToHardware(string hwdName)
{
YVoc hwd = YVoc.FindVoc(hwdName);
// first redo base_init to update all _func pointers
base_init(hwd, hwdName);
// then setup Yocto-API pointers and callbacks
init(hwd);
}
// perform the 2nd stage setup that requires YoctoAPI object
protected void init(YVoc hwd)
{
if (hwd == null)
{
return;
}
base.init(hwd);
InternalStuff.log("registering Voc callback");
_func.registerValueCallback(valueChangeCallback);
}
public static YVocProxy FindVoc(string name)
{
// cases to handle:
// name ="" no matching unknwn
// name ="" unknown exists
// name != "" no matching unknown
// name !="" unknown exists
YVoc func = null;
YVocProxy res = (YVocProxy)YFunctionProxy.FindSimilarUnknownFunction("YVocProxy");
if (name == "")
{
if (res != null)
{
return(res);
}
res = (YVocProxy)YFunctionProxy.FindSimilarKnownFunction("YVocProxy");
if (res != null)
{
return(res);
}
func = YVoc.FirstVoc();
if (func != null)
{
name = func.get_hardwareId();
if (func.get_userData() != null)
{
return((YVocProxy)func.get_userData());
}
}
}
else
{
func = YVoc.FindVoc(name);
if (func.get_userData() != null)
{
return((YVocProxy)func.get_userData());
}
}
if (res == null)
{
res = new YVocProxy(func, name);
}
if (func != null)
{
res.linkToHardware(name);
if (func.isOnline())
{
res.arrival();
}
}
return(res);
}
/**
* <summary>
* Enumerates all functions of type Voc available on the devices
* currently reachable by the library, and returns their unique hardware ID.
* <para>
* Each of these IDs can be provided as argument to the method
* <c>YVoc.FindVoc</c> to obtain an object that can control the
* corresponding device.
* </para>
* </summary>
* <returns>
* an array of strings, each string containing the unique hardwareId
* of a device function currently connected.
* </returns>
*/
public static new string[] GetSimilarFunctions()
{
List <string> res = new List <string>();
YVoc it = YVoc.FirstVoc();
while (it != null)
{
res.Add(it.get_hardwareId());
it = it.nextVoc();
}
return(res.ToArray());
}
/**
* <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>
* </summary>
* <param name="func">
* a string that uniquely characterizes the Volatile Organic Compound sensor
* </param>
* <returns>
* a <c>YVoc</c> object allowing you to drive the Volatile Organic Compound sensor.
* </returns>
*/
public static YVoc FindVoc(string func)
{
YVoc obj;
obj = (YVoc)YFunction._FindFromCache("Voc", func);
if (obj == null)
{
obj = new YVoc(func);
YFunction._AddToCache("Voc", func, obj);
}
return(obj);
}
static void Main(string[] args)
{
string errmsg = "";
string target;
YVoc vocsensor;
if (args.Length < 1)
{
usage();
}
target = args[0].ToUpper();
// Setup the API to use local USB devices
if (YAPI.RegisterHub("usb", ref errmsg) != YAPI.SUCCESS)
{
Console.WriteLine("RegisterHub error: " + errmsg);
Environment.Exit(0);
}
if (target == "ANY")
{
vocsensor = YVoc.FirstVoc();
if (vocsensor == null)
{
Console.WriteLine("No module connected (check USB cable) ");
Environment.Exit(0);
}
Console.WriteLine("using " + vocsensor.get_module().get_serialNumber());
}
else
{
vocsensor = YVoc.FindVoc(target + ".voc");
}
if (!vocsensor.isOnline())
{
Console.WriteLine("Module not connected");
Console.WriteLine("check identification and USB cable");
Environment.Exit(0);
}
while (vocsensor.isOnline())
{
Console.WriteLine("VOC: " + vocsensor.get_currentValue().ToString() + " ppm");
Console.WriteLine(" (press Ctrl-C to exit)");
YAPI.Sleep(1000, ref errmsg);
}
YAPI.FreeAPI();
}
public override async Task <int> Run()
{
try {
YVoc vocsensor;
// Setup the API to use local USB devices
await YAPI.RegisterHub(HubURL);
if (Target.ToLower() == "any")
{
vocsensor = YVoc.FirstVoc();
if (vocsensor == null)
{
WriteLine("No module connected (check USB cable) ");
return(-1);
}
YModule m = await vocsensor.get_module();
WriteLine("using " + await m.get_serialNumber());
}
else
{
vocsensor = YVoc.FindVoc(Target + ".voc");
}
while (await vocsensor.isOnline())
{
WriteLine("VOC: " + await vocsensor.get_currentValue() + " ppm");
await YAPI.Sleep(1000);
}
WriteLine("Module not connected (check identification and USB cable)");
} catch (YAPI_Exception ex) {
WriteLine("error: " + ex.Message);
}
YAPI.FreeAPI();
return(0);
}
// perform the initial setup that may be done without a YoctoAPI object (hwd can be null)
internal override void base_init(YFunction hwd, string instantiationName)
{
_func = (YVoc)hwd;
base.base_init(hwd, instantiationName);
}
// property cache
//--- (end of YVoc definitions)
//--- (YVoc implementation)
internal YVocProxy(YVoc hwd, string instantiationName) : base(hwd, instantiationName)
{
InternalStuff.log("Voc " + instantiationName + " instantiation");
base_init(hwd, instantiationName);
}
/**
* <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>
* </summary>
* <param name="func">
* a string that uniquely characterizes the Volatile Organic Compound sensor
* </param>
* <returns>
* a <c>YVoc</c> object allowing you to drive the Volatile Organic Compound sensor.
* </returns>
*/
public static YVoc FindVoc(string func)
{
YVoc obj;
obj = (YVoc) YFunction._FindFromCache("Voc", func);
if (obj == null) {
obj = new YVoc(func);
YFunction._AddToCache("Voc", func, obj);
}
return obj;
}
