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

class BrickMaster(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • master – Type: BrickMaster

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).

int BrickMaster.getStackVoltage()
Returns:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the stack voltage. 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.

int BrickMaster.getStackCurrent()
Returns:
  • current – Type: int, Unit: 1 mA, Range: [0 to 216 - 1]

Returns the stack current. 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

void BrickMaster.setExtensionType(short extension, long exttype)
Parameters:
  • extension – Type: short, Range: [0 to 1]
  • exttype – Type: long, Range: See constants

Writes the extension type to the EEPROM of a specified extension. The extension is either 0 or 1 (0 is the lower one, 1 is the upper one, 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:

For exttype:

  • 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
long BrickMaster.getExtensionType(short extension)
Parameters:
  • extension – Type: short, Range: [0 to 1]
Returns:
  • exttype – Type: long, Range: See constants

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

The following constants are available for this function:

For exttype:

  • 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
boolean BrickMaster.isChibiPresent()
Returns:
  • present – Type: boolean

Returns true if the Master Brick is at position 0 in the stack and a Chibi Extension is available.

void BrickMaster.setChibiAddress(short address)
Parameters:
  • address – Type: short, Range: [1 to 255]

Sets the address 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.

short BrickMaster.getChibiAddress()
Returns:
  • address – Type: short, Range: [1 to 255]

Returns the address as set by setChibiAddress().

void BrickMaster.setChibiMasterAddress(short address)
Parameters:
  • address – Type: short, Range: [1 to 255]

Sets the address 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.

short BrickMaster.getChibiMasterAddress()
Returns:
  • address – Type: short, Range: [1 to 255]

Returns the address as set by setChibiMasterAddress().

void BrickMaster.setChibiSlaveAddress(short num, short address)
Parameters:
  • num – Type: short, Range: [0 to 254]
  • address – Type: short, Range: [0 to 255]

Sets up to 254 slave addresses. 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.

short BrickMaster.getChibiSlaveAddress(short num)
Parameters:
  • num – Type: short, Range: [0 to 254]
Returns:
  • address – Type: short, Range: [0 to 255]

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

short BrickMaster.getChibiSignalStrength()
Returns:
  • signalStrength – Type: short, Unit: 1 dB, Range: [0 to 255]

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

BrickMaster.ChibiErrorLog BrickMaster.getChibiErrorLog()
Return Object:
  • underrun – Type: int, Range: [0 to 216 - 1]
  • crcError – Type: int, Range: [0 to 216 - 1]
  • noAck – Type: int, Range: [0 to 216 - 1]
  • overflow – Type: int, Range: [0 to 216 - 1]

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.

void BrickMaster.setChibiFrequency(short frequency)
Parameters:
  • frequency – Type: short, Range: See constants

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:

For frequency:

  • 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
short BrickMaster.getChibiFrequency()
Returns:
  • frequency – Type: short, Range: See constants

Returns the frequency value as set by setChibiFrequency().

The following constants are available for this function:

For frequency:

  • 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
void BrickMaster.setChibiChannel(short channel)
Parameters:
  • channel – Type: short, Range: ?

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.

short BrickMaster.getChibiChannel()
Returns:
  • channel – Type: short, Range: ?

Returns the channel as set by setChibiChannel().

boolean BrickMaster.isRS485Present()
Returns:
  • present – Type: boolean

Returns true if the Master Brick is at position 0 in the stack and a RS485 Extension is available.

void BrickMaster.setRS485Address(short address)
Parameters:
  • address – Type: short, Range: [0 to 255]

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.

short BrickMaster.getRS485Address()
Returns:
  • address – Type: short, Range: [0 to 255]

Returns the address as set by setRS485Address().

void BrickMaster.setRS485SlaveAddress(short num, short address)
Parameters:
  • num – Type: short, Range: [0 to 255]
  • address – Type: short, Range: [0 to 255]

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.

short BrickMaster.getRS485SlaveAddress(short num)
Parameters:
  • num – Type: short, Range: [0 to 255]
Returns:
  • address – Type: short, Range: [0 to 255]

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

int BrickMaster.getRS485ErrorLog()
Returns:
  • crcError – Type: int, Range: [0 to 216 - 1]

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.

void BrickMaster.setRS485Configuration(long speed, char parity, short stopbits)
Parameters:
  • speed – Type: long, Unit: 1 Bd, Range: [0 to 232 - 1]
  • parity – Type: char, Range: See constants
  • stopbits – Type: short, Range: [1 to 2]

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

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 (100kBd).

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:

For parity:

  • BrickMaster.RS485_PARITY_NONE = 'n'
  • BrickMaster.RS485_PARITY_EVEN = 'e'
  • BrickMaster.RS485_PARITY_ODD = 'o'
BrickMaster.RS485Configuration BrickMaster.getRS485Configuration()
Return Object:
  • speed – Type: long, Unit: 1 Bd, Range: [0 to 232 - 1]
  • parity – Type: char, Range: See constants
  • stopbits – Type: short, Range: [1 to 2]

Returns the configuration as set by setRS485Configuration().

The following constants are available for this function:

For parity:

  • BrickMaster.RS485_PARITY_NONE = 'n'
  • BrickMaster.RS485_PARITY_EVEN = 'e'
  • BrickMaster.RS485_PARITY_ODD = 'o'
boolean BrickMaster.isWifiPresent()
Returns:
  • present – Type: boolean

Returns true if the Master Brick is at position 0 in the stack and a WIFI Extension is available.

void BrickMaster.setWifiConfiguration(String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway, int port)
Parameters:
  • ssid – Type: String, Length: up to 32
  • connection – Type: short, Range: See constants
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223

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

For connection:

  • 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
BrickMaster.WifiConfiguration BrickMaster.getWifiConfiguration()
Return Object:
  • ssid – Type: String, Length: up to 32
  • connection – Type: short, Range: See constants
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223

Returns the configuration as set by setWifiConfiguration().

The following constants are available for this function:

For connection:

  • 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
void BrickMaster.setWifiEncryption(short encryption, String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength, int privateKeyLength)
Parameters:
  • encryption – Type: short, Range: See constants
  • key – Type: String, Length: up to 50
  • keyIndex – Type: short, Range: [1 to 4]
  • eapOptions – Type: short, Range: See constants
  • caCertificateLength – Type: int, Unit: 1 B, Range: [0 to 1312]
  • clientCertificateLength – Type: int, Unit: 1 B, Range: [0 to 1312]
  • privateKeyLength – Type: int, Unit: 1 B, Range: [0 to 4320]

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

For encryption:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3

For eapOptions:

  • 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
BrickMaster.WifiEncryption BrickMaster.getWifiEncryption()
Return Object:
  • encryption – Type: short, Range: See constants
  • key – Type: String, Length: up to 50
  • keyIndex – Type: short, Range: [1 to 4]
  • eapOptions – Type: short, Range: See constants
  • caCertificateLength – Type: int, Range: [0 to 216 - 1]
  • clientCertificateLength – Type: int, Range: [0 to 216 - 1]
  • privateKeyLength – Type: int, Range: [0 to 216 - 1]

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:

For encryption:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3

For eapOptions:

  • 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
BrickMaster.WifiStatus BrickMaster.getWifiStatus()
Return Object:
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]
  • bssid – Type: short[], Length: 6, Range: [0 to 255]
  • channel – Type: short, Range: ?
  • rssi – Type: short, Range: [-215 to 215 - 1]
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • rxCount – Type: long, Range: [0 to 232 - 1]
  • txCount – Type: long, Range: [0 to 232 - 1]
  • state – Type: short, Range: See constants

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:

For state:

  • 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
void BrickMaster.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.

void BrickMaster.setWifiCertificate(int index, short[] data, short dataLength)
Parameters:
  • index – Type: int, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 216 - 1]
  • data – Type: short[], Length: 32, Range: [0 to 255]
  • dataLength – Type: short, Unit: 1 B, Range: [0 to 32]

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.

BrickMaster.WifiCertificate BrickMaster.getWifiCertificate(int index)
Parameters:
  • index – Type: int, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 216 - 1]
Return Object:
  • data – Type: short[], Length: 32, Range: [0 to 255]
  • dataLength – Type: short, Range: [0 to 32]

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

void BrickMaster.setWifiPowerMode(short mode)
Parameters:
  • mode – Type: short, Range: See constants, Default: 0

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

For mode:

  • BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
short BrickMaster.getWifiPowerMode()
Returns:
  • mode – Type: short, Range: See constants, Default: 0

Returns the power mode as set by setWifiPowerMode().

The following constants are available for this function:

For mode:

  • BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
BrickMaster.WifiBufferInfo BrickMaster.getWifiBufferInfo()
Return Object:
  • overflow – Type: long, Range: [0 to 232 - 1]
  • lowWatermark – Type: int, Unit: 1 B, Range: [0 to 1500]
  • used – Type: int, Unit: 1 B, Range: [0 to 1500]

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.

void BrickMaster.setWifiRegulatoryDomain(short domain)
Parameters:
  • domain – Type: short, Range: See constants, Default: 1

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

For domain:

  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2
short BrickMaster.getWifiRegulatoryDomain()
Returns:
  • domain – Type: short, Range: See constants, Default: 1

Returns the regulatory domain as set by setWifiRegulatoryDomain().

The following constants are available for this function:

For domain:

  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2
int BrickMaster.getUSBVoltage()
Returns:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

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

void BrickMaster.setLongWifiKey(String key)
Parameters:
  • key – Type: String, Length: up to 64

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).

String BrickMaster.getLongWifiKey()
Returns:
  • key – Type: String, Length: up to 64

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).

void BrickMaster.setWifiHostname(String hostname)
Parameters:
  • hostname – Type: String, Length: up to 16

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).

String BrickMaster.getWifiHostname()
Returns:
  • hostname – Type: String, Length: up to 16

Returns the hostname as set by setWifiHostname().

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

New in version 2.0.5 (Firmware).

boolean BrickMaster.isEthernetPresent()
Returns:
  • present – Type: boolean

Returns true if the Master Brick is at position 0 in the stack and an Ethernet Extension is available.

New in version 2.1.0 (Firmware).

void BrickMaster.setEthernetConfiguration(short connection, short[] ip, short[] subnetMask, short[] gateway, int port)
Parameters:
  • connection – Type: short, Range: See constants
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223

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

For connection:

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

New in version 2.1.0 (Firmware).

BrickMaster.EthernetConfiguration BrickMaster.getEthernetConfiguration()
Return Object:
  • connection – Type: short, Range: See constants
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223

Returns the configuration as set by setEthernetConfiguration().

The following constants are available for this function:

For connection:

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

New in version 2.1.0 (Firmware).

BrickMaster.EthernetStatus BrickMaster.getEthernetStatus()
Return Object:
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • rxCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • txCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • hostname – Type: String, Length: up to 32

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).

void BrickMaster.setEthernetHostname(String hostname)
Parameters:
  • hostname – Type: String, Length: up to 32

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).

void BrickMaster.setEthernetMACAddress(short[] macAddress)
Parameters:
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]

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).

void BrickMaster.setEthernetWebsocketConfiguration(short sockets, int port)
Parameters:
  • sockets – Type: short, Range: [0 to 7], Default: 3
  • port – Type: int, Range: [0 to 216 - 1], Default: 4280

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.

New in version 2.2.0 (Firmware).

BrickMaster.EthernetWebsocketConfiguration BrickMaster.getEthernetWebsocketConfiguration()
Return Object:
  • sockets – Type: short, Range: [0 to 7], Default: 3
  • port – Type: int, Range: [0 to 216 - 1], Default: 4280

Returns the configuration as set by setEthernetConfiguration().

New in version 2.2.0 (Firmware).

void BrickMaster.setEthernetAuthenticationSecret(String secret)
Parameters:
  • secret – Type: String, Length: up to 64, Default: ''

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).

String BrickMaster.getEthernetAuthenticationSecret()
Returns:
  • secret – Type: String, Length: up to 64, Default: ''

Returns the authentication secret as set by setEthernetAuthenticationSecret().

New in version 2.2.0 (Firmware).

void BrickMaster.setWifiAuthenticationSecret(String secret)
Parameters:
  • secret – Type: String, Length: up to 64, Default: ''

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).

String BrickMaster.getWifiAuthenticationSecret()
Returns:
  • secret – Type: String, Length: up to 64, Default: ''

Returns the authentication secret as set by setWifiAuthenticationSecret().

New in version 2.2.0 (Firmware).

short BrickMaster.getConnectionType()
Returns:
  • connectionType – Type: short, Range: See constants

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

The following constants are available for this function:

For connectionType:

  • 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).

boolean BrickMaster.isWifi2Present()
Returns:
  • present – Type: boolean

Returns true if the Master Brick is at position 0 in the stack and a WIFI Extension 2.0 is available.

New in version 2.4.0 (Firmware).

byte BrickMaster.startWifi2Bootloader()
Returns:
  • result – Type: byte, Range: [-128 to 127]

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).

byte BrickMaster.writeWifi2SerialPort(short[] data, short length)
Parameters:
  • data – Type: short[], Length: 60, Range: [0 to 255]
  • length – Type: short, Unit: 1 B, Range: [0 to 60]
Returns:
  • result – Type: byte, Range: [-128 to 127]

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).

BrickMaster.ReadWifi2SerialPort BrickMaster.readWifi2SerialPort(short length)
Parameters:
  • length – Type: short, Range: [0 to 255]
Return Object:
  • data – Type: short[], Length: 60, Range: [0 to 60]
  • result – Type: short, Range: [0 to 255]

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).

void BrickMaster.setWifi2AuthenticationSecret(String secret)
Parameters:
  • secret – Type: String, Length: up to 64

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).

String BrickMaster.getWifi2AuthenticationSecret()
Returns:
  • secret – Type: String, Length: up to 64

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

New in version 2.4.0 (Firmware).

void BrickMaster.setWifi2Configuration(int port, int websocketPort, int websitePort, short phyMode, short sleepMode, short website)
Parameters:
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223
  • websocketPort – Type: int, Range: [0 to 216 - 1], Default: 4280
  • websitePort – Type: int, Range: [0 to 216 - 1], Default: 80
  • phyMode – Type: short, Range: See constants
  • sleepMode – Type: short, Range: [0 to 255]
  • website – Type: short, Range: [0 to 255]

Sets the general configuration of the WIFI Extension 2.0.

The port parameter sets the port number that your programm will connect to.

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

The website_port parameter sets the port number for the website of the WIFI Extension 2.0.

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

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:

For phyMode:

  • 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).

BrickMaster.Wifi2Configuration BrickMaster.getWifi2Configuration()
Return Object:
  • port – Type: int, Range: [0 to 216 - 1], Default: 4223
  • websocketPort – Type: int, Range: [0 to 216 - 1], Default: 4280
  • websitePort – Type: int, Range: [0 to 216 - 1], Default: 80
  • phyMode – Type: short, Range: See constants
  • sleepMode – Type: short, Range: [0 to 255]
  • website – Type: short, Range: [0 to 255]

Returns the general configuration as set by setWifi2Configuration().

The following constants are available for this function:

For phyMode:

  • 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).

BrickMaster.Wifi2Status BrickMaster.getWifi2Status()
Return Object:
  • clientEnabled – Type: boolean
  • clientStatus – Type: short, Range: See constants
  • clientIP – Type: short[], Length: 4, Range: [0 to 255]
  • clientSubnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • clientGateway – Type: short[], Length: 4, Range: [0 to 255]
  • clientMACAddress – Type: short[], Length: 6, Range: [0 to 255]
  • clientRXCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • clientTXCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • clientRSSI – Type: byte, Range: [-128 to 127]
  • apEnabled – Type: boolean
  • apIP – Type: short[], Length: 4, Range: [0 to 255]
  • apSubnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • apGateway – Type: short[], Length: 4, Range: [0 to 255]
  • apMACAddress – Type: short[], Length: 6, Range: [0 to 255]
  • apRXCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • apTXCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • apConnectedCount – Type: short, Range: [0 to 255]

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

The following constants are available for this function:

For clientStatus:

  • 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).

void BrickMaster.setWifi2ClientConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress, short[] bssid)
Parameters:
  • enable – Type: boolean, Default: true
  • ssid – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]
  • bssid – Type: short[], Length: 6, Range: [0 to 255]

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 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).

BrickMaster.Wifi2ClientConfiguration BrickMaster.getWifi2ClientConfiguration()
Return Object:
  • enable – Type: boolean, Default: true
  • ssid – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]
  • bssid – Type: short[], Length: 6, Range: [0 to 255]

Returns the client configuration as set by setWifi2ClientConfiguration().

New in version 2.4.0 (Firmware).

void BrickMaster.setWifi2ClientHostname(String hostname)
Parameters:
  • hostname – Type: String, Length: up to 32

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).

String BrickMaster.getWifi2ClientHostname()
Returns:
  • hostname – Type: String, Length: up to 32

Returns the client hostname as set by setWifi2ClientHostname().

New in version 2.4.0 (Firmware).

void BrickMaster.setWifi2ClientPassword(String password)
Parameters:
  • password – Type: String, Length: up to 64

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).

String BrickMaster.getWifi2ClientPassword()
Returns:
  • password – Type: String, Length: up to 64

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).

void BrickMaster.setWifi2APConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel, short[] macAddress)
Parameters:
  • enable – Type: boolean, Default: true
  • ssid – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • encryption – Type: short, Range: See constants, Default: 4
  • hidden – Type: boolean, Default: false
  • channel – Type: short, Range: [0 to 255], Default: 1
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]

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 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. Use the setWifi2APPassword() function to set the encryption password.

The hidden parameter makes the access point hide or show its SSID.

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

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:

For encryption:

  • 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).

BrickMaster.Wifi2APConfiguration BrickMaster.getWifi2APConfiguration()
Return Object:
  • enable – Type: boolean, Default: true
  • ssid – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • encryption – Type: short, Range: See constants, Default: 4
  • hidden – Type: boolean, Default: false
  • channel – Type: short, Range: [0 to 255], Default: 1
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]

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

The following constants are available for this function:

For encryption:

  • 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).

void BrickMaster.setWifi2APPassword(String password)
Parameters:
  • password – Type: String, Length: up to 64

Sets the access point password (at least 8 and 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).

String BrickMaster.getWifi2APPassword()
Returns:
  • password – Type: String, Length: up to 64

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).

short BrickMaster.saveWifi2Configuration()
Returns:
  • result – Type: short, Range: [0 to 255]

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).

short[] BrickMaster.getWifi2FirmwareVersion()
Return Object:
  • firmwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]

Returns the current version of the WIFI Extension 2.0 firmware.

New in version 2.4.0 (Firmware).

void BrickMaster.enableWifi2StatusLED()

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

New in version 2.4.0 (Firmware).

void BrickMaster.disableWifi2StatusLED()

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

New in version 2.4.0 (Firmware).

boolean BrickMaster.isWifi2StatusLEDEnabled()
Returns:
  • enabled – Type: boolean

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

New in version 2.4.0 (Firmware).

void BrickMaster.setWifi2MeshConfiguration(boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, String groupSSIDPrefix, short[] gatewayIP, int gatewayPort)
Parameters:
  • enable – Type: boolean, Default: false
  • rootIP – Type: short[], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
  • rootSubnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • rootGateway – Type: short[], Length: 4, Range: [0 to 255]
  • routerBSSID – Type: short[], Length: 6, Range: [0 to 255]
  • groupID – Type: short[], Length: 6, Range: [0 to 255]
  • groupSSIDPrefix – Type: String, Length: up to 16
  • gatewayIP – Type: short[], Length: 4, Range: [0 to 255]
  • gatewayPort – Type: int, Range: [0 to 216 - 1]

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 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).

BrickMaster.Wifi2MeshConfiguration BrickMaster.getWifi2MeshConfiguration()
Return Object:
  • enable – Type: boolean, Default: false
  • rootIP – Type: short[], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
  • rootSubnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • rootGateway – Type: short[], Length: 4, Range: [0 to 255]
  • routerBSSID – Type: short[], Length: 6, Range: [0 to 255]
  • groupID – Type: short[], Length: 6, Range: [0 to 255]
  • groupSSIDPrefix – Type: String, Length: up to 16
  • gatewayIP – Type: short[], Length: 4, Range: [0 to 255]
  • gatewayPort – Type: int, Range: [0 to 216 - 1]

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh configuration as set by setWifi2MeshConfiguration().

New in version 2.4.2 (Firmware).

void BrickMaster.setWifi2MeshRouterSSID(String ssid)
Parameters:
  • ssid – Type: String, Length: up to 32

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).

String BrickMaster.getWifi2MeshRouterSSID()
Returns:
  • ssid – Type: String, Length: up to 32

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).

void BrickMaster.setWifi2MeshRouterPassword(String password)
Parameters:
  • password – Type: String, Length: up to 64

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).

String BrickMaster.getWifi2MeshRouterPassword()
Returns:
  • password – Type: String, Length: up to 64

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).

BrickMaster.Wifi2MeshCommonStatus BrickMaster.getWifi2MeshCommonStatus()
Return Object:
  • status – Type: short, Range: See constants
  • rootNode – Type: boolean
  • rootCandidate – Type: boolean
  • connectedNodes – Type: int, Range: [0 to 216 - 1]
  • rxCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]
  • txCount – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

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:

For status:

  • 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).

BrickMaster.Wifi2MeshClientStatus BrickMaster.getWifi2MeshClientStatus()
Return Object:
  • hostname – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]

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).

BrickMaster.Wifi2MeshAPStatus BrickMaster.getWifi2MeshAPStatus()
Return Object:
  • ssid – Type: String, Length: up to 32
  • ip – Type: short[], Length: 4, Range: [0 to 255]
  • subnetMask – Type: short[], Length: 4, Range: [0 to 255]
  • gateway – Type: short[], Length: 4, Range: [0 to 255]
  • macAddress – Type: short[], Length: 6, Range: [0 to 255]

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).

void BrickMaster.setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)
Parameters:
  • enableDynamicBaudrate – Type: boolean, Default: true
  • minimumDynamicBaudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

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.

New in version 2.4.6 (Firmware).

BrickMaster.SPITFPBaudrateConfig BrickMaster.getSPITFPBaudrateConfig()
Return Object:
  • enableDynamicBaudrate – Type: boolean, Default: true
  • minimumDynamicBaudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see setSPITFPBaudrateConfig().

New in version 2.4.6 (Firmware).

long BrickMaster.getSendTimeoutCount(short communicationMethod)
Parameters:
  • communicationMethod – Type: short, Range: See constants
Returns:
  • timeoutCount – Type: long, Range: [0 to 232 - 1]

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:

For communicationMethod:

  • 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).

void BrickMaster.setSPITFPBaudrate(char brickletPort, long baudrate)
Parameters:
  • brickletPort – Type: char, Range: ['a' to 'd']
  • baudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Sets the baudrate for a specific Bricklet port.

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.

New in version 2.4.3 (Firmware).

long BrickMaster.getSPITFPBaudrate(char brickletPort)
Parameters:
  • brickletPort – Type: char, Range: ['a' to 'd']
Returns:
  • baudrate – Type: long, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

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

New in version 2.4.3 (Firmware).

BrickMaster.SPITFPErrorCount BrickMaster.getSPITFPErrorCount(char brickletPort)
Parameters:
  • brickletPort – Type: char, Range: ['a' to 'd']
Return Object:
  • errorCountACKChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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).

void BrickMaster.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).

void BrickMaster.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).

boolean BrickMaster.isStatusLEDEnabled()
Returns:
  • enabled – Type: boolean, Default: true

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

New in version 2.3.2 (Firmware).

BrickMaster.Protocol1BrickletName BrickMaster.getProtocol1BrickletName(char port)
Parameters:
  • port – Type: char, Range: ['a' to 'd']
Return Object:
  • protocolVersion – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • name – Type: String, Length: up to 40

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.

short BrickMaster.getChipTemperature()
Returns:
  • temperature – Type: short, Unit: 1/10 °C, Range: [-215 to 215 - 1]

Returns the temperature 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.

void BrickMaster.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!

BrickMaster.Identity BrickMaster.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['0' to '8']
  • hardwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – 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. There is also a constant for the device identifier of this Brick.

Callback Configuration Functions

void BrickMaster.setStackCurrentCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

New in version 2.0.5 (Firmware).

long BrickMaster.getStackCurrentCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setStackCurrentCallbackPeriod().

New in version 2.0.5 (Firmware).

void BrickMaster.setStackVoltageCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

New in version 2.0.5 (Firmware).

long BrickMaster.getStackVoltageCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setStackVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

void BrickMaster.setUSBVoltageCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

New in version 2.0.5 (Firmware).

long BrickMaster.getUSBVoltageCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setUSBVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

void BrickMaster.setStackCurrentCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0

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

For option:

  • 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).

BrickMaster.StackCurrentCallbackThreshold BrickMaster.getStackCurrentCallbackThreshold()
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setStackCurrentCallbackThreshold().

The following constants are available for this function:

For option:

  • 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).

void BrickMaster.setStackVoltageCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

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

For option:

  • 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).

BrickMaster.StackVoltageCallbackThreshold BrickMaster.getStackVoltageCallbackThreshold()
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setStackVoltageCallbackThreshold().

The following constants are available for this function:

For option:

  • 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).

void BrickMaster.setUSBVoltageCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

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

For option:

  • 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).

BrickMaster.USBVoltageCallbackThreshold BrickMaster.getUSBVoltageCallbackThreshold()
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: int, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setUSBVoltageCallbackThreshold().

The following constants are available for this function:

For option:

  • 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).

void BrickMaster.setDebouncePeriod(long debounce)
Parameters:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

New in version 2.0.5 (Firmware).

long BrickMaster.getDebouncePeriod()
Returns:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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.

callback BrickMaster.StackCurrentCallback
Event Object:
  • current – Type: int, Unit: 1 mA, Range: [0 to 216 - 1]

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.

callback BrickMaster.StackVoltageCallback
Event Object:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

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.

callback BrickMaster.USBVoltageCallback
Event Object:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

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

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.

callback BrickMaster.StackCurrentReachedCallback
Event Object:
  • current – Type: int, Unit: 1 mA, Range: [0 to 216 - 1]

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

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.

callback BrickMaster.StackVoltageReachedCallback
Event Object:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

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

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.

callback BrickMaster.USBVoltageReachedCallback
Event Object:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 216 - 1]

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.

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.

short[] BrickMaster.getAPIVersion()
Return Object:
  • apiVersion – Type: short[], Length: 3
    • 1: major – Type: short, Range: [0 to 255]
    • 2: minor – Type: short, Range: [0 to 255]
    • 3: revision – Type: short, 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.

boolean BrickMaster.getResponseExpected(short functionId)
Parameters:
  • functionId – Type: short, Range: See constants
Returns:
  • responseExpected – Type: boolean

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:

For functionId:

  • 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
void BrickMaster.setResponseExpected(short functionId, boolean responseExpected)
Parameters:
  • functionId – Type: short, Range: See constants
  • responseExpected – Type: boolean

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:

For functionId:

  • 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
void BrickMaster.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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

Constants

int BrickMaster.DEVICE_IDENTIFIER

This constant is used to identify a Master Brick.

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

String BrickMaster.DEVICE_DISPLAY_NAME

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