Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the JavaScript API bindings for the AC Current Bricklet. General information and technical specifications for the AC Current Bricklet are summarized in its hardware description.
An installation guide for the JavaScript API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:
The namespace for the JavaScript bindings is Tinkerforge.*.
Parameters: |
|
---|
Creates an object with the unique device ID uid:
var acCurrent = new BrickletACCurrent("YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Callback: |
|
---|
TODO
If you want to get the current periodically, it is recommended to use the callback CALLBACK_CURRENT and set the period with setCurrentCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Callback: |
|
---|
Callback: |
|
---|
Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.
If you want the analog value periodically, it is recommended to use the callback CALLBACK_ANALOG_VALUE and set the period with setAnalogValueCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Sets the length of a moving averaging for the moisture value.
Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.
The range for the averaging is 1-50.
The default value is 50.
Callback: |
|
---|
Returns the length of the moving average as set by setMovingAverage().
Return type: | [int, int, int] |
---|
Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
Parameters: |
|
---|---|
Return type: | boolean |
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
See setResponseExpected() for the list of function ID constants available for this function.
Parameters: |
|
---|
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled and callbacks it is always disabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
The following function ID constants are available for this function:
Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Callback: |
|
---|
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.
The position can be 'a', 'b', 'c' or 'd'.
The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.
Parameters: |
|
---|
Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.
Parameters: |
|
---|---|
Callback: | undefined |
Sets the period in ms with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.
CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.
The default value is 0.
Callback: |
|
---|
Returns the period as set by setCurrentCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.
CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.
The default value is 0.
Callback: |
|
---|
Returns the period as set by setAnalogValueCallbackPeriod().
Parameters: |
|
---|---|
Callback: | undefined |
Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the current is outside the min and max values |
'i' | Callback is triggered when the current is inside the min and max values |
'<' | Callback is triggered when the current is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the current is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Callback: |
|
---|
Returns the threshold as set by setCurrentCallbackThreshold().
The following constants are available for this function:
Parameters: |
|
---|---|
Callback: | undefined |
Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the analog value is outside the min and max values |
'i' | Callback is triggered when the analog value is inside the min and max values |
'<' | Callback is triggered when the analog value is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the analog value is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Callback: |
|
---|
Returns the threshold as set by setAnalogValueCallbackThreshold().
The following constants are available for this function:
Parameters: |
|
---|---|
Callback: | undefined |
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Callback: |
|
---|
Returns the debounce period as set by setDebouncePeriod().
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:
acCurrent.on(BrickletACCurrent.CALLBACK_EXAMPLE,
function (param) {
console.log(param);
}
);
The available constants with inherent number and type of parameters are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by setCurrentCallbackPeriod(). The parameter is the current of the sensor.
CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.
CALLBACK_ANALOG_VALUE is only triggered if the current has changed since the last triggering.
Parameters: |
|
---|
This callback is triggered when the threshold as set by setCurrentCallbackThreshold() is reached. The parameter is the current of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().
Parameters: |
|
---|
This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().
This constant is used to identify a AC Current Bricklet.
The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.