PHP - Industrial Counter Bricklet

Dies ist die Beschreibung der PHP 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 PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.php)

 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
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletIndustrialCounter.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIndustrialCounter;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Industrial Counter Bricklet

$ipcon = new IPConnection(); // Create IP connection
$ic = new BrickletIndustrialCounter(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Get current counter from channel 0
$counter = $ic->getCounter(BrickletIndustrialCounter::CHANNEL_0);
echo "Counter (Channel 0): $counter\n";

// Get current signal data from channel 0
$signal_data = $ic->getSignalData(BrickletIndustrialCounter::CHANNEL_0);

echo "Duty Cycle (Channel 0): " . $signal_data['duty_cycle']/100.0 . " %\n";
echo "Period (Channel 0): " . $signal_data['period'] . " ns\n";
echo "Frequency (Channel 0): " . $signal_data['frequency']/1000.0 . " Hz\n";
echo "Value (Channel 0): " . $signal_data['value'] . "\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

API

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen

class BrickletIndustrialCounter(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $industrial_counter – Typ: BrickletIndustrialCounter

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

<?php   $industrial_counter = new BrickletIndustrialCounter('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletIndustrialCounter::getCounter(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $counter – Typ: int, 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:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3
array BrickletIndustrialCounter::getAllCounter()
Rückgabe:
  • $counter – Typ: array(int, ...), Länge: 4, Wertebereich: [-263 bis 263 - 1]

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

void BrickletIndustrialCounter::setCounter(int $channel, int $counter)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $counter – Typ: int, 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:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3
void BrickletIndustrialCounter::setAllCounter(array $counter)
Parameter:
  • $counter – Typ: array(int, ...), Länge: 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.

array BrickletIndustrialCounter::getSignalData(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe-Array:
  • 'duty_cycle' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'period' – Typ: int, Wertebereich: [0 bis 264 - 1]
  • 'frequency' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'value' – Typ: bool

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

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low

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

Für $channel:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3
array BrickletIndustrialCounter::getAllSignalData()
Rückgabe-Array:
  • 'duty_cycle' – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 216 - 1]
  • 'period' – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 264 - 1]
  • 'frequency' – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 232 - 1]
  • 'value' – Typ: array(bool, ...), Länge: 4

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

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low
void BrickletIndustrialCounter::setCounterActive(int $channel, bool $active)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $active – Typ: bool

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:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3
void BrickletIndustrialCounter::setAllCounterActive(array $active)
Parameter:
  • $active – Typ: array(bool, ...), Länge: 4

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

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

bool BrickletIndustrialCounter::getCounterActive(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $active – Typ: bool

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:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3
array BrickletIndustrialCounter::getAllCounterActive()
Rückgabe:
  • $active – Typ: array(bool, ...), Länge: 4

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

true = aktiviert, false = deaktiviert.

void BrickletIndustrialCounter::setCounterConfiguration(int $channel, int $count_edge, int $count_direction, int $duty_cycle_prescaler, int $frequency_integration_time)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $count_edge – Typ: int, Wertebereich: Siehe Konstanten
  • $count_direction – Typ: int, Wertebereich: Siehe Konstanten
  • $duty_cycle_prescaler – Typ: int, Wertebereich: Siehe Konstanten
  • $frequency_integration_time – Typ: int, Wertebereich: Siehe Konstanten

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. Standardwert ist steigend.
  • 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. Standardwert ist hochzählend.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details. Standardwert ist 1.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details. Standardwert ist 1024ms.

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

Für $channel:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3

Für $count_edge:

  • BrickletIndustrialCounter::COUNT_EDGE_RISING = 0
  • BrickletIndustrialCounter::COUNT_EDGE_FALLING = 1
  • BrickletIndustrialCounter::COUNT_EDGE_BOTH = 2

Für $count_direction:

  • BrickletIndustrialCounter::COUNT_DIRECTION_UP = 0
  • BrickletIndustrialCounter::COUNT_DIRECTION_DOWN = 1
  • BrickletIndustrialCounter::COUNT_DIRECTION_EXTERNAL_UP = 2
  • BrickletIndustrialCounter::COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für $duty_cycle_prescaler:

  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_1 = 0
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_2 = 1
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_4 = 2
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_8 = 3
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_16 = 4
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_32 = 5
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_64 = 6
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_128 = 7
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_256 = 8
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_512 = 9
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_1024 = 10
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_2048 = 11
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_4096 = 12
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_8192 = 13
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_16384 = 14
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_32768 = 15

Für $frequency_integration_time:

  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_32768_MS = 8
array BrickletIndustrialCounter::getCounterConfiguration(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe-Array:
  • 'count_edge' – Typ: int, Wertebereich: Siehe Konstanten
  • 'count_direction' – Typ: int, Wertebereich: Siehe Konstanten
  • 'duty_cycle_prescaler' – Typ: int, Wertebereich: Siehe Konstanten
  • 'frequency_integration_time' – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Zähler-Konfiguration zurück, wie Sie mittels setCounterConfiguration() gesetzt wurde.

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

Für $channel:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3

Für $count_edge:

  • BrickletIndustrialCounter::COUNT_EDGE_RISING = 0
  • BrickletIndustrialCounter::COUNT_EDGE_FALLING = 1
  • BrickletIndustrialCounter::COUNT_EDGE_BOTH = 2

Für $count_direction:

  • BrickletIndustrialCounter::COUNT_DIRECTION_UP = 0
  • BrickletIndustrialCounter::COUNT_DIRECTION_DOWN = 1
  • BrickletIndustrialCounter::COUNT_DIRECTION_EXTERNAL_UP = 2
  • BrickletIndustrialCounter::COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für $duty_cycle_prescaler:

  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_1 = 0
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_2 = 1
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_4 = 2
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_8 = 3
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_16 = 4
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_32 = 5
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_64 = 6
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_128 = 7
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_256 = 8
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_512 = 9
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_1024 = 10
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_2048 = 11
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_4096 = 12
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_8192 = 13
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_16384 = 14
  • BrickletIndustrialCounter::DUTY_CYCLE_PRESCALER_32768 = 15

Für $frequency_integration_time:

  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BrickletIndustrialCounter::FREQUENCY_INTEGRATION_TIME_32768_MS = 8
void BrickletIndustrialCounter::setChannelLEDConfig(int $channel, int $config)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für $channel:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3

Für $config:

  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialCounter::getChannelLEDConfig(int $channel)
Parameter:
  • $channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Kanal-LED-Konfiguration zurück, wie von setChannelLEDConfig() gesetzt.

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

Für $channel:

  • BrickletIndustrialCounter::CHANNEL_0 = 0
  • BrickletIndustrialCounter::CHANNEL_1 = 1
  • BrickletIndustrialCounter::CHANNEL_2 = 2
  • BrickletIndustrialCounter::CHANNEL_3 = 3

Für $config:

  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter::CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

array BrickletIndustrialCounter::getAPIVersion()
Rückgabe:
  • $api_version – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]

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.

bool BrickletIndustrialCounter::getResponseExpected(int $function_id)
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 setResponseExpected(). 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:

  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER = 3
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER = 4
  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER_ACTIVE = 7
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BrickletIndustrialCounter::FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BrickletIndustrialCounter::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialCounter::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialCounter::FUNCTION_RESET = 243
  • BrickletIndustrialCounter::FUNCTION_WRITE_UID = 248
void BrickletIndustrialCounter::setResponseExpected(int $function_id, bool $response_expected)
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:

  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER = 3
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER = 4
  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER_ACTIVE = 7
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BrickletIndustrialCounter::FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BrickletIndustrialCounter::FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BrickletIndustrialCounter::FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BrickletIndustrialCounter::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialCounter::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialCounter::FUNCTION_RESET = 243
  • BrickletIndustrialCounter::FUNCTION_WRITE_UID = 248
void BrickletIndustrialCounter::setResponseExpectedAll(bool $response_expected)
Parameter:
  • $response_expected – Typ: bool

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

array BrickletIndustrialCounter::getSPITFPErrorCount()
Rückgabe-Array:
  • 'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_frame' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • '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.

int BrickletIndustrialCounter::setBootloaderMode(int $mode)
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 Bootlodaer- 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:

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

Für $status:

  • BrickletIndustrialCounter::BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialCounter::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialCounter::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialCounter::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialCounter::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialCounter::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialCounter::getBootloaderMode()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für $mode:

  • BrickletIndustrialCounter::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialCounter::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialCounter::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialCounter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialCounter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialCounter::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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.

int BrickletIndustrialCounter::writeFirmware(array $data)
Parameter:
  • $data – Typ: array(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 setWriteFirmwarePointer() 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.

void BrickletIndustrialCounter::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletIndustrialCounter::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialCounter::getStatusLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

Für $config:

  • BrickletIndustrialCounter::STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialCounter::getChipTemperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

void BrickletIndustrialCounter::reset()

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.

void BrickletIndustrialCounter::writeUID(int $uid)
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.

int BrickletIndustrialCounter::readUID()
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.

array BrickletIndustrialCounter::getIdentity()
Rückgabe-Array:
  • 'uid' – Typ: string, Länge: bis zu 8
  • 'connected_uid' – Typ: string, Länge: bis zu 8
  • 'position' – Typ: string
  • 'hardware_version' – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]
  • 'firmware_version' – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]
  • '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 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.

Konfigurationsfunktionen für Callbacks

void BrickletIndustrialCounter::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameter:
  • $callback_id – Typ: int
  • $callback – Typ: callable
  • $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

void BrickletIndustrialCounter::setAllCounterCallbackConfiguration(int $period, bool $value_has_to_change)
Parameter:
  • $period – Typ: int, 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 CALLBACK_ALL_COUNTER 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.

array BrickletIndustrialCounter::getAllCounterCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, 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 setAllCounterCallbackConfiguration() gesetzt.

void BrickletIndustrialCounter::setAllSignalDataCallbackConfiguration(int $period, bool $value_has_to_change)
Parameter:
  • $period – Typ: int, 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 CALLBACK_ALL_SIGNAL_DATA 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.

array BrickletIndustrialCounter::getAllSignalDataCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, 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 setAllSignalDataCallbackConfiguration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$industrial_counter->registerCallback(BrickletIndustrialCounter::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

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.

int BrickletIndustrialCounter::CALLBACK_ALL_COUNTER
<?php   void callback(array $counter [, mixed $user_data])   ?>
Callback-Parameter:
  • $counter – Typ: array(int, ...), Länge: 4, Wertebereich: [-263 bis 263 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAllCounterCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie getAllCounter().

int BrickletIndustrialCounter::CALLBACK_ALL_SIGNAL_DATA
<?php   void callback(array $duty_cycle, array $period, array $frequency, array $value [, mixed $user_data])   ?>
Callback-Parameter:
  • $duty_cycle – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 216 - 1]
  • $period – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 264 - 1]
  • $frequency – Typ: array(int, ...), Länge: 4, Wertebereich: [0 bis 232 - 1]
  • $value – Typ: array(bool, ...), Länge: 4
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setAllSignalDataCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie getAllSignalData().

Konstanten

int BrickletIndustrialCounter::DEVICE_IDENTIFIER

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

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletIndustrialCounter::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.