Visual Basic .NET - Master Brick

This is the description of the Visual Basic .NET API bindings for the Master Brick. General information and technical specifications for the Master Brick are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples

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

Stack Status

Download (ExampleStackStatus.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Imports System
Imports Tinkerforge

Module ExampleStackStatus
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XXYYZZ" ' Change XXYYZZ to the UID of your Master Brick

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim master As New BrickMaster(UID, ipcon) ' Create device object

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

        ' Get current stack voltage
        Dim stackVoltage As Integer = master.GetStackVoltage()
        Console.WriteLine("Stack Voltage: " + (stackVoltage/1000.0).ToString() + " V")

        ' Get current stack current
        Dim stackCurrent As Integer = master.GetStackCurrent()
        Console.WriteLine("Stack Current: " + (stackCurrent/1000.0).ToString() + " A")

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickMaster(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim master As New BrickMaster("YOUR_DEVICE_UID", ipcon)

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

Function BrickMaster.GetStackVoltage() As Integer

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.

Function BrickMaster.GetStackCurrent() As Integer

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

Sub BrickMaster.SetExtensionType(ByVal extension As Byte, ByVal exttype As Long)

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

Possible extension types:

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

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

The following constants are available for this function:

  • BrickMaster.EXTENSION_TYPE_CHIBI = 1
  • BrickMaster.EXTENSION_TYPE_RS485 = 2
  • BrickMaster.EXTENSION_TYPE_WIFI = 3
  • BrickMaster.EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster.EXTENSION_TYPE_WIFI2 = 5
Function BrickMaster.GetExtensionType(ByVal extension As Byte) As Long

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

The following constants are available for this function:

  • BrickMaster.EXTENSION_TYPE_CHIBI = 1
  • BrickMaster.EXTENSION_TYPE_RS485 = 2
  • BrickMaster.EXTENSION_TYPE_WIFI = 3
  • BrickMaster.EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster.EXTENSION_TYPE_WIFI2 = 5
Function BrickMaster.IsChibiPresent() As Boolean

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

Sub BrickMaster.SetChibiAddress(ByVal address As Byte)

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.

Function BrickMaster.GetChibiAddress() As Byte

Returns the address as set by SetChibiAddress().

Sub BrickMaster.SetChibiMasterAddress(ByVal address As Byte)

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.

Function BrickMaster.GetChibiMasterAddress() As Byte

Returns the address as set by SetChibiMasterAddress().

Sub BrickMaster.SetChibiSlaveAddress(ByVal num As Byte, ByVal address As Byte)

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.

Function BrickMaster.GetChibiSlaveAddress(ByVal num As Byte) As Byte

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

Function BrickMaster.GetChibiSignalStrength() As Byte

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

Sub BrickMaster.GetChibiErrorLog(ByRef underrun As Integer, ByRef crcError As Integer, ByRef noAck As Integer, ByRef overflow As Integer)

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.

Sub BrickMaster.SetChibiFrequency(ByVal frequency As Byte)

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
Function BrickMaster.GetChibiFrequency() As Byte

Returns the frequency value as set by SetChibiFrequency().

The following constants are available for this function:

  • BrickMaster.CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
  • BrickMaster.CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
  • BrickMaster.CHIBI_FREQUENCY_BPSK40_915_MHZ = 3
Sub BrickMaster.SetChibiChannel(ByVal channel As Byte)

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.

Function BrickMaster.GetChibiChannel() As Byte

Returns the channel as set by SetChibiChannel().

Function BrickMaster.IsRS485Present() As Boolean

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

Sub BrickMaster.SetRS485Address(ByVal address As Byte)

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.

Function BrickMaster.GetRS485Address() As Byte

Returns the address as set by SetRS485Address().

Sub BrickMaster.SetRS485SlaveAddress(ByVal num As Byte, ByVal address As Byte)

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.

Function BrickMaster.GetRS485SlaveAddress(ByVal num As Byte) As Byte

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

Function BrickMaster.GetRS485ErrorLog() As Integer

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.

Sub BrickMaster.SetRS485Configuration(ByVal speed As Long, ByVal parity As Char, ByVal stopbits As Byte)

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"C
  • BrickMaster.RS485_PARITY_EVEN = "e"C
  • BrickMaster.RS485_PARITY_ODD = "o"C
Sub BrickMaster.GetRS485Configuration(ByRef speed As Long, ByRef parity As Char, ByRef stopbits As Byte)

Returns the configuration as set by SetRS485Configuration().

The following constants are available for this function:

  • BrickMaster.RS485_PARITY_NONE = "n"C
  • BrickMaster.RS485_PARITY_EVEN = "e"C
  • BrickMaster.RS485_PARITY_ODD = "o"C
Function BrickMaster.IsWifiPresent() As Boolean

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

Sub BrickMaster.SetWifiConfiguration(ByVal ssid As String, ByVal connection As Byte, ByVal ip() As Byte, ByVal subnetMask() As Byte, ByVal gateway() As Byte, ByVal port As Integer)

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
Sub BrickMaster.GetWifiConfiguration(ByRef ssid As String, ByRef connection As Byte, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef port As Integer)

Returns the configuration as set by SetWifiConfiguration().

The following constants are available for this function:

  • BrickMaster.WIFI_CONNECTION_DHCP = 0
  • BrickMaster.WIFI_CONNECTION_STATIC_IP = 1
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_DHCP = 2
  • BrickMaster.WIFI_CONNECTION_ACCESS_POINT_STATIC_IP = 3
  • BrickMaster.WIFI_CONNECTION_AD_HOC_DHCP = 4
  • BrickMaster.WIFI_CONNECTION_AD_HOC_STATIC_IP = 5
Sub BrickMaster.SetWifiEncryption(ByVal encryption As Byte, ByVal key As String, ByVal keyIndex As Byte, ByVal eapOptions As Byte, ByVal caCertificateLength As Integer, ByVal clientCertificateLength As Integer, ByVal privateKeyLength As Integer)

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

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

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

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

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

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

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

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

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

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

The following constants are available for this function:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16
Sub BrickMaster.GetWifiEncryption(ByRef encryption As Byte, ByRef key As String, ByRef keyIndex As Byte, ByRef eapOptions As Byte, ByRef caCertificateLength As Integer, ByRef clientCertificateLength As Integer, ByRef privateKeyLength As Integer)

Returns the encryption as set by SetWifiEncryption().

Note

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

The following constants are available for this function:

  • BrickMaster.WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster.WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster.WIFI_ENCRYPTION_WEP = 2
  • BrickMaster.WIFI_ENCRYPTION_NO_ENCRYPTION = 3
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster.WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster.WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster.WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16
Sub BrickMaster.GetWifiStatus(ByRef macAddress() As Byte, ByRef bssid() As Byte, ByRef channel As Byte, ByRef rssi As Short, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef rxCount As Long, ByRef txCount As Long, ByRef state As Byte)

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

Possible states are:

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

The following constants are available for this function:

  • BrickMaster.WIFI_STATE_DISASSOCIATED = 0
  • BrickMaster.WIFI_STATE_ASSOCIATED = 1
  • BrickMaster.WIFI_STATE_ASSOCIATING = 2
  • BrickMaster.WIFI_STATE_ERROR = 3
  • BrickMaster.WIFI_STATE_NOT_INITIALIZED_YET = 255
Sub BrickMaster.RefreshWifiStatus()

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

Sub BrickMaster.SetWifiCertificate(ByVal index As Integer, ByVal data() As Byte, ByVal dataLength As Byte)

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.

Sub BrickMaster.GetWifiCertificate(ByVal index As Integer, ByRef data() As Byte, ByRef dataLength As Byte)

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

Sub BrickMaster.SetWifiPowerMode(ByVal mode As Byte)

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
Function BrickMaster.GetWifiPowerMode() As Byte

Returns the power mode as set by SetWifiPowerMode().

The following constants are available for this function:

  • BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
Sub BrickMaster.GetWifiBufferInfo(ByRef overflow As Long, ByRef lowWatermark As Integer, ByRef used As Integer)

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.

Sub BrickMaster.SetWifiRegulatoryDomain(ByVal domain As Byte)

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
Function BrickMaster.GetWifiRegulatoryDomain() As Byte

Returns the regulatory domain as set by SetWifiRegulatoryDomain().

The following constants are available for this function:

  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster.WIFI_DOMAIN_CHANNEL_1TO14 = 2
Function BrickMaster.GetUSBVoltage() As Integer

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

Sub BrickMaster.SetLongWifiKey(ByVal key As String)

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

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

New in version 2.0.2 (Firmware).

Function BrickMaster.GetLongWifiKey() As String

Returns the encryption key as set by SetLongWifiKey().

Note

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

New in version 2.0.2 (Firmware).

Sub BrickMaster.SetWifiHostname(ByVal hostname As String)

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

Function BrickMaster.GetWifiHostname() As String

Returns the hostname as set by SetWifiHostname().

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

New in version 2.0.5 (Firmware).

Function BrickMaster.IsEthernetPresent() As Boolean

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

New in version 2.1.0 (Firmware).

Sub BrickMaster.SetEthernetConfiguration(ByVal connection As Byte, ByVal ip() As Byte, ByVal subnetMask() As Byte, ByVal gateway() As Byte, ByVal port As Integer)

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

Value Description
0 DHCP
1 Static IP

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

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

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

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

The following constants are available for this function:

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

New in version 2.1.0 (Firmware).

Sub BrickMaster.GetEthernetConfiguration(ByRef connection As Byte, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef port As Integer)

Returns the configuration as set by SetEthernetConfiguration().

The following constants are available for this function:

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

New in version 2.1.0 (Firmware).

Sub BrickMaster.GetEthernetStatus(ByRef macAddress() As Byte, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef rxCount As Long, ByRef txCount As Long, ByRef hostname As String)

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

Sub BrickMaster.SetEthernetHostname(ByVal hostname As String)

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

Setting an empty String will restore the default hostname.

The current hostname can be discovered with GetEthernetStatus().

New in version 2.1.0 (Firmware).

Sub BrickMaster.SetEthernetMACAddress(ByVal macAddress() As Byte)

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

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

New in version 2.1.0 (Firmware).

Sub BrickMaster.SetEthernetWebsocketConfiguration(ByVal sockets As Byte, ByVal port As Integer)

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

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

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

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

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

New in version 2.2.0 (Firmware).

Sub BrickMaster.GetEthernetWebsocketConfiguration(ByRef sockets As Byte, ByRef port As Integer)

Returns the configuration as set by SetEthernetConfiguration().

New in version 2.2.0 (Firmware).

Sub BrickMaster.SetEthernetAuthenticationSecret(ByVal secret As String)

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

Function BrickMaster.GetEthernetAuthenticationSecret() As String

Returns the authentication secret as set by SetEthernetAuthenticationSecret().

New in version 2.2.0 (Firmware).

Sub BrickMaster.SetWifiAuthenticationSecret(ByVal secret As String)

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

Function BrickMaster.GetWifiAuthenticationSecret() As String

Returns the authentication secret as set by SetWifiAuthenticationSecret().

New in version 2.2.0 (Firmware).

Function BrickMaster.GetConnectionType() As Byte

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

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Function BrickMaster.IsWifi2Present() As Boolean

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

New in version 2.4.0 (Firmware).

Function BrickMaster.StartWifi2Bootloader() As Short

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

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

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

New in version 2.4.0 (Firmware).

Function BrickMaster.WriteWifi2SerialPort(ByVal data() As Byte, ByVal length As Byte) As Short

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

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

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.ReadWifi2SerialPort(ByVal length As Byte, ByRef data() As Byte, ByRef result As Byte)

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

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

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2AuthenticationSecret(ByVal secret As String)

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

See the authentication tutorial for more information.

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

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

New in version 2.4.0 (Firmware).

Function BrickMaster.GetWifi2AuthenticationSecret() As String

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2Configuration(ByVal port As Integer, ByVal websocketPort As Integer, ByVal websitePort As Integer, ByVal phyMode As Byte, ByVal sleepMode As Byte, ByVal website As Byte)

Sets the general configuration of the WIFI Extension 2.0.

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

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

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

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

The sleep_mode parameter is currently unused.

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

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

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

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.GetWifi2Configuration(ByRef port As Integer, ByRef websocketPort As Integer, ByRef websitePort As Integer, ByRef phyMode As Byte, ByRef sleepMode As Byte, ByRef website As Byte)

Returns the general configuration as set by SetWifi2Configuration().

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.GetWifi2Status(ByRef clientEnabled As Boolean, ByRef clientStatus As Byte, ByRef clientIP() As Byte, ByRef clientSubnetMask() As Byte, ByRef clientGateway() As Byte, ByRef clientMACAddress() As Byte, ByRef clientRXCount As Long, ByRef clientTXCount As Long, ByRef clientRSSI As Short, ByRef apEnabled As Boolean, ByRef apIP() As Byte, ByRef apSubnetMask() As Byte, ByRef apGateway() As Byte, ByRef apMACAddress() As Byte, ByRef apRXCount As Long, ByRef apTXCount As Long, ByRef apConnectedCount As Byte)

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

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2ClientConfiguration(ByVal enable As Boolean, ByVal ssid As String, ByVal ip() As Byte, ByVal subnetMask() As Byte, ByVal gateway() As Byte, ByVal macAddress() As Byte, ByVal bssid() As Byte)

Sets the client specific configuration of the WIFI Extension 2.0.

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

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

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

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

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

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

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.GetWifi2ClientConfiguration(ByRef enable As Boolean, ByRef ssid As String, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef macAddress() As Byte, ByRef bssid() As Byte)

Returns the client configuration as set by SetWifi2ClientConfiguration().

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2ClientHostname(ByVal hostname As String)

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

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

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

New in version 2.4.0 (Firmware).

Function BrickMaster.GetWifi2ClientHostname() As String

Returns the client hostname as set by SetWifi2ClientHostname().

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2ClientPassword(ByVal password As String)

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

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

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

New in version 2.4.0 (Firmware).

Function BrickMaster.GetWifi2ClientPassword() As String

Returns the client password as set by SetWifi2ClientPassword().

Note

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2APConfiguration(ByVal enable As Boolean, ByVal ssid As String, ByVal ip() As Byte, ByVal subnetMask() As Byte, ByVal gateway() As Byte, ByVal encryption As Byte, ByVal hidden As Boolean, ByVal channel As Byte, ByVal macAddress() As Byte)

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

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

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

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

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

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

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

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

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

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

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.GetWifi2APConfiguration(ByRef enable As Boolean, ByRef ssid As String, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef encryption As Byte, ByRef hidden As Boolean, ByRef channel As Byte, ByRef macAddress() As Byte)

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

The following constants are available for this function:

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2APPassword(ByVal password As String)

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

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

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

New in version 2.4.0 (Firmware).

Function BrickMaster.GetWifi2APPassword() As String

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

Note

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

New in version 2.4.0 (Firmware).

Function BrickMaster.SaveWifi2Configuration() As Byte

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

Function BrickMaster.GetWifi2FirmwareVersion() As Byte()

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.EnableWifi2StatusLED()

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.DisableWifi2StatusLED()

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

New in version 2.4.0 (Firmware).

Function BrickMaster.IsWifi2StatusLEDEnabled() As Boolean

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

New in version 2.4.0 (Firmware).

Sub BrickMaster.SetWifi2MeshConfiguration(ByVal enable As Boolean, ByVal rootIP() As Byte, ByVal rootSubnetMask() As Byte, ByVal rootGateway() As Byte, ByVal routerBSSID() As Byte, ByVal groupID() As Byte, ByVal groupSSIDPrefix As String, ByVal gatewayIP() As Byte, ByVal gatewayPort As Integer)

Requires WIFI Extension 2.0 firmware 2.1.0.

Sets the mesh specific configuration of the WIFI Extension 2.0.

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

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

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

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

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

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

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

New in version 2.4.2 (Firmware).

Sub BrickMaster.GetWifi2MeshConfiguration(ByRef enable As Boolean, ByRef rootIP() As Byte, ByRef rootSubnetMask() As Byte, ByRef rootGateway() As Byte, ByRef routerBSSID() As Byte, ByRef groupID() As Byte, ByRef groupSSIDPrefix As String, ByRef gatewayIP() As Byte, ByRef gatewayPort As Integer)

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh configuration as set by SetWifi2MeshConfiguration().

New in version 2.4.2 (Firmware).

Sub BrickMaster.SetWifi2MeshRouterSSID(ByVal ssid As String)

Requires WIFI Extension 2.0 firmware 2.1.0.

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

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

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

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

New in version 2.4.2 (Firmware).

Function BrickMaster.GetWifi2MeshRouterSSID() As String

Requires WIFI Extension 2.0 firmware 2.1.0.

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

New in version 2.4.2 (Firmware).

Sub BrickMaster.SetWifi2MeshRouterPassword(ByVal password As String)

Requires WIFI Extension 2.0 firmware 2.1.0.

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

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

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

New in version 2.4.2 (Firmware).

Function BrickMaster.GetWifi2MeshRouterPassword() As String

Requires WIFI Extension 2.0 firmware 2.1.0.

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

New in version 2.4.2 (Firmware).

Sub BrickMaster.GetWifi2MeshCommonStatus(ByRef status As Byte, ByRef rootNode As Boolean, ByRef rootCandidate As Boolean, ByRef connectedNodes As Integer, ByRef rxCount As Long, ByRef txCount As Long)

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the common mesh status of the WIFI Extension 2.0.

The following constants are available for this function:

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

New in version 2.4.2 (Firmware).

Sub BrickMaster.GetWifi2MeshClientStatus(ByRef hostname As String, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef macAddress() As Byte)

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

Sub BrickMaster.GetWifi2MeshAPStatus(ByRef ssid As String, ByRef ip() As Byte, ByRef subnetMask() As Byte, ByRef gateway() As Byte, ByRef macAddress() As Byte)

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

Function BrickMaster.GetAPIVersion() As Byte()

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

Function BrickMaster.GetResponseExpected(ByVal functionId As Byte) As Boolean

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

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

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

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

Sub BrickMaster.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

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

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

The following function ID constants are available for this function:

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

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

Sub BrickMaster.SetSPITFPBaudrateConfig(ByVal enableDynamicBaudrate As Boolean, ByVal minimumDynamicBaudrate As Long)

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

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

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

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

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

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

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

New in version 2.4.6 (Firmware).

Sub BrickMaster.GetSPITFPBaudrateConfig(ByRef enableDynamicBaudrate As Boolean, ByRef minimumDynamicBaudrate As Long)

Returns the baudrate config, see SetSPITFPBaudrateConfig().

New in version 2.4.6 (Firmware).

Function BrickMaster.GetSendTimeoutCount(ByVal communicationMethod As Byte) As Long

Returns the timeout count for the different communication methods.

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

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

The following constants are available for this function:

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

New in version 2.4.3 (Firmware).

Sub BrickMaster.SetSPITFPBaudrate(ByVal brickletPort As Char, ByVal baudrate As Long)

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

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

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

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

The default baudrate for all ports is 1400000.

New in version 2.4.3 (Firmware).

Function BrickMaster.GetSPITFPBaudrate(ByVal brickletPort As Char) As Long

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

New in version 2.4.3 (Firmware).

Sub BrickMaster.GetSPITFPErrorCount(ByVal brickletPort As Char, ByRef errorCountACKChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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

Sub BrickMaster.EnableStatusLED()

Enables the status LED.

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

The default state is enabled.

New in version 2.3.2 (Firmware).

Sub BrickMaster.DisableStatusLED()

Disables the status LED.

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

The default state is enabled.

New in version 2.3.2 (Firmware).

Function BrickMaster.IsStatusLEDEnabled() As Boolean

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

New in version 2.3.2 (Firmware).

Sub BrickMaster.GetProtocol1BrickletName(ByVal port As Char, ByRef protocolVersion As Byte, ByRef firmwareVersion() As Byte, ByRef name As String)

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.

Function BrickMaster.GetChipTemperature() As Short

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.

Sub BrickMaster.Reset()

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

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

Sub BrickMaster.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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

The position can be '0'-'8' (stack position).

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

Callback Configuration Functions

Sub BrickMaster.SetStackCurrentCallbackPeriod(ByVal period As Long)

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Function BrickMaster.GetStackCurrentCallbackPeriod() As Long

Returns the period as set by SetStackCurrentCallbackPeriod().

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetStackVoltageCallbackPeriod(ByVal period As Long)

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Function BrickMaster.GetStackVoltageCallbackPeriod() As Long

Returns the period as set by SetStackVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetUSBVoltageCallbackPeriod(ByVal period As Long)

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

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

The default value is 0.

New in version 2.0.5 (Firmware).

Function BrickMaster.GetUSBVoltageCallbackPeriod() As Long

Returns the period as set by SetUSBVoltageCallbackPeriod().

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetStackCurrentCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the StackCurrentReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.GetStackCurrentCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Returns the threshold as set by SetStackCurrentCallbackThreshold().

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetStackVoltageCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the StackVoltageReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.GetStackVoltageCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Returns the threshold as set by SetStackVoltageCallbackThreshold().

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetUSBVoltageCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

Sets the thresholds for the USBVoltageReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.GetUSBVoltageCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Returns the threshold as set by SetUSBVoltageCallbackThreshold().

The following constants are available for this function:

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

New in version 2.0.5 (Firmware).

Sub BrickMaster.SetDebouncePeriod(ByVal debounce As Long)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

New in version 2.0.5 (Firmware).

Function BrickMaster.GetDebouncePeriod() As Long

Returns the debounce period as set by SetDebouncePeriod().

New in version 2.0.5 (Firmware).

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickMaster, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler master.ExampleCallback, AddressOf MyCallback

The available callback property and their 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.

Event BrickMaster.StackCurrentCallback(ByVal sender As BrickMaster, ByVal current As Integer)

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

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

New in version 2.0.5 (Firmware).

Event BrickMaster.StackVoltageCallback(ByVal sender As BrickMaster, ByVal voltage As Integer)

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

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

New in version 2.0.5 (Firmware).

Event BrickMaster.USBVoltageCallback(ByVal sender As BrickMaster, ByVal voltage As Integer)

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

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

Does not work with hardware version 2.1.

New in version 2.0.5 (Firmware).

Event BrickMaster.StackCurrentReachedCallback(ByVal sender As BrickMaster, ByVal current As Integer)

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

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

New in version 2.0.5 (Firmware).

Event BrickMaster.StackVoltageReachedCallback(ByVal sender As BrickMaster, ByVal voltage As Integer)

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

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

New in version 2.0.5 (Firmware).

Event BrickMaster.USBVoltageReachedCallback(ByVal sender As BrickMaster, ByVal voltage As Integer)

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

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

New in version 2.0.5 (Firmware).

Constants

Const BrickMaster.DEVICE_IDENTIFIER

This constant is used to identify a Master Brick.

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

Const BrickMaster.DEVICE_DISPLAY_NAME

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