Software / API Bindings / Perl / API Reference and Examples / Bricks / ESP32 Ethernet Brick

Perl - ESP32 Ethernet Brick¶

This is the description of the Perl API bindings for the ESP32 Ethernet Brick. General information and technical specifications for the ESP32 Ethernet Brick are summarized in its hardware description.

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

API¶

Generally, every subroutine of the Perl bindings can report an error as Tinkerforge::Error object via croak(). The object has a get_code() and a get_message() subroutine. There are different error code:

Error->ALREADY_CONNECTED = 11
Error->NOT_CONNECTED = 12
Error->CONNECT_FAILED = 13
Error->INVALID_FUNCTION_ID = 21
Error->TIMEOUT = 31
Error->INVALID_PARAMETER = 41
Error->FUNCTION_NOT_SUPPORTED = 42
Error->UNKNOWN_ERROR = 43
Error->STREAM_OUT_OF_SYNC = 51
Error->INVALID_UID = 61
Error->NON_ASCII_CHAR_IN_SECRET = 71
Error->WRONG_DEVICE_TYPE = 81
Error->DEVICE_REPLACED = 82
Error->WRONG_RESPONSE_LENGTH = 83

All functions listed below are thread-safe.

Advanced Functions¶

BrickESP32Ethernet->get_identity()¶

Return Array:

Return Array:	0: $uid – Type: string, Length: up to 8 1: $connected_uid – Type: string, Length: up to 8 2: $position – Type: char, Range: ['0' to '8'] 3: \@hardware_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 4: \@firmware_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255] 5: $device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

0: $uid – Type: string, Length: up to 8
1: $connected_uid – Type: string, Length: up to 8
2: $position – Type: char, Range: ['0' to '8']
3: \@hardware_version – Type: [int, ...], Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

4: \@firmware_version – Type: [int, ...], Length: 3

0: $major – Type: int, Range: [0 to 255]
1: $minor – Type: int, Range: [0 to 255]
2: $revision – Type: int, Range: [0 to 255]

5: $device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

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

The position is the position in the stack from '0' (bottom) to '8' (top).

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickESP32Ethernet->get_api_version()¶

Return Array:	0: \@api_version – Type: [int, ...], Length: 3 0: $major – Type: int, Range: [0 to 255] 1: $minor – Type: int, Range: [0 to 255] 2: $revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickESP32Ethernet->get_response_expected($function_id)¶

Parameters:	$function_id – Type: int, Range: See constants
Returns:	$response_expected – Type: bool

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 set_response_expected(). 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

BrickESP32Ethernet->set_response_expected($function_id, $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool
Returns:	undef

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.

The following constants are available for this function:

For $function_id:

BrickESP32Ethernet->set_response_expected_all($response_expected)¶

Parameters:	$response_expected – Type: bool
Returns:	undef

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

Constants¶

BrickESP32Ethernet->DEVICE_IDENTIFIER¶

This constant is used to identify a ESP32 Ethernet Brick.

The get_identity() function and the IPConnection->CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickESP32Ethernet->DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a ESP32 Ethernet Brick.