Ruby - CO2 Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das CO2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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_co2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
co2 = BrickletCO2.new UID, ipcon # Create device object

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

# Get current CO2 concentration
co2_concentration = co2.get_co2_concentration
puts "CO2 Concentration: #{co2_concentration} ppm"

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_co2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
co2 = BrickletCO2.new UID, ipcon # Create device object

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

# Register CO2 concentration callback
co2.register_callback(BrickletCO2::CALLBACK_CO2_CONCENTRATION) do |co2_concentration|
  puts "CO2 Concentration: #{co2_concentration} ppm"
end

# Set period for CO2 concentration callback to 1s (1000ms)
# Note: The CO2 concentration callback is only called every second
#       if the CO2 concentration has changed since the last call!
co2.set_co2_concentration_callback_period 1000

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

Threshold

Download (example_threshold.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
32
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_co2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
co2 = BrickletCO2.new UID, ipcon # Create device object

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
co2.set_debounce_period 10000

# Register CO2 concentration reached callback
co2.register_callback(BrickletCO2::CALLBACK_CO2_CONCENTRATION_REACHED) do |co2_concentration|
  puts "CO2 Concentration: #{co2_concentration} ppm"
end

# Configure threshold for CO2 concentration "greater than 750 ppm"
co2.set_co2_concentration_callback_threshold '>', 750, 0

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletCO2::new(uid, ipcon) → co2
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • co2 – Typ: BrickletCO2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

co2 = BrickletCO2.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletCO2#get_co2_concentration → int
Rückgabe:
  • co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Gibt die gemessene CO2-Konzentration zurück.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den ::CALLBACK_CO2_CONCENTRATION Callback zu nutzen und die Periode mit #set_co2_concentration_callback_period vorzugeben.

Fortgeschrittene Funktionen

BrickletCO2#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr, Wertebereich: ['a' bis 'h', 'z']
  • 3: hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletCO2#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:
  • callback_id – Typ: int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletCO2#set_co2_concentration_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_CO2_CONCENTRATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

BrickletCO2#get_co2_concentration_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_co2_concentration_callback_period gesetzt.

BrickletCO2#set_co2_concentration_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ::CALLBACK_CO2_CONCENTRATION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die CO2-Konzentration außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die CO2-Konzentration innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die CO2-Konzentration kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die CO2-Konzentration größer als der min Wert ist (max wird ignoriert)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletCO2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2::THRESHOLD_OPTION_GREATER = '>'
BrickletCO2#get_co2_concentration_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 2: max – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_co2_concentration_callback_threshold gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletCO2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2::THRESHOLD_OPTION_GREATER = '>'
BrickletCO2#set_debounce_period(debounce) → nil
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletCO2#get_debounce_period → int
Rückgabe:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

co2.register_callback BrickletCO2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletCO2::CALLBACK_CO2_CONCENTRATION
Callback-Parameter:
  • co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_co2_concentration_callback_period, ausgelöst. Der Parameter ist die gemessene CO2-Konzentration des Sensors.

Der ::CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

BrickletCO2::CALLBACK_CO2_CONCENTRATION_REACHED
Callback-Parameter:
  • co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_co2_concentration_callback_threshold gesetzt, erreicht wird. Der Parameter ist die gemessene CO2-Konzentration.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletCO2#get_api_version → [int, ...]
Rückgabe-Array:
  • 0: api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletCO2#get_response_expected(function_id) → bool
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickletCO2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • BrickletCO2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • BrickletCO2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletCO2#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickletCO2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • BrickletCO2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • BrickletCO2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletCO2#set_response_expected_all(response_expected) → nil
Parameter:
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickletCO2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 Bricklet zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletCO2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.