yoctolib-esm
Version:
Yoctopuce library for TypeScript/JavaScript, as an ECMAScript 2015 module
475 lines (474 loc) • 21.7 kB
TypeScript
/*********************************************************************
*
* $Id: svn_id $
*
* Implements the high-level API for DigitalIO 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 { YAPIContext, YFunction } from './yocto_api.js';
/**
* YDigitalIO Class: digital IO port control interface, available for instance in the Yocto-IO or the
* Yocto-Maxi-IO-V2
*
* The YDigitalIO class allows you drive a Yoctopuce digital input/output port.
* It can be used to set up the direction of each channel, to read the state of each channel
* and to switch the state of each channel configures as an output.
* You can work on all channels at once, or one by one. Most functions
* use a binary representation for channels where bit 0 matches channel #0 , bit 1 matches channel
* #1 and so on. If you are not familiar with numbers binary representation, you will find more
* information here: https://en.wikipedia.org/wiki/Binary_number#Representation. It is also possible
* to automatically generate short pulses of a determined duration. Electrical behavior
* of each I/O can be modified (open drain and reverse polarity).
*/
export declare class YDigitalIO extends YFunction {
_className: string;
_portState: number;
_portDirection: number;
_portOpenDrain: number;
_portPolarity: number;
_portDiags: number;
_portSize: number;
_outputVoltage: YDigitalIO.OUTPUTVOLTAGE;
_command: string;
_valueCallbackDigitalIO: YDigitalIO.ValueCallback | null;
readonly PORTSTATE_INVALID: number;
readonly PORTDIRECTION_INVALID: number;
readonly PORTOPENDRAIN_INVALID: number;
readonly PORTPOLARITY_INVALID: number;
readonly PORTDIAGS_INVALID: number;
readonly PORTSIZE_INVALID: number;
readonly OUTPUTVOLTAGE_USB_5V: YDigitalIO.OUTPUTVOLTAGE;
readonly OUTPUTVOLTAGE_USB_3V: YDigitalIO.OUTPUTVOLTAGE;
readonly OUTPUTVOLTAGE_EXT_V: YDigitalIO.OUTPUTVOLTAGE;
readonly OUTPUTVOLTAGE_INVALID: YDigitalIO.OUTPUTVOLTAGE;
readonly COMMAND_INVALID: string;
static readonly PORTSTATE_INVALID: number;
static readonly PORTDIRECTION_INVALID: number;
static readonly PORTOPENDRAIN_INVALID: number;
static readonly PORTPOLARITY_INVALID: number;
static readonly PORTDIAGS_INVALID: number;
static readonly PORTSIZE_INVALID: number;
static readonly OUTPUTVOLTAGE_USB_5V: YDigitalIO.OUTPUTVOLTAGE;
static readonly OUTPUTVOLTAGE_USB_3V: YDigitalIO.OUTPUTVOLTAGE;
static readonly OUTPUTVOLTAGE_EXT_V: YDigitalIO.OUTPUTVOLTAGE;
static readonly OUTPUTVOLTAGE_INVALID: YDigitalIO.OUTPUTVOLTAGE;
static readonly COMMAND_INVALID: string;
constructor(yapi: YAPIContext, func: string);
imm_parseAttr(name: string, val: any): number;
/**
* Returns the digital IO port state as an integer with each bit
* representing a channel.
* value 0 = 0b00000000 -> all channels are OFF
* value 1 = 0b00000001 -> channel #0 is ON
* value 2 = 0b00000010 -> channel #1 is ON
* value 3 = 0b00000011 -> channels #0 and #1 are ON
* value 4 = 0b00000100 -> channel #2 is ON
* and so on...
*
* @return an integer corresponding to the digital IO port state as an integer with each bit
* representing a channel
*
* On failure, throws an exception or returns YDigitalIO.PORTSTATE_INVALID.
*/
get_portState(): Promise<number>;
/**
* Changes the state of all digital IO port's channels at once: the parameter
* is an integer where each bit represents a channel, with bit 0 matching channel #0.
* To set all channels to 0 -> 0b00000000 -> parameter = 0
* To set channel #0 to 1 -> 0b00000001 -> parameter = 1
* To set channel #1 to 1 -> 0b00000010 -> parameter = 2
* To set channel #0 and #1 -> 0b00000011 -> parameter = 3
* To set channel #2 to 1 -> 0b00000100 -> parameter = 4
* an so on....
* Only channels configured as outputs will be affecter, according to the value
* configured using set_portDirection.
*
* @param newval : an integer corresponding to the state of all digital IO port's channels at once: the parameter
* is an integer where each bit represents a channel, with bit 0 matching channel #0
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_portState(newval: number): Promise<number>;
/**
* Returns the I/O direction of all channels of the port (bitmap): 0 makes a bit an input, 1 makes it an output.
*
* @return an integer corresponding to the I/O direction of all channels of the port (bitmap): 0 makes
* a bit an input, 1 makes it an output
*
* On failure, throws an exception or returns YDigitalIO.PORTDIRECTION_INVALID.
*/
get_portDirection(): Promise<number>;
/**
* Changes the I/O direction of all channels of the port (bitmap): 0 makes a bit an input, 1 makes it an output.
* Remember to call the saveToFlash() method to make sure the setting is kept after a reboot.
*
* @param newval : an integer corresponding to the I/O direction of all channels of the port (bitmap):
* 0 makes a bit an input, 1 makes it an output
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_portDirection(newval: number): Promise<number>;
/**
* Returns the electrical interface for each bit of the port. For each bit set to 0 the matching I/O
* works in the regular,
* intuitive way, for each bit set to 1, the I/O works in reverse mode.
*
* @return an integer corresponding to the electrical interface for each bit of the port
*
* On failure, throws an exception or returns YDigitalIO.PORTOPENDRAIN_INVALID.
*/
get_portOpenDrain(): Promise<number>;
/**
* Changes the electrical interface for each bit of the port. 0 makes a bit a regular input/output, 1 makes
* it an open-drain (open-collector) input/output. Remember to call the
* saveToFlash() method to make sure the setting is kept after a reboot.
*
* @param newval : an integer corresponding to the electrical interface for each bit of the port
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_portOpenDrain(newval: number): Promise<number>;
/**
* Returns the polarity of all the bits of the port. For each bit set to 0, the matching I/O works the regular,
* intuitive way; for each bit set to 1, the I/O works in reverse mode.
*
* @return an integer corresponding to the polarity of all the bits of the port
*
* On failure, throws an exception or returns YDigitalIO.PORTPOLARITY_INVALID.
*/
get_portPolarity(): Promise<number>;
/**
* Changes the polarity of all the bits of the port: For each bit set to 0, the matching I/O works the regular,
* intuitive way; for each bit set to 1, the I/O works in reverse mode.
* Remember to call the saveToFlash() method to make sure the setting will be kept after a reboot.
*
* @param newval : an integer corresponding to the polarity of all the bits of the port: For each bit
* set to 0, the matching I/O works the regular,
* intuitive way; for each bit set to 1, the I/O works in reverse mode
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_portPolarity(newval: number): Promise<number>;
/**
* Returns the port state diagnostics. Bit 0 indicates a shortcut on output 0, etc.
* Bit 8 indicates a power failure, and bit 9 signals overheating (overcurrent).
* During normal use, all diagnostic bits should stay clear.
*
* @return an integer corresponding to the port state diagnostics
*
* On failure, throws an exception or returns YDigitalIO.PORTDIAGS_INVALID.
*/
get_portDiags(): Promise<number>;
/**
* Returns the number of bits (i.e. channels)implemented in the I/O port.
*
* @return an integer corresponding to the number of bits (i.e
*
* On failure, throws an exception or returns YDigitalIO.PORTSIZE_INVALID.
*/
get_portSize(): Promise<number>;
/**
* Returns the voltage source used to drive output bits.
*
* @return a value among YDigitalIO.OUTPUTVOLTAGE_USB_5V, YDigitalIO.OUTPUTVOLTAGE_USB_3V and
* YDigitalIO.OUTPUTVOLTAGE_EXT_V corresponding to the voltage source used to drive output bits
*
* On failure, throws an exception or returns YDigitalIO.OUTPUTVOLTAGE_INVALID.
*/
get_outputVoltage(): Promise<YDigitalIO.OUTPUTVOLTAGE>;
/**
* Changes the voltage source used to drive output bits.
* Remember to call the saveToFlash() method to make sure the setting is kept after a reboot.
*
* @param newval : a value among YDigitalIO.OUTPUTVOLTAGE_USB_5V, YDigitalIO.OUTPUTVOLTAGE_USB_3V and
* YDigitalIO.OUTPUTVOLTAGE_EXT_V corresponding to the voltage source used to drive output bits
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_outputVoltage(newval: YDigitalIO.OUTPUTVOLTAGE): Promise<number>;
get_command(): Promise<string>;
set_command(newval: string): Promise<number>;
/**
* Retrieves a digital IO 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 digital IO port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YDigitalIO.isOnline() 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.
*
* 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 digital IO port, for instance
* YMINIIO0.digitalIO.
*
* @return a YDigitalIO object allowing you to drive the digital IO port.
*/
static FindDigitalIO(func: string): YDigitalIO;
/**
* Retrieves a digital IO 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 digital IO port is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YDigitalIO.isOnline() 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.
*
* @param yctx : a YAPI context
* @param func : a string that uniquely characterizes the digital IO port, for instance
* YMINIIO0.digitalIO.
*
* @return a YDigitalIO object allowing you to drive the digital IO port.
*/
static FindDigitalIOInContext(yctx: YAPIContext, func: string): YDigitalIO;
/**
* Registers the callback function that is invoked on every change of advertised value.
* The callback is 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. 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
*/
registerValueCallback(callback: YDigitalIO.ValueCallback | null): Promise<number>;
_invokeValueCallback(value: string): Promise<number>;
/**
* Sets a single bit (i.e. channel) of the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0
* @param bitstate : the state of the bit (1 or 0)
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_bitState(bitno: number, bitstate: number): Promise<number>;
/**
* Returns the state of a single bit (i.e. channel) of the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0
*
* @return the bit state (0 or 1)
*
* On failure, throws an exception or returns a negative error code.
*/
get_bitState(bitno: number): Promise<number>;
/**
* Reverts a single bit (i.e. channel) of the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
toggle_bitState(bitno: number): Promise<number>;
/**
* Changes the direction of a single bit (i.e. channel) from the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0
* @param bitdirection : direction to set, 0 makes the bit an input, 1 makes it an output.
* Remember to call the saveToFlash() method to make sure the setting is kept after a reboot.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_bitDirection(bitno: number, bitdirection: number): Promise<number>;
/**
* Returns the direction of a single bit (i.e. channel) from the I/O port (0 means the bit is an
* input, 1 an output).
*
* @param bitno : the bit number; lowest bit has index 0
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
get_bitDirection(bitno: number): Promise<number>;
/**
* Changes the polarity of a single bit from the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0.
* @param bitpolarity : polarity to set, 0 makes the I/O work in regular mode, 1 makes the I/O works
* in reverse mode.
* Remember to call the saveToFlash() method to make sure the setting is kept after a reboot.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_bitPolarity(bitno: number, bitpolarity: number): Promise<number>;
/**
* Returns the polarity of a single bit from the I/O port (0 means the I/O works in regular mode, 1
* means the I/O works in reverse mode).
*
* @param bitno : the bit number; lowest bit has index 0
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
get_bitPolarity(bitno: number): Promise<number>;
/**
* Changes the electrical interface of a single bit from the I/O port.
*
* @param bitno : the bit number; lowest bit has index 0
* @param opendrain : 0 makes a bit a regular input/output, 1 makes
* it an open-drain (open-collector) input/output. Remember to call the
* saveToFlash() method to make sure the setting is kept after a reboot.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_bitOpenDrain(bitno: number, opendrain: number): Promise<number>;
/**
* Returns the type of electrical interface of a single bit from the I/O port. (0 means the bit is an
* input, 1 an output).
*
* @param bitno : the bit number; lowest bit has index 0
*
* @return 0 means the a bit is a regular input/output, 1 means the bit is an open-drain
* (open-collector) input/output.
*
* On failure, throws an exception or returns a negative error code.
*/
get_bitOpenDrain(bitno: number): Promise<number>;
/**
* Triggers a pulse on a single bit for a specified duration. The specified bit
* will be turned to 1, and then back to 0 after the given duration.
*
* @param bitno : the bit number; lowest bit has index 0
* @param ms_duration : desired pulse duration in milliseconds. Be aware that the device time
* resolution is not guaranteed up to the millisecond.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
pulse(bitno: number, ms_duration: number): Promise<number>;
/**
* Schedules a pulse on a single bit for a specified duration. The specified bit
* will be turned to 1, and then back to 0 after the given duration.
*
* @param bitno : the bit number; lowest bit has index 0
* @param ms_delay : waiting time before the pulse, in milliseconds
* @param ms_duration : desired pulse duration in milliseconds. Be aware that the device time
* resolution is not guaranteed up to the millisecond.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
delayedPulse(bitno: number, ms_delay: number, ms_duration: number): Promise<number>;
/**
* Continues the enumeration of digital IO ports started using yFirstDigitalIO().
* Caution: You can't make any assumption about the returned digital IO ports order.
* If you want to find a specific a digital IO port, use DigitalIO.findDigitalIO()
* and a hardwareID or a logical name.
*
* @return a pointer to a YDigitalIO object, corresponding to
* a digital IO port currently online, or a null pointer
* if there are no more digital IO ports to enumerate.
*/
nextDigitalIO(): YDigitalIO | null;
/**
* Starts the enumeration of digital IO ports currently accessible.
* Use the method YDigitalIO.nextDigitalIO() to iterate on
* next digital IO ports.
*
* @return a pointer to a YDigitalIO object, corresponding to
* the first digital IO port currently online, or a null pointer
* if there are none.
*/
static FirstDigitalIO(): YDigitalIO | null;
/**
* Starts the enumeration of digital IO ports currently accessible.
* Use the method YDigitalIO.nextDigitalIO() to iterate on
* next digital IO ports.
*
* @param yctx : a YAPI context.
*
* @return a pointer to a YDigitalIO object, corresponding to
* the first digital IO port currently online, or a null pointer
* if there are none.
*/
static FirstDigitalIOInContext(yctx: YAPIContext): YDigitalIO | null;
}
export declare namespace YDigitalIO {
const enum OUTPUTVOLTAGE {
USB_5V = 0,
USB_3V = 1,
EXT_V = 2,
INVALID = -1
}
interface ValueCallback {
(func: YDigitalIO, value: string): void;
}
}