PHP - CAN Bricklet 2.0

Dies ist die Beschreibung der PHP API Bindings für das CAN Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CAN Bricklet 2.0 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).

Loopback

Download (ExampleLoopback.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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletCANV2;

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

// Callback function for frame read callback
function cb_frameRead($frame_type, $identifier, $data)
{
    echo "Frame Type: $frame_type\n";
    echo "Identifier: $identifier\n";
    echo "Data (Length: " . count($data) . "):";

    for ($i = 0; $i < count($data) && $i < 8; ++$i) {
        echo " " . $data[$i];
    }

    echo "\n";
    echo "\n";
}

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

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

// Configure transceiver for loopback mode
$can->setTransceiverConfiguration(1000000, 625, BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK);

// Register frame read callback to function cb_frameRead
$can->registerCallback(BrickletCANV2::CALLBACK_FRAME_READ, 'cb_frameRead');

// Enable frame read callback
$can->setFrameReadCallbackConfiguration(TRUE);

// Write standard data frame with identifier 1742 and 3 bytes of data
$can->writeFrame(BrickletCANV2::FRAME_TYPE_STANDARD_DATA, 1742, array(42, 23, 17));

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API

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

Grundfunktionen

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

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

<?php   $can_v2 = new BrickletCANV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

bool BrickletCANV2::writeFrame(int $frame_type, int $identifier, array $data)
Parameter:
  • $frame_type – Typ: int, Wertebereich: Siehe Konstanten
  • $identifier – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $data – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]
Rückgabe:
  • $success – Typ: bool

Schreibt einen Data- oder Remote-Frame in den Schreib-Queue, damit dieser über den CAN-Transceiver übertragen wird.

Das Bricklet unterstützt die Standard 11-Bit (CAN 2.0A) und die zusätzlichen Extended 29-Bit (CAN 2.0B) Identifier. Für Standard-Frames verwendet das Bricklet Bit 0 bis 10 des identifier Parameters als Standard 11-Bit Identifier. Für Extended-Frames verwendet das Bricklet Bit 0 bis 28 des identifier Parameters als Extended 29-Bit Identifier.

Das data Parameter kann bis zu 15 Bytes lang sein. Für Data-Frames werden davon bis zu 8 Bytes als die eigentlichen Daten verwendet. Das Längenfeld (DLC) im Daten- oder Remote-Frame wird auf die eigentliche Länge des data Parameters gesetzt. Dies erlaubt es Daten- und Remote-Frames mit Überlänge zu übertragen. Für Remote-Frames wird nur die Länge data Parameters verwendet. Die eigentlichen data Bytes werden ignoriert.

Gibt true zurück, wenn der Frame dem Schreib-Queue erfolgreich hinzugefügt wurde. Gibt false zurück wenn Frame nicht hinzugefügt werden konnte, weil der Schreib-Queue bereits voll ist oder weil der Schreib-Buffer oder das Schreib-Backlog mit einer Länge von Null konfiguriert sind (siehe setQueueConfiguration()).

Das Schreib-Queue kann überlaufen, wenn Frames schneller geschrieben werden als das Bricklet sie über deb CAN-Transceiver übertragen kann. Dies kann dadurch passieren, dass der CAN-Transceiver als nur-lesend oder mit einer niedrigen Baudrate konfiguriert ist (siehe setTransceiverConfiguration()). Es kann auch sein, dass der CAN-Bus stark belastet ist und der Frame nicht übertragen werden kann, da er immer wieder die Arbitrierung verliert. Ein anderer Grund kann sein, dass der CAN-Transceiver momentan deaktiviert ist, bedingt durch ein hohes Schreib-Fehlerlevel (siehe getErrorLog()).

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3
array BrickletCANV2::readFrame()
Rückgabe-Array:
  • 'success' – Typ: bool
  • 'frame_type' – Typ: int, Wertebereich: Siehe Konstanten
  • 'identifier' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'data' – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]

Versucht den nächsten Data- oder Remote-Frame aus dem Lese-Queue zu lesen und zurückzugeben. Falls ein Frame erfolgreich gelesen wurde, dann wird der success Rückgabewert auf true gesetzt und die anderen Rückgabewerte beinhalte den gelesenen Frame. Falls der Lese-Queue leer ist und kein Frame gelesen werden konnte, dann wird der success Rückgabewert auf false gesetzt und die anderen Rückgabewerte beinhalte ungültige Werte.

Der identifier Rückgabewerte folgt dem für writeFrame() beschriebenen Format.

Der data Rückgabewerte kann bis zu 15 Bytes lang sein. Bei Data-Frames sind davon bis zu 8 Byte die eigentlich empfangenen Daten. Alle Bytes nach dem 8ten Byte sind immer Null und dienen nur der Wiedergabe der Länge von Data- und Remote-Frames mit Überlänge. Für Remote-Frames stellt die Länge des data Rückgabewertes die angefragte Länge dar. Die eigentlichen data Bytes sind immer Null.

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden sollen (siehe setReadFilterConfiguration()).

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe die setFrameReadCallbackConfiguration() Funktion und den CALLBACK_FRAME_READ Callback.

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3
void BrickletCANV2::setTransceiverConfiguration(int $baud_rate, int $sample_point, int $transceiver_mode)
Parameter:
  • $baud_rate – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $sample_point – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $transceiver_mode – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Transceiver-Konfiguration für die CAN-Bus-Kommunikation.

Die Baudrate kann in Bit/s zwischen 10 und 1000 kBit/s eingestellt werden und der Abtastpunkt kann in 1/10 % zwischen 50 und 90 % eingestellt werden.

Der CAN-Transceiver hat drei verschiedene Modi:

  • Normal: Es wird vom CAN-Bus gelesen und auf den CAN-Bus geschrieben und aktiv an der Bus-Fehlererkennung und dem Acknowledgement mitgewirkt.
  • Loopback: Alle Lese- und Schreiboperationen werden intern durchgeführt. Der Transceiver ist nicht mit dem eigentlichen CAN-Bus verbunden.
  • Read-Only: Es wird nur vom CAN-Bus gelesen, allerdings ohne aktiv an der Bus-Fehlererkennung oder dem Acknowledgement mitzuwirken. Nur der empfangende Teil des Transceivers ist mit dem CAN-Bus verbunden.

Der Standard ist: 125 kBit/s, 62,5 % und normaler Transceiver-Modus.

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

Für $transceiver_mode:

  • BrickletCANV2::TRANSCEIVER_MODE_NORMAL = 0
  • BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK = 1
  • BrickletCANV2::TRANSCEIVER_MODE_READ_ONLY = 2
array BrickletCANV2::getTransceiverConfiguration()
Rückgabe-Array:
  • 'baud_rate' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'sample_point' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'transceiver_mode' – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $transceiver_mode:

  • BrickletCANV2::TRANSCEIVER_MODE_NORMAL = 0
  • BrickletCANV2::TRANSCEIVER_MODE_LOOPBACK = 1
  • BrickletCANV2::TRANSCEIVER_MODE_READ_ONLY = 2

Fortgeschrittene Funktionen

void BrickletCANV2::setQueueConfiguration(int $write_buffer_size, int $write_buffer_timeout, int $write_backlog_size, array $read_buffer_sizes, int $read_backlog_size)
Parameter:
  • $write_buffer_size – Typ: int, Wertebereich: [0 bis 255]
  • $write_buffer_timeout – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $write_backlog_size – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $read_buffer_sizes – Typ: array(int, ...), Länge: variabel, Wertebereich: [-128 bis 127]
  • $read_backlog_size – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Schreibe- und Lese-Queue-Konfiguration.

Der CAN-Transceiver hat insgesamt 32 Buffer in Hardware für das Übertragen und Empfangen von Frames. Zusätzlich hat das Bricklet ein Backlog für insgesamt 768 Frames in Software. Die Buffer und das Backlog können frei in Schreib- und Lese-Queues aufgeteilt werden.

writeFrame() schreibt einen Frame in das Schreib-Backlog. Das Bricklet überträgt den Frame vom Backlog in einen freien Schreib-Buffer. Der CAN-Transceiver überträgt dann den Frame vom Schreib-Buffer über den CAN-Bus. Falls kein Schreib-Buffer (write_buffer_size ist Null) oder kein Schreib-Backlog (write_backlog_size ist Null) vorhanden ist dann kann kein Frame übertragen werden und writeFrame() gibt immer false zurück.

Der CAN-Transceiver empfängt einen Frame vom CAN-Bus und speichert ihn in einem freien Lese-Buffer. Das Bricklet übertragt den Frame vom Lese-Buffer in das Lese-Backlog. readFrame() ließt den Frame aus dem Lese-Backlog und gibt ihn zurück. Falls keine Lese-Buffer (read_buffer_sizes ist leer) oder kein Lese-Backlog (read_backlog_size ist Null) vorhanden ist dann kann kein Frame empfangen werden und readFrame() gibt immer false zurück.

Es kann mehrere Lese-Buffer geben, da der CAN-Transceiver nicht Data- und Remote-Frames in den gleichen Lese-Buffer empfangen kann. Eine positive Lese-Buffer-Größe stellt einen Data-Frame-Lese-Buffer dar und eine negative Lese-Buffer-Größe stellt einen Remote-Frame-Lese-Buffer dar. Eine Lese-Buffer-Länge von Null ist nicht erlaubt. Standardmäßig ist der erste Lese-Buffer für Data-Frames konfiguriert und der zweite Lese-Buffer ist für Remote-Frames konfiguriert. Es kann bis zu 32 verschiedene Lese-Buffer geben, unter der Annahme, dass kein Schreib-Buffer verwendet wird. Jeder Lese-Buffer hat seine eigene Filter-Konfiguration (siehe setReadFilterConfiguration()).

Eine gültige Queue-Konfiguration erfüllt diese Bedingungen:

write_buffer_size + read_buffer_size_0 + read_buffer_size_1 + ... + read_buffer_size_31 <= 32
write_backlog_size + read_backlog_size <= 768

Der Schreib-Timeout hat drei verschiedene Modi, die festlegen wie mit einer fehlgeschlagen Frame-Übertragung umgegangen werden soll:

  • Single-Shot (< 0): Es wird nur ein Übertragungsversuch durchgeführt. Falls die Übertragung fehlschlägt wird der Frame verworfen.
  • Infinite (= 0): Es werden unendlich viele Übertragungsversuche durchgeführt. Der Frame wird niemals verworfen.
  • Milliseconds (> 0): Es wird eine beschränkte Anzahl Übertragungsversuche durchgeführt. Falls der Frame nach der eingestellten Anzahl Millisekunden noch nicht erfolgreich übertragen wurde, dann wird er verworfen.

Der aktuelle Inhalt der Queues geht bei einem Aufruf dieser Funktion verloren.

Der Standard ist:

  • 8 Schreib-Buffer,
  • unendlicher Schreib-Timeout,
  • 383 Schreib-Backlog-Frames,
  • 16 Lese-Buffer für Data-Frames,
  • 8 Lese-Buffer für Remote-Frames und
  • 383 Lese-Backlog-Frames.
array BrickletCANV2::getQueueConfiguration()
Rückgabe-Array:
  • 'write_buffer_size' – Typ: int, Wertebereich: [0 bis 255]
  • 'write_buffer_timeout' – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 'write_backlog_size' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'read_buffer_sizes' – Typ: array(int, ...), Länge: variabel, Wertebereich: [-128 bis 127]
  • 'read_backlog_size' – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Queue-Konfiguration zurück, wie von setQueueConfiguration() gesetzt.

void BrickletCANV2::setReadFilterConfiguration(int $buffer_index, int $filter_mode, int $filter_mask, int $filter_identifier)
Parameter:
  • $buffer_index – Typ: int, Wertebereich: [0 bis 255]
  • $filter_mode – Typ: int, Wertebereich: Siehe Konstanten
  • $filter_mask – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $filter_identifier – Typ: int, Wertebereich: [0 bis 232 - 1]

Setzt die Konfiguration für den Lesefilter des angegebenen Lese-Buffers. Damit kann festgelegt werden, welche Frames von der CAN-Transceiver überhaupt empfangen und im Lese-Buffer abgelegt werden sollen.

Der Lesefilter hat vier verschiedene Modi, die festlegen ob und wie die Filter-Maske und der Filter-Identifier angewendet werden:

  • Accept-All: Alle Frames werden empfangen.
  • Match-Standard-Only: Nur Standard-Frames mit übereinstimmendem Identifier werden empfangen.
  • Match-Extended-Only: Nur Extended-Frames mit übereinstimmendem Identifier werden empfangen.
  • Match-Standard-And-Extended: Standard- und Extended-Frames mit übereinstimmendem Identifier werden empfangen.

Filter-Maske und Filter-Identifier werden als Bitmasken verwendet. Ihre Verwendung hängt vom Filter-Modus ab:

  • Accept-All: Filter-Maske und Filter-Identifier werden ignoriert.
  • Match-Standard-Only: Bit 0 bis 10 (11 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet.
  • Match-Extended-Only: Bit 0 bis 28 (29 Bits) der Filter-Maske und des Filter-Identifiers Abgleich mit dem 29-Bit Identifier von Extended-Frames verwendet.
  • Match-Standard-And-Extended: Bit 18 bis 28 (11 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 11-Bit Identifier von Standard-Frames verwendet, Bit 0 bis 17 (18 Bits) werden in diesem Fall ignoriert. Bit 0 bis 28 (18 Bits) der Filter-Maske und des Filter-Identifiers werden zum Abgleich mit dem 29-Bit Identifier von Extended-Frames verwendet.

Filter-Maske und Filter-Identifier werden auf diese Weise angewendet: Mit der Filter-Maske werden die Frame-Identifier-Bits ausgewählt, die mit den entsprechenden Filter-Identifier-Bits verglichen werden sollen. Alle nicht-ausgewählten Bits werden automatisch akzeptiert. Alle ausgewählten Bits müssen dem Filter-Identifier entsprechen, um akzeptiert zu werden. Wenn alle Bits für den ausgewählte Modus akzeptiert wurden, dann ist der Frame akzeptiert und wird im Lese-Buffer abgelegt.

Filter-Masken-Bit Filter-Identifier-Bit Frame-Identifier-Bit Ergebnis
0 X X akzeptiert
1 0 0 akzeptiert
1 0 1 verworfen
1 1 0 verworfen
1 1 1 akzeptiert

Ein Beispiel: Um nur Standard-Frames mit Identifier 0x123 zu empfangen kann der Modus auf Match-Standard-Only mit 0x7FF als Filter-Maske und 0x123 als Filter-Identifier eingestellt werden. Die Maske 0x7FF wählt alle 11 Identifier-Bits zum Abgleich aus, so dass der Identifier exakt 0x123 sein muss um akzeptiert zu werden.

Da bis zu 32 Lese-Buffer konfiguriert werden können (siehe setQueueConfiguration()) können auch bis zu 32 verschiedenen Lesefilter gleichzeitig konfiguriert werden.

Der Standardmodus ist Accept-All für alle Lese-Buffer.

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

Für $filter_mode:

  • BrickletCANV2::FILTER_MODE_ACCEPT_ALL = 0
  • BrickletCANV2::FILTER_MODE_MATCH_STANDARD_ONLY = 1
  • BrickletCANV2::FILTER_MODE_MATCH_EXTENDED_ONLY = 2
  • BrickletCANV2::FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3
array BrickletCANV2::getReadFilterConfiguration(int $buffer_index)
Parameter:
  • $buffer_index – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 'filter_mode' – Typ: int, Wertebereich: Siehe Konstanten
  • 'filter_mask' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'filter_identifier' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Lese-Filter-Konfiguration zurück, wie von setReadFilterConfiguration() gesetzt.

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

Für $filter_mode:

  • BrickletCANV2::FILTER_MODE_ACCEPT_ALL = 0
  • BrickletCANV2::FILTER_MODE_MATCH_STANDARD_ONLY = 1
  • BrickletCANV2::FILTER_MODE_MATCH_EXTENDED_ONLY = 2
  • BrickletCANV2::FILTER_MODE_MATCH_STANDARD_AND_EXTENDED = 3
array BrickletCANV2::getErrorLog()
Rückgabe-Array:
  • 'transceiver_state' – Typ: int, Wertebereich: Siehe Konstanten
  • 'transceiver_write_error_level' – Typ: int, Wertebereich: [0 bis 255]
  • 'transceiver_read_error_level' – Typ: int, Wertebereich: [0 bis 255]
  • 'transceiver_stuffing_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'transceiver_format_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'transceiver_ack_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'transceiver_bit1_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'transceiver_bit0_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'transceiver_crc_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'write_buffer_timeout_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'read_buffer_overflow_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'read_buffer_overflow_error_occurred' – Typ: array(bool, ...), Länge: variabel
  • 'read_backlog_overflow_error_count' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt Informationen über verschiedene Fehlerarten zurück.

Die Schreib- und Lesefehler-Level geben Aufschluss über das aktuelle Level der Stuffing-, Form-, Acknowledgement-, Bit-, und Prüfsummen-Fehler während CAN-Bus Schreib- und Leseoperationen. Für jede dieser Fehlerarten ist jeweils auch ein eigener Zähler vorhanden.

Wenn das Schreibfehler-Level 255 überschreitet dann wird der CAN-Transceiver deaktiviert und es können keine Frames mehr übertragen und empfangen werden. Wenn auf dem CAN-Bus für eine Weile Ruhe herrscht, dann wird der CAN-Transceiver automatisch wieder aktiviert.

Die Werte für Schreib-Buffer-Timeout, Lese-Buffer- und Lese-Backlog-Überlauf zählen die Anzahl dieser Fehler:

  • Ein Schreib-Buffer-Timeout tritt dann auf, wenn ein Frame nicht übertragen werden konnte bevor der eingestellte Schreib-Buffer-Timeout abgelaufen ist (siehe setQueueConfiguration()).
  • Ein Lese-Buffer-Überlauf tritt dann auf, wenn in einem der Lese-Buffer des CAN-Transceiver noch der zuletzt empfangen Frame steht wenn der nächste Frame ankommt. In diesem Fall geht der zuletzt empfangen Frame verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt als das Bricklet behandeln kann. Mit Hilfe des Lesefilters (siehe setReadFilterConfiguration()) kann die Anzahl der empfangen Frames verringert werden. Dieser Zähler ist nicht exakt, sondern stellt eine untere Grenze da. Es kann vorkommen, dass das Bricklet nicht alle Überläufe erkennt, wenn diese in schneller Abfolge auftreten.
  • Ein Lese-Backlog-Überlauf tritt dann auf, wenn das Lese-Backlog des Bricklets bereits voll ist und noch ein Frame von einem Lese-Buffer des CAN-Transceiver gelesen werden soll. In diesem Fall geht der Frame im Lese-Buffer verloren. Dies passiert, wenn der CAN-Transceiver mehr Frames empfängt, die dem Lese-Backlog hinzugefügt werden sollen, als Frames mit der readFrame() Funktion aus dem Lese-Backlog entnommen werden. Die Verwendung des CALLBACK_FRAME_READ Callbacks stellt sicher, dass der Lese-Backlog nicht überlaufen kann.

Der Lese-Buffer-Überlauf-Zähler zählt die Überläuft aller konfigurierten Lese-Buffer. In welchem Lese-Buffer seit dem letzten Aufruf dieser Funktion ein Überlauf aufgetreten ist kann an der Liste des Lese-Buffer-Überlauf-Auftretens (read_buffer_overflow_error_occurred) abgelesen werden.

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

Für $transceiver_state:

  • BrickletCANV2::TRANSCEIVER_STATE_ACTIVE = 0
  • BrickletCANV2::TRANSCEIVER_STATE_PASSIVE = 1
  • BrickletCANV2::TRANSCEIVER_STATE_DISABLED = 2
void BrickletCANV2::setCommunicationLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal pro 40 empfangenen oder gesendeten Frames.

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:

  • BrickletCANV2::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
int BrickletCANV2::getCommunicationLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletCANV2::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCANV2::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
void BrickletCANV2::setErrorLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Error-LED.

Standardmäßig (Show-Transceiver-State) geht die LED an, wenn der CAN-Transceiver im Passive oder Disabled Zustand ist (siehe getErrorLog()). Wenn der CAN-Transceiver im Active Zustand ist, dann geht die LED aus.

Wenn die LED als Show-Error konfiguriert ist, dann geht die LED an wenn ein Error auftritt. Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

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:

  • BrickletCANV2::ERROR_LED_CONFIG_OFF = 0
  • BrickletCANV2::ERROR_LED_CONFIG_ON = 1
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_ERROR = 4
int BrickletCANV2::getErrorLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletCANV2::ERROR_LED_CONFIG_OFF = 0
  • BrickletCANV2::ERROR_LED_CONFIG_ON = 1
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_TRANSCEIVER_STATE = 3
  • BrickletCANV2::ERROR_LED_CONFIG_SHOW_ERROR = 4
void BrickletCANV2::setTimestampedFrameConfiguration(bool $enabled, int $write_backlog_size, int $read_backlog_size)
Parameter:
  • $enabled – Typ: bool
  • $write_backlog_size – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $read_backlog_size – Typ: int, Wertebereich: [0 bis 216 - 1]

Neu in Version 2.0.3 (Plugin).

array BrickletCANV2::getTimestampedFrameConfiguration()
Rückgabe-Array:
  • 'enabled' – Typ: bool
  • 'write_backlog_size' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'read_backlog_size' – Typ: int, Wertebereich: [0 bis 216 - 1]

Neu in Version 2.0.3 (Plugin).

bool BrickletCANV2::writeTimestampedFrame(int $frame_type, int $identifier, array $data, int $timestamp)
Parameter:
  • $frame_type – Typ: int, Wertebereich: Siehe Konstanten
  • $identifier – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $data – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]
  • $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
Rückgabe:
  • $success – Typ: bool

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

Neu in Version 2.0.3 (Plugin).

array BrickletCANV2::readTimestampedFrame()
Rückgabe-Array:
  • 'success' – Typ: bool
  • 'frame_type' – Typ: int, Wertebereich: Siehe Konstanten
  • 'identifier' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'data' – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]
  • 'timestamp' – Typ: int, Wertebereich: [0 bis 264 - 1]

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

Neu in Version 2.0.3 (Plugin).

int BrickletCANV2::getTimestamp()
Rückgabe:
  • $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]

Neu in Version 2.0.3 (Plugin).

array BrickletCANV2::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 BrickletCANV2::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:

  • BrickletCANV2::FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
  • BrickletCANV2::FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
  • BrickletCANV2::FUNCTION_SET_QUEUE_CONFIGURATION = 7
  • BrickletCANV2::FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
  • BrickletCANV2::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
  • BrickletCANV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BrickletCANV2::FUNCTION_SET_TIMESTAMPED_FRAME_CONFIGURATION = 17
  • BrickletCANV2::FUNCTION_SET_TIMESTAMPED_FRAME_READ_CALLBACK_CONFIGURATION = 22
  • BrickletCANV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCANV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCANV2::FUNCTION_RESET = 243
  • BrickletCANV2::FUNCTION_WRITE_UID = 248
void BrickletCANV2::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:

  • BrickletCANV2::FUNCTION_SET_FRAME_READ_CALLBACK_CONFIGURATION = 3
  • BrickletCANV2::FUNCTION_SET_TRANSCEIVER_CONFIGURATION = 5
  • BrickletCANV2::FUNCTION_SET_QUEUE_CONFIGURATION = 7
  • BrickletCANV2::FUNCTION_SET_READ_FILTER_CONFIGURATION = 9
  • BrickletCANV2::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
  • BrickletCANV2::FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BrickletCANV2::FUNCTION_SET_TIMESTAMPED_FRAME_CONFIGURATION = 17
  • BrickletCANV2::FUNCTION_SET_TIMESTAMPED_FRAME_READ_CALLBACK_CONFIGURATION = 22
  • BrickletCANV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCANV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCANV2::FUNCTION_RESET = 243
  • BrickletCANV2::FUNCTION_WRITE_UID = 248
void BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::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:

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

Für $status:

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

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

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

  • BrickletCANV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletCANV2::STATUS_LED_CONFIG_ON = 1
  • BrickletCANV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCANV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::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 BrickletCANV2::setFrameReadCallbackConfiguration(bool $enabled)
Parameter:
  • $enabled – Typ: bool

Aktiviert und deaktiviert den CALLBACK_FRAME_READ Callback.

Standardmäßig ist der Callback deaktiviert.

bool BrickletCANV2::getFrameReadCallbackConfiguration()
Rückgabe:
  • $enabled – Typ: bool

Gibt true zurück falls der CALLBACK_FRAME_READ Callback aktiviert ist, false sonst.

void BrickletCANV2::setTimestampedFrameReadCallbackConfiguration(bool $enabled)
Parameter:
  • $enabled – Typ: bool

Neu in Version 2.0.3 (Plugin).

bool BrickletCANV2::getTimestampedFrameReadCallbackConfiguration()
Rückgabe:
  • $enabled – Typ: bool

Neu in Version 2.0.3 (Plugin).

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";
}

$can_v2->registerCallback(BrickletCANV2::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 BrickletCANV2::CALLBACK_FRAME_READ
<?php   void callback(int $frame_type, int $identifier, array $data [, mixed $user_data])   ?>
Callback-Parameter:
  • $frame_type – Typ: int, Wertebereich: Siehe Konstanten
  • $identifier – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $data – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst, sobald ein Data- oder Remote-Frame vom CAN-Transceiver empfangen wurde.

Der identifier Rückgabewerte folgt dem für writeFrame() beschriebenen Format.

Für Details zum data Rückgabewerte siehe readFrame().

Mittels eines einstellbaren Lesefilters kann festgelegt werden, welche Frames vom CAN-Transceiver überhaupt empfangen und im Lese-Queue abgelegt werden sollen (siehe setQueueConfiguration()).

Dieser Callback kann durch setFrameReadCallbackConfiguration() aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für data ausgelöst.

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3
int BrickletCANV2::CALLBACK_TIMESTAMPED_FRAME_READ
<?php   void callback(int $frame_type, int $identifier, array $data, int $timestamp [, mixed $user_data])   ?>
Callback-Parameter:
  • $frame_type – Typ: int, Wertebereich: Siehe Konstanten
  • $identifier – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $data – Typ: array(int, ...), Länge: variabel, Wertebereich: [0 bis 255]
  • $timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • $user_data – Typ: mixed

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für data ausgelöst.

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

Für $frame_type:

  • BrickletCANV2::FRAME_TYPE_STANDARD_DATA = 0
  • BrickletCANV2::FRAME_TYPE_STANDARD_REMOTE = 1
  • BrickletCANV2::FRAME_TYPE_EXTENDED_DATA = 2
  • BrickletCANV2::FRAME_TYPE_EXTENDED_REMOTE = 3

Neu in Version 2.0.3 (Plugin).

Konstanten

int BrickletCANV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CAN Bricklet 2.0 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 BrickletCANV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CAN Bricklet 2.0 dar.