Ruby - Analog Out Bricklet

Dies ist die Beschreibung der Ruby API Bindings für das Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog Out 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_out'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
ao = BrickletAnalogOut.new UID, ipcon # Create device object

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

# Set output voltage to 3.3V
ao.set_voltage 3300

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

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletAnalogOut::new(uid, ipcon) → analog_out
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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 (siehe Beispiele oben).

BrickletAnalogOut#set_voltage(voltage) → nil
Parameter:voltage -- int

Setzt die Spannung in mV. Der mögliche Bereich ist 0V bis 5V (0-5000). Dieser Funktionsaufruf setzt den Modus auf 0 (siehe #set_mode).

Der Standardwert ist 0 (im Modus 1).

BrickletAnalogOut#get_voltage → int

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

BrickletAnalogOut#set_mode(mode) → nil
Parameter:mode -- int

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

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

Der Standardmodus ist 1.

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

  • 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

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

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

  • 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_api_version → [int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) 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 -- int

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.

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletAnalogOut#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut::FUNCTION_SET_MODE = 3
BrickletAnalogOut#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletAnalogOut#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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 kann 'a', 'b', 'c' oder 'd' sein.

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

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

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.