Software / API Bindings / Ruby / API Reference and Examples / Bricks / Master Brick

Ruby - Master Brick¶

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

Examples¶

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

Stack Status¶

Download (example_stack_status.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_master'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
master = BrickMaster.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current stack voltage
stack_voltage = master.get_stack_voltage
puts "Stack Voltage: #{stack_voltage/1000.0} V"

# Get current stack current
stack_current = master.get_stack_current
puts "Stack Current: #{stack_current/1000.0} A"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickMaster::new(uid, ipcon) → master¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	master – Type: BrickMaster

Creates an object with the unique device ID uid:

master = BrickMaster.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickMaster#get_stack_voltage → int¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 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.

Note

It is not possible to measure voltages supplied per PoE or USB with this function.

BrickMaster#get_stack_current → int¶

Returns:	current – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 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.

Note

It is not possible to measure the current drawn via PoE or USB with this function.

Advanced Functions¶

BrickMaster#set_extension_type(extension, exttype) → nil¶

Parameters:	extension – Type: int, Range: [0 to 1] exttype – Type: int, 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

BrickMaster#get_extension_type(extension) → int¶

Parameters:	extension – Type: int, Range: [0 to 1]
Returns:	exttype – Type: int, Range: See constants

Returns the type for a given extension as set by #set_extension_type.

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

BrickMaster#is_chibi_present → bool¶

Returns:	present – Type: bool

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

BrickMaster#set_chibi_address(address) → nil¶

Parameters:	address – Type: int, 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.

BrickMaster#get_chibi_address → int¶

Returns:	address – Type: int, Range: [1 to 255]

Returns the address as set by #set_chibi_address.

BrickMaster#set_chibi_master_address(address) → nil¶

Parameters:	address – Type: int, 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.

BrickMaster#get_chibi_master_address → int¶

Returns:	address – Type: int, Range: [1 to 255]

Returns the address as set by #set_chibi_master_address.

BrickMaster#set_chibi_slave_address(num, address) → nil¶

Parameters:	num – Type: int, Range: [0 to 254] address – Type: int, 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.

BrickMaster#get_chibi_slave_address(num) → int¶

Parameters:	num – Type: int, Range: [0 to 254]
Returns:	address – Type: int, Range: [0 to 255]

Returns the slave address for a given num as set by #set_chibi_slave_address.

BrickMaster#get_chibi_signal_strength → int¶

Returns:	signal_strength – Type: int, Unit: 1 dB, Range: [0 to 255]

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

BrickMaster#get_chibi_error_log → [int, int, int, int]¶

Return Array:	0: underrun – Type: int, Range: [0 to 2¹⁶ - 1] 1: crc_error – Type: int, Range: [0 to 2¹⁶ - 1] 2: no_ack – Type: int, Range: [0 to 2¹⁶ - 1] 3: overflow – Type: int, Range: [0 to 2¹⁶ - 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.

BrickMaster#set_chibi_frequency(frequency) → nil¶

Parameters:	frequency – Type: int, 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

BrickMaster#get_chibi_frequency → int¶

Returns:	frequency – Type: int, Range: See constants

Returns the frequency value as set by #set_chibi_frequency.

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

BrickMaster#set_chibi_channel(channel) → nil¶

Parameters:	channel – Type: int, 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.

BrickMaster#get_chibi_channel → int¶

Returns:	channel – Type: int, Range: ?

Returns the channel as set by #set_chibi_channel.

BrickMaster#is_rs485_present → bool¶

Returns:	present – Type: bool

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

BrickMaster#set_rs485_address(address) → nil¶

Parameters:	address – Type: int, 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.

BrickMaster#get_rs485_address → int¶

Returns:	address – Type: int, Range: [0 to 255]

Returns the address as set by #set_rs485_address.

BrickMaster#set_rs485_slave_address(num, address) → nil¶

Parameters:	num – Type: int, Range: [0 to 255] address – Type: int, 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.

BrickMaster#get_rs485_slave_address(num) → int¶

Parameters:	num – Type: int, Range: [0 to 255]
Returns:	address – Type: int, Range: [0 to 255]

Returns the slave address for a given num as set by #set_rs485_slave_address.

BrickMaster#get_rs485_error_log → int¶

Returns:	crc_error – Type: int, Range: [0 to 2¹⁶ - 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.

BrickMaster#set_rs485_configuration(speed, parity, stopbits) → nil¶

Parameters:	speed – Type: int, Unit: 1 Bd, Range: [0 to 2³² - 1] parity – Type: chr, Range: See constants stopbits – Type: int, 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#get_rs485_configuration → [int, chr, int]¶

Return Array:	0: speed – Type: int, Unit: 1 Bd, Range: [0 to 2³² - 1] 1: parity – Type: chr, Range: See constants 2: stopbits – Type: int, Range: [1 to 2]

Returns the configuration as set by #set_rs485_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#is_wifi_present → bool¶

Returns:	present – Type: bool

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

BrickMaster#set_wifi_configuration(ssid, connection, ip, subnet_mask, gateway, port) → nil¶

Parameters:	ssid – Type: str, Length: up to 32 connection – Type: int, Range: See constants ip – Type: [int, ...], Length: 4, Range: [0 to 255] subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] gateway – Type: [int, ...], Length: 4, Range: [0 to 255] port – Type: int, Range: [0 to 2¹⁶ - 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#get_wifi_configuration → [str, int, [int, ...], [int, ...], [int, ...], int]¶

Return Array:	0: ssid – Type: str, Length: up to 32 1: connection – Type: int, Range: See constants 2: ip – Type: [int, ...], Length: 4, Range: [0 to 255] 3: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] 4: gateway – Type: [int, ...], Length: 4, Range: [0 to 255] 5: port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4223

Returns the configuration as set by #set_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#set_wifi_encryption(encryption, key, key_index, eap_options, ca_certificate_length, client_certificate_length, private_key_length) → nil¶

Parameters:

Parameters:	encryption – Type: int, Range: See constants key – Type: str, Length: up to 50 key_index – Type: int, Range: [1 to 4] eap_options – Type: int, Range: See constants ca_certificate_length – Type: int, Unit: 1 B, Range: [0 to 1312] client_certificate_length – Type: int, Unit: 1 B, Range: [0 to 1312] private_key_length – Type: int, Unit: 1 B, Range: [0 to 4320]

encryption – Type: int, Range: See constants
key – Type: str, Length: up to 50
key_index – Type: int, Range: [1 to 4]
eap_options – Type: int, Range: See constants
ca_certificate_length – Type: int, Unit: 1 B, Range: [0 to 1312]
client_certificate_length – Type: int, Unit: 1 B, Range: [0 to 1312]
private_key_length – 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 #set_long_wifi_key.

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 #set_wifi_certificate. 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 eap_options:

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#get_wifi_encryption → [int, str, int, int, int, int, int]¶

Return Array:

Return Array:	0: encryption – Type: int, Range: See constants 1: key – Type: str, Length: up to 50 2: key_index – Type: int, Range: [1 to 4] 3: eap_options – Type: int, Range: See constants 4: ca_certificate_length – Type: int, Range: [0 to 2¹⁶ - 1] 5: client_certificate_length – Type: int, Range: [0 to 2¹⁶ - 1] 6: private_key_length – Type: int, Range: [0 to 2¹⁶ - 1]

0: encryption – Type: int, Range: See constants
1: key – Type: str, Length: up to 50
2: key_index – Type: int, Range: [1 to 4]
3: eap_options – Type: int, Range: See constants
4: ca_certificate_length – Type: int, Range: [0 to 2¹⁶ - 1]
5: client_certificate_length – Type: int, Range: [0 to 2¹⁶ - 1]
6: private_key_length – Type: int, Range: [0 to 2¹⁶ - 1]

Returns the encryption as set by #set_wifi_encryption.

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

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#get_wifi_status → [[int, ...], [int, ...], int, int, [int, ...], [int, ...], [int, ...], int, int, int]¶

Return Array:

Return Array:	0: mac_address – Type: [int, ...], Length: 6, Range: [0 to 255] 1: bssid – Type: [int, ...], Length: 6, Range: [0 to 255] 2: channel – Type: int, Range: ? 3: rssi – Type: int, Range: [-2¹⁵ to 2¹⁵ - 1] 4: ip – Type: [int, ...], Length: 4, Range: [0 to 255] 5: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] 6: gateway – Type: [int, ...], Length: 4, Range: [0 to 255] 7: rx_count – Type: int, Range: [0 to 2³² - 1] 8: tx_count – Type: int, Range: [0 to 2³² - 1] 9: state – Type: int, Range: See constants

0: mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]
1: bssid – Type: [int, ...], Length: 6, Range: [0 to 255]
2: channel – Type: int, Range: ?
3: rssi – Type: int, Range: [-2¹⁵ to 2¹⁵ - 1]
4: ip – Type: [int, ...], Length: 4, Range: [0 to 255]
5: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
6: gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
7: rx_count – Type: int, Range: [0 to 2³² - 1]
8: tx_count – Type: int, Range: [0 to 2³² - 1]
9: state – Type: int, 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 #refresh_wifi_status 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

BrickMaster#refresh_wifi_status → nil¶: Refreshes the Wi-Fi status (see #get_wifi_status). 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.

BrickMaster#set_wifi_certificate(index, data, data_length) → nil¶

Parameters:	index – Type: int, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 2¹⁶ - 1] data – Type: [int, ...], Length: 32, Range: [0 to 255] data_length – Type: int, 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#get_wifi_certificate(index) → [[int, ...], int]¶

Parameters:	index – Type: int, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 2¹⁶ - 1]
Return Array:	0: data – Type: [int, ...], Length: 32, Range: [0 to 255] 1: data_length – Type: int, Range: [0 to 32]

Returns the certificate for a given index as set by #set_wifi_certificate.

BrickMaster#set_wifi_power_mode(mode) → nil¶

Parameters:	mode – Type: int, 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

BrickMaster#get_wifi_power_mode → int¶

Returns:	mode – Type: int, Range: See constants, Default: 0

Returns the power mode as set by #set_wifi_power_mode.

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#get_wifi_buffer_info → [int, int, int]¶

Return Array:	0: overflow – Type: int, Range: [0 to 2³² - 1] 1: low_watermark – Type: int, Unit: 1 B, Range: [0 to 1500] 2: 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.

BrickMaster#set_wifi_regulatory_domain(domain) → nil¶

Parameters:	domain – Type: int, 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

BrickMaster#get_wifi_regulatory_domain → int¶

Returns:	domain – Type: int, Range: See constants, Default: 1

Returns the regulatory domain as set by #set_wifi_regulatory_domain.

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

BrickMaster#get_usb_voltage → int¶

Returns:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

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

BrickMaster#set_long_wifi_key(key) → nil¶

Parameters:	key – Type: str, 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 #set_wifi_encryption 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).

BrickMaster#get_long_wifi_key → str¶

Returns:	key – Type: str, Length: up to 64

Returns the encryption key as set by #set_long_wifi_key.

Note

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

New in version 2.0.2 (Firmware).

BrickMaster#set_wifi_hostname(hostname) → nil¶

Parameters:	hostname – Type: str, 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).

BrickMaster#get_wifi_hostname → str¶

Returns:	hostname – Type: str, Length: up to 16

Returns the hostname as set by #set_wifi_hostname.

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

New in version 2.0.5 (Firmware).

BrickMaster#is_ethernet_present → bool¶

Returns:	present – Type: bool

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

BrickMaster#set_ethernet_configuration(connection, ip, subnet_mask, gateway, port) → nil¶

Parameters:	connection – Type: int, Range: See constants ip – Type: [int, ...], Length: 4, Range: [0 to 255] subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] gateway – Type: [int, ...], Length: 4, Range: [0 to 255] port – Type: int, Range: [0 to 2¹⁶ - 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#get_ethernet_configuration → [int, [int, ...], [int, ...], [int, ...], int]¶

Return Array:	0: connection – Type: int, Range: See constants 1: ip – Type: [int, ...], Length: 4, Range: [0 to 255] 2: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] 3: gateway – Type: [int, ...], Length: 4, Range: [0 to 255] 4: port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4223

Returns the configuration as set by #set_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#get_ethernet_status → [[int, ...], [int, ...], [int, ...], [int, ...], int, int, str]¶

Return Array:

0: mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]
1: ip – Type: [int, ...], Length: 4, Range: [0 to 255]
2: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
3: gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
4: rx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
5: tx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
6: hostname – Type: str, 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).

BrickMaster#set_ethernet_hostname(hostname) → nil¶

Parameters:	hostname – Type: str, 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 #get_ethernet_status.

New in version 2.1.0 (Firmware).

BrickMaster#set_ethernet_mac_address(mac_address) → nil¶

Parameters:	mac_address – Type: [int, ...], 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 #get_ethernet_status.

New in version 2.1.0 (Firmware).

BrickMaster#set_ethernet_websocket_configuration(sockets, port) → nil¶

Parameters:	sockets – Type: int, Range: [0 to 7], Default: 3 port – Type: int, Range: [0 to 2¹⁶ - 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#get_ethernet_websocket_configuration → [int, int]¶

Return Array:	0: sockets – Type: int, Range: [0 to 7], Default: 3 1: port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4280

Returns the configuration as set by #set_ethernet_configuration.

New in version 2.2.0 (Firmware).

BrickMaster#set_ethernet_authentication_secret(secret) → nil¶

Parameters:	secret – Type: str, 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).

BrickMaster#get_ethernet_authentication_secret → str¶

Returns:	secret – Type: str, Length: up to 64, Default: ''

Returns the authentication secret as set by #set_ethernet_authentication_secret.

New in version 2.2.0 (Firmware).

BrickMaster#set_wifi_authentication_secret(secret) → nil¶

Parameters:	secret – Type: str, 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).

BrickMaster#get_wifi_authentication_secret → str¶

Returns:	secret – Type: str, Length: up to 64, Default: ''

Returns the authentication secret as set by #set_wifi_authentication_secret.

New in version 2.2.0 (Firmware).

BrickMaster#get_connection_type → int¶

Returns:	connection_type – Type: int, Range: See constants

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

The following constants are available for this function:

For connection_type:

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

BrickMaster#is_wifi2_present → bool¶

Returns:	present – Type: bool

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

BrickMaster#start_wifi2_bootloader → int¶

Returns:	result – Type: int, Range: [-128 to 127]

Starts the bootloader of the WIFI Extension 2.0. Returns 0 on success. Afterwards the #write_wifi2_serial_port and #read_wifi2_serial_port 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 #get_connection_type 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#write_wifi2_serial_port(data, length) → int¶

Parameters:	data – Type: [int, ...], Length: 60, Range: [0 to 255] length – Type: int, Unit: 1 B, Range: [0 to 60]
Returns:	result – Type: int, 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 #start_wifi2_bootloader 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#read_wifi2_serial_port(length) → [[int, ...], int]¶

Parameters:	length – Type: int, Range: [0 to 255]
Return Array:	0: data – Type: [int, ...], Length: 60, Range: [0 to 60] 1: result – Type: int, 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 #start_wifi2_bootloader 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#set_wifi2_authentication_secret(secret) → nil¶

Parameters:	secret – Type: str, 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 #save_wifi2_configuration 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#get_wifi2_authentication_secret → str¶

Returns:	secret – Type: str, Length: up to 64

Returns the WIFI authentication secret as set by #set_wifi2_authentication_secret.

New in version 2.4.0 (Firmware).

BrickMaster#set_wifi2_configuration(port, websocket_port, website_port, phy_mode, sleep_mode, website) → nil¶

Parameters:	port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4223 websocket_port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4280 website_port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 80 phy_mode – Type: int, Range: See constants sleep_mode – Type: int, Range: [0 to 255] website – Type: int, 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 #save_wifi2_configuration 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 phy_mode:

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#get_wifi2_configuration → [int, int, int, int, int, int]¶

Return Array:	0: port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4223 1: websocket_port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 4280 2: website_port – Type: int, Range: [0 to 2¹⁶ - 1], Default: 80 3: phy_mode – Type: int, Range: See constants 4: sleep_mode – Type: int, Range: [0 to 255] 5: website – Type: int, Range: [0 to 255]

Returns the general configuration as set by #set_wifi2_configuration.

The following constants are available for this function:

For phy_mode:

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#get_wifi2_status → [bool, int, [int, ...], [int, ...], [int, ...], [int, ...], int, int, int, bool, [int, ...], [int, ...], [int, ...], [int, ...], int, int, int]¶

Return Array:

0: client_enabled – Type: bool
1: client_status – Type: int, Range: See constants
2: client_ip – Type: [int, ...], Length: 4, Range: [0 to 255]
3: client_subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
4: client_gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
5: client_mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]
6: client_rx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
7: client_tx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
8: client_rssi – Type: int, Range: [-128 to 127]
9: ap_enabled – Type: bool
10: ap_ip – Type: [int, ...], Length: 4, Range: [0 to 255]
11: ap_subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
12: ap_gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
13: ap_mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]
14: ap_rx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
15: ap_tx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]
16: ap_connected_count – Type: int, 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 client_status:

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

BrickMaster#set_wifi2_client_configuration(enable, ssid, ip, subnet_mask, gateway, mac_address, bssid) → nil¶

Parameters:	enable – Type: bool, Default: true ssid – Type: str, Length: up to 32 ip – Type: [int, ...], Length: 4, Range: [0 to 255] subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] gateway – Type: [int, ...], Length: 4, Range: [0 to 255] mac_address – Type: [int, ...], Length: 6, Range: [0 to 255] bssid – Type: [int, ...], 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 #save_wifi2_configuration 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#get_wifi2_client_configuration → [bool, str, [int, ...], [int, ...], [int, ...], [int, ...], [int, ...]]¶

Return Array:

0: enable – Type: bool, Default: true
1: ssid – Type: str, Length: up to 32
2: ip – Type: [int, ...], Length: 4, Range: [0 to 255]
3: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
4: gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
5: mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]
6: bssid – Type: [int, ...], Length: 6, Range: [0 to 255]

Returns the client configuration as set by #set_wifi2_client_configuration.

New in version 2.4.0 (Firmware).

BrickMaster#set_wifi2_client_hostname(hostname) → nil¶

Parameters:	hostname – Type: str, 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 #save_wifi2_configuration 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#get_wifi2_client_hostname → str¶

Returns:	hostname – Type: str, Length: up to 32

Returns the client hostname as set by #set_wifi2_client_hostname.

New in version 2.4.0 (Firmware).

BrickMaster#set_wifi2_client_password(password) → nil¶

Parameters:	password – Type: str, 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 #save_wifi2_configuration 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#get_wifi2_client_password → str¶

Returns:	password – Type: str, Length: up to 64

Returns the client password as set by #set_wifi2_client_password.

Note

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

New in version 2.4.0 (Firmware).

BrickMaster#set_wifi2_ap_configuration(enable, ssid, ip, subnet_mask, gateway, encryption, hidden, channel, mac_address) → nil¶

Parameters:

enable – Type: bool, Default: true
ssid – Type: str, Length: up to 32
ip – Type: [int, ...], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
encryption – Type: int, Range: See constants, Default: 4
hidden – Type: bool, Default: false
channel – Type: int, Range: [0 to 255], Default: 1
mac_address – Type: [int, ...], 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.

The encryption parameter sets the encryption mode to be used. Possible values are Open (no encryption), WEP or WPA/WPA2 PSK. Use the #set_wifi2_ap_password 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 #save_wifi2_configuration 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#get_wifi2_ap_configuration → [bool, str, [int, ...], [int, ...], [int, ...], int, bool, int, [int, ...]]¶

Return Array:

0: enable – Type: bool, Default: true
1: ssid – Type: str, Length: up to 32
2: ip – Type: [int, ...], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
3: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
4: gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
5: encryption – Type: int, Range: See constants, Default: 4
6: hidden – Type: bool, Default: false
7: channel – Type: int, Range: [0 to 255], Default: 1
8: mac_address – Type: [int, ...], Length: 6, Range: [0 to 255]

Returns the access point configuration as set by #set_wifi2_ap_configuration.

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#set_wifi2_ap_password(password) → nil¶

Parameters:	password – Type: str, Length: up to 64

Sets the access point password (at least 8 and up to 63 chars) for the configured encryption mode, see #set_wifi2_ap_configuration.

To apply configuration changes to the WIFI Extension 2.0 the #save_wifi2_configuration 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#get_wifi2_ap_password → str¶

Returns:	password – Type: str, Length: up to 64

Returns the access point password as set by #set_wifi2_ap_password.

Note

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

New in version 2.4.0 (Firmware).

BrickMaster#save_wifi2_configuration → int¶

Returns:	result – Type: int, 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).

BrickMaster#get_wifi2_firmware_version → [int, ...]¶

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

Returns the current version of the WIFI Extension 2.0 firmware.

New in version 2.4.0 (Firmware).

BrickMaster#enable_wifi2_status_led → nil¶: Turns the green status LED of the WIFI Extension 2.0 on.

New in version 2.4.0 (Firmware).

BrickMaster#disable_wifi2_status_led → nil¶: Turns the green status LED of the WIFI Extension 2.0 off.

New in version 2.4.0 (Firmware).

BrickMaster#is_wifi2_status_led_enabled → bool¶

Returns:	enabled – Type: bool, Default: true

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

New in version 2.4.0 (Firmware).

BrickMaster#set_wifi2_mesh_configuration(enable, root_ip, root_subnet_mask, root_gateway, router_bssid, group_id, group_ssid_prefix, gateway_ip, gateway_port) → nil¶

Parameters:

enable – Type: bool, Default: false
root_ip – Type: [int, ...], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
root_subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
root_gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
router_bssid – Type: [int, ...], Length: 6, Range: [0 to 255]
group_id – Type: [int, ...], Length: 6, Range: [0 to 255]
group_ssid_prefix – Type: str, Length: up to 16
gateway_ip – Type: [int, ...], Length: 4, Range: [0 to 255]
gateway_port – Type: int, Range: [0 to 2¹⁶ - 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 #set_wifi2_mesh_router_ssid. 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 #save_wifi2_configuration 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#get_wifi2_mesh_configuration → [bool, [int, ...], [int, ...], [int, ...], [int, ...], [int, ...], str, [int, ...], int]¶

Return Array:

0: enable – Type: bool, Default: false
1: root_ip – Type: [int, ...], Length: 4, Range: [0 to 255], Default: [0, 0, 0, 0]
2: root_subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255]
3: root_gateway – Type: [int, ...], Length: 4, Range: [0 to 255]
4: router_bssid – Type: [int, ...], Length: 6, Range: [0 to 255]
5: group_id – Type: [int, ...], Length: 6, Range: [0 to 255]
6: group_ssid_prefix – Type: str, Length: up to 16
7: gateway_ip – Type: [int, ...], Length: 4, Range: [0 to 255]
8: gateway_port – Type: int, Range: [0 to 2¹⁶ - 1]

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh configuration as set by #set_wifi2_mesh_configuration.

New in version 2.4.2 (Firmware).

BrickMaster#set_wifi2_mesh_router_ssid(ssid) → nil¶

Parameters:	ssid – Type: str, 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 #save_wifi2_configuration 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#get_wifi2_mesh_router_ssid → str¶

Returns:	ssid – Type: str, Length: up to 32

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router SSID as set by #set_wifi2_mesh_router_ssid.

New in version 2.4.2 (Firmware).

BrickMaster#set_wifi2_mesh_router_password(password) → nil¶

Parameters:	password – Type: str, 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 #save_wifi2_configuration 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#get_wifi2_mesh_router_password → str¶

Returns:	password – Type: str, Length: up to 64

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router password as set by #set_wifi2_mesh_router_password.

New in version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_common_status → [int, bool, bool, int, int, int]¶

Return Array:	0: status – Type: int, Range: See constants 1: root_node – Type: bool 2: root_candidate – Type: bool 3: connected_nodes – Type: int, Range: [0 to 2¹⁶ - 1] 4: rx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 1] 5: tx_count – Type: int, Unit: 1 B, Range: [0 to 2³² - 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#get_wifi2_mesh_client_status → [str, [int, ...], [int, ...], [int, ...], [int, ...]]¶

Return Array:	0: hostname – Type: str, Length: up to 32 1: ip – Type: [int, ...], Length: 4, Range: [0 to 255] 2: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] 3: gateway – Type: [int, ...], Length: 4, Range: [0 to 255] 4: mac_address – Type: [int, ...], 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#get_wifi2_mesh_ap_status → [str, [int, ...], [int, ...], [int, ...], [int, ...]]¶

Return Array:	0: ssid – Type: str, Length: up to 32 1: ip – Type: [int, ...], Length: 4, Range: [0 to 255] 2: subnet_mask – Type: [int, ...], Length: 4, Range: [0 to 255] 3: gateway – Type: [int, ...], Length: 4, Range: [0 to 255] 4: mac_address – Type: [int, ...], 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).

BrickMaster#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) → nil¶

Parameters:	enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: int, 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 sent/received and decreased linearly if little data is sent/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 #set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate as set by #set_spitfp_baudrate will be used statically.

New in version 2.4.6 (Firmware).

BrickMaster#get_spitfp_baudrate_config → [bool, int]¶

Return Array:	0: enable_dynamic_baudrate – Type: bool, Default: true 1: minimum_dynamic_baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see #set_spitfp_baudrate_config.

New in version 2.4.6 (Firmware).

BrickMaster#get_send_timeout_count(communication_method) → int¶

Parameters:	communication_method – Type: int, Range: See constants
Returns:	timeout_count – Type: int, Range: [0 to 2³² - 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 communication_method:

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

BrickMaster#set_spitfp_baudrate(bricklet_port, baudrate) → nil¶

Parameters:	bricklet_port – Type: chr, Range: ['a' to 'd'] baudrate – Type: int, 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 #get_spitfp_error_count) you can decrease the baudrate.

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

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

New in version 2.4.3 (Firmware).

BrickMaster#get_spitfp_baudrate(bricklet_port) → int¶

Parameters:	bricklet_port – Type: chr, Range: ['a' to 'd']
Returns:	baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Returns the baudrate for a given Bricklet port, see #set_spitfp_baudrate.

New in version 2.4.3 (Firmware).

BrickMaster#get_spitfp_error_count(bricklet_port) → [int, int, int, int]¶

Parameters:	bricklet_port – Type: chr, Range: ['a' to 'd']
Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] 2: error_count_frame – Type: int, Range: [0 to 2³² - 1] 3: error_count_overflow – Type: int, Range: [0 to 2³² - 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).

BrickMaster#enable_status_led → nil¶

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

BrickMaster#disable_status_led → nil¶

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

BrickMaster#is_status_led_enabled → bool¶

Returns:	enabled – Type: bool, Default: true

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

New in version 2.3.2 (Firmware).

BrickMaster#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

BrickMaster#reset → nil¶

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#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8
1: connected_uid – Type: str, Length: up to 8
2: position – Type: chr, Range: ['0' to '8']
3: hardware_version – Type: [int, ...], Length: 3

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

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

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

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

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

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

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

Callback Configuration Functions¶

BrickMaster#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

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

BrickMaster#set_stack_current_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the ::CALLBACK_STACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

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

New in version 2.0.5 (Firmware).

BrickMaster#get_stack_current_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_stack_current_callback_period.

New in version 2.0.5 (Firmware).

BrickMaster#set_stack_voltage_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the ::CALLBACK_STACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

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

New in version 2.0.5 (Firmware).

BrickMaster#get_stack_voltage_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_stack_voltage_callback_period.

New in version 2.0.5 (Firmware).

BrickMaster#set_usb_voltage_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the ::CALLBACK_USB_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.

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

New in version 2.0.5 (Firmware).

BrickMaster#get_usb_voltage_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_usb_voltage_callback_period.

New in version 2.0.5 (Firmware).

BrickMaster#set_stack_current_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the ::CALLBACK_STACK_CURRENT_REACHED 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#get_stack_current_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 0 2: max – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by #set_stack_current_callback_threshold.

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#set_stack_voltage_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the ::CALLBACK_STACK_VOLTAGE_REACHED 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#get_stack_voltage_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 2: max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by #set_stack_voltage_callback_threshold.

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#set_usb_voltage_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the ::CALLBACK_USB_VOLTAGE_REACHED 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#get_usb_voltage_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0 2: max – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by #set_usb_voltage_callback_threshold.

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#set_debounce_period(debounce) → nil¶

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

::CALLBACK_STACK_CURRENT_REACHED,
::CALLBACK_STACK_VOLTAGE_REACHED,
::CALLBACK_USB_VOLTAGE_REACHED

are triggered, if the thresholds

#set_stack_current_callback_threshold,
#set_stack_voltage_callback_threshold,
#set_usb_voltage_callback_threshold

keep being reached.

New in version 2.0.5 (Firmware).

BrickMaster#get_debounce_period → int¶

Returns:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by #set_debounce_period.

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 the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

master.register_callback BrickMaster::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters 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.

BrickMaster::CALLBACK_STACK_CURRENT¶

Callback Parameters:	current – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

This callback is triggered periodically with the period that is set by #set_stack_current_callback_period. The parameter is the current of the sensor.

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

New in version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_VOLTAGE¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

This callback is triggered periodically with the period that is set by #set_stack_voltage_callback_period. The parameter is the voltage of the sensor.

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

New in version 2.0.5 (Firmware).

BrickMaster::CALLBACK_USB_VOLTAGE¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

This callback is triggered periodically with the period that is set by #set_usb_voltage_callback_period. The parameter is the USB voltage.

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

Does not work with hardware version 2.1 or newer.

New in version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_CURRENT_REACHED¶

Callback Parameters:	current – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

This callback is triggered when the threshold as set by #set_stack_current_callback_threshold 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 #set_debounce_period.

New in version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_VOLTAGE_REACHED¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

This callback is triggered when the threshold as set by #set_stack_voltage_callback_threshold 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 #set_debounce_period.

New in version 2.0.5 (Firmware).

BrickMaster::CALLBACK_USB_VOLTAGE_REACHED¶

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

This callback is triggered when the threshold as set by #set_usb_voltage_callback_threshold 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 #set_debounce_period.

New in version 2.0.5 (Firmware).

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.

BrickMaster#get_api_version → [int, ...]¶

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

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

BrickMaster#get_response_expected(function_id) → bool¶

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

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

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

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

The following constants are available for this function:

For function_id:

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_BRICKLETS_ENABLED = 113
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
BrickMaster::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickMaster#set_response_expected(function_id, response_expected) → nil¶

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

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

The following constants are available for this function:

For function_id:

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_BRICKLETS_ENABLED = 113
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
BrickMaster::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickMaster#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickMaster#set_bricklet_xmc_flash_config(config, parameter1, parameter2, data) → [int, [int, ...]]¶

Parameters:	config – Type: int, Range: [0 to 2³² - 1] parameter1 – Type: int, Range: [0 to 2³² - 1] parameter2 – Type: int, Range: [0 to 2³² - 1] data – Type: [int, ...], Length: 52, Range: [0 to 255]
Return Array:	0: return_value – Type: int, Range: [0 to 2³² - 1] 1: return_data – Type: [int, ...], Length: 60, Range: [0 to 255]

This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets.

If you need to flash a boostrapper/bootloader (for exmaple because you made your own Bricklet from scratch) please take a look at our open source flash and test tool at https://github.com/Tinkerforge/flash-test

Don't use this function directly.

New in version 2.5.0 (Firmware).

BrickMaster#set_bricklet_xmc_flash_data(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	return_data – Type: int, Range: [0 to 2³² - 1]

This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets.

Don't use this function directly.

New in version 2.5.0 (Firmware).

BrickMaster#set_bricklets_enabled(bricklets_enabled) → nil¶

Parameters:	bricklets_enabled – Type: bool

This function is only available in Master Brick hardware version >= 3.0.

Enables/disables all four Bricklets if set to true/false.

If you disable the Bricklets the power supply to the Bricklets will be disconnected. The Bricklets will lose all configurations if disabled.

New in version 2.5.0 (Firmware).

BrickMaster#get_bricklets_enabled → bool¶

Returns:	bricklets_enabled – Type: bool

Returns true if the Bricklets are enabled, false otherwise.

New in version 2.5.0 (Firmware).

BrickMaster#get_protocol1_bricklet_name(port) → [int, [int, ...], str]¶

Parameters:	port – Type: chr, Range: ['a' to 'd']
Return Array:	0: protocol_version – Type: int, Range: [0 to 255] 1: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 2: name – Type: str, 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.

BrickMaster#write_bricklet_plugin(port, offset, chunk) → nil¶

Parameters:	port – Type: chr, Range: ['a' to 'd'] offset – Type: int, Range: [0 to 255] chunk – Type: [int, ...], Length: 32, Range: [0 to 255]

Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32.

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

BrickMaster#read_bricklet_plugin(port, offset) → [int, ...]¶

Parameters:	port – Type: chr, Range: ['a' to 'd'] offset – Type: int, Range: [0 to 255]
Returns:	chunk – Type: [int, ...], Length: 32, Range: [0 to 255]

Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32.

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

Constants¶

BrickMaster::DEVICE_IDENTIFIER¶

This constant is used to identify a Master Brick.

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

BrickMaster::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Master Brick.