PHP - XMC1400 Breakout Bricklet

This is the description of the PHP API bindings for the XMC1400 Breakout Bricklet. General information and technical specifications for the XMC1400 Breakout Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

GPIO

Download (ExampleGPIO.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletXMC1400Breakout;

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

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

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

// Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
for($i = 0; $i < 5; $i++) {
    sleep(1);
    $xb->setGPIOConfig(1, 0, BrickletXMC1400Breakout::GPIO_MODE_OUTPUT_PUSH_PULL, 0,
                       FALSE);
    sleep(1);
    $xb->setGPIOConfig(1, 0, BrickletXMC1400Breakout::GPIO_MODE_OUTPUT_PUSH_PULL, 0,
                       TRUE);
}

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

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletXMC1400Breakout(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $xmc1400_breakout = new BrickletXMC1400Breakout('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

void BrickletXMC1400Breakout::setGPIOConfig(int $port, int $pin, int $mode, int $input_hysteresis, bool $output_level)

Example for a setter function. The values are the values that can be given to the XMC_GPIO_Init function. See communication.c in the firmware.

The following constants are available for this function:

  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_TRISTATE = 0
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_PULL_DOWN = 1
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_PULL_UP = 2
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_SAMPLING = 3
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_INVERTED_TRISTATE = 4
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_INVERTED_PULL_DOWN = 5
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_INVERTED_PULL_UP = 6
  • BrickletXMC1400Breakout::GPIO_MODE_INPUT_INVERTED_SAMPLING = 7
  • BrickletXMC1400Breakout::GPIO_MODE_OUTPUT_PUSH_PULL = 8
  • BrickletXMC1400Breakout::GPIO_MODE_OUTPUT_OPEN_DRAIN = 9
  • BrickletXMC1400Breakout::GPIO_INPUT_HYSTERESIS_STANDARD = 0
  • BrickletXMC1400Breakout::GPIO_INPUT_HYSTERESIS_LARGE = 4
bool BrickletXMC1400Breakout::getGPIOInput(int $port, int $pin)

Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.

void BrickletXMC1400Breakout::setADCChannelConfig(int $channel, bool $enable)

Enables a ADC channel for the ADC driver example (adc.c/adc.h).

There are 8 ADC channels and they correspond to the following pins:

  • Channel 0: P2_6
  • Channel 1: P2_8
  • Channel 2: P2_9
  • Channel 3: P2_10
  • Channel 4: P2_11
  • Channel 5: P2_0
  • Channel 6: P2_1
  • Channel 7: P2_2
bool BrickletXMC1400Breakout::getADCChannelConfig(int $channel)

Returns the config for the given channel as set by setADCChannelConfig().

int BrickletXMC1400Breakout::getADCChannelValue(int $channel)

Returns the 12-bit value of the given ADC channel of the ADC driver example.

array BrickletXMC1400Breakout::getADCValues()

Returns the values for all 8 ADC channels of the adc driver example.

This example function also has a corresponding callback.

See setADCValuesCallbackConfiguration() and CALLBACK_ADC_VALUES callback.

int BrickletXMC1400Breakout::getCount()

Returns the value of the example count (see example.c).

This example function uses the "add_callback_value_function"-helper in the generator. The getter as well as the callback and callback configuration functions are auto-generated for the API as well as the firmware.

If you want to get the value periodically, it is recommended to use the CALLBACK_COUNT callback. You can set the callback configuration with setCountCallbackConfiguration().

Advanced Functions

array BrickletXMC1400Breakout::getAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

bool BrickletXMC1400Breakout::getResponseExpected(int $function_id)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • BrickletXMC1400Breakout::FUNCTION_SET_GPIO_CONFIG = 1
  • BrickletXMC1400Breakout::FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • BrickletXMC1400Breakout::FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • BrickletXMC1400Breakout::FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • BrickletXMC1400Breakout::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletXMC1400Breakout::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletXMC1400Breakout::FUNCTION_RESET = 243
  • BrickletXMC1400Breakout::FUNCTION_WRITE_UID = 248
void BrickletXMC1400Breakout::setResponseExpected(int $function_id, bool $response_expected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

  • BrickletXMC1400Breakout::FUNCTION_SET_GPIO_CONFIG = 1
  • BrickletXMC1400Breakout::FUNCTION_SET_ADC_CHANNEL_CONFIG = 3
  • BrickletXMC1400Breakout::FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION = 7
  • BrickletXMC1400Breakout::FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION = 11
  • BrickletXMC1400Breakout::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletXMC1400Breakout::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletXMC1400Breakout::FUNCTION_RESET = 243
  • BrickletXMC1400Breakout::FUNCTION_WRITE_UID = 248
void BrickletXMC1400Breakout::setResponseExpectedAll(bool $response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

array BrickletXMC1400Breakout::getSPITFPErrorCount()

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletXMC1400Breakout::setBootloaderMode(int $mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletXMC1400Breakout::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_OK = 0
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletXMC1400Breakout::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletXMC1400Breakout::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletXMC1400Breakout::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletXMC1400Breakout::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletXMC1400Breakout::setWriteFirmwarePointer(int $pointer)

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletXMC1400Breakout::writeFirmware(array $data)

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletXMC1400Breakout::setStatusLEDConfig(int $config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_OFF = 0
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_ON = 1
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletXMC1400Breakout::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_OFF = 0
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_ON = 1
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletXMC1400Breakout::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletXMC1400Breakout::getChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletXMC1400Breakout::reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

void BrickletXMC1400Breakout::writeUID(int $uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int BrickletXMC1400Breakout::readUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

array BrickletXMC1400Breakout::getIdentity()

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletXMC1400Breakout::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletXMC1400Breakout::setADCValuesCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms is the period with which the CALLBACK_ADC_VALUES callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

array BrickletXMC1400Breakout::getADCValuesCallbackConfiguration()

Returns the callback configuration as set by setADCValuesCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

void BrickletXMC1400Breakout::setCountCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_COUNT callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_COUNT callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletXMC1400Breakout::THRESHOLD_OPTION_OFF = 'x'
  • BrickletXMC1400Breakout::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletXMC1400Breakout::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletXMC1400Breakout::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletXMC1400Breakout::THRESHOLD_OPTION_GREATER = '>'
array BrickletXMC1400Breakout::getCountCallbackConfiguration()

Returns the callback configuration as set by setCountCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

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

$xmc1400_breakout->registerCallback(BrickletXMC1400Breakout::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

int BrickletXMC1400Breakout::CALLBACK_ADC_VALUES
<?php   void callback(array $values [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setADCValuesCallbackConfiguration().

The parameters are the same as getADCValues().

int BrickletXMC1400Breakout::CALLBACK_COUNT
<?php   void callback(int $count [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setCountCallbackConfiguration().

The parameter is the same as getCount().

Constants

int BrickletXMC1400Breakout::DEVICE_IDENTIFIER

This constant is used to identify a XMC1400 Breakout Bricklet.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletXMC1400Breakout::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a XMC1400 Breakout Bricklet.