yoctolib-esm
Version:
Yoctopuce library for TypeScript/JavaScript, as an ECMAScript 2015 module
339 lines • 13.8 kB
JavaScript
/*********************************************************************
*
* $Id: svn_id $
*
* Implements the high-level API for HubPort functions
*
* - - - - - - - - - License information: - - - - - - - - -
*
* Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
*
* Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
* non-exclusive license to use, modify, copy and integrate this
* file into your software for the sole purpose of interfacing
* with Yoctopuce products.
*
* You may reproduce and distribute copies of this file in
* source or object form, as long as the sole purpose of this
* code is to interface with Yoctopuce products. You must retain
* this notice in the distributed source file.
*
* You should refer to Yoctopuce General Terms and Conditions
* for additional information regarding your rights and
* obligations.
*
* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
* WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
* EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
* COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
* SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
* LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
* CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
* BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
* WARRANTY, OR OTHERWISE.
*
*********************************************************************/
import { YAPI, YFunction } from './yocto_api.js';
//--- (YHubPort class start)
/**
* YHubPort Class: YoctoHub slave port control interface, available for instance in the
* YoctoHub-Ethernet, the YoctoHub-GSM-4G, the YoctoHub-Shield or the YoctoHub-Wireless-n
*
* The YHubPort class provides control over the power supply for slave ports
* on a YoctoHub. It provide information about the device connected to it.
* The logical name of a YHubPort is always automatically set to the
* unique serial number of the Yoctopuce device connected to it.
*/
//--- (end of YHubPort class start)
export class YHubPort extends YFunction {
//--- (end of YHubPort attributes declaration)
constructor(yapi, func) {
//--- (YHubPort constructor)
super(yapi, func);
this._enabled = YHubPort.ENABLED_INVALID;
this._portState = YHubPort.PORTSTATE_INVALID;
this._baudRate = YHubPort.BAUDRATE_INVALID;
this._valueCallbackHubPort = null;
// API symbols as object properties
this.ENABLED_FALSE = 0;
this.ENABLED_TRUE = 1;
this.ENABLED_INVALID = -1;
this.PORTSTATE_OFF = 0;
this.PORTSTATE_OVRLD = 1;
this.PORTSTATE_ON = 2;
this.PORTSTATE_RUN = 3;
this.PORTSTATE_PROG = 4;
this.PORTSTATE_INVALID = -1;
this.BAUDRATE_INVALID = YAPI.INVALID_UINT;
this._className = 'HubPort';
//--- (end of YHubPort constructor)
}
//--- (YHubPort implementation)
imm_parseAttr(name, val) {
switch (name) {
case 'enabled':
this._enabled = val;
return 1;
case 'portState':
this._portState = val;
return 1;
case 'baudRate':
this._baudRate = val;
return 1;
}
return super.imm_parseAttr(name, val);
}
/**
* Returns true if the YoctoHub port is powered, false otherwise.
*
* @return either YHubPort.ENABLED_FALSE or YHubPort.ENABLED_TRUE, according to true if the YoctoHub
* port is powered, false otherwise
*
* On failure, throws an exception or returns YHubPort.ENABLED_INVALID.
*/
async get_enabled() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YHubPort.ENABLED_INVALID;
}
}
res = this._enabled;
return res;
}
/**
* Changes the activation of the YoctoHub port. If the port is enabled, the
* connected module is powered. Otherwise, port power is shut down.
*
* @param newval : either YHubPort.ENABLED_FALSE or YHubPort.ENABLED_TRUE, according to the activation
* of the YoctoHub port
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
async set_enabled(newval) {
let rest_val;
rest_val = String(newval);
return await this._setAttr('enabled', rest_val);
}
/**
* Returns the current state of the YoctoHub port.
*
* @return a value among YHubPort.PORTSTATE_OFF, YHubPort.PORTSTATE_OVRLD, YHubPort.PORTSTATE_ON,
* YHubPort.PORTSTATE_RUN and YHubPort.PORTSTATE_PROG corresponding to the current state of the YoctoHub port
*
* On failure, throws an exception or returns YHubPort.PORTSTATE_INVALID.
*/
async get_portState() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YHubPort.PORTSTATE_INVALID;
}
}
res = this._portState;
return res;
}
/**
* Returns the current baud rate used by this YoctoHub port, in kbps.
* The default value is 1000 kbps, but a slower rate may be used if communication
* problems are encountered.
*
* @return an integer corresponding to the current baud rate used by this YoctoHub port, in kbps
*
* On failure, throws an exception or returns YHubPort.BAUDRATE_INVALID.
*/
async get_baudRate() {
let res;
if (this._cacheExpiration <= this._yapi.GetTickCount()) {
if (await this.load(this._yapi.defaultCacheValidity) != this._yapi.SUCCESS) {
return YHubPort.BAUDRATE_INVALID;
}
}
res = this._baudRate;
return res;
}
/**
* Retrieves a YoctoHub slave port for a given identifier.
* The identifier can be specified using several formats:
*
* - FunctionLogicalName
* - ModuleSerialNumber.FunctionIdentifier
* - ModuleSerialNumber.FunctionLogicalName
* - ModuleLogicalName.FunctionIdentifier
* - ModuleLogicalName.FunctionLogicalName
*
*
* This function does not require that the YoctoHub slave port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YHubPort.isOnline() to test if the YoctoHub slave port is
* indeed online at a given time. In case of ambiguity when looking for
* a YoctoHub slave 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.
*
* 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.
*
* @param func : a string that uniquely characterizes the YoctoHub slave port, for instance
* YHUBETH1.hubPort1.
*
* @return a YHubPort object allowing you to drive the YoctoHub slave port.
*/
static FindHubPort(func) {
let obj;
obj = YFunction._FindFromCache('HubPort', func);
if (obj == null) {
obj = new YHubPort(YAPI, func);
YFunction._AddToCache('HubPort', func, obj);
}
return obj;
}
/**
* Retrieves a YoctoHub slave port for a given identifier in a YAPI context.
* The identifier can be specified using several formats:
*
* - FunctionLogicalName
* - ModuleSerialNumber.FunctionIdentifier
* - ModuleSerialNumber.FunctionLogicalName
* - ModuleLogicalName.FunctionIdentifier
* - ModuleLogicalName.FunctionLogicalName
*
*
* This function does not require that the YoctoHub slave port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YHubPort.isOnline() to test if the YoctoHub slave port is
* indeed online at a given time. In case of ambiguity when looking for
* a YoctoHub slave 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.
*
* @param yctx : a YAPI context
* @param func : a string that uniquely characterizes the YoctoHub slave port, for instance
* YHUBETH1.hubPort1.
*
* @return a YHubPort object allowing you to drive the YoctoHub slave port.
*/
static FindHubPortInContext(yctx, func) {
let obj;
obj = YFunction._FindFromCacheInContext(yctx, 'HubPort', func);
if (obj == null) {
obj = new YHubPort(yctx, func);
YFunction._AddToCache('HubPort', func, obj);
}
return obj;
}
/**
* Registers the callback function that is invoked on every change of advertised value.
* The callback is then invoked only during the execution of ySleep or yHandleEvents.
* This provides control over the time when the callback is triggered. For good responsiveness,
* remember to call one of these two functions periodically. The callback is called once juste after beeing
* registered, passing the current advertised value of the function, provided that it is not an empty string.
* To unregister a callback, pass a null pointer as argument.
*
* @param callback : the callback function to call, or a null pointer. The callback function should take two
* arguments: the function object of which the value has changed, and the character string describing
* the new advertised value.
* @noreturn
*/
async registerValueCallback(callback) {
let val;
if (callback != null) {
await YFunction._UpdateValueCallbackList(this, true);
}
else {
await YFunction._UpdateValueCallbackList(this, false);
}
this._valueCallbackHubPort = callback;
// Immediately invoke value callback with current value
if (callback != null && await this.isOnline()) {
val = this._advertisedValue;
if (!(val == '')) {
await this._invokeValueCallback(val);
}
}
return 0;
}
async _invokeValueCallback(value) {
if (this._valueCallbackHubPort != null) {
try {
await this._valueCallbackHubPort(this, value);
}
catch (e) {
this._yapi.imm_log('Exception in valueCallback:', e);
}
}
else {
await super._invokeValueCallback(value);
}
return 0;
}
/**
* Continues the enumeration of YoctoHub slave ports started using yFirstHubPort().
* Caution: You can't make any assumption about the returned YoctoHub slave ports order.
* If you want to find a specific a YoctoHub slave port, use HubPort.findHubPort()
* and a hardwareID or a logical name.
*
* @return a pointer to a YHubPort object, corresponding to
* a YoctoHub slave port currently online, or a null pointer
* if there are no more YoctoHub slave ports to enumerate.
*/
nextHubPort() {
let resolve = this._yapi.imm_resolveFunction(this._className, this._func);
if (resolve.errorType != YAPI.SUCCESS)
return null;
let next_hwid = this._yapi.imm_getNextHardwareId(this._className, resolve.result);
if (next_hwid == null)
return null;
return YHubPort.FindHubPortInContext(this._yapi, next_hwid);
}
/**
* Starts the enumeration of YoctoHub slave ports currently accessible.
* Use the method YHubPort.nextHubPort() to iterate on
* next YoctoHub slave ports.
*
* @return a pointer to a YHubPort object, corresponding to
* the first YoctoHub slave port currently online, or a null pointer
* if there are none.
*/
static FirstHubPort() {
let next_hwid = YAPI.imm_getFirstHardwareId('HubPort');
if (next_hwid == null)
return null;
return YHubPort.FindHubPort(next_hwid);
}
/**
* Starts the enumeration of YoctoHub slave ports currently accessible.
* Use the method YHubPort.nextHubPort() to iterate on
* next YoctoHub slave ports.
*
* @param yctx : a YAPI context.
*
* @return a pointer to a YHubPort object, corresponding to
* the first YoctoHub slave port currently online, or a null pointer
* if there are none.
*/
static FirstHubPortInContext(yctx) {
let next_hwid = yctx.imm_getFirstHardwareId('HubPort');
if (next_hwid == null)
return null;
return YHubPort.FindHubPortInContext(yctx, next_hwid);
}
}
// API symbols as static members
YHubPort.ENABLED_FALSE = 0;
YHubPort.ENABLED_TRUE = 1;
YHubPort.ENABLED_INVALID = -1;
YHubPort.PORTSTATE_OFF = 0;
YHubPort.PORTSTATE_OVRLD = 1;
YHubPort.PORTSTATE_ON = 2;
YHubPort.PORTSTATE_RUN = 3;
YHubPort.PORTSTATE_PROG = 4;
YHubPort.PORTSTATE_INVALID = -1;
YHubPort.BAUDRATE_INVALID = YAPI.INVALID_UINT;
//# sourceMappingURL=yocto_hubport.js.map