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

Examples

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

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call ac-current-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the AC Current Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the AC Current Bricklet and exits
tinkerforge dispatch ac-current-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the AC Current Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the AC Current Bricklet and exits
tinkerforge call ac-current-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch ac-current-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call ac-current-bricklet <uid> get-current
Output:
  • current -- int

TODO

If you want to get the current periodically, it is recommended to use the callback current and set the period with set-current-callback-period.

tinkerforge call ac-current-bricklet <uid> set-configuration <current-range>
Parameters:
  • <current-range> -- int
Output:

no output

tinkerforge call ac-current-bricklet <uid> get-configuration
Output:
  • current-range -- int

Advanced Functions

tinkerforge call ac-current-bricklet <uid> get-analog-value
Output:
  • value -- int

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 analog-value and set the period with set-analog-value-callback-period.

tinkerforge call ac-current-bricklet <uid> set-moving-average <average>
Parameters:
  • <average> -- int
Output:

no output

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.

tinkerforge call ac-current-bricklet <uid> get-moving-average
Output:
  • average -- int

Returns the length of the moving average as set by set-moving-average.

tinkerforge call ac-current-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

Callback Configuration Functions

tinkerforge call ac-current-bricklet <uid> set-current-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

Sets the period in ms with which the current callback is triggered periodically. A value of 0 turns the callback off.

current is only triggered if the current has changed since the last triggering.

The default value is 0.

tinkerforge call ac-current-bricklet <uid> get-current-callback-period
Output:
  • period -- int

Returns the period as set by set-current-callback-period.

tinkerforge call ac-current-bricklet <uid> set-analog-value-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

Sets the period in ms with which the analog-value callback is triggered periodically. A value of 0 turns the callback off.

analog-value is only triggered if the analog value has changed since the last triggering.

The default value is 0.

tinkerforge call ac-current-bricklet <uid> get-analog-value-callback-period
Output:
  • period -- int

Returns the period as set by set-analog-value-callback-period.

tinkerforge call ac-current-bricklet <uid> set-current-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

Sets the thresholds for the 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 symbols are available for this function:

  • off = x, for <option>
  • outside = o, for <option>
  • inside = i, for <option>
  • smaller = <, for <option>
  • greater = >, for <option>
tinkerforge call ac-current-bricklet <uid> get-current-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-current-callback-threshold.

The following symbols are available for this function:

  • off = x, for option
  • outside = o, for option
  • inside = i, for option
  • smaller = <, for option
  • greater = >, for option
tinkerforge call ac-current-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

Sets the thresholds for the 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 symbols are available for this function:

  • off = x, for <option>
  • outside = o, for <option>
  • inside = i, for <option>
  • smaller = <, for <option>
  • greater = >, for <option>
tinkerforge call ac-current-bricklet <uid> get-analog-value-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-analog-value-callback-threshold.

The following symbols are available for this function:

  • off = x, for option
  • outside = o, for option
  • inside = i, for option
  • smaller = <, for option
  • greater = >, for option
tinkerforge call ac-current-bricklet <uid> set-debounce-period <debounce>
Parameters:
  • <debounce> -- int
Output:

no output

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

tinkerforge call ac-current-bricklet <uid> get-debounce-period
Output:
  • debounce -- int

Returns the debounce period as set by set-debounce-period.

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch ac-current-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch ac-current-bricklet <uid> current
Output:
  • current -- int

This callback is triggered periodically with the period that is set by set-current-callback-period. The parameter is the current of the sensor.

current is only triggered if the current has changed since the last triggering.

tinkerforge dispatch ac-current-bricklet <uid> analog-value
Output:
  • value -- int

This callback is triggered periodically with the period that is set by set-analog-value-callback-period. The parameter is the analog value of the sensor.

analog-value is only triggered if the current has changed since the last triggering.

tinkerforge dispatch ac-current-bricklet <uid> current-reached
Output:
  • current -- int

This callback is triggered when the threshold as set by set-current-callback-threshold 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 set-debounce-period.

tinkerforge dispatch ac-current-bricklet <uid> analog-value-reached
Output:
  • value -- int

This callback is triggered when the threshold as set by set-analog-value-callback-threshold 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 set-debounce-period.

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