Ruby - Hall Effect Bricklet

This is the description of the Ruby API bindings for the Hall Effect Bricklet. General information and technical specifications for the Hall Effect Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

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

Simple

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_hall_effect'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Hall Effect Bricklet

ipcon = IPConnection.new # Create IP connection
he = BrickletHallEffect.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current edge count without reset
count = he.get_edge_count false
puts "Count: #{count}"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback

Download (example_callback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_hall_effect'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Hall Effect Bricklet

ipcon = IPConnection.new # Create IP connection
he = BrickletHallEffect.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register edge count callback
he.register_callback(BrickletHallEffect::CALLBACK_EDGE_COUNT) do |count, value|
  puts "Count: #{count}"
end

# Set period for edge count callback to 0.05s (50ms)
# Note: The edge count callback is only called every 0.05 seconds
#       if the edge count has changed since the last call!
he.set_edge_count_callback_period 50

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All functions listed below are thread-safe.

Basic Functions

BrickletHallEffect::new(uid, ipcon) → hall_effect
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • hall_effect – Type: BrickletHallEffect

Creates an object with the unique device ID uid:

hall_effect = BrickletHallEffect.new 'YOUR_DEVICE_UID', ipcon

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

BrickletHallEffect#get_value → bool
Returns:
  • value – Type: bool

Returns true if a magnetic field of 3.5 millitesla or greater is detected.

BrickletHallEffect#get_edge_count(reset_counter) → int
Parameters:
  • reset_counter – Type: bool
Returns:
  • count – Type: int, Range: [0 to 232 - 1]

Returns the current value of the edge counter. You can configure edge type (rising, falling, both) that is counted with #set_edge_count_config.

If you set the reset counter to true, the count is set back to 0 directly after it is read.

Advanced Functions

BrickletHallEffect#set_edge_count_config(edge_type, debounce) → nil
Parameters:
  • edge_type – Type: int, Range: See constants, Default: 0
  • debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising
  • 1 = falling
  • 2 = both

A magnetic field of 3.5 millitesla or greater causes a falling edge and a magnetic field of 2.5 millitesla or smaller causes a rising edge.

If a magnet comes near the Bricklet the signal goes low (falling edge), if a magnet is removed from the vicinity the signal goes high (rising edge).

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following constants are available for this function:

For edge_type:

  • BrickletHallEffect::EDGE_TYPE_RISING = 0
  • BrickletHallEffect::EDGE_TYPE_FALLING = 1
  • BrickletHallEffect::EDGE_TYPE_BOTH = 2
BrickletHallEffect#get_edge_count_config → [int, int]
Return Array:
  • 0: edge_type – Type: int, Range: See constants, Default: 0
  • 1: debounce – Type: int, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time as set by #set_edge_count_config.

The following constants are available for this function:

For edge_type:

  • BrickletHallEffect::EDGE_TYPE_RISING = 0
  • BrickletHallEffect::EDGE_TYPE_FALLING = 1
  • BrickletHallEffect::EDGE_TYPE_BOTH = 2
BrickletHallEffect#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Return Array:
  • 0: uid – Type: str, Length: up to 8
  • 1: connected_uid – Type: str, Length: up to 8
  • 2: position – Type: chr, Range: ['a' to 'h', 'i', 'z']
  • 3: hardware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • 4: firmware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletHallEffect#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:
  • callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletHallEffect#set_edge_interrupt(edges) → nil
Parameters:
  • edges – Type: int, Range: [0 to 232 - 1], Default: 0

Sets the number of edges until an interrupt is invoked.

If edges is set to n, an interrupt is invoked for every n-th detected edge.

If edges is set to 0, the interrupt is disabled.

BrickletHallEffect#get_edge_interrupt → int
Returns:
  • edges – Type: int, Range: [0 to 232 - 1], Default: 0

Returns the edges as set by #set_edge_interrupt.

BrickletHallEffect#set_edge_count_callback_period(period) → nil
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the ::CALLBACK_EDGE_COUNT callback is triggered periodically. A value of 0 turns the callback off.

The ::CALLBACK_EDGE_COUNT callback is only triggered if the edge count has changed since the last triggering.

BrickletHallEffect#get_edge_count_callback_period → int
Returns:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by #set_edge_count_callback_period.

Callbacks

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

hall_effect.register_callback BrickletHallEffect::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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.

BrickletHallEffect::CALLBACK_EDGE_COUNT
Callback Parameters:
  • count – Type: int, Range: [0 to 232 - 1]
  • value – Type: bool

This callback is triggered periodically with the period that is set by #set_edge_count_callback_period. The parameters are the current count and the current value (see #get_value and #get_edge_count).

The ::CALLBACK_EDGE_COUNT callback is only triggered if the count or value changed since the last triggering.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletHallEffect#get_api_version → [int, ...]
Return Array:
  • 0: api_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletHallEffect#get_response_expected(function_id) → bool
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

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 #set_response_expected. 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.

The following constants are available for this function:

For function_id:

  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • BrickletHallEffect::FUNCTION_SET_EDGE_INTERRUPT = 5
  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
BrickletHallEffect#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool

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.

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 constants are available for this function:

For function_id:

  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CONFIG = 3
  • BrickletHallEffect::FUNCTION_SET_EDGE_INTERRUPT = 5
  • BrickletHallEffect::FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7
BrickletHallEffect#set_response_expected_all(response_expected) → nil
Parameters:
  • response_expected – Type: bool

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

Constants

BrickletHallEffect::DEVICE_IDENTIFIER

This constant is used to identify a Hall Effect Bricklet.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletHallEffect::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Hall Effect Bricklet.