Modbus - Master Brick

This is the description of the Modbus protocol for the Master Brick. General information and technical specifications for the Master Brick are summarized in its hardware description.

API

A general description of the Modbus protocol structure can be found here.

Basic Functions

BrickMaster.get_stack_voltage
Function ID:
  • 1
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

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

BrickMaster.get_stack_current
Function ID:
  • 2
Request:
  • empty payload
Response:
  • current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1]

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

Advanced Functions

BrickMaster.set_extension_type
Function ID:
  • 3
Request:
  • extension – Type: uint8, Range: [0 to 1]
  • exttype – Type: uint32, Range: See meanings
Response:
  • no response

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 meanings are defined for the elements of this function:

For exttype:

  • 1 = Chibi
  • 2 = RS485
  • 3 = Wifi
  • 4 = Ethernet
  • 5 = Wifi2
BrickMaster.get_extension_type
Function ID:
  • 4
Request:
  • extension – Type: uint8, Range: [0 to 1]
Response:
  • exttype – Type: uint32, Range: See meanings

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

The following meanings are defined for the elements of this function:

For exttype:

  • 1 = Chibi
  • 2 = RS485
  • 3 = Wifi
  • 4 = Ethernet
  • 5 = Wifi2
BrickMaster.is_chibi_present
Function ID:
  • 5
Request:
  • empty payload
Response:
  • 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
Function ID:
  • 6
Request:
  • address – Type: uint8, Range: [1 to 255]
Response:
  • no response

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
Function ID:
  • 7
Request:
  • empty payload
Response:
  • address – Type: uint8, Range: [1 to 255]

Returns the address as set by set_chibi_address.

BrickMaster.set_chibi_master_address
Function ID:
  • 8
Request:
  • address – Type: uint8, Range: [1 to 255]
Response:
  • no response

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
Function ID:
  • 9
Request:
  • empty payload
Response:
  • address – Type: uint8, Range: [1 to 255]

Returns the address as set by set_chibi_master_address.

BrickMaster.set_chibi_slave_address
Function ID:
  • 10
Request:
  • num – Type: uint8, Range: [0 to 254]
  • address – Type: uint8, Range: [0 to 255]
Response:
  • no response

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
Function ID:
  • 11
Request:
  • num – Type: uint8, Range: [0 to 254]
Response:
  • address – Type: uint8, Range: [0 to 255]

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

BrickMaster.get_chibi_signal_strength
Function ID:
  • 12
Request:
  • empty payload
Response:
  • signal_strength – Type: uint8, 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
Function ID:
  • 13
Request:
  • empty payload
Response:
  • underrun – Type: uint16, Range: [0 to 216 - 1]
  • crc_error – Type: uint16, Range: [0 to 216 - 1]
  • no_ack – Type: uint16, Range: [0 to 216 - 1]
  • overflow – Type: uint16, Range: [0 to 216 - 1]

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

BrickMaster.set_chibi_frequency
Function ID:
  • 14
Request:
  • frequency – Type: uint8, Range: See meanings
Response:
  • no response

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 meanings are defined for the elements of this function:

For frequency:

  • 0 = OQPSK 868 MHz
  • 1 = OQPSK 915 MHz
  • 2 = OQPSK 780 MHz
  • 3 = BPSK40.915 MHz
BrickMaster.get_chibi_frequency
Function ID:
  • 15
Request:
  • empty payload
Response:
  • frequency – Type: uint8, Range: See meanings

Returns the frequency value as set by set_chibi_frequency.

The following meanings are defined for the elements of this function:

For frequency:

  • 0 = OQPSK 868 MHz
  • 1 = OQPSK 915 MHz
  • 2 = OQPSK 780 MHz
  • 3 = BPSK40.915 MHz
BrickMaster.set_chibi_channel
Function ID:
  • 16
Request:
  • channel – Type: uint8, Range: ?
Response:
  • no response

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
Function ID:
  • 17
Request:
  • empty payload
Response:
  • channel – Type: uint8, Range: ?

Returns the channel as set by set_chibi_channel.

BrickMaster.is_rs485_present
Function ID:
  • 18
Request:
  • empty payload
Response:
  • 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
Function ID:
  • 19
Request:
  • address – Type: uint8, Range: [0 to 255]
Response:
  • no response

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
Function ID:
  • 20
Request:
  • empty payload
Response:
  • address – Type: uint8, Range: [0 to 255]

Returns the address as set by set_rs485_address.

BrickMaster.set_rs485_slave_address
Function ID:
  • 21
Request:
  • num – Type: uint8, Range: [0 to 255]
  • address – Type: uint8, Range: [0 to 255]
Response:
  • no response

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
Function ID:
  • 22
Request:
  • num – Type: uint8, Range: [0 to 255]
Response:
  • address – Type: uint8, Range: [0 to 255]

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

BrickMaster.get_rs485_error_log
Function ID:
  • 23
Request:
  • empty payload
Response:
  • crc_error – Type: uint16, Range: [0 to 216 - 1]

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

BrickMaster.set_rs485_configuration
Function ID:
  • 24
Request:
  • speed – Type: uint32, Unit: 1 Bd, Range: [0 to 232 - 1]
  • parity – Type: char, Range: See meanings
  • stopbits – Type: uint8, Range: [1 to 2]
Response:
  • no response

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 meanings are defined for the elements of this function:

For parity:

  • 'n' = None
  • 'e' = Even
  • 'o' = Odd
BrickMaster.get_rs485_configuration
Function ID:
  • 25
Request:
  • empty payload
Response:
  • speed – Type: uint32, Unit: 1 Bd, Range: [0 to 232 - 1]
  • parity – Type: char, Range: See meanings
  • stopbits – Type: uint8, Range: [1 to 2]

Returns the configuration as set by set_rs485_configuration.

The following meanings are defined for the elements of this function:

For parity:

  • 'n' = None
  • 'e' = Even
  • 'o' = Odd
BrickMaster.is_wifi_present
Function ID:
  • 26
Request:
  • empty payload
Response:
  • 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
Function ID:
  • 27
Request:
  • ssid – Type: char[32]
  • connection – Type: uint8, Range: See meanings
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223
Response:
  • no response

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 meanings are defined for the elements of this function:

For connection:

  • 0 = DHCP
  • 1 = Static IP
  • 2 = Access Point DHCP
  • 3 = Access Point Static IP
  • 4 = Ad Hoc DHCP
  • 5 = Ad Hoc Static IP
BrickMaster.get_wifi_configuration
Function ID:
  • 28
Request:
  • empty payload
Response:
  • ssid – Type: char[32]
  • connection – Type: uint8, Range: See meanings
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223

Returns the configuration as set by set_wifi_configuration.

The following meanings are defined for the elements of this function:

For connection:

  • 0 = DHCP
  • 1 = Static IP
  • 2 = Access Point DHCP
  • 3 = Access Point Static IP
  • 4 = Ad Hoc DHCP
  • 5 = Ad Hoc Static IP
BrickMaster.set_wifi_encryption
Function ID:
  • 29
Request:
  • encryption – Type: uint8, Range: See meanings
  • key – Type: char[50]
  • key_index – Type: uint8, Range: [1 to 4]
  • eap_options – Type: uint8, Range: See meanings
  • ca_certificate_length – Type: uint16, Unit: 1 B, Range: [0 to 1312]
  • client_certificate_length – Type: uint16, Unit: 1 B, Range: [0 to 1312]
  • private_key_length – Type: uint16, Unit: 1 B, Range: [0 to 4320]
Response:
  • no response

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 meanings are defined for the elements of this function:

For encryption:

  • 0 = WPA WPA2
  • 1 = WPA Enterprise
  • 2 = WEP
  • 3 = No Encryption

For eap_options:

  • 0 = Outer Auth EAP FAST
  • 1 = Outer Auth EAP TLS
  • 2 = Outer Auth EAP TTLS
  • 3 = Outer Auth EAP PEAP
  • 0 = Inner Auth EAP MSCHAP
  • 4 = Inner Auth EAP GTC
  • 0 = Cert Type CA Cert
  • 8 = Cert Type Client Cert
  • 16 = Cert Type Private Key
BrickMaster.get_wifi_encryption
Function ID:
  • 30
Request:
  • empty payload
Response:
  • encryption – Type: uint8, Range: See meanings
  • key – Type: char[50]
  • key_index – Type: uint8, Range: [1 to 4]
  • eap_options – Type: uint8, Range: See meanings
  • ca_certificate_length – Type: uint16, Range: [0 to 216 - 1]
  • client_certificate_length – Type: uint16, Range: [0 to 216 - 1]
  • private_key_length – Type: uint16, Range: [0 to 216 - 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 meanings are defined for the elements of this function:

For encryption:

  • 0 = WPA WPA2
  • 1 = WPA Enterprise
  • 2 = WEP
  • 3 = No Encryption

For eap_options:

  • 0 = Outer Auth EAP FAST
  • 1 = Outer Auth EAP TLS
  • 2 = Outer Auth EAP TTLS
  • 3 = Outer Auth EAP PEAP
  • 0 = Inner Auth EAP MSCHAP
  • 4 = Inner Auth EAP GTC
  • 0 = Cert Type CA Cert
  • 8 = Cert Type Client Cert
  • 16 = Cert Type Private Key
BrickMaster.get_wifi_status
Function ID:
  • 31
Request:
  • empty payload
Response:
  • mac_address – Type: uint8[6], Range: [0 to 255]
  • bssid – Type: uint8[6], Range: [0 to 255]
  • channel – Type: uint8, Range: ?
  • rssi – Type: int16, Range: [-215 to 215 - 1]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • rx_count – Type: uint32, Range: [0 to 232 - 1]
  • tx_count – Type: uint32, Range: [0 to 232 - 1]
  • state – Type: uint8, Range: See meanings

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 meanings are defined for the elements of this function:

For state:

  • 0 = Disassociated
  • 1 = Associated
  • 2 = Associating
  • 3 = Error
  • 255 = Not Initialized Yet
BrickMaster.refresh_wifi_status
Function ID:
  • 32
Request:
  • empty payload
Response:
  • no response

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
Function ID:
  • 33
Request:
  • index – Type: uint16, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 216 - 1]
  • data – Type: uint8[32], Range: [0 to 255]
  • data_length – Type: uint8, Unit: 1 B, Range: [0 to 32]
Response:
  • no response

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
Function ID:
  • 34
Request:
  • index – Type: uint16, Range: [0 to 1311, 10000 to 11311, 20000 to 24319, 65534 to 216 - 1]
Response:
  • data – Type: uint8[32], Range: [0 to 255]
  • data_length – Type: uint8, Range: [0 to 32]

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

BrickMaster.set_wifi_power_mode
Function ID:
  • 35
Request:
  • mode – Type: uint8, Range: See meanings, Default: 0
Response:
  • no response

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 meanings are defined for the elements of this function:

For mode:

  • 0 = Full Speed
  • 1 = Low Power
BrickMaster.get_wifi_power_mode
Function ID:
  • 36
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings, Default: 0

Returns the power mode as set by set_wifi_power_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Full Speed
  • 1 = Low Power
BrickMaster.get_wifi_buffer_info
Function ID:
  • 37
Request:
  • empty payload
Response:
  • overflow – Type: uint32, Range: [0 to 232 - 1]
  • low_watermark – Type: uint16, Unit: 1 B, Range: [0 to 1500]
  • used – Type: uint16, 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
Function ID:
  • 38
Request:
  • domain – Type: uint8, Range: See meanings, Default: 1
Response:
  • no response

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 meanings are defined for the elements of this function:

For domain:

  • 0 = Channel 1To11
  • 1 = Channel 1To13
  • 2 = Channel 1To14
BrickMaster.get_wifi_regulatory_domain
Function ID:
  • 39
Request:
  • empty payload
Response:
  • domain – Type: uint8, Range: See meanings, Default: 1

Returns the regulatory domain as set by set_wifi_regulatory_domain.

The following meanings are defined for the elements of this function:

For domain:

  • 0 = Channel 1To11
  • 1 = Channel 1To13
  • 2 = Channel 1To14
BrickMaster.get_usb_voltage
Function ID:
  • 40
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

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

BrickMaster.set_long_wifi_key
Function ID:
  • 41
Request:
  • key – Type: char[64]
Response:
  • no response

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
Function ID:
  • 42
Request:
  • empty payload
Response:
  • key – Type: char[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
Function ID:
  • 43
Request:
  • hostname – Type: char[16]
Response:
  • no response

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
Function ID:
  • 44
Request:
  • empty payload
Response:
  • hostname – Type: char[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
Function ID:
  • 65
Request:
  • empty payload
Response:
  • 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
Function ID:
  • 66
Request:
  • connection – Type: uint8, Range: See meanings
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223
Response:
  • no response

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.

New in version 2.1.0 (Firmware).

The following meanings are defined for the elements of this function:

For connection:

  • 0 = DHCP
  • 1 = Static IP
BrickMaster.get_ethernet_configuration
Function ID:
  • 67
Request:
  • empty payload
Response:
  • connection – Type: uint8, Range: See meanings
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223

Returns the configuration as set by set_ethernet_configuration.

New in version 2.1.0 (Firmware).

The following meanings are defined for the elements of this function:

For connection:

  • 0 = DHCP
  • 1 = Static IP
BrickMaster.get_ethernet_status
Function ID:
  • 68
Request:
  • empty payload
Response:
  • mac_address – Type: uint8[6], Range: [0 to 255]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • rx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • tx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • hostname – Type: char[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
Function ID:
  • 69
Request:
  • hostname – Type: char[32]
Response:
  • no response

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
Function ID:
  • 70
Request:
  • mac_address – Type: uint8[6], Range: [0 to 255]
Response:
  • no response

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
Function ID:
  • 71
Request:
  • sockets – Type: uint8, Range: [0 to 7], Default: 3
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4280
Response:
  • no response

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
Function ID:
  • 72
Request:
  • empty payload
Response:
  • sockets – Type: uint8, Range: [0 to 7], Default: 3
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4280

Returns the configuration as set by set_ethernet_configuration.

New in version 2.2.0 (Firmware).

BrickMaster.set_ethernet_authentication_secret
Function ID:
  • 73
Request:
  • secret – Type: char[64], Default: ""
Response:
  • no response

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
Function ID:
  • 74
Request:
  • empty payload
Response:
  • secret – Type: char[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
Function ID:
  • 75
Request:
  • secret – Type: char[64], Default: ""
Response:
  • no response

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
Function ID:
  • 76
Request:
  • empty payload
Response:
  • secret – Type: char[64], Default: ""

Returns the authentication secret as set by set_wifi_authentication_secret.

New in version 2.2.0 (Firmware).

BrickMaster.get_connection_type
Function ID:
  • 77
Request:
  • empty payload
Response:
  • connection_type – Type: uint8, Range: See meanings

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

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For connection_type:

  • 0 = None
  • 1 = USB
  • 2 = SPI Stack
  • 3 = Chibi
  • 4 = RS485
  • 5 = Wifi
  • 6 = Ethernet
  • 7 = Wifi2
BrickMaster.is_wifi2_present
Function ID:
  • 78
Request:
  • empty payload
Response:
  • 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
Function ID:
  • 79
Request:
  • empty payload
Response:
  • result – Type: int8, 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
Function ID:
  • 80
Request:
  • data – Type: uint8[60], Range: [0 to 255]
  • length – Type: uint8, Unit: 1 B, Range: [0 to 60]
Response:
  • result – Type: int8, 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
Function ID:
  • 81
Request:
  • length – Type: uint8, Range: [0 to 255]
Response:
  • data – Type: uint8[60], Range: [0 to 60]
  • result – Type: uint8, 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
Function ID:
  • 82
Request:
  • secret – Type: char[64]
Response:
  • no response

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
Function ID:
  • 83
Request:
  • empty payload
Response:
  • secret – Type: char[64]

Returns the WIFI authentication secret as set by set_wifi2_authentication_secret.

New in version 2.4.0 (Firmware).

BrickMaster.set_wifi2_configuration
Function ID:
  • 84
Request:
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223
  • websocket_port – Type: uint16, Range: [0 to 216 - 1], Default: 4280
  • website_port – Type: uint16, Range: [0 to 216 - 1], Default: 80
  • phy_mode – Type: uint8, Range: See meanings
  • sleep_mode – Type: uint8, Range: [0 to 255]
  • website – Type: uint8, Range: [0 to 255]
Response:
  • no response

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.

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For phy_mode:

  • 0 = B
  • 1 = G
  • 2 = N
BrickMaster.get_wifi2_configuration
Function ID:
  • 85
Request:
  • empty payload
Response:
  • port – Type: uint16, Range: [0 to 216 - 1], Default: 4223
  • websocket_port – Type: uint16, Range: [0 to 216 - 1], Default: 4280
  • website_port – Type: uint16, Range: [0 to 216 - 1], Default: 80
  • phy_mode – Type: uint8, Range: See meanings
  • sleep_mode – Type: uint8, Range: [0 to 255]
  • website – Type: uint8, Range: [0 to 255]

Returns the general configuration as set by set_wifi2_configuration.

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For phy_mode:

  • 0 = B
  • 1 = G
  • 2 = N
BrickMaster.get_wifi2_status
Function ID:
  • 86
Request:
  • empty payload
Response:
  • client_enabled – Type: bool
  • client_status – Type: uint8, Range: See meanings
  • client_ip – Type: uint8[4], Range: [0 to 255]
  • client_subnet_mask – Type: uint8[4], Range: [0 to 255]
  • client_gateway – Type: uint8[4], Range: [0 to 255]
  • client_mac_address – Type: uint8[6], Range: [0 to 255]
  • client_rx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • client_tx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • client_rssi – Type: int8, Range: [-128 to 127]
  • ap_enabled – Type: bool
  • ap_ip – Type: uint8[4], Range: [0 to 255]
  • ap_subnet_mask – Type: uint8[4], Range: [0 to 255]
  • ap_gateway – Type: uint8[4], Range: [0 to 255]
  • ap_mac_address – Type: uint8[6], Range: [0 to 255]
  • ap_rx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • ap_tx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • ap_connected_count – Type: uint8, Range: [0 to 255]

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

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For client_status:

  • 0 = Idle
  • 1 = Connecting
  • 2 = Wrong Password
  • 3 = No AP Found
  • 4 = Connect Failed
  • 5 = Got IP
  • 255 = Unknown
BrickMaster.set_wifi2_client_configuration
Function ID:
  • 87
Request:
  • enable – Type: bool, Default: true
  • ssid – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • mac_address – Type: uint8[6], Range: [0 to 255]
  • bssid – Type: uint8[6], Range: [0 to 255]
Response:
  • no response

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
Function ID:
  • 88
Request:
  • empty payload
Response:
  • enable – Type: bool, Default: true
  • ssid – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • mac_address – Type: uint8[6], Range: [0 to 255]
  • bssid – Type: uint8[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
Function ID:
  • 89
Request:
  • hostname – Type: char[32]
Response:
  • no response

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
Function ID:
  • 90
Request:
  • empty payload
Response:
  • hostname – Type: char[32]

Returns the client hostname as set by set_wifi2_client_hostname.

New in version 2.4.0 (Firmware).

BrickMaster.set_wifi2_client_password
Function ID:
  • 91
Request:
  • password – Type: char[64]
Response:
  • no response

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
Function ID:
  • 92
Request:
  • empty payload
Response:
  • password – Type: char[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
Function ID:
  • 93
Request:
  • enable – Type: bool, Default: true
  • ssid – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255], Default: [0, 0, 0, 0]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • encryption – Type: uint8, Range: See meanings, Default: 4
  • hidden – Type: bool, Default: false
  • channel – Type: uint8, Range: [0 to 255], Default: 1
  • mac_address – Type: uint8[6], Range: [0 to 255]
Response:
  • no response

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

The enable parameter enables or disables the access point part of the WIFI Extension 2.0.

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

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

The encryption parameter sets the encryption mode to be used. Possible values are Open (no encryption), WEP or WPA/WPA2 PSK. Use the 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.

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For encryption:

  • 0 = Open
  • 1 = WEP
  • 2 = WPA PSK
  • 3 = WPA2 PSK
  • 4 = WPA WPA2 PSK
BrickMaster.get_wifi2_ap_configuration
Function ID:
  • 94
Request:
  • empty payload
Response:
  • enable – Type: bool, Default: true
  • ssid – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255], Default: [0, 0, 0, 0]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • encryption – Type: uint8, Range: See meanings, Default: 4
  • hidden – Type: bool, Default: false
  • channel – Type: uint8, Range: [0 to 255], Default: 1
  • mac_address – Type: uint8[6], Range: [0 to 255]

Returns the access point configuration as set by set_wifi2_ap_configuration.

New in version 2.4.0 (Firmware).

The following meanings are defined for the elements of this function:

For encryption:

  • 0 = Open
  • 1 = WEP
  • 2 = WPA PSK
  • 3 = WPA2 PSK
  • 4 = WPA WPA2 PSK
BrickMaster.set_wifi2_ap_password
Function ID:
  • 95
Request:
  • password – Type: char[64]
Response:
  • no response

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
Function ID:
  • 96
Request:
  • empty payload
Response:
  • password – Type: char[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
Function ID:
  • 97
Request:
  • empty payload
Response:
  • result – Type: uint8, 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
Function ID:
  • 98
Request:
  • empty payload
Response:
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, 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
Function ID:
  • 99
Request:
  • empty payload
Response:
  • no response

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

New in version 2.4.0 (Firmware).

BrickMaster.disable_wifi2_status_led
Function ID:
  • 100
Request:
  • empty payload
Response:
  • no response

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
Function ID:
  • 101
Request:
  • empty payload
Response:
  • enabled – Type: bool

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
Function ID:
  • 102
Request:
  • enable – Type: bool, Default: false
  • root_ip – Type: uint8[4], Range: [0 to 255], Default: [0, 0, 0, 0]
  • root_subnet_mask – Type: uint8[4], Range: [0 to 255]
  • root_gateway – Type: uint8[4], Range: [0 to 255]
  • router_bssid – Type: uint8[6], Range: [0 to 255]
  • group_id – Type: uint8[6], Range: [0 to 255]
  • group_ssid_prefix – Type: char[16]
  • gateway_ip – Type: uint8[4], Range: [0 to 255]
  • gateway_port – Type: uint16, Range: [0 to 216 - 1]
Response:
  • no response

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
Function ID:
  • 103
Request:
  • empty payload
Response:
  • enable – Type: bool, Default: false
  • root_ip – Type: uint8[4], Range: [0 to 255], Default: [0, 0, 0, 0]
  • root_subnet_mask – Type: uint8[4], Range: [0 to 255]
  • root_gateway – Type: uint8[4], Range: [0 to 255]
  • router_bssid – Type: uint8[6], Range: [0 to 255]
  • group_id – Type: uint8[6], Range: [0 to 255]
  • group_ssid_prefix – Type: char[16]
  • gateway_ip – Type: uint8[4], Range: [0 to 255]
  • gateway_port – Type: uint16, Range: [0 to 216 - 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
Function ID:
  • 104
Request:
  • ssid – Type: char[32]
Response:
  • no response

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
Function ID:
  • 105
Request:
  • empty payload
Response:
  • ssid – Type: char[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
Function ID:
  • 106
Request:
  • password – Type: char[64]
Response:
  • no response

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
Function ID:
  • 107
Request:
  • empty payload
Response:
  • password – Type: char[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
Function ID:
  • 108
Request:
  • empty payload
Response:
  • status – Type: uint8, Range: See meanings
  • root_node – Type: bool
  • root_candidate – Type: bool
  • connected_nodes – Type: uint16, Range: [0 to 216 - 1]
  • rx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
  • tx_count – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the common mesh status of the WIFI Extension 2.0.

New in version 2.4.2 (Firmware).

The following meanings are defined for the elements of this function:

For status:

  • 0 = Disabled
  • 1 = WIFI Connecting
  • 2 = Got IP
  • 3 = Mesh Local
  • 4 = Mesh Online
  • 5 = AP Available
  • 6 = AP Setup
  • 7 = Leaf Available
BrickMaster.get_wifi2_mesh_client_status
Function ID:
  • 109
Request:
  • empty payload
Response:
  • hostname – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • mac_address – Type: uint8[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
Function ID:
  • 110
Request:
  • empty payload
Response:
  • ssid – Type: char[32]
  • ip – Type: uint8[4], Range: [0 to 255]
  • subnet_mask – Type: uint8[4], Range: [0 to 255]
  • gateway – Type: uint8[4], Range: [0 to 255]
  • mac_address – Type: uint8[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
Function ID:
  • 231
Request:
  • enable_dynamic_baudrate – Type: bool, Default: true
  • minimum_dynamic_baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Response:
  • no response

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

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

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

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

The maximum value of the baudrate can be set per port with the function 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
Function ID:
  • 232
Request:
  • empty payload
Response:
  • enable_dynamic_baudrate – Type: bool, Default: true
  • minimum_dynamic_baudrate – Type: uint32, 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
Function ID:
  • 233
Request:
  • communication_method – Type: uint8, Range: See meanings
Response:
  • timeout_count – Type: uint32, Range: [0 to 232 - 1]

Returns the timeout count for the different communication methods.

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

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

New in version 2.4.3 (Firmware).

The following meanings are defined for the elements of this function:

For communication_method:

  • 0 = None
  • 1 = USB
  • 2 = SPI Stack
  • 3 = Chibi
  • 4 = RS485
  • 5 = WIFI
  • 6 = Ethernet
  • 7 = WIFI V2
BrickMaster.set_spitfp_baudrate
Function ID:
  • 234
Request:
  • bricklet_port – Type: char, Range: ['a' to 'd']
  • baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Response:
  • no response

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 you applications we recommend to not change the baudrate.

New in version 2.4.3 (Firmware).

BrickMaster.get_spitfp_baudrate
Function ID:
  • 235
Request:
  • bricklet_port – Type: char, Range: ['a' to 'd']
Response:
  • baudrate – Type: uint32, 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
Function ID:
  • 237
Request:
  • bricklet_port – Type: char, Range: ['a' to 'd']
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Brick side. All Bricklets have a similar function that returns the errors on the Bricklet side.

New in version 2.4.3 (Firmware).

BrickMaster.enable_status_led
Function ID:
  • 238
Request:
  • empty payload
Response:
  • no response

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
Function ID:
  • 239
Request:
  • empty payload
Response:
  • no response

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
Function ID:
  • 240
Request:
  • empty payload
Response:
  • enabled – Type: bool, Default: true

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

New in version 2.3.2 (Firmware).

BrickMaster.get_protocol1_bricklet_name
Function ID:
  • 241
Request:
  • port – Type: char, Range: ['a' to 'd']
Response:
  • protocol_version – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • name – Type: char[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.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1/10 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

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

BrickMaster.reset
Function ID:
  • 243
Request:
  • empty payload
Response:
  • no response

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
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['0' to '8']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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

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

The device identifier numbers can be found here

Callback Configuration Functions

BrickMaster.set_stack_current_callback_period
Function ID:
  • 45
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

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
Function ID:
  • 46
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 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
Function ID:
  • 47
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

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
Function ID:
  • 48
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 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
Function ID:
  • 49
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

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
Function ID:
  • 50
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 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
Function ID:
  • 51
Request:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0
Response:
  • no response

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)

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.get_stack_current_callback_threshold
Function ID:
  • 52
Request:
  • empty payload
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by set_stack_current_callback_threshold.

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.set_stack_voltage_callback_threshold
Function ID:
  • 53
Request:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
Response:
  • no response

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)

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.get_stack_voltage_callback_threshold
Function ID:
  • 54
Request:
  • empty payload
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by set_stack_voltage_callback_threshold.

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.set_usb_voltage_callback_threshold
Function ID:
  • 55
Request:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
Response:
  • no response

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)

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.get_usb_voltage_callback_threshold
Function ID:
  • 56
Request:
  • empty payload
Response:
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by set_usb_voltage_callback_threshold.

New in version 2.0.5 (Firmware).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickMaster.set_debounce_period
Function ID:
  • 57
Request:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:
  • no response

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

New in version 2.0.5 (Firmware).

BrickMaster.get_debounce_period
Function ID:
  • 58
Request:
  • empty payload
Response:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

New in version 2.0.5 (Firmware).

Callbacks

BrickMaster.CALLBACK_STACK_CURRENT
Function ID:
  • 59
Response:
  • current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by set_stack_current_callback_period. The response value 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
Function ID:
  • 60
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by set_stack_voltage_callback_period. The response value 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
Function ID:
  • 61
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by set_usb_voltage_callback_period. The response value 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.

New in version 2.0.5 (Firmware).

BrickMaster.CALLBACK_STACK_CURRENT_REACHED
Function ID:
  • 62
Response:
  • current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by set_stack_current_callback_threshold is reached. The response value 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
Function ID:
  • 63
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by set_stack_voltage_callback_threshold is reached. The response value 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
Function ID:
  • 64
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by set_usb_voltage_callback_threshold is reached. The response value 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).