MATLAB/Octave - Master Brick

This is the description of the MATLAB/Octave API bindings for the Master Brick. General information and technical specifications for the Master Brick are summarized in its hardware description.

An installation guide for the MATLAB/Octave API bindings is part of their general description.

Examples

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

Stack Status (MATLAB)

Download (matlab_example_stack_status.m)

 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
function matlab_example_stack_status()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickMaster;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your Master Brick

    ipcon = IPConnection(); % Create IP connection
    master = handle(BrickMaster(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current stack voltage
    stackVoltage = master.getStackVoltage();
    fprintf('Stack Voltage: %g V\n', stackVoltage/1000.0);

    % Get current stack current
    stackCurrent = master.getStackCurrent();
    fprintf('Stack Current: %g A\n', stackCurrent/1000.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Stack Status (Octave)

Download (octave_example_stack_status.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
function octave_example_stack_status()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your Master Brick

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    master = javaObject("com.tinkerforge.BrickMaster", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current stack voltage
    stackVoltage = master.getStackVoltage();
    fprintf("Stack Voltage: %g V\n", stackVoltage/1000.0);

    % Get current stack current
    stackCurrent = master.getStackCurrent();
    fprintf("Stack Current: %g A\n", stackCurrent/1000.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

API

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

public class BrickMaster(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickMaster;

master = BrickMaster('YOUR_DEVICE_UID', ipcon);

In Octave:

master = java_new("com.tinkerforge.BrickMaster", "YOUR_DEVICE_UID", ipcon);

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

public int getStackVoltage()

Returns the stack voltage in mV. The stack voltage is the voltage that is supplied via the stack, i.e. it is given by a Step-Down or Step-Up Power Supply.

public int getStackCurrent()

Returns the stack current in mA. The stack current is the current that is drawn via the stack, i.e. it is given by a Step-Down or Step-Up Power Supply.

Advanced Functions

public void setExtensionType(short extension, long exttype)

Writes the extension type to the EEPROM of a specified extension. The extension is either 0 or 1 (0 is the on the bottom, 1 is the one on top, if only one extension is present use 0).

Possible extension types:

Type Description
1 Chibi
2 RS485
3 WIFI
4 Ethernet
5 WIFI 2.0

The extension type is already set when bought and it can be set with the Brick Viewer, it is unlikely that you need this function.

The following constants are available for this function:

  • BrickMaster.EXTENSION_TYPE_CHIBI = 1
  • BrickMaster.EXTENSION_TYPE_RS485 = 2
  • BrickMaster.EXTENSION_TYPE_WIFI = 3
  • BrickMaster.EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster.EXTENSION_TYPE_WIFI2 = 5
public long getExtensionType(short extension)

Returns the type for a given extension as set by setExtensionType().

The following constants are available for this function:

  • BrickMaster.EXTENSION_TYPE_CHIBI = 1
  • BrickMaster.EXTENSION_TYPE_RS485 = 2
  • BrickMaster.EXTENSION_TYPE_WIFI = 3
  • BrickMaster.EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster.EXTENSION_TYPE_WIFI2 = 5
public boolean isChibiPresent()

Returns true if a Chibi Extension is available to be used by the Master Brick.

public void setChibiAddress(short address)

Sets the address (1-255) belonging to the Chibi Extension.

It is possible to set the address with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

public short getChibiAddress()

Returns the address as set by setChibiAddress().

public void setChibiMasterAddress(short address)

Sets the address (1-255) of the Chibi Master. This address is used if the Chibi Extension is used as slave (i.e. it does not have a USB connection).

It is possible to set the address with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

public short getChibiMasterAddress()

Returns the address as set by setChibiMasterAddress().

public void setChibiSlaveAddress(short num, short address)

Sets up to 254 slave addresses. Valid addresses are in range 1-255. 0 has a special meaning, it is used as list terminator and not allowed as normal slave address. The address numeration (via num parameter) has to be used ascending from 0. For example: If you use the Chibi Extension in Master mode (i.e. the stack has an USB connection) and you want to talk to three other Chibi stacks with the slave addresses 17, 23, and 42, you should call with (0, 17), (1, 23), (2, 42) and (3, 0). The last call with (3, 0) is a list terminator and indicates that the Chibi slave address list contains 3 addresses in this case.

It is possible to set the addresses with the Brick Viewer, that will take care of correct address numeration and list termination.

The slave addresses will be saved in the EEPROM of the Chibi Extension, they don't have to be set on every startup.

public short getChibiSlaveAddress(short num)

Returns the slave address for a given num as set by setChibiSlaveAddress().

public short getChibiSignalStrength()

Returns the signal strength in dBm. The signal strength updates every time a packet is received.

public BrickMaster.ChibiErrorLog getChibiErrorLog()

Returns underrun, CRC error, no ACK and overflow error counts of the Chibi communication. If these errors start rising, it is likely that either the distance between two Chibi stacks is becoming too big or there are interferences.

The returned object has the public member variables int underrun, int crcError, int noAck and int overflow.

public void setChibiFrequency(short frequency)

Sets the Chibi frequency range for the Chibi Extension. Possible values are:

Type Description
0 OQPSK 868MHz (Europe)
1 OQPSK 915MHz (US)
2 OQPSK 780MHz (China)
3 BPSK40 915MHz

It is possible to set the frequency with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

The following constants are available for this function:

  • BrickMaster.CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
  • BrickMaster.CHIBI_FREQUENCY_BPSK40_915_MHZ = 3
public short getChibiFrequency()

Returns the frequency value as set by setChibiFrequency().

The following constants are available for this function:

  • BrickMaster.CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
  • BrickMaster.CHIBI_FREQUENCY_BPSK40_915_MHZ = 3
public void setChibiChannel(short channel)

Sets the channel used by the Chibi Extension. Possible channels are different for different frequencies:

Frequency Possible Channels
OQPSK 868MHz (Europe) 0
OQPSK 915MHz (US) 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
OQPSK 780MHz (China) 0, 1, 2, 3
BPSK40 915MHz 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

It is possible to set the channel with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

public short getChibiChannel()

Returns the channel as set by setChibiChannel().

public boolean isRS485Present()

Returns true if a RS485 Extension is available to be used by the Master Brick.

public void setRS485Address(short address)

Sets the address (0-255) belonging to the RS485 Extension.

Set to 0 if the RS485 Extension should be the RS485 Master (i.e. connected to a PC via USB).

It is possible to set the address with the Brick Viewer and it will be saved in the EEPROM of the RS485 Extension, it does not have to be set on every startup.

public short getRS485Address()

Returns the address as set by setRS485Address().

public void setRS485SlaveAddress(short num, short address)

Sets up to 255 slave addresses. Valid addresses are in range 1-255. 0 has a special meaning, it is used as list terminator and not allowed as normal slave address. The address numeration (via num parameter) has to be used ascending from 0. For example: If you use the RS485 Extension in Master mode (i.e. the stack has an USB connection) and you want to talk to three other RS485 stacks with the addresses 17, 23, and 42, you should call with (0, 17), (1, 23), (2, 42) and (3, 0). The last call with (3, 0) is a list terminator and indicates that the RS485 slave address list contains 3 addresses in this case.

It is possible to set the addresses with the Brick Viewer, that will take care of correct address numeration and list termination.

The slave addresses will be saved in the EEPROM of the Chibi Extension, they don't have to be set on every startup.

public short getRS485SlaveAddress(short num)

Returns the slave address for a given num as set by setRS485SlaveAddress().

public int getRS485ErrorLog()

Returns CRC error counts of the RS485 communication. If this counter starts rising, it is likely that the distance between the RS485 nodes is too big or there is some kind of interference.

public void setRS485Configuration(long speed, char parity, short stopbits)

Sets the configuration of the RS485 Extension. Speed is given in baud. The Master Brick will try to match the given baud rate as exactly as possible. The maximum recommended baud rate is 2000000 (2Mbit/s). Possible values for parity are 'n' (none), 'e' (even) and 'o' (odd). Possible values for stop bits are 1 and 2.

If your RS485 is unstable (lost messages etc.), the first thing you should try is to decrease the speed. On very large bus (e.g. 1km), you probably should use a value in the range of 100000 (100kbit/s).

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

The following constants are available for this function:

  • BrickMaster.RS485_PARITY_NONE = 'n'
  • BrickMaster.RS485_PARITY_EVEN = 'e'
  • BrickMaster.RS485_PARITY_ODD = 'o'
public BrickMaster.RS485Configuration getRS485Configuration()

Returns the configuration as set by setRS485Configuration().

The following constants are available for this function:

  • BrickMaster.RS485_PARITY_NONE = 'n'
  • BrickMaster.RS485_PARITY_EVEN = 'e'
  • BrickMaster.RS485_PARITY_ODD = 'o'

The returned object has the public member variables long speed, char parity and short stopbits.

public boolean isWifiPresent()

Returns true if a WIFI Extension is available to be used by the Master Brick.

public void setWifiConfiguration(String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway, int port)

Sets the configuration of the WIFI Extension. The ssid can have a max length of 32 characters. Possible values for connection are:

Value Description
0 DHCP
1 Static IP
2 Access Point: DHCP
3 Access Point: Static IP
4 Ad Hoc: DHCP
5 Ad Hoc: Static IP

If you set connection to one of the static IP options then you have to supply ip, subnet_mask and gateway as an array of size 4 (first element of the array is the least significant byte of the address). If connection is set to one of the DHCP options then ip, subnet_mask and gateway are ignored, you can set them to 0.

The last parameter is the port that your program will connect to. The default port, that is used by brickd, is 4223.

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the WIFI configuration.

The following constants are available for this function:

  • BrickMaster.WIFI_CONNECTION_DHCP = 0
  • BrickMaster.WIFI_CONNECTION_STATIC_IP = 1
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_DHCP = 2
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_STATIC_IP = 3
  • BrickMaster.WIFI_CONNECTION_AD_HOC_DHCP = 4
  • BrickMaster.WIFI_CONNECTION_AD_HOC_STATIC_IP = 5
public BrickMaster.WifiConfiguration getWifiConfiguration()

Returns the configuration as set by setWifiConfiguration().

The following constants are available for this function:

  • BrickMaster.WIFI_CONNECTION_DHCP = 0
  • BrickMaster.WIFI_CONNECTION_STATIC_IP = 1
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_DHCP = 2
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_STATIC_IP = 3
  • BrickMaster.WIFI_CONNECTION_AD_HOC_DHCP = 4
  • BrickMaster.WIFI_CONNECTION_AD_HOC_STATIC_IP = 5

The returned object has the public member variables String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway and int port.

public void setWifiEncryption(short encryption, String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength, int privateKeyLength)

Sets the encryption of the WIFI Extension. The first parameter is the type of the encryption. Possible values are:

Value Description
0 WPA/WPA2
1 WPA Enterprise (EAP-FAST, EAP-TLS, EAP-TTLS, PEAP)
2 WEP
3 No Encryption

The key has a max length of 50 characters and is used if encryption is set to 0 or 2 (WPA/WPA2 or WEP). Otherwise the value is ignored.

For WPA/WPA2 the key has to be at least 8 characters long. If you want to set a key with more than 50 characters, see setLongWifiKey().

For WEP the key has to be either 10 or 26 hexadecimal digits long. It is possible to set the WEP key_index (1-4). If you don't know your key_index, it is likely 1.

If you choose WPA Enterprise as encryption, you have to set eap_options and the length of the certificates (for other encryption types these parameters are ignored). The certificate length are given in byte and the certificates themselves can be set with setWifiCertificate(). eap_options consist of the outer authentication (bits 1-2), inner authentication (bit 3) and certificate type (bits 4-5):

Option Bits Description
outer authentication 1-2 0=EAP-FAST, 1=EAP-TLS, 2=EAP-TTLS, 3=EAP-PEAP
inner authentication 3 0=EAP-MSCHAP, 1=EAP-GTC
certificate type 4-5 0=CA Certificate, 1=Client Certificate, 2=Private Key

Example for EAP-TTLS + EAP-GTC + Private Key: option = 2 | (1 << 2) | (2 << 3).

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the Wi-Fi encryption.

The following constants are available for this function:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16
public BrickMaster.WifiEncryption getWifiEncryption()

Returns the encryption as set by setWifiEncryption().

Note

Since Master Brick Firmware version 2.4.4 the key is not returned anymore.

The following constants are available for this function:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16

The returned object has the public member variables short encryption, String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength and int privateKeyLength.

public BrickMaster.WifiStatus getWifiStatus()

Returns the status of the WIFI Extension. The state is updated automatically, all of the other parameters are updated on startup and every time refreshWifiStatus() is called.

Possible states are:

State Description
0 Disassociated
1 Associated
2 Associating
3 Error
255 Not initialized yet

The following constants are available for this function:

  • BrickMaster.WIFI_STATE_DISASSOCIATED = 0
  • BrickMaster.WIFI_STATE_ASSOCIATED = 1
  • BrickMaster.WIFI_STATE_ASSOCIATING = 2
  • BrickMaster.WIFI_STATE_ERROR = 3
  • BrickMaster.WIFI_STATE_NOT_INITIALIZED_YET = 255

The returned object has the public member variables short[] macAddress, short[] bssid, short channel, short rssi, short[] ip, short[] subnetMask, short[] gateway, long rxCount, long txCount and short state.

public void refreshWifiStatus()

Refreshes the Wi-Fi status (see getWifiStatus()). To read the status of the Wi-Fi module, the Master Brick has to change from data mode to command mode and back. This transaction and the readout itself is unfortunately time consuming. This means, that it might take some ms until the stack with attached WIFI Extension reacts again after this function is called.

public void setWifiCertificate(int index, short[] data, short dataLength)

This function is used to set the certificate as well as password and username for WPA Enterprise. To set the username use index 0xFFFF, to set the password use index 0xFFFE. The max length of username and password is 32.

The certificate is written in chunks of size 32 and the index is used as the index of the chunk. data_length should nearly always be 32. Only the last chunk can have a length that is not equal to 32.

The starting index of the CA Certificate is 0, of the Client Certificate 10000 and for the Private Key 20000. Maximum sizes are 1312, 1312 and 4320 byte respectively.

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after uploading the certificate.

It is recommended to use the Brick Viewer to set the certificate, username and password.

public BrickMaster.WifiCertificate getWifiCertificate(int index)

Returns the certificate for a given index as set by setWifiCertificate().

The returned object has the public member variables short[] data and short dataLength.

public void setWifiPowerMode(short mode)

Sets the power mode of the WIFI Extension. Possible modes are:

Mode Description
0 Full Speed (high power consumption, high throughput)
1 Low Power (low power consumption, low throughput)

The default value is 0 (Full Speed).

The following constants are available for this function:

  • BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
public short getWifiPowerMode()

Returns the power mode as set by setWifiPowerMode().

The following constants are available for this function:

  • BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
public BrickMaster.WifiBufferInfo getWifiBufferInfo()

Returns informations about the Wi-Fi receive buffer. The Wi-Fi receive buffer has a max size of 1500 byte and if data is transfered too fast, it might overflow.

The return values are the number of overflows, the low watermark (i.e. the smallest number of bytes that were free in the buffer) and the bytes that are currently used.

You should always try to keep the buffer empty, otherwise you will have a permanent latency. A good rule of thumb is, that you can transfer 1000 messages per second without problems.

Try to not send more then 50 messages at a time without any kind of break between them.

The returned object has the public member variables long overflow, int lowWatermark and int used.

public void setWifiRegulatoryDomain(short domain)

Sets the regulatory domain of the WIFI Extension. Possible domains are:

Domain Description
0 FCC: Channel 1-11 (N/S America, Australia, New Zealand)
1 ETSI: Channel 1-13 (Europe, Middle East, Africa)
2 TELEC: Channel 1-14 (Japan)

The default value is 1 (ETSI).

The following constants are available for this function:

  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2
public short getWifiRegulatoryDomain()

Returns the regulatory domain as set by setWifiRegulatoryDomain().

The following constants are available for this function:

  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2
public int getUSBVoltage()

Returns the USB voltage in mV. Does not work with hardware version 2.1.

public void setLongWifiKey(String key)

Sets a long Wi-Fi key (up to 63 chars, at least 8 chars) for WPA encryption. This key will be used if the key in setWifiEncryption() is set to "-". In the old protocol, a payload of size 63 was not possible, so the maximum key length was 50 chars.

With the new protocol this is possible, since we didn't want to break API, this function was added additionally.

New in version 2.0.2 (Firmware).

public String getLongWifiKey()

Returns the encryption key as set by setLongWifiKey().

Note

Since Master Brick firmware version 2.4.4 the key is not returned anymore.

New in version 2.0.2 (Firmware).

public void setWifiHostname(String hostname)

Sets the hostname of the WIFI Extension. The hostname will be displayed by access points as the hostname in the DHCP clients table.

Setting an empty String will restore the default hostname.

New in version 2.0.5 (Firmware).

public String getWifiHostname()

Returns the hostname as set by setWifiHostname().

An empty String means, that the default hostname is used.

New in version 2.0.5 (Firmware).

public boolean isEthernetPresent()

Returns true if a Ethernet Extension is available to be used by the Master Brick.

New in version 2.1.0 (Firmware).

public void setEthernetConfiguration(short connection, short[] ip, short[] subnetMask, short[] gateway, int port)

Sets the configuration of the Ethernet Extension. Possible values for connection are:

Value Description
0 DHCP
1 Static IP

If you set connection to static IP options then you have to supply ip, subnet_mask and gateway as an array of size 4 (first element of the array is the least significant byte of the address). If connection is set to the DHCP options then ip, subnet_mask and gateway are ignored, you can set them to 0.

The last parameter is the port that your program will connect to. The default port, that is used by brickd, is 4223.

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the Ethernet configuration.

The following constants are available for this function:

  • BrickMaster.ETHERNET_CONNECTION_DHCP = 0
  • BrickMaster.ETHERNET_CONNECTION_STATIC_IP = 1

New in version 2.1.0 (Firmware).

public BrickMaster.EthernetConfiguration getEthernetConfiguration()

Returns the configuration as set by setEthernetConfiguration().

The following constants are available for this function:

  • BrickMaster.ETHERNET_CONNECTION_DHCP = 0
  • BrickMaster.ETHERNET_CONNECTION_STATIC_IP = 1

New in version 2.1.0 (Firmware).

The returned object has the public member variables short connection, short[] ip, short[] subnetMask, short[] gateway and int port.

public BrickMaster.EthernetStatus getEthernetStatus()

Returns the status of the Ethernet Extension.

mac_address, ip, subnet_mask and gateway are given as an array. The first element of the array is the least significant byte of the address.

rx_count and tx_count are the number of bytes that have been received/send since last restart.

hostname is the currently used hostname.

New in version 2.1.0 (Firmware).

The returned object has the public member variables short[] macAddress, short[] ip, short[] subnetMask, short[] gateway, long rxCount, long txCount and String hostname.

public void setEthernetHostname(String hostname)

Sets the hostname of the Ethernet Extension. The hostname will be displayed by access points as the hostname in the DHCP clients table.

Setting an empty String will restore the default hostname.

The current hostname can be discovered with getEthernetStatus().

New in version 2.1.0 (Firmware).

public void setEthernetMACAddress(short[] macAddress)

Sets the MAC address of the Ethernet Extension. The Ethernet Extension should come configured with a valid MAC address, that is also written on a sticker of the extension itself.

The MAC address can be read out again with getEthernetStatus().

New in version 2.1.0 (Firmware).

public void setEthernetWebsocketConfiguration(short sockets, int port)

Sets the Ethernet WebSocket configuration. The first parameter sets the number of socket connections that are reserved for WebSockets. The range is 0-7. The connections are shared with the plain sockets. Example: If you set the connections to 3, there will be 3 WebSocket and 4 plain socket connections available.

The second parameter is the port for the WebSocket connections. The port can not be the same as the port for the plain socket connections.

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the Ethernet configuration.

The default values are 3 for the socket connections and 4280 for the port.

New in version 2.2.0 (Firmware).

public BrickMaster.EthernetWebsocketConfiguration getEthernetWebsocketConfiguration()

Returns the configuration as set by setEthernetConfiguration().

New in version 2.2.0 (Firmware).

The returned object has the public member variables short sockets and int port.

public void setEthernetAuthenticationSecret(String secret)

Sets the Ethernet authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication.

See the authentication tutorial for more information.

The secret is stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the Ethernet authentication secret.

The default value is an empty string (authentication disabled).

New in version 2.2.0 (Firmware).

public String getEthernetAuthenticationSecret()

Returns the authentication secret as set by setEthernetAuthenticationSecret().

New in version 2.2.0 (Firmware).

public void setWifiAuthenticationSecret(String secret)

Sets the WIFI authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication.

See the authentication tutorial for more information.

The secret is stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

It is recommended to use the Brick Viewer to set the WIFI authentication secret.

The default value is an empty string (authentication disabled).

New in version 2.2.0 (Firmware).

public String getWifiAuthenticationSecret()

Returns the authentication secret as set by setWifiAuthenticationSecret().

New in version 2.2.0 (Firmware).

public short getConnectionType()

Returns the type of the connection over which this function was called.

The following constants are available for this function:

  • BrickMaster.CONNECTION_TYPE_NONE = 0
  • BrickMaster.CONNECTION_TYPE_USB = 1
  • BrickMaster.CONNECTION_TYPE_SPI_STACK = 2
  • BrickMaster.CONNECTION_TYPE_CHIBI = 3
  • BrickMaster.CONNECTION_TYPE_RS485 = 4
  • BrickMaster.CONNECTION_TYPE_WIFI = 5
  • BrickMaster.CONNECTION_TYPE_ETHERNET = 6
  • BrickMaster.CONNECTION_TYPE_WIFI2 = 7

New in version 2.4.0 (Firmware).

public boolean isWifi2Present()

Returns true if a WIFI Extension 2.0 is available to be used by the Master Brick.

New in version 2.4.0 (Firmware).

public byte startWifi2Bootloader()

Starts the bootloader of the WIFI Extension 2.0. Returns 0 on success. Afterwards the writeWifi2SerialPort() and readWifi2SerialPort() functions can be used to communicate with the bootloader to flash a new firmware.

The bootloader should only be started over a USB connection. It cannot be started over a WIFI2 connection, see the getConnectionType() function.

It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public byte writeWifi2SerialPort(short[] data, short length)

Writes up to 60 bytes (number of bytes to be written specified by length) to the serial port of the bootloader of the WIFI Extension 2.0. Returns 0 on success.

Before this function can be used the bootloader has to be started using the startWifi2Bootloader() function.

It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public BrickMaster.ReadWifi2SerialPort readWifi2SerialPort(short length)

Reads up to 60 bytes (number of bytes to be read specified by length) from the serial port of the bootloader of the WIFI Extension 2.0. Returns the number of actually read bytes.

Before this function can be used the bootloader has to be started using the startWifi2Bootloader() function.

It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

The returned object has the public member variables short[] data and short result.

public void setWifi2AuthenticationSecret(String secret)

Sets the WIFI authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication. The default value is an empty string (authentication disabled).

See the authentication tutorial for more information.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public String getWifi2AuthenticationSecret()

Returns the WIFI authentication secret as set by setWifi2AuthenticationSecret().

New in version 2.4.0 (Firmware).

public void setWifi2Configuration(int port, int websocketPort, int websitePort, short phyMode, short sleepMode, short website)

Sets the general configuration of the WIFI Extension 2.0.

The port parameter sets the port number that your programm will connect to. The default value is 4223.

The websocket_port parameter sets the WebSocket port number that your JavaScript programm will connect to. The default value is 4280.

The website_port parameter sets the port number for the website of the WIFI Extension 2.0. The default value is 80.

The phy_mode parameter sets the specific wireless network mode to be used. Possible values are B, G and N. The default value is G.

The sleep_mode parameter is currently unused.

The website parameter is used to enable or disable the web interface of the WIFI Extension 2.0, which is available from firmware version 2.0.1. Note that, for firmware version 2.0.3 and older, to disable the the web interface the website_port parameter must be set to 1 and greater than 1 to enable the web interface. For firmware version 2.0.4 and later, setting this parameter to 1 will enable the web interface and setting it to 0 will disable the web interface.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

The following constants are available for this function:

  • BrickMaster.WIFI2_PHY_MODE_B = 0
  • BrickMaster.WIFI2_PHY_MODE_G = 1
  • BrickMaster.WIFI2_PHY_MODE_N = 2

New in version 2.4.0 (Firmware).

public BrickMaster.Wifi2Configuration getWifi2Configuration()

Returns the general configuration as set by setWifi2Configuration().

The following constants are available for this function:

  • BrickMaster.WIFI2_PHY_MODE_B = 0
  • BrickMaster.WIFI2_PHY_MODE_G = 1
  • BrickMaster.WIFI2_PHY_MODE_N = 2

New in version 2.4.0 (Firmware).

The returned object has the public member variables int port, int websocketPort, int websitePort, short phyMode, short sleepMode and short website.

public BrickMaster.Wifi2Status getWifi2Status()

Returns the client and access point status of the WIFI Extension 2.0.

The following constants are available for this function:

  • BrickMaster.WIFI2_CLIENT_STATUS_IDLE = 0
  • BrickMaster.WIFI2_CLIENT_STATUS_CONNECTING = 1
  • BrickMaster.WIFI2_CLIENT_STATUS_WRONG_PASSWORD = 2
  • BrickMaster.WIFI2_CLIENT_STATUS_NO_AP_FOUND = 3
  • BrickMaster.WIFI2_CLIENT_STATUS_CONNECT_FAILED = 4
  • BrickMaster.WIFI2_CLIENT_STATUS_GOT_IP = 5
  • BrickMaster.WIFI2_CLIENT_STATUS_UNKNOWN = 255

New in version 2.4.0 (Firmware).

The returned object has the public member variables boolean clientEnabled, short clientStatus, short[] clientIP, short[] clientSubnetMask, short[] clientGateway, short[] clientMACAddress, long clientRXCount, long clientTXCount, byte clientRSSI, boolean apEnabled, short[] apIP, short[] apSubnetMask, short[] apGateway, short[] apMACAddress, long apRXCount, long apTXCount and short apConnectedCount.

public void setWifi2ClientConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress, short[] bssid)

Sets the client specific configuration of the WIFI Extension 2.0.

The enable parameter enables or disables the client part of the WIFI Extension 2.0. The default value is true.

The ssid parameter sets the SSID (up to 32 characters) of the access point to connect to.

If the ip parameter is set to all zero then subnet_mask and gateway parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP.

If the mac_address parameter is set to all zero then the factory MAC address is used. Otherwise this parameter can be used to set a custom MAC address.

If the bssid parameter is set to all zero then WIFI Extension 2.0 will connect to any access point that matches the configured SSID. Otherwise this parameter can be used to make the WIFI Extension 2.0 only connect to an access point if SSID and BSSID match.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public BrickMaster.Wifi2ClientConfiguration getWifi2ClientConfiguration()

Returns the client configuration as set by setWifi2ClientConfiguration().

New in version 2.4.0 (Firmware).

The returned object has the public member variables boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress and short[] bssid.

public void setWifi2ClientHostname(String hostname)

Sets the client hostname (up to 32 characters) of the WIFI Extension 2.0. The hostname will be displayed by access points as the hostname in the DHCP clients table.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public String getWifi2ClientHostname()

Returns the client hostname as set by setWifi2ClientHostname().

New in version 2.4.0 (Firmware).

public void setWifi2ClientPassword(String password)

Sets the client password (up to 63 chars) for WPA/WPA2 encryption.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public String getWifi2ClientPassword()

Returns the client password as set by setWifi2ClientPassword().

Note

Since WIFI Extension 2.0 firmware version 2.1.3 the password is not returned anymore.

New in version 2.4.0 (Firmware).

public void setWifi2APConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel, short[] macAddress)

Sets the access point specific configuration of the WIFI Extension 2.0.

The enable parameter enables or disables the access point part of the WIFI Extension 2.0. The default value is true.

The ssid parameter sets the SSID (up to 32 characters) of the access point.

If the ip parameter is set to all zero then subnet_mask and gateway parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP.

The encryption parameter sets the encryption mode to be used. Possible values are Open (no encryption), WEP or WPA/WPA2 PSK. The default value is WPA/WPA2 PSK. Use the setWifi2APPassword() function to set the encryption password.

The hidden parameter makes the access point hide or show its SSID. The default value is false.

The channel parameter sets the channel (1 to 13) of the access point. The default value is 1.

If the mac_address parameter is set to all zero then the factory MAC address is used. Otherwise this parameter can be used to set a custom MAC address.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

The following constants are available for this function:

  • BrickMaster.WIFI2_AP_ENCRYPTION_OPEN = 0
  • BrickMaster.WIFI2_AP_ENCRYPTION_WEP = 1
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA_PSK = 2
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA2_PSK = 3
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK = 4

New in version 2.4.0 (Firmware).

public BrickMaster.Wifi2APConfiguration getWifi2APConfiguration()

Returns the access point configuration as set by setWifi2APConfiguration().

The following constants are available for this function:

  • BrickMaster.WIFI2_AP_ENCRYPTION_OPEN = 0
  • BrickMaster.WIFI2_AP_ENCRYPTION_WEP = 1
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA_PSK = 2
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA2_PSK = 3
  • BrickMaster.WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK = 4

New in version 2.4.0 (Firmware).

The returned object has the public member variables boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel and short[] macAddress.

public void setWifi2APPassword(String password)

Sets the access point password (up to 63 chars) for the configured encryption mode, see setWifi2APConfiguration().

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.0 (Firmware).

public String getWifi2APPassword()

Returns the access point password as set by setWifi2APPassword().

Note

Since WIFI Extension 2.0 firmware version 2.1.3 the password is not returned anymore.

New in version 2.4.0 (Firmware).

public short saveWifi2Configuration()

All configuration functions for the WIFI Extension 2.0 do not change the values permanently. After configuration this function has to be called to permanently store the values.

The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.

New in version 2.4.0 (Firmware).

public short[] getWifi2FirmwareVersion()

Returns the current version of the WIFI Extension 2.0 firmware (major, minor, revision).

New in version 2.4.0 (Firmware).

public void enableWifi2StatusLED()

Turns the green status LED of the WIFI Extension 2.0 on.

New in version 2.4.0 (Firmware).

public void disableWifi2StatusLED()

Turns the green status LED of the WIFI Extension 2.0 off.

New in version 2.4.0 (Firmware).

public boolean isWifi2StatusLEDEnabled()

Returns true if the green status LED of the WIFI Extension 2.0 is turned on.

New in version 2.4.0 (Firmware).

public void setWifi2MeshConfiguration(boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, String groupSSIDPrefix, short[] gatewayIP, int gatewayPort)

Requires WIFI Extension 2.0 firmware 2.1.0.

Sets the mesh specific configuration of the WIFI Extension 2.0.

The enable parameter enables or disables the mesh part of the WIFI Extension 2.0. The default value is false. The mesh part cannot be enabled together with the client and access-point part.

If the root_ip parameter is set to all zero then root_subnet_mask and root_gateway parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP.

If the router_bssid parameter is set to all zero then the information is taken from Wi-Fi scan when connecting the SSID as set by setWifi2MeshRouterSSID(). This only works if the the SSID is not hidden. In case the router has hidden SSID this parameter must be specified, otherwise the node will not be able to reach the mesh router.

The group_id and the group_ssid_prefix parameters identifies a particular mesh network and nodes configured with same group_id and the group_ssid_prefix are considered to be in the same mesh network.

The gateway_ip and the gateway_port parameters specifies the location of the brickd that supports mesh feature.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

public BrickMaster.Wifi2MeshConfiguration getWifi2MeshConfiguration()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh configuration as set by setWifi2MeshConfiguration().

New in version 2.4.2 (Firmware).

The returned object has the public member variables boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, String groupSSIDPrefix, short[] gatewayIP and int gatewayPort.

public void setWifi2MeshRouterSSID(String ssid)

Requires WIFI Extension 2.0 firmware 2.1.0.

Sets the mesh router SSID of the WIFI Extension 2.0. It is used to specify the mesh router to connect to.

Note that even though in the argument of this function a 32 characters long SSID is allowed, in practice valid SSID should have a maximum of 31 characters. This is due to a bug in the mesh library that we use in the firmware of the extension.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

public String getWifi2MeshRouterSSID()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router SSID as set by setWifi2MeshRouterSSID().

New in version 2.4.2 (Firmware).

public void setWifi2MeshRouterPassword(String password)

Requires WIFI Extension 2.0 firmware 2.1.0.

Sets the mesh router password (up to 64 characters) for WPA/WPA2 encryption. The password will be used to connect to the mesh router.

To apply configuration changes to the WIFI Extension 2.0 the saveWifi2Configuration() function has to be called and the Master Brick has to be restarted afterwards.

It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

public String getWifi2MeshRouterPassword()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router password as set by setWifi2MeshRouterPassword().

New in version 2.4.2 (Firmware).

public BrickMaster.Wifi2MeshCommonStatus getWifi2MeshCommonStatus()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the common mesh status of the WIFI Extension 2.0.

The following constants are available for this function:

  • BrickMaster.WIFI2_MESH_STATUS_DISABLED = 0
  • BrickMaster.WIFI2_MESH_STATUS_WIFI_CONNECTING = 1
  • BrickMaster.WIFI2_MESH_STATUS_GOT_IP = 2
  • BrickMaster.WIFI2_MESH_STATUS_MESH_LOCAL = 3
  • BrickMaster.WIFI2_MESH_STATUS_MESH_ONLINE = 4
  • BrickMaster.WIFI2_MESH_STATUS_AP_AVAILABLE = 5
  • BrickMaster.WIFI2_MESH_STATUS_AP_SETUP = 6
  • BrickMaster.WIFI2_MESH_STATUS_LEAF_AVAILABLE = 7

New in version 2.4.2 (Firmware).

The returned object has the public member variables short status, boolean rootNode, boolean rootCandidate, int connectedNodes, long rxCount and long txCount.

public BrickMaster.Wifi2MeshClientStatus getWifi2MeshClientStatus()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh client status of the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

The returned object has the public member variables String hostname, short[] ip, short[] subnetMask, short[] gateway and short[] macAddress.

public BrickMaster.Wifi2MeshAPStatus getWifi2MeshAPStatus()

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh AP status of the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

The returned object has the public member variables String ssid, short[] ip, short[] subnetMask, short[] gateway and short[] macAddress.

public short[] 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.

public boolean getResponseExpected(short functionId)

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.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(short functionId, boolean responseExpected)

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 function ID constants are available for this function:

  • BrickMaster.FUNCTION_SET_EXTENSION_TYPE = 3
  • BrickMaster.FUNCTION_SET_CHIBI_ADDRESS = 6
  • BrickMaster.FUNCTION_SET_CHIBI_MASTER_ADDRESS = 8
  • BrickMaster.FUNCTION_SET_CHIBI_SLAVE_ADDRESS = 10
  • BrickMaster.FUNCTION_SET_CHIBI_FREQUENCY = 14
  • BrickMaster.FUNCTION_SET_CHIBI_CHANNEL = 16
  • BrickMaster.FUNCTION_SET_RS485_ADDRESS = 19
  • BrickMaster.FUNCTION_SET_RS485_SLAVE_ADDRESS = 21
  • BrickMaster.FUNCTION_SET_RS485_CONFIGURATION = 24
  • BrickMaster.FUNCTION_SET_WIFI_CONFIGURATION = 27
  • BrickMaster.FUNCTION_SET_WIFI_ENCRYPTION = 29
  • BrickMaster.FUNCTION_REFRESH_WIFI_STATUS = 32
  • BrickMaster.FUNCTION_SET_WIFI_CERTIFICATE = 33
  • BrickMaster.FUNCTION_SET_WIFI_POWER_MODE = 35
  • BrickMaster.FUNCTION_SET_WIFI_REGULATORY_DOMAIN = 38
  • BrickMaster.FUNCTION_SET_LONG_WIFI_KEY = 41
  • BrickMaster.FUNCTION_SET_WIFI_HOSTNAME = 43
  • BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD = 45
  • BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD = 47
  • BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD = 49
  • BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD = 51
  • BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD = 53
  • BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD = 55
  • BrickMaster.FUNCTION_SET_DEBOUNCE_PERIOD = 57
  • BrickMaster.FUNCTION_SET_ETHERNET_CONFIGURATION = 66
  • BrickMaster.FUNCTION_SET_ETHERNET_HOSTNAME = 69
  • BrickMaster.FUNCTION_SET_ETHERNET_MAC_ADDRESS = 70
  • BrickMaster.FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION = 71
  • BrickMaster.FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET = 73
  • BrickMaster.FUNCTION_SET_WIFI_AUTHENTICATION_SECRET = 75
  • BrickMaster.FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET = 82
  • BrickMaster.FUNCTION_SET_WIFI2_CONFIGURATION = 84
  • BrickMaster.FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION = 87
  • BrickMaster.FUNCTION_SET_WIFI2_CLIENT_HOSTNAME = 89
  • BrickMaster.FUNCTION_SET_WIFI2_CLIENT_PASSWORD = 91
  • BrickMaster.FUNCTION_SET_WIFI2_AP_CONFIGURATION = 93
  • BrickMaster.FUNCTION_SET_WIFI2_AP_PASSWORD = 95
  • BrickMaster.FUNCTION_ENABLE_WIFI2_STATUS_LED = 99
  • BrickMaster.FUNCTION_DISABLE_WIFI2_STATUS_LED = 100
  • BrickMaster.FUNCTION_SET_WIFI2_MESH_CONFIGURATION = 102
  • BrickMaster.FUNCTION_SET_WIFI2_MESH_ROUTER_SSID = 104
  • BrickMaster.FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD = 106
  • BrickMaster.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickMaster.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickMaster.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickMaster.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickMaster.FUNCTION_RESET = 243
public void setResponseExpectedAll(boolean responseExpected)

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

public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Brick will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate will be increased exponentially if lots of data is send/received and decreased linearly if little data is send/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

The minimum dynamic baudrate has a value range of 400000 to 2000000 baud.

By default dynamic baudrate is enabled and the minimum dynamic baudrate is 400000.

New in version 2.4.6 (Firmware).

public BrickMaster.SPITFPBaudrateConfig getSPITFPBaudrateConfig()

Returns the baudrate config, see setSPITFPBaudrateConfig().

New in version 2.4.6 (Firmware).

The returned object has the public member variables boolean enableDynamicBaudrate and long minimumDynamicBaudrate.

public long getSendTimeoutCount(short communicationMethod)

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

The following constants are available for this function:

  • BrickMaster.COMMUNICATION_METHOD_NONE = 0
  • BrickMaster.COMMUNICATION_METHOD_USB = 1
  • BrickMaster.COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickMaster.COMMUNICATION_METHOD_CHIBI = 3
  • BrickMaster.COMMUNICATION_METHOD_RS485 = 4
  • BrickMaster.COMMUNICATION_METHOD_WIFI = 5
  • BrickMaster.COMMUNICATION_METHOD_ETHERNET = 6
  • BrickMaster.COMMUNICATION_METHOD_WIFI_V2 = 7

New in version 2.4.3 (Firmware).

public void setSPITFPBaudrate(char brickletPort, long baudrate)

Sets the baudrate for a specific Bricklet port ('a' - 'd'). The baudrate can be in the range 400000 to 2000000.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in you applications we recommend to not change the baudrate.

The default baudrate for all ports is 1400000.

New in version 2.4.3 (Firmware).

public long getSPITFPBaudrate(char brickletPort)

Returns the baudrate for a given Bricklet port, see setSPITFPBaudrate().

New in version 2.4.3 (Firmware).

public BrickMaster.SPITFPErrorCount getSPITFPErrorCount(char brickletPort)

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 Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.4.3 (Firmware).

The returned object has the public member variables long errorCountACKChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public void enableStatusLED()

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

New in version 2.3.2 (Firmware).

public void disableStatusLED()

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

New in version 2.3.2 (Firmware).

public boolean isStatusLEDEnabled()

Returns true if the status LED is enabled, false otherwise.

New in version 2.3.2 (Firmware).

public BrickMaster.Protocol1BrickletName getProtocol1BrickletName(char port)

Returns the firmware and protocol version and the name of the Bricklet for a given port.

This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.

The returned object has the public member variables short protocolVersion, short[] firmwareVersion and String name.

public short getChipTemperature()

Returns the temperature in °C/10 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 an accuracy of +-15%. Practically it is only useful as an indicator for temperature changes.

public void reset()

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

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

public BrickMaster.Identity getIdentity()

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 can be '0'-'8' (stack position).

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

The returned object has the public member variables String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion and int deviceIdentifier.

Callback Configuration Functions

public void setStackCurrentCallbackPeriod(long period)

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

The StackCurrentCallback callback is only triggered if the current has changed since the last triggering.

The default value is 0.

New in version 2.0.5 (Firmware).

public long getStackCurrentCallbackPeriod()

Returns the period as set by setStackCurrentCallbackPeriod().

New in version 2.0.5 (Firmware).

public void setStackVoltageCallbackPeriod(long period)

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

The StackVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

New in version 2.0.5 (Firmware).

public long getStackVoltageCallbackPeriod()

Returns the period as set by setStackVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

public void setUSBVoltageCallbackPeriod(long period)

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

The USBVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

The default value is 0.

New in version 2.0.5 (Firmware).

public long getUSBVoltageCallbackPeriod()

Returns the period as set by setUSBVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

public void setStackCurrentCallbackThreshold(char option, int min, int max)

Sets the thresholds for the StackCurrentReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

public BrickMaster.StackCurrentCallbackThreshold getStackCurrentCallbackThreshold()

Returns the threshold as set by setStackCurrentCallbackThreshold().

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

The returned object has the public member variables char option, int min and int max.

public void setStackVoltageCallbackThreshold(char option, int min, int max)

Sets the thresholds for the StackVoltageReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

public BrickMaster.StackVoltageCallbackThreshold getStackVoltageCallbackThreshold()

Returns the threshold as set by setStackVoltageCallbackThreshold().

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

The returned object has the public member variables char option, int min and int max.

public void setUSBVoltageCallbackThreshold(char option, int min, int max)

Sets the thresholds for the USBVoltageReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

public BrickMaster.USBVoltageCallbackThreshold getUSBVoltageCallbackThreshold()

Returns the threshold as set by setUSBVoltageCallbackThreshold().

The following constants are available for this function:

  • BrickMaster.THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster.THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster.THRESHOLD_OPTION_GREATER = '>'

New in version 2.0.5 (Firmware).

The returned object has the public member variables char option, int min and int max.

public void setDebouncePeriod(long debounce)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

New in version 2.0.5 (Firmware).

public long getDebouncePeriod()

Returns the debounce period as set by setDebouncePeriod().

New in version 2.0.5 (Firmware).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields 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.

public callback BrickMaster.StackCurrentCallback
Parameters:current -- int

This callback is triggered periodically with the period that is set by setStackCurrentCallbackPeriod(). The parameter is the current of the sensor.

The StackCurrentCallback callback is only triggered if the current has changed since the last triggering.

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addStackCurrentCallback() function. An added callback function can be removed with the removeStackCurrentCallback() function.

public callback BrickMaster.StackVoltageCallback
Parameters:voltage -- int

This callback is triggered periodically with the period that is set by setStackVoltageCallbackPeriod(). The parameter is the voltage of the sensor.

The StackVoltageCallback callback is only triggered if the voltage has changed since the last triggering.

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addStackVoltageCallback() function. An added callback function can be removed with the removeStackVoltageCallback() function.

public callback BrickMaster.USBVoltageCallback
Parameters:voltage -- int

This callback is triggered periodically with the period that is set by setUSBVoltageCallbackPeriod(). The parameter is the USB voltage in mV.

The USBVoltageCallback callback is only triggered if the USB voltage has changed since the last triggering.

Does not work with hardware version 2.1.

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addUSBVoltageCallback() function. An added callback function can be removed with the removeUSBVoltageCallback() function.

public callback BrickMaster.StackCurrentReachedCallback
Parameters:current -- int

This callback is triggered when the threshold as set by setStackCurrentCallbackThreshold() is reached. The parameter is the stack current in mA.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addStackCurrentReachedCallback() function. An added callback function can be removed with the removeStackCurrentReachedCallback() function.

public callback BrickMaster.StackVoltageReachedCallback
Parameters:voltage -- int

This callback is triggered when the threshold as set by setStackVoltageCallbackThreshold() is reached. The parameter is the stack voltage in mV.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addStackVoltageReachedCallback() function. An added callback function can be removed with the removeStackVoltageReachedCallback() function.

public callback BrickMaster.USBVoltageReachedCallback
Parameters:voltage -- int

This callback is triggered when the threshold as set by setUSBVoltageCallbackThreshold() is reached. The parameter is the voltage of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

New in version 2.0.5 (Firmware).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addUSBVoltageReachedCallback() function. An added callback function can be removed with the removeUSBVoltageReachedCallback() function.

Constants

public static final int BrickMaster.DEVICE_IDENTIFIER

This constant is used to identify a Master Brick.

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

public static final String BrickMaster.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Master Brick.