Deutsch
English
Menu

Shell - ESP32 Ethernet Brick

This is the description of the Shell 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 Shell API bindings is part of their general description.

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)

  • 2: syntax error

  • 21: Python 2.5 or newer is required

  • 22: Python argparse module is missing

  • 23: socket error

  • 24: other exception

  • 25: invalid placeholder in format string

  • 26: authentication error

  • 201: timeout occurred

  • 209: invalid argument value

  • 210: function is not supported

  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call esp32-ethernet-brick [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> – Type: String
  • <function> – Type: String

The call command is used to call a function of the ESP32 Ethernet Brick. It can take several options:

  • --help shows help for the specific call command and exits

  • --list-functions shows a list of known functions of the ESP32 Ethernet Brick and exits

tinkerforge dispatch esp32-ethernet-brick [<option>..] <uid> <callback>
Parameters:
  • <uid> – Type: String
  • <callback> – Type: String

The dispatch command is used to dispatch a callback of the ESP32 Ethernet Brick. It can take several options:

  • --help shows help for the specific dispatch command and exits

  • --list-callbacks shows a list of known callbacks of the ESP32 Ethernet Brick and exits

tinkerforge call esp32-ethernet-brick <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> – Type: String
  • <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch esp32-ethernet-brick <uid> <callback> [<option>..]
Parameters:
  • <uid> – Type: String
  • <callback> – Type: String

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Advanced Functions

tinkerforge call esp32-ethernet-brick <uid> get-identity
Output:
  • uid – Type: String, Length: up to 8
  • connected-uid – Type: String, Length: up to 8
  • position – Type: Char, Range: [0 to 8]
  • hardware-version – Type: Int Array, 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]
  • firmware-version – Type: Int Array, 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]
  • device-identifier – Type: Int, Range: [0 to 216 - 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.