Ruby - One Wire Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das One Wire Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des One Wire 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).

Read Ds18b20 Temperature

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_one_wire'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ow = BrickletOneWire.new UID, ipcon # Create device object

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

ow.write_command 0, 78 # WRITE SCRATCHPAD
ow.write 0 # ALARM H (unused)
ow.write 0 # ALARM L (unused)
ow.write 127 # CONFIGURATION: 12-bit mode

# Read temperature 10 times
for _ in 0..9
  ow.write_command 0, 68 # CONVERT T (start temperature conversion)
  sleep 1 # Wait for conversion to finish
  ow.write_command 0, 190 # READ SCRATCHPAD

  t_low = ow.read
  t_high = ow.read

  temperature = t_low[0] | (t_high[0] << 8)

  # Negative 12-bit values are sign-extended to 16-bit two's complement
  if (temperature > 1 << 12)
    temperature -= 1 << 16
  end

  # 12-bit mode measures in units of 1/16°C
  puts "Temperature: #{temperature/16.0} °C"
end

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

one_wire = BrickletOneWire.new 'YOUR_DEVICE_UID', ipcon

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

BrickletOneWire#search_bus → [[int, ...], int]
Rückgabe-Array:
  • 0: identifier – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 264 - 1]
  • 1: status – Typ: int, Wertebereich: Siehe Konstanten

Gibt eine Liste mit bis zu 64 Identifiern von angeschlossenen 1-Wire Geräten zurück. Jeder Identifier ist 64-Bit und besteht aus 8-Bit Familien-Code, 48-Bit ID und 8-Bit CRC.

Um diese Liste zu erhalten führt das Bricklet den SEARCH ROM Algorithmus von Maxim aus.

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

Für status:

  • BrickletOneWire::STATUS_OK = 0
  • BrickletOneWire::STATUS_BUSY = 1
  • BrickletOneWire::STATUS_NO_PRESENCE = 2
  • BrickletOneWire::STATUS_TIMEOUT = 3
  • BrickletOneWire::STATUS_ERROR = 4
BrickletOneWire#reset_bus → int
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bus mit einer 1-Wire Reset Operation zurück.

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

Für status:

  • BrickletOneWire::STATUS_OK = 0
  • BrickletOneWire::STATUS_BUSY = 1
  • BrickletOneWire::STATUS_NO_PRESENCE = 2
  • BrickletOneWire::STATUS_TIMEOUT = 3
  • BrickletOneWire::STATUS_ERROR = 4
BrickletOneWire#write(data) → int
Parameter:
  • data – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Schreibt ein Byte an Daten auf den 1-Wire Bus.

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

Für status:

  • BrickletOneWire::STATUS_OK = 0
  • BrickletOneWire::STATUS_BUSY = 1
  • BrickletOneWire::STATUS_NO_PRESENCE = 2
  • BrickletOneWire::STATUS_TIMEOUT = 3
  • BrickletOneWire::STATUS_ERROR = 4
BrickletOneWire#read → [int, int]
Rückgabe-Array:
  • 0: data – Typ: int, Wertebereich: [0 bis 255]
  • 1: status – Typ: int, Wertebereich: Siehe Konstanten

Liest ein Byte an Daten vom 1-Wire Bus.

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

Für status:

  • BrickletOneWire::STATUS_OK = 0
  • BrickletOneWire::STATUS_BUSY = 1
  • BrickletOneWire::STATUS_NO_PRESENCE = 2
  • BrickletOneWire::STATUS_TIMEOUT = 3
  • BrickletOneWire::STATUS_ERROR = 4
BrickletOneWire#write_command(identifier, command) → int
Parameter:
  • identifier – Typ: int, Wertebereich: [0 bis 264 - 1]
  • command – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Sendet einen Befehl an das 1-Wire Gerät mit der angegebenen Identifier. Die Liste der Identifier können mittels #search_bus ermittelt werden. Die MATCH ROM Operation wird verwendet, um den Befehl zu übertragen.

Wenn nur ein Gerät angeschlossen ist, oder der Befehl an alle Geräte gesendet werden soll kann als Identifier 0 verwendet werden. Dann wird die SKIP ROM Operation verwendet, um den Befehl zu übertragen.

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

Für status:

  • BrickletOneWire::STATUS_OK = 0
  • BrickletOneWire::STATUS_BUSY = 1
  • BrickletOneWire::STATUS_NO_PRESENCE = 2
  • BrickletOneWire::STATUS_TIMEOUT = 3
  • BrickletOneWire::STATUS_ERROR = 4

Fortgeschrittene Funktionen

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die 1-Wire Kommunikation durch Aufblinken an.

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

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

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

Für config:

  • BrickletOneWire::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
BrickletOneWire#get_communication_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BrickletOneWire::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOneWire::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
BrickletOneWire#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.

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

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

Für status:

  • BrickletOneWire::BOOTLOADER_STATUS_OK = 0
  • BrickletOneWire::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletOneWire::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletOneWire::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletOneWire::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletOneWire::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletOneWire#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:

  • BrickletOneWire::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletOneWire::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletOneWire::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletOneWire::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletOneWire::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletOneWire#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.

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

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

  • BrickletOneWire::STATUS_LED_CONFIG_OFF = 0
  • BrickletOneWire::STATUS_LED_CONFIG_ON = 1
  • BrickletOneWire::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOneWire::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletOneWire#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:

  • BrickletOneWire::STATUS_LED_CONFIG_OFF = 0
  • BrickletOneWire::STATUS_LED_CONFIG_ON = 1
  • BrickletOneWire::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletOneWire::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletOneWire#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.

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

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

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

BrickletOneWire#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', '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.

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.

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

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

  • BrickletOneWire::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
  • BrickletOneWire::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOneWire::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOneWire::FUNCTION_RESET = 243
  • BrickletOneWire::FUNCTION_WRITE_UID = 248
BrickletOneWire#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:

  • BrickletOneWire::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 6
  • BrickletOneWire::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOneWire::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOneWire::FUNCTION_RESET = 243
  • BrickletOneWire::FUNCTION_WRITE_UID = 248
BrickletOneWire#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

BrickletOneWire::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein One Wire 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.

BrickletOneWire::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines One Wire Bricklet dar.