PHP - AC Current Bricklet

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 PHP 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 PHP API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletACCurrent(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $ac_current = new BrickletACCurrent('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

int BrickletACCurrent::getCurrent()

TODO

If you want to get the current periodically, it is recommended to use the callback CALLBACK_CURRENT and set the period with setCurrentCallbackPeriod().

void BrickletACCurrent::setConfiguration(int $current_range)
int BrickletACCurrent::getConfiguration()

Advanced Functions

int BrickletACCurrent::getAnalogValue()

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().

void BrickletACCurrent::setMovingAverage(int $average)

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.

int BrickletACCurrent::getMovingAverage()

Returns the length of the moving average as set by setMovingAverage().

array BrickletACCurrent::getAPIVersion()

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.

bool BrickletACCurrent::getResponseExpected(int $function_id)

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.

void BrickletACCurrent::setResponseExpected(int $function_id, bool $response_expected)

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:

  • BrickletACCurrent::FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 3
  • BrickletACCurrent::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletACCurrent::FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 7
  • BrickletACCurrent::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletACCurrent::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletACCurrent::FUNCTION_SET_MOVING_AVERAGE = 13
  • BrickletACCurrent::FUNCTION_SET_CONFIGURATION = 15
void BrickletACCurrent::setResponseExpectedAll(bool $response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

array BrickletACCurrent::getIdentity()

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.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletACCurrent::registerCallback(int $id, callable $callback, mixed $userData=NULL)

Registers a callback with ID $id to the callable $callback. The $userData will be given as a parameter of the callback.

The available IDs with corresponding function signatures are listed below.

void BrickletACCurrent::setCurrentCallbackPeriod(int $period)

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.

int BrickletACCurrent::getCurrentCallbackPeriod()

Returns the period as set by setCurrentCallbackPeriod().

void BrickletACCurrent::setAnalogValueCallbackPeriod(int $period)

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.

int BrickletACCurrent::getAnalogValueCallbackPeriod()

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletACCurrent::setCurrentCallbackThreshold(string $option, int $min, int $max)

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:

  • BrickletACCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletACCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletACCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletACCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletACCurrent::THRESHOLD_OPTION_GREATER = '>'
array BrickletACCurrent::getCurrentCallbackThreshold()

Returns the threshold as set by setCurrentCallbackThreshold().

The following constants are available for this function:

  • BrickletACCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletACCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletACCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletACCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletACCurrent::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletACCurrent::setAnalogValueCallbackThreshold(string $option, int $min, int $max)

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:

  • BrickletACCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletACCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletACCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletACCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletACCurrent::THRESHOLD_OPTION_GREATER = '>'
array BrickletACCurrent::getAnalogValueCallbackThreshold()

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

  • BrickletACCurrent::THRESHOLD_OPTION_OFF = 'x'
  • BrickletACCurrent::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletACCurrent::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletACCurrent::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletACCurrent::THRESHOLD_OPTION_GREATER = '>'

The returned array has the keys option, min and max.

void BrickletACCurrent::setDebouncePeriod(int $debounce)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

int BrickletACCurrent::getDebouncePeriod()

Returns the debounce period as set by setDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$ac_current->registerCallback(BrickletACCurrent::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletACCurrent::CALLBACK_CURRENT
<?php   void callback(int $current [, mixed $userData])   ?>

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.

int BrickletACCurrent::CALLBACK_ANALOG_VALUE
<?php   void callback(int $value [, mixed $userData])   ?>

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.

int BrickletACCurrent::CALLBACK_CURRENT_REACHED
<?php   void callback(int $current [, mixed $userData])   ?>

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().

int BrickletACCurrent::CALLBACK_ANALOG_VALUE_REACHED
<?php   void callback(int $value [, mixed $userData])   ?>

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().

Constants

int BrickletACCurrent::DEVICE_IDENTIFIER

This constant is used to identify a AC Current Bricklet.

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Creative Commons Licence The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.