PHP - Motorized Linear Poti Bricklet¶

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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotorizedLinearPoti;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet

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

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

// Get current position
$position = $mlp->getPosition();
echo "Position: $position\n"; // Range: 0 to 100

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

?>

Callback¶

Download (ExampleCallback.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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotorizedLinearPoti;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet

// Callback function for position callback
function cb_position($position)
{
    echo "Position: $position\n"; // Range: 0 to 100
}

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

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

// Register position callback to function cb_position
$mlp->registerCallback(BrickletMotorizedLinearPoti::CALLBACK_POSITION, 'cb_position');

// Set period for position callback to 0.05s (50ms) without a threshold
$mlp->setPositionCallbackConfiguration(50, FALSE, 'x', 0, 0);

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

?>

Motor¶

Download (ExampleMotor.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/BrickletMotorizedLinearPoti.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletMotorizedLinearPoti;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Motorized Linear Poti Bricklet

// Callback function for position reached callback
function cb_positionReached($position)
{
    echo "Position: $position\n"; // Range: 0 to 100
}

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

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

// Register position reached callback to function cb_positionReached
$mlp->registerCallback(BrickletMotorizedLinearPoti::CALLBACK_POSITION_REACHED,
                       'cb_positionReached');

// Move slider smooth to the middle
$mlp->setMotorPosition(50, BrickletMotorizedLinearPoti::DRIVE_MODE_SMOOTH, FALSE);

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

?>

Grundfunktionen¶

class BrickletMotorizedLinearPoti(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$motorized_linear_poti – Typ: BrickletMotorizedLinearPoti

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

<?php   $motorized_linear_poti = new BrickletMotorizedLinearPoti('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletMotorizedLinearPoti::getPosition()¶

Rückgabe:	$position – Typ: int, Wertebereich: [0 bis 100]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_POSITION Callback verwendet werden. Der Callback wird mit der Funktion setPositionCallbackConfiguration() konfiguriert.

void BrickletMotorizedLinearPoti::setMotorPosition(int $position, int $drive_mode, bool $hold_position)¶

Parameter:	$position – Typ: int, Wertebereich: [0 bis 100] $drive_mode – Typ: int, Wertebereich: Siehe Konstanten $hold_position – Typ: bool

Setzt die Position des Potentiometers. Nach Aufruf der Funktion wird das Potentiometer sofort diese Position anfahren. Abhängig von dem gewählten Drive Mode wird die Position entweder so schnell wie möglich angefahren oder langsam dafür aber gleichmäßig (smooth).

Die Position kann zwischen 0 (Regler unten) und 100 (Regler oben) festgelegt werden.

Wenn der Hold Position Parameter auf True gesetzt wird, wird die Position automatisch gehalten. Wenn ein Nutzer die Position ändert, fährt das Potentiometer die alte Position anschließend wieder an.

Wenn der Hold Position Parameter auf False gesetzt wird, kann die Position vom Nutzer geändert werden, nachdem die Sollposition erreicht wurde.

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

Für $drive_mode:

• BrickletMotorizedLinearPoti::DRIVE_MODE_FAST = 0
• BrickletMotorizedLinearPoti::DRIVE_MODE_SMOOTH = 1

array BrickletMotorizedLinearPoti::getMotorPosition()¶

Rückgabe-Array:	'position' – Typ: int, Wertebereich: [0 bis 100] 'drive_mode' – Typ: int, Wertebereich: Siehe Konstanten 'hold_position' – Typ: bool 'position_reached' – Typ: bool

Gibt die letzte Motor Position, die mittels setMotorPosition() gesetzt wurde zurück. Dies ist nicht die aktuelle Position des Potentiometers (dafür ist getPosition() gedacht). Zusätzlich wird die letzte Konfiguration zurückgegeben.

Der Position Reached Parameter ist True, wenn der letzte Sollwert (Motor Position) erreicht wurde. Die reale Position könnte sich seitdem jedoch geändert haben.

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

Für $drive_mode:

• BrickletMotorizedLinearPoti::DRIVE_MODE_FAST = 0
• BrickletMotorizedLinearPoti::DRIVE_MODE_SMOOTH = 1

Fortgeschrittene Funktionen¶

void BrickletMotorizedLinearPoti::calibrate()¶

Startet die Kalibrierung. Das Potentiometer fährt dabei die Extrempunkte an.

Die Kalibrierung wird im internen Flash gespeichert und muss nicht bei jedem Start neu durchgeführt werden.

Das Motorized Linear Poti Bricklet wird von Tinkerforge während des Funktionstests kalibriert.

array BrickletMotorizedLinearPoti::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.

void BrickletMotorizedLinearPoti::setStatusLEDConfig(int $config)¶

Parameter:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für $config:

• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_OFF = 0
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_ON = 1
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotorizedLinearPoti::getStatusLEDConfig()¶

Rückgabe:	$config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $config:

• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_OFF = 0
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_ON = 1
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletMotorizedLinearPoti::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletMotorizedLinearPoti::getChipTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletMotorizedLinearPoti::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.

array BrickletMotorizedLinearPoti::getIdentity()¶

Rückgabe-Array:

'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

void BrickletMotorizedLinearPoti::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 BrickletMotorizedLinearPoti::setPositionCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 $value_has_to_change – Typ: bool, Standardwert: FALSE $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 $max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_POSITION 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_POSITION Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für $option:

• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_OFF = 'x'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_GREATER = '>'

array BrickletMotorizedLinearPoti::getPositionCallbackConfiguration()¶

Rückgabe-Array:	'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 'value_has_to_change' – Typ: bool, Standardwert: FALSE 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' 'min' – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 'max' – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setPositionCallbackConfiguration() gesetzt.

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

Für $option:

• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_OFF = 'x'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_INSIDE = 'i'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_SMALLER = '<'
• BrickletMotorizedLinearPoti::THRESHOLD_OPTION_GREATER = '>'

void BrickletMotorizedLinearPoti::setPositionReachedCallbackConfiguration(bool $enabled)¶

Parameter:	$enabled – Typ: bool, Standardwert: TRUE

Aktiviert/Deaktiviert den CALLBACK_POSITION_REACHED Callback.

bool BrickletMotorizedLinearPoti::getPositionReachedCallbackConfiguration()¶

Rückgabe:	$enabled – Typ: bool, Standardwert: TRUE

Gibt die CALLBACK_POSITION_REACHED Callback Konfiguration zurück, wie von setPositionReachedCallbackConfiguration() 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";
}

$motorized_linear_poti->registerCallback(BrickletMotorizedLinearPoti::CALLBACK_EXAMPLE, 'myCallback');

?>

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

int BrickletMotorizedLinearPoti::CALLBACK_POSITION¶

<?php   void callback(int $position [, mixed $user_data])   ?>

Callback-Parameter:	$position – Typ: int, Wertebereich: [0 bis 100] $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getPosition().

int BrickletMotorizedLinearPoti::CALLBACK_POSITION_REACHED¶

<?php   void callback(int $position [, mixed $user_data])   ?>

Callback-Parameter:	$position – Typ: int, Wertebereich: [0 bis 100] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn die mittels setMotorPosition() gesetzte Position erreicht wird.

Der Parameter ist die aktuelle Position.

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.

array BrickletMotorizedLinearPoti::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletMotorizedLinearPoti::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:

• BrickletMotorizedLinearPoti::FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2
• BrickletMotorizedLinearPoti::FUNCTION_SET_MOTOR_POSITION = 5
• BrickletMotorizedLinearPoti::FUNCTION_CALIBRATE = 7
• BrickletMotorizedLinearPoti::FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8
• BrickletMotorizedLinearPoti::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotorizedLinearPoti::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotorizedLinearPoti::FUNCTION_RESET = 243
• BrickletMotorizedLinearPoti::FUNCTION_WRITE_UID = 248

void BrickletMotorizedLinearPoti::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:

• BrickletMotorizedLinearPoti::FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2
• BrickletMotorizedLinearPoti::FUNCTION_SET_MOTOR_POSITION = 5
• BrickletMotorizedLinearPoti::FUNCTION_CALIBRATE = 7
• BrickletMotorizedLinearPoti::FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8
• BrickletMotorizedLinearPoti::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletMotorizedLinearPoti::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletMotorizedLinearPoti::FUNCTION_RESET = 243
• BrickletMotorizedLinearPoti::FUNCTION_WRITE_UID = 248

void BrickletMotorizedLinearPoti::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.

Interne Funktionen¶

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

int BrickletMotorizedLinearPoti::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 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:

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

Für $status:

• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_OK = 0
• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletMotorizedLinearPoti::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletMotorizedLinearPoti::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:

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

void BrickletMotorizedLinearPoti::setWriteFirmwarePointer(int $pointer)¶

Parameter:	$pointer – Typ: int, Einheit: 1 B, 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 BrickletMotorizedLinearPoti::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 BrickletMotorizedLinearPoti::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 BrickletMotorizedLinearPoti::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.

Konstanten¶

int BrickletMotorizedLinearPoti::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Motorized Linear Poti 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 BrickletMotorizedLinearPoti::DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Motorized Linear Poti Bricklet dar.