Ruby - Air Quality Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality 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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_air_quality'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
aq = BrickletAirQuality.new UID, ipcon # Create device object

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

# Get current all values as [iaq_index, iaq_index_accuracy, temperature, humidity,
#                            air_pressure]
all_values = aq.get_all_values

puts "IAQ Index: #{all_values[0]}"

if all_values[1] == BrickletAirQuality::ACCURACY_UNRELIABLE
  puts "IAQ Index Accuracy: Unreliable"
elsif all_values[1] == BrickletAirQuality::ACCURACY_LOW
  puts "IAQ Index Accuracy: Low"
elsif all_values[1] == BrickletAirQuality::ACCURACY_MEDIUM
  puts "IAQ Index Accuracy: Medium"
elsif all_values[1] == BrickletAirQuality::ACCURACY_HIGH
  puts "IAQ Index Accuracy: High"
end

puts "Temperature: #{all_values[2]/100.0} °C"
puts "Humidity: #{all_values[3]/100.0} %RH"
puts "Air Pressure: #{all_values[4]/100.0} hPa"

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_air_quality'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
aq = BrickletAirQuality.new UID, ipcon # Create device object

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

# Register all values callback
aq.register_callback(BrickletAirQuality::CALLBACK_ALL_VALUES) do |iaq_index,
                                                                  iaq_index_accuracy,
                                                                  temperature, humidity,
                                                                  air_pressure|
  puts "IAQ Index: #{iaq_index}"

  if iaq_index_accuracy == BrickletAirQuality::ACCURACY_UNRELIABLE
    puts "IAQ Index Accuracy: Unreliable"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_LOW
    puts "IAQ Index Accuracy: Low"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_MEDIUM
    puts "IAQ Index Accuracy: Medium"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_HIGH
    puts "IAQ Index Accuracy: High"
  end

  puts "Temperature: #{temperature/100.0} °C"
  puts "Humidity: #{humidity/100.0} %RH"
  puts "Air Pressure: #{air_pressure/100.0} hPa"
  puts ''
end

# Set period for all values callback to 1s (1000ms)
aq.set_all_values_callback_configuration 1000, false

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

air_quality = BrickletAirQuality.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletAirQuality#get_all_values → [int, int, int, int, int]
Rückgabe-Array:
  • 0: iaq_index – Typ: int, Wertebereich: [0 bis 500]
  • 1: iaq_index_accuracy – Typ: int, Wertebereich: Siehe Konstanten
  • 2: temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]
  • 3: humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]
  • 4: air_pressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index (ein höherer Werte bedeutet eine stärkere Luftverschmutzung), IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

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

Für iaq_index_accuracy:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality#set_temperature_offset(offset) → nil
Parameter:
  • offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Setzt ein Temperatur-Offset. Ein Offset von 10 verringert die gemessene Temperatur um 0,1 °C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

BrickletAirQuality#get_temperature_offset → int
Rückgabe:
  • offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Gibt das Temperatur-Offset zurück, wie mittels #set_temperature_offset gesetzt.

BrickletAirQuality#get_iaq_index → [int, int]
Rückgabe-Array:
  • 0: iaq_index – Typ: int, Wertebereich: [0 bis 500]
  • 1: iaq_index_accuracy – Typ: int, Wertebereich: Siehe Konstanten

Gibt den IAQ Index und dessen Genaugkeit zurück. Ein höherer Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_IAQ_INDEX Callback verwendet werden. Der Callback wird mit der Funktion #set_iaq_index_callback_configuration konfiguriert.

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

Für iaq_index_accuracy:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality#get_temperature → int
Rückgabe:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Gibt die Temperatur zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion #set_temperature_callback_configuration konfiguriert.

BrickletAirQuality#get_humidity → int
Rückgabe:
  • humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]

Gibt die relative Luftfeuchtigkeit zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_HUMIDITY Callback verwendet werden. Der Callback wird mit der Funktion #set_humidity_callback_configuration konfiguriert.

BrickletAirQuality#get_air_pressure → int
Rückgabe:
  • air_pressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Gibt den Luftdruck Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der ::CALLBACK_AIR_PRESSURE Callback verwendet werden. Der Callback wird mit der Funktion #set_air_pressure_callback_configuration konfiguriert.

Fortgeschrittene Funktionen

BrickletAirQuality#remove_calibration → nil

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

BrickletAirQuality#set_background_calibration_duration(duration) → nil
Parameter:
  • duration – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

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

Für duration:

  • BrickletAirQuality::DURATION_4_DAYS = 0
  • BrickletAirQuality::DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

BrickletAirQuality#get_background_calibration_duration → int
Rückgabe:
  • duration – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Länge der Hintergrundkalibrierung zurück, wie von #set_background_calibration_duration gesetzt.

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

Für duration:

  • BrickletAirQuality::DURATION_4_DAYS = 0
  • BrickletAirQuality::DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

BrickletAirQuality#get_spitfp_error_count → [int, int, int, int]
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletAirQuality#set_bootloader_mode(mode) → int
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletAirQuality::BOOTLOADER_STATUS_OK = 0
  • BrickletAirQuality::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAirQuality::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAirQuality::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAirQuality::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAirQuality::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletAirQuality#get_bootloader_mode → int
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletAirQuality#set_write_firmware_pointer(pointer) → nil
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAirQuality#write_firmware(data) → int
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletAirQuality#set_status_led_config(config) → nil
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • BrickletAirQuality::STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality::STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAirQuality#get_status_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

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

Für config:

  • BrickletAirQuality::STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality::STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAirQuality#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletAirQuality#reset → nil

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletAirQuality#write_uid(uid) → nil
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletAirQuality#read_uid → int
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletAirQuality#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 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

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

BrickletAirQuality#set_all_values_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_ALL_VALUES Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

BrickletAirQuality#get_all_values_callback_configuration → [int, bool]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_all_values_callback_configuration gesetzt.

BrickletAirQuality#set_iaq_index_callback_configuration(period, value_has_to_change) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_IAQ_INDEX Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

BrickletAirQuality#get_iaq_index_callback_configuration → [int, bool]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_iaq_index_callback_configuration gesetzt.

BrickletAirQuality#set_temperature_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • BrickletAirQuality::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality::THRESHOLD_OPTION_GREATER = '>'
BrickletAirQuality#get_temperature_callback_configuration → [int, bool, chr, int, int]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false
  • 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 4: max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_temperature_callback_configuration gesetzt.

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

Für option:

  • BrickletAirQuality::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality::THRESHOLD_OPTION_GREATER = '>'
BrickletAirQuality#set_humidity_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_HUMIDITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_HUMIDITY Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • BrickletAirQuality::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality::THRESHOLD_OPTION_GREATER = '>'
BrickletAirQuality#get_humidity_callback_configuration → [int, bool, chr, int, int]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false
  • 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: min – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 4: max – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_humidity_callback_configuration gesetzt.

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

Für option:

  • BrickletAirQuality::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality::THRESHOLD_OPTION_GREATER = '>'
BrickletAirQuality#set_air_pressure_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der ::CALLBACK_AIR_PRESSURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den ::CALLBACK_AIR_PRESSURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • BrickletAirQuality::THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality::THRESHOLD_OPTION_GREATER = '>'
BrickletAirQuality#get_air_pressure_callback_configuration → [int, bool, chr, int, int]
Rückgabe-Array:
  • 0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 1: value_has_to_change – Typ: bool, Standardwert: false
  • 2: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 3: min – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • 4: max – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels #set_air_pressure_callback_configuration gesetzt.

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

Für option:

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

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:

air_quality.register_callback BrickletAirQuality::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.

BrickletAirQuality::CALLBACK_ALL_VALUES
Callback-Parameter:
  • iaq_index – Typ: int, Wertebereich: [0 bis 500]
  • iaq_index_accuracy – Typ: int, Wertebereich: Siehe Konstanten
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]
  • humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]
  • air_pressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_all_values_callback_configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie #get_all_values.

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

Für iaq_index_accuracy:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality::CALLBACK_IAQ_INDEX
Callback-Parameter:
  • iaq_index – Typ: int, Wertebereich: [0 bis 500]
  • iaq_index_accuracy – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_iaq_index_callback_configuration gesetzten Konfiguration

Die Parameter sind die gleichen wie #get_iaq_index.

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

Für iaq_index_accuracy:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality::CALLBACK_TEMPERATURE
Callback-Parameter:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_temperature_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_temperature.

BrickletAirQuality::CALLBACK_HUMIDITY
Callback-Parameter:
  • humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_humidity_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_humidity.

BrickletAirQuality::CALLBACK_AIR_PRESSURE
Callback-Parameter:
  • air_pressure – Typ: int, Einheit: 1/100 hPa, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels #set_air_pressure_callback_configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie #get_air_pressure.

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.

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

BrickletAirQuality#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:

  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • BrickletAirQuality::FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • BrickletAirQuality::FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • BrickletAirQuality::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • BrickletAirQuality::FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • BrickletAirQuality::FUNCTION_REMOVE_CALIBRATION = 23
  • BrickletAirQuality::FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • BrickletAirQuality::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAirQuality::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAirQuality::FUNCTION_RESET = 243
  • BrickletAirQuality::FUNCTION_WRITE_UID = 248
BrickletAirQuality#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:

  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • BrickletAirQuality::FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • BrickletAirQuality::FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • BrickletAirQuality::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • BrickletAirQuality::FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • BrickletAirQuality::FUNCTION_REMOVE_CALIBRATION = 23
  • BrickletAirQuality::FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • BrickletAirQuality::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAirQuality::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAirQuality::FUNCTION_RESET = 243
  • BrickletAirQuality::FUNCTION_WRITE_UID = 248
BrickletAirQuality#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

BrickletAirQuality::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Air Quality 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.

BrickletAirQuality::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.