Ruby - Industrial Analog Out Bricklet 2.0

Dies ist die Beschreibung der Ruby API Bindings für das Industrial Analog Out Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Analog Out Bricklet 2.0 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 Current

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_analog_out_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
iao = BrickletIndustrialAnalogOutV2.new UID, ipcon # Create device object

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

# Set output current to 4.5mA
iao.set_current 4500
iao.set_enabled true

puts 'Press key to exit'
$stdin.gets

iao.set_enabled false

ipcon.disconnect

Simple Voltage

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_analog_out_v2'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
iao = BrickletIndustrialAnalogOutV2.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
iao.set_voltage 3300
iao.set_enabled true

puts 'Press key to exit'
$stdin.gets

iao.set_enabled false

ipcon.disconnect

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

industrial_analog_out_v2 = BrickletIndustrialAnalogOutV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletIndustrialAnalogOutV2#set_enabled(enabled) → nil
Parameter:
  • enabled – Typ: bool, Standardwert: false

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

BrickletIndustrialAnalogOutV2#get_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

BrickletIndustrialAnalogOutV2#set_voltage(voltage) → nil
Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

BrickletIndustrialAnalogOutV2#get_voltage → int
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 10000]

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

BrickletIndustrialAnalogOutV2#set_current(current) → nil
Parameter:
  • current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

BrickletIndustrialAnalogOutV2#get_current → int
Rückgabe:
  • current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

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

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

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels #set_out_led_status_config eingestellt werden.

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

Für config:

  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
BrickletIndustrialAnalogOutV2#get_out_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Out-LED-Konfiguration zurück, wie von #set_out_led_config gesetzt.

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

Für config:

  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_OFF = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_ON = 1
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialAnalogOutV2::OUT_LED_CONFIG_SHOW_OUT_STATUS = 3
BrickletIndustrialAnalogOutV2#set_out_led_status_config(min, max, config) → nil
Parameter:
  • min – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 0
  • max – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 10000
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe #set_out_led_config.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_INTENSITY = 1
BrickletIndustrialAnalogOutV2#get_out_led_status_config → [int, int, int]
Rückgabe-Array:
  • 0: min – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 0
  • 1: max – Typ: int, Wertebereich: [0 bis 24000], Standardwert: 10000
  • 2: config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Out-LED-Status-Konfiguration zurück, wie von #set_out_led_status_config gesetzt.

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

Für config:

  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_THRESHOLD = 0
  • BrickletIndustrialAnalogOutV2::OUT_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen

BrickletIndustrialAnalogOutV2#set_configuration(voltage_range, current_range) → nil
Parameter:
  • voltage_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • current_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOutV2#get_configuration → [int, int]
Rückgabe-Array:
  • 0: voltage_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
  • 1: current_range – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für voltage_range:

  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOutV2::VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOutV2::CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOutV2#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.

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

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

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

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

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

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

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

  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_ENABLED = 1
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_VOLTAGE = 3
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CURRENT = 5
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CONFIGURATION = 7
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_CONFIG = 9
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialAnalogOutV2::FUNCTION_RESET = 243
  • BrickletIndustrialAnalogOutV2::FUNCTION_WRITE_UID = 248
BrickletIndustrialAnalogOutV2#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:

  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_ENABLED = 1
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_VOLTAGE = 3
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CURRENT = 5
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_CONFIGURATION = 7
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_CONFIG = 9
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialAnalogOutV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialAnalogOutV2::FUNCTION_RESET = 243
  • BrickletIndustrialAnalogOutV2::FUNCTION_WRITE_UID = 248
BrickletIndustrialAnalogOutV2#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.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

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

Für status:

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

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

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

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

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

Konstanten

BrickletIndustrialAnalogOutV2::DEVICE_IDENTIFIER

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

BrickletIndustrialAnalogOutV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet 2.0 dar.