Rust - Industrial Counter Bricklet

Dies ist die Beschreibung der Rust API Bindings für das Industrial Counter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Counter Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rs)

 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
use std::{error::Error, io};

use tinkerforge::{industrial_counter_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Counter Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ic = IndustrialCounterBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current counter from channel 0.
    let counter = ic.get_counter(INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0).recv()?;
    println!("Counter (Channel 0): {}", counter);

    // Get current signal data from channel 0.
    let signal_data = ic.get_signal_data(INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0).recv()?;

    println!("Duty Cycle (Channel 0): {} %", signal_data.duty_cycle as f32 / 100.0);
    println!("Period (Channel 0): {} ns", signal_data.period);
    println!("Frequency (Channel 0): {} Hz", signal_data.frequency as f32 / 1000.0);
    println!("Value (Channel 0): {}", signal_data.value);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn IndustrialCounterBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialCounterBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • industrial_counter – Typ: IndustrialCounterBricklet

Erzeugt ein neues IndustrialCounterBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let industrial_counter = IndustrialCounterBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn IndustrialCounterBricklet::get_counter(&self, channel: u8) → ConvertingReceiver<i64>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • counter – Typ: i64, Wertebereich: [-263 bis 263 - 1]

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3
pub fn IndustrialCounterBricklet::get_all_counter(&self) → ConvertingReceiver<[i64; 4]>
Rückgabe:
  • counter – Typ: [i64; 4], Wertebereich: [-263 bis 263 - 1]

Gibt die Zählerstände für alle vier Kanäle zurück.

pub fn IndustrialCounterBricklet::set_counter(&self, channel: u8, counter: i64) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • counter – Typ: i64, Wertebereich: [-263 bis 263 - 1]

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3
pub fn IndustrialCounterBricklet::set_all_counter(&self, counter: [i64; 4]) → ConvertingReceiver<()>
Parameter:
  • counter – Typ: [i64; 4], Wertebereich: [-263 bis 263 - 1]

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

pub fn IndustrialCounterBricklet::get_signal_data(&self, channel: u8) → ConvertingReceiver<SignalData>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • duty_cycle – Typ: u16, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: u64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: u32, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3
pub fn IndustrialCounterBricklet::get_all_signal_data(&self) → ConvertingReceiver<AllSignalData>
Rückgabeobjekt:
  • duty_cycle – Typ: [u16; 4], Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [u64; 4], Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [u32; 4], Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [bool; 4]

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

pub fn IndustrialCounterBricklet::set_counter_active(&self, channel: u8, active: bool) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • active – Typ: bool, Standardwert: true

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3
pub fn IndustrialCounterBricklet::set_all_counter_active(&self, active: [bool; 4]) → ConvertingReceiver<()>
Parameter:
  • active – Typ: [bool; 4], Standardwert: [true, true, true, true]

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

pub fn IndustrialCounterBricklet::get_counter_active(&self, channel: u8) → ConvertingReceiver<bool>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • active – Typ: bool, Standardwert: true

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3
pub fn IndustrialCounterBricklet::get_all_counter_active(&self) → ConvertingReceiver<[bool; 4]>
Rückgabe:
  • active – Typ: [bool; 4], Standardwert: [true, true, true, true]

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

pub fn IndustrialCounterBricklet::set_counter_configuration(&self, channel: u8, count_edge: u8, count_direction: u8, duty_cycle_prescaler: u8, frequency_integration_time: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • count_edge – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • count_direction – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • duty_cycle_prescaler – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequency_integration_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

  • Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen.
  • Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

Für count_edge:

  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_RISING = 0
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_FALLING = 1
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_BOTH = 2

Für count_direction:

  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_UP = 0
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_DOWN = 1
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_UP = 2
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für duty_cycle_prescaler:

  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8 = 3
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16 = 4
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32 = 5
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_64 = 6
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_128 = 7
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_256 = 8
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_512 = 9
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1024 = 10
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2048 = 11
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4096 = 12
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8192 = 13
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16384 = 14
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32768 = 15

Für frequency_integration_time:

  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_32768_MS = 8
pub fn IndustrialCounterBricklet::get_counter_configuration(&self, channel: u8) → ConvertingReceiver<CounterConfiguration>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • count_edge – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • count_direction – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • duty_cycle_prescaler – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequency_integration_time – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Zähler-Konfiguration zurück, wie Sie mittels IndustrialCounterBricklet::set_counter_configuration gesetzt wurde.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

Für count_edge:

  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_RISING = 0
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_FALLING = 1
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_EDGE_BOTH = 2

Für count_direction:

  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_UP = 0
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_DOWN = 1
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_UP = 2
  • INDUSTRIAL_COUNTER_BRICKLET_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für duty_cycle_prescaler:

  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8 = 3
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16 = 4
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32 = 5
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_64 = 6
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_128 = 7
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_256 = 8
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_512 = 9
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_1024 = 10
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_2048 = 11
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_4096 = 12
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_8192 = 13
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_16384 = 14
  • INDUSTRIAL_COUNTER_BRICKLET_DUTY_CYCLE_PRESCALER_32768 = 15

Für frequency_integration_time:

  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • INDUSTRIAL_COUNTER_BRICKLET_FREQUENCY_INTEGRATION_TIME_32768_MS = 8
pub fn IndustrialCounterBricklet::set_channel_led_config(&self, channel: u8, config: u8) → ConvertingReceiver<()>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

Für config:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
pub fn IndustrialCounterBricklet::get_channel_led_config(&self, channel: u8) → ConvertingReceiver<u8>
Parameter:
  • channel – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von IndustrialCounterBricklet::set_channel_led_config gesetzt.

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

Für channel:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_0 = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_1 = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_2 = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_3 = 3

Für config:

  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

pub fn IndustrialCounterBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, 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.

pub fn IndustrialCounterBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, 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:

  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn IndustrialCounterBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_COUNTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn IndustrialCounterBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameter:
  • pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für IndustrialCounterBricklet::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.

pub fn IndustrialCounterBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von IndustrialCounterBricklet::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.

pub fn IndustrialCounterBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, 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:

  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn IndustrialCounterBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_COUNTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn IndustrialCounterBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Rückgabe:
  • temperature – Typ: i16, 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.

pub fn IndustrialCounterBricklet::reset(&self) → ConvertingReceiver<()>

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.

pub fn IndustrialCounterBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, 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.

pub fn IndustrialCounterBricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, 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.

pub fn IndustrialCounterBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'i', 'z']
  • hardware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, 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

pub fn IndustrialCounterBricklet::set_all_counter_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, 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 IndustrialCounterBricklet::get_all_counter_callback_receiver 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.

pub fn IndustrialCounterBricklet::get_all_counter_callback_configuration(&self) → ConvertingReceiver<AllCounterCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels IndustrialCounterBricklet::set_all_counter_callback_configuration gesetzt.

pub fn IndustrialCounterBricklet::set_all_signal_data_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>
Parameter:
  • period – Typ: u32, 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 IndustrialCounterBricklet::get_all_signal_data_callback_receiver 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.

pub fn IndustrialCounterBricklet::get_all_signal_data_callback_configuration(&self) → ConvertingReceiver<AllSignalDataCallbackConfiguration>
Rückgabeobjekt:
  • period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels IndustrialCounterBricklet::set_all_signal_data_callback_configuration gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

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.

pub fn IndustrialCounterBricklet::get_all_counter_callback_receiver(&self) → ConvertingCallbackReceiver<[i64; 4]>
Event:
  • counter – Typ: [i64; 4], Wertebereich: [-263 bis 263 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen All Counter-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels IndustrialCounterBricklet::set_all_counter_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind der gleiche wie IndustrialCounterBricklet::get_all_counter.

pub fn IndustrialCounterBricklet::get_all_signal_data_callback_receiver(&self) → ConvertingCallbackReceiver<AllSignalDataEvent>
Event-Objekt:
  • duty_cycle – Typ: [u16; 4], Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [u64; 4], Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [u32; 4], Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [bool; 4]

Receiver die mit dieser Funktion erstellt werden, empfangen All Signal Data-Events.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels IndustrialCounterBricklet::set_all_signal_data_callback_configuration gesetzten Konfiguration

Die Felder der empfangenen Struktur sind der gleiche wie IndustrialCounterBricklet::get_all_signal_data.

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.

pub fn IndustrialCounterBricklet::get_api_version(&self) → [u8; 3]
Rückgabeobjekt:
  • api_version – Typ: [u8; 3]
    • 0: major – Typ: u8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: u8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: u8, 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.

pub fn IndustrialCounterBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, 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 IndustrialCounterBricklet::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:

  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER = 3
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER = 4
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_ACTIVE = 7
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_RESET = 243
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn IndustrialCounterBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameter:
  • function_id – Typ: u8, 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:

  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER = 3
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER = 4
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_ACTIVE = 7
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_RESET = 243
  • INDUSTRIAL_COUNTER_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn IndustrialCounterBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameter:
  • response_expected – Typ: bool

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

Konstanten

pub const IndustrialCounterBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Counter Bricklet zu identifizieren.

Die IndustrialCounterBricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const IndustrialCounterBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.