Ruby - Analog Out Bricklet¶

Simple¶

Download (example_simple.rb)

 1#!/usr/bin/env ruby
 2# -*- ruby encoding: utf-8 -*-
 3
 4require 'tinkerforge/ip_connection'
 5require 'tinkerforge/bricklet_analog_out'
 6
 7include Tinkerforge
 8
 9HOST = 'localhost'
10PORT = 4223
11UID = 'XYZ' # Change XYZ to the UID of your Analog Out Bricklet
12
13ipcon = IPConnection.new # Create IP connection
14ao = BrickletAnalogOut.new UID, ipcon # Create device object
15
16ipcon.connect HOST, PORT # Connect to brickd
17# Don't use device before ipcon is connected
18
19# Set output voltage to 3.3V
20ao.set_voltage 3300
21
22puts 'Press key to exit'
23$stdin.gets
24ipcon.disconnect

Grundfunktionen¶

BrickletAnalogOut::new(uid, ipcon) → analog_out¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	analog_out – Typ: BrickletAnalogOut

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

analog_out = BrickletAnalogOut.new 'YOUR_DEVICE_UID', ipcon

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

BrickletAnalogOut#set_voltage(voltage) → nil¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 5000], Standardwert: 0

Setzt die Spannung. Dieser Funktionsaufruf setzt den Modus auf 0 (siehe #set_mode).

BrickletAnalogOut#get_voltage → int¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 5000], Standardwert: 0

Gibt die Spannung zurück, wie von #set_voltage gesetzt.

BrickletAnalogOut#set_mode(mode) → nil¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Modus des Analogwertes. Mögliche Modi:

• 0: normaler Modus (Analogwert, wie von #set_voltage gesetzt, wird ausgegeben.)

• 1: 1k Ohm Widerstand gegen Masse

• 2: 100k Ohm Widerstand gegen Masse

• 3: 500k Ohm Widerstand gegen Masse

Setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0 V. Es kann über einen Aufruf von #set_voltage direkt auf eine höhere Ausgabespannung gewechselt werden .

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

Für mode:

• BrickletAnalogOut::MODE_ANALOG_VALUE = 0

• BrickletAnalogOut::MODE_1K_TO_GROUND = 1

• BrickletAnalogOut::MODE_100K_TO_GROUND = 2

• BrickletAnalogOut::MODE_500K_TO_GROUND = 3

BrickletAnalogOut#get_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den Modus zurück, wie von #set_mode gesetzt.

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

Für mode:

• BrickletAnalogOut::MODE_ANALOG_VALUE = 0

• BrickletAnalogOut::MODE_1K_TO_GROUND = 1

• BrickletAnalogOut::MODE_100K_TO_GROUND = 2

• BrickletAnalogOut::MODE_500K_TO_GROUND = 3

Fortgeschrittene Funktionen¶

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

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.

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

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

• BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1

• BrickletAnalogOut::FUNCTION_SET_MODE = 3

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

• BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1

• BrickletAnalogOut::FUNCTION_SET_MODE = 3

BrickletAnalogOut#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¶

BrickletAnalogOut::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Analog Out 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.

BrickletAnalogOut::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet dar.