Python - Master Brick¶

This is the API description for the Python bindings of the Master Brick. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the Master Brick and get the first examples running can be found here.

Examples¶

The example code below is public domain.

Stack Status¶

Download

#!/usr/bin/env python
# -*- coding: utf-8 -*-  

HOST = "localhost"
PORT = 4223
UID = "aySDPZAhvvd" # Change to your UID

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_master import Master

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    master = Master(UID, ipcon) # Create device object

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

    # Get voltage and current from stack (in mV/mA)
    voltage = master.get_stack_voltage()
    current = master.get_stack_current()

    print('Stack Voltage: ' + str(voltage/1000.0) + ' V')
    print('Stack Current: ' + str(current/1000.0) + ' A')

    raw_input('Press key to exit\n') # Use input() in Python 3
    ipcon.disconnect()

API¶

All methods listed below are thread-safe.

Basic Functions¶

Master(uid, ipcon)¶

Parameters:	uid – string ipcon – IPConnection

Creates an object with the unique device ID uid:

master = Master("YOUR_DEVICE_UID", ipcon)

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

Master.get_stack_voltage()¶

Return type:	int

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

Master.get_stack_current()¶

Return type:	int

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

Advanced Functions¶

Master.set_extension_type(extension, exttype)¶

Parameters:	extension – int exttype – int
Return type:	None

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

Possible extension types:

Type	Description
1	Chibi
2	RS485
3	WIFI
4	Ethernet

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 value will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

The following constants are available for this function:

BrickMaster.EXTENSION_TYPE_CHIBI = 1
BrickMaster.EXTENSION_TYPE_RS485 = 2
BrickMaster.EXTENSION_TYPE_WIFI = 3
BrickMaster.EXTENSION_TYPE_ETHERNET = 4

Master.get_extension_type(extension)¶

Parameters:	extension – int
Return type:	int

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

The following constants are available for this function:

BrickMaster.EXTENSION_TYPE_CHIBI = 1
BrickMaster.EXTENSION_TYPE_RS485 = 2
BrickMaster.EXTENSION_TYPE_WIFI = 3
BrickMaster.EXTENSION_TYPE_ETHERNET = 4

Master.is_chibi_present()¶

Return type:	bool

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

New in version 1.1.0 (Firmware).

Master.set_chibi_address(address)¶

Parameters:	address – int
Return type:	None

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

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

New in version 1.1.0 (Firmware).

Master.get_chibi_address()¶

Return type:	int

Returns the address as set by set_chibi_address().

New in version 1.1.0 (Firmware).

Master.set_chibi_master_address(address)¶

Parameters:	address – int
Return type:	None

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

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

New in version 1.1.0 (Firmware).

Master.get_chibi_master_address()¶

Return type:	int

Returns the address as set by set_chibi_master_address().

New in version 1.1.0 (Firmware).

Master.set_chibi_slave_address(num, address)¶

Parameters:	num – int address – int
Return type:	None

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

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

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

New in version 1.1.0 (Firmware).

Master.get_chibi_slave_address(num)¶

Parameters:	num – int
Return type:	int

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

New in version 1.1.0 (Firmware).

Master.get_chibi_signal_strength()¶

Return type:	int

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

New in version 1.1.0 (Firmware).

Master.get_chibi_error_log()¶

Return type:	(int, int, int, int)

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.

New in version 1.1.0 (Firmware).

The returned namedtuple has the variables underrun, crc_error, no_ack and overflow.

Master.set_chibi_frequency(frequency)¶

Parameters:	frequency – int
Return type:	None

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

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

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

The following constants are available for this function:

BrickMaster.CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
BrickMaster.CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
BrickMaster.CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
BrickMaster.CHIBI_FREQUENCY_BPSK40_915_MHZ = 3

New in version 1.1.0 (Firmware).

Master.get_chibi_frequency()¶

Return type:	int

Returns the frequency value as set by set_chibi_frequency().

The following constants are available for this function:

BrickMaster.CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
BrickMaster.CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
BrickMaster.CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
BrickMaster.CHIBI_FREQUENCY_BPSK40_915_MHZ = 3

New in version 1.1.0 (Firmware).

Master.set_chibi_channel(channel)¶

Parameters:	channel – int
Return type:	None

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.

New in version 1.1.0 (Firmware).

Master.get_chibi_channel()¶

Return type:	int

Returns the channel as set by set_chibi_channel().

New in version 1.1.0 (Firmware).

Master.is_rs485_present()¶

Return type:	bool

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

New in version 1.2.0 (Firmware).

Master.set_rs485_address(address)¶

Parameters:	address – int
Return type:	None

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.

New in version 1.2.0 (Firmware).

Master.get_rs485_address()¶

Return type:	int

Returns the address as set by set_rs485_address().

New in version 1.2.0 (Firmware).

Master.set_rs485_slave_address(num, address)¶

Parameters:	num – int address – int
Return type:	None

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.

New in version 1.2.0 (Firmware).

Master.get_rs485_slave_address(num)¶

Parameters:	num – int
Return type:	int

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

New in version 1.2.0 (Firmware).

Master.get_rs485_error_log()¶

Return type:	int

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.

New in version 1.2.0 (Firmware).

Master.set_rs485_configuration(speed, parity, stopbits)¶

Parameters:	speed – int parity – chr stopbits – int
Return type:	None

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

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

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

The following constants are available for this function:

BrickMaster.RS485_PARITY_NONE = ‘n’
BrickMaster.RS485_PARITY_EVEN = ‘e’
BrickMaster.RS485_PARITY_ODD = ‘o’

New in version 1.2.0 (Firmware).

Master.get_rs485_configuration()¶

Return type:	(int, chr, int)

Returns the configuration as set by set_rs485_configuration().

The following constants are available for this function:

BrickMaster.RS485_PARITY_NONE = ‘n’
BrickMaster.RS485_PARITY_EVEN = ‘e’
BrickMaster.RS485_PARITY_ODD = ‘o’

New in version 1.2.0 (Firmware).

The returned namedtuple has the variables speed, parity and stopbits.

Master.is_wifi_present()¶

Return type:	bool

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

New in version 1.2.0 (Firmware).

Master.set_wifi_configuration(ssid, connection, ip, subnet_mask, gateway, port)¶

Parameters:	ssid – str connection – int ip – [int, int, int, int] subnet_mask – [int, int, int, int] gateway – [int, int, int, int] port – int
Return type:	None

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

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

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

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

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

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

The following constants are available for this function:

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

New in version 1.3.0 (Firmware).

Master.get_wifi_configuration()¶

Return type:	(str, int, [int, int, int, int], [int, int, int, int], [int, int, int, int], int)

Returns the configuration as set by set_wifi_configuration().

The following constants are available for this function:

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

New in version 1.3.0 (Firmware).

The returned namedtuple has the variables ssid, connection, ip, subnet_mask, gateway and port.

Master.set_wifi_encryption(encryption, key, key_index, eap_options, ca_certificate_length, client_certificate_length, private_key_length)¶

Parameters:	encryption – int key – str key_index – int eap_options – int ca_certificate_length – int client_certificate_length – int private_key_length – int
Return type:	None

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 certificate length are given in byte and 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 auth	1-2	0=EAP-FAST, 1=EAP-TLS, 2=EAP-TTLS, 3=EAP-PEAP
inner auth	3	0=EAP-MSCHAP, 1=EAP-GTC
cert 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 WIFI encryption.

The following constants are available for this function:

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

New in version 1.3.0 (Firmware).

Master.get_wifi_encryption()¶

Return type:	(int, str, int, int, int, int, int)

Returns the encryption as set by set_wifi_encryption().

The following constants are available for this function:

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

New in version 1.3.0 (Firmware).

The returned namedtuple has the variables encryption, key, key_index, eap_options, ca_certificate_length, client_certificate_length and private_key_length.

Master.get_wifi_status()¶

Return type:	([int, int, int, int, int, int], [int, int, int, int, int, int], int, int, [int, int, int, int], [int, int, int, int], [int, int, int, int], int, int, int)

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:

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

New in version 1.3.0 (Firmware).

The returned namedtuple has the variables mac_address, bssid, channel, rssi, ip, subnet_mask, gateway, rx_count, tx_count and state.

Master.refresh_wifi_status()¶

Return type:	None

Refreshes the WIFI status (see get_wifi_status()). To read the status of the WIFI 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 Extensions reacts again after this function is called.

New in version 1.3.0 (Firmware).

Master.set_wifi_certificate(index, data, data_length)¶

Parameters:	index – int data – [int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int] data_length – int
Return type:	None

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

New in version 1.3.0 (Firmware).

Master.get_wifi_certificate(index)¶

Parameters:	index – int
Return type:	([int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int, int], int)

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

New in version 1.3.0 (Firmware).

The returned namedtuple has the variables data and data_length.

Master.set_wifi_power_mode(mode)¶

Parameters:	mode – int
Return type:	None

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

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

The default value is 0 (Full Speed).

The following constants are available for this function:

BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1

New in version 1.3.0 (Firmware).

Master.get_wifi_power_mode()¶

Return type:	int

Returns the power mode as set by set_wifi_power_mode().

The following constants are available for this function:

BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1

New in version 1.3.0 (Firmware).

Master.get_wifi_buffer_info()¶

Return type:	(int, int, int)

Returns informations about the WIFI receive buffer. The WIFI 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.

New in version 1.3.2 (Firmware).

The returned namedtuple has the variables overflow, low_watermark and used.

Master.set_wifi_regulatory_domain(domain)¶

Parameters:	domain – int
Return type:	None

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

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

The default value is 1 (ETSI).

The following constants are available for this function:

BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2

New in version 1.3.4 (Firmware).

Master.get_wifi_regulatory_domain()¶

Return type:	int

Returns the regulatory domain as set by set_wifi_regulatory_domain().

The following constants are available for this function:

BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2

New in version 1.3.4 (Firmware).

Master.get_usb_voltage()¶

Return type:	int

Returns the USB voltage in mV.

New in version 1.3.5 (Firmware).

Master.set_long_wifi_key(key)¶

Parameters:	key – str
Return type:	None

Sets a long WIFI 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).

Master.get_long_wifi_key()¶

Return type:	str

Returns the encryption key as set by set_long_wifi_key().

New in version 2.0.2 (Firmware).

Master.set_wifi_hostname(hostname)¶

Parameters:	hostname – str
Return type:	None

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

Master.get_wifi_hostname()¶

Return type:	str

Returns the hostname as set by get_wifi_hostname().

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

New in version 2.0.5 (Firmware).

Master.is_ethernet_present()¶

Return type:	bool

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

New in version 2.1.0 (Firmware).

Master.set_ethernet_configuration(connection, ip, subnet_mask, gateway, port)¶

Parameters:	connection – int ip – [int, int, int, int] subnet_mask – [int, int, int, int] gateway – [int, int, int, int] port – int
Return type:	None

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

Value	Description
0	DHCP
1	Static IP

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

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

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

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

The following constants are available for this function:

BrickMaster.ETHERNET_CONNECTION_DHCP = 0
BrickMaster.ETHERNET_CONNECTION_STATIC_IP = 1

New in version 2.1.0 (Firmware).

Master.get_ethernet_configuration()¶

Return type:	(int, [int, int, int, int], [int, int, int, int], [int, int, int, int], int)

Returns the configuration as set by set_ethernet_configuration().

The following constants are available for this function:

BrickMaster.ETHERNET_CONNECTION_DHCP = 0
BrickMaster.ETHERNET_CONNECTION_STATIC_IP = 1

New in version 2.1.0 (Firmware).

The returned namedtuple has the variables connection, ip, subnet_mask, gateway and port.

Master.get_ethernet_status()¶

Return type:	([int, int, int, int, int, int], [int, int, int, int], [int, int, int, int], [int, int, int, int], int, int, str)

Returns the status of the Ethernet Extension.

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

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

hostname is the currently used hostname.

New in version 2.1.0 (Firmware).

The returned namedtuple has the variables mac_address, ip, subnet_mask, gateway, rx_count, tx_count and hostname.

Master.set_ethernet_hostname(hostname)¶

Parameters:	hostname – str
Return type:	None

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

Master.set_ethernet_mac_address(mac_address)¶

Parameters:	mac_address – [int, int, int, int, int, int]
Return type:	None

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

Master.get_api_version()¶

Return type:	[int, int, int]

Returns the API version (major, minor, revision) of the bindings for this device.

Master.get_response_expected(function_id)¶

Parameters:	function_id – int
Return 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 send and errors are silently ignored, because they cannot be detected.

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

Master.set_response_expected(function_id, response_expected)¶

Parameters:	function_id – int response_expected – bool
Return type:	None

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 and callbacks it is always disabled.

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

The following function ID constants are available for this function:

BrickMaster.FUNCTION_SET_EXTENSION_TYPE = 3
BrickMaster.FUNCTION_SET_CHIBI_ADDRESS = 6
BrickMaster.FUNCTION_SET_CHIBI_MASTER_ADDRESS = 8
BrickMaster.FUNCTION_SET_CHIBI_SLAVE_ADDRESS = 10
BrickMaster.FUNCTION_SET_CHIBI_FREQUENCY = 14
BrickMaster.FUNCTION_SET_CHIBI_CHANNEL = 16
BrickMaster.FUNCTION_SET_RS485_ADDRESS = 19
BrickMaster.FUNCTION_SET_RS485_SLAVE_ADDRESS = 21
BrickMaster.FUNCTION_SET_RS485_CONFIGURATION = 24
BrickMaster.FUNCTION_SET_WIFI_CONFIGURATION = 27
BrickMaster.FUNCTION_SET_WIFI_ENCRYPTION = 29
BrickMaster.FUNCTION_REFRESH_WIFI_STATUS = 32
BrickMaster.FUNCTION_SET_WIFI_CERTIFICATE = 33
BrickMaster.FUNCTION_SET_WIFI_POWER_MODE = 35
BrickMaster.FUNCTION_SET_WIFI_REGULATORY_DOMAIN = 38
BrickMaster.FUNCTION_SET_LONG_WIFI_KEY = 41
BrickMaster.FUNCTION_SET_WIFI_HOSTNAME = 43
BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD = 45
BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD = 47
BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD = 49
BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD = 51
BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD = 53
BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD = 55
BrickMaster.FUNCTION_SET_DEBOUNCE_PERIOD = 57
BrickMaster.FUNCTION_SET_ETHERNET_CONFIGURATION = 66
BrickMaster.FUNCTION_SET_ETHERNET_HOSTNAME = 69
BrickMaster.FUNCTION_SET_ETHERNET_MAC_ADDRESS = 70
BrickMaster.FUNCTION_RESET = 243

Master.set_response_expected_all(response_expected)¶

Parameters:	response_expected – bool
Return type:	None

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

Master.get_protocol1_bricklet_name(port)¶

Parameters:	port – chr
Return type:	(int, [int, int, int], str)

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.

New in version 2.0.0 (Firmware).

The returned namedtuple has the variables protocol_version, firmware_version and name.

Master.get_chip_temperature()¶

Return type:	int

Returns the temperature in °C/10 as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has an accuracy of +-15%. Practically it is only useful as an indicator for temperature changes.

New in version 1.2.1 (Firmware).

Master.reset()¶

Return type:	None

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!

New in version 1.2.1 (Firmware).

Master.get_identity()¶

Return type:	(str, str, chr, [int, int, int], [int, int, int], int)

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

The position can be ‘0’-‘8’ (stack position).

The device identifiers can be found here.

New in version 2.0.0 (Firmware).

The returned namedtuple has the variables uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions¶

Master.register_callback(id, callback)¶

Parameters:	id – int callback – callable
Return type:	None

Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

Master.set_stack_current_callback_period(period)¶

Parameters:	period – int
Return type:	None

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Master.get_stack_current_callback_period()¶

Return type:	int

Returns the period as set by SetCurrentCallbackPeriod().

New in version 2.0.5 (Firmware).

Master.set_stack_voltage_callback_period(period)¶

Parameters:	period – int
Return type:	None

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Master.get_stack_voltage_callback_period()¶

Return type:	int

Returns the period as set by set_stack_voltage_callback_period().

New in version 2.0.5 (Firmware).

Master.set_usb_voltage_callback_period(period)¶

Parameters:	period – int
Return type:	None

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Master.get_usb_voltage_callback_period()¶

Return type:	int

Returns the period as set by set_usb_voltage_callback_period().

New in version 2.0.5 (Firmware).

Master.set_stack_current_callback_threshold(option, min, max)¶

Parameters:	option – chr min – int max – int
Return type:	None

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 default value is (‘x’, 0, 0).

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

Master.get_stack_current_callback_threshold()¶

Return type:	(chr, int, int)

Returns the threshold as set by set_stack_current_callback_threshold().

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

The returned namedtuple has the variables option, min and max.

Master.set_stack_voltage_callback_threshold(option, min, max)¶

Parameters:	option – chr min – int max – int
Return type:	None

Sets the thresholds for the StackStackVoltageReached() callback.

The following options are possible:

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

The default value is (‘x’, 0, 0).

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

Master.get_stack_voltage_callback_threshold()¶

Return type:	(chr, int, int)

Returns the threshold as set by set_stack_voltage_callback_threshold().

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

The returned namedtuple has the variables option, min and max.

Master.set_usb_voltage_callback_threshold(option, min, max)¶

Parameters:	option – chr min – int max – int
Return type:	None

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 default value is (‘x’, 0, 0).

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

Master.get_usb_voltage_callback_threshold()¶

Return type:	(chr, int, int)

Returns the threshold as set by set_usb_voltage_callback_threshold().

The following constants are available for this function:

BrickMaster.THRESHOLD_OPTION_OFF = ‘x’
BrickMaster.THRESHOLD_OPTION_OUTSIDE = ‘o’
BrickMaster.THRESHOLD_OPTION_INSIDE = ‘i’
BrickMaster.THRESHOLD_OPTION_SMALLER = ‘<’
BrickMaster.THRESHOLD_OPTION_GREATER = ‘>’

New in version 2.0.5 (Firmware).

The returned namedtuple has the variables option, min and max.

Master.set_debounce_period(debounce)¶

Parameters:	debounce – int
Return type:	None

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

The default value is 100.

New in version 2.0.5 (Firmware).

Master.get_debounce_period()¶

Return type:	int

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 the callback function:

def my_callback(param):
    print(param)

master.register_callback(Master.CALLBACK_EXAMPLE, my_callback)

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.

Master.CALLBACK_STACK_CURRENT¶

Parameters:	current – int

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.

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

New in version 2.0.5 (Firmware).

Master.CALLBACK_STACK_VOLTAGE¶

Parameters:	voltage – int

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.

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

New in version 2.0.5 (Firmware).

Master.CALLBACK_USB_VOLTAGE¶

Parameters:	voltage – int

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

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

New in version 2.0.5 (Firmware).

Master.CALLBACK_STACK_CURRENT_REACHED¶

Parameters:	current – int

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

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

New in version 2.0.5 (Firmware).

Master.CALLBACK_STACK_VOLTAGE_REACHED¶

Parameters:	voltage – int

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

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

New in version 2.0.5 (Firmware).

Master.CALLBACK_USB_VOLTAGE_REACHED¶

Parameters:	voltage – int

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

Constants¶

Master.DEVICE_IDENTIFIER¶

This constant is used to identify a Master Brick.

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

Chip Award Winner

Table Of Contents

Previous topic

Next topic

Python - Master Brick¶

Examples¶

Stack Status¶

API¶

Basic Functions¶

Advanced Functions¶

Callback Configuration Functions¶

Callbacks¶

Constants¶

Important Infos

About us

Follow us