..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-vbnet">Software</a> / Visual Basic .NET - Master Brick

.. |device_identifier_constant| replace:: There is also a :ref:`constant <master_brick_vbnet_constants>` for the device identifier of this Brick.

.. _master_brick_vbnet:

Visual Basic .NET - Master Brick
================================

This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` for the :ref:`Master Brick <master_brick>`. General information and technical
specifications for the Master Brick are summarized in its :ref:`hardware description
<master_brick_description>`.

An :ref:`installation guide <api_bindings_vbnet_install>` for the Visual Basic .NET API
bindings is part of their general description.

.. _master_brick_vbnet_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Stack Status
^^^^^^^^^^^^

`Download (ExampleStackStatus.vb) <https://github.com/Tinkerforge/master-brick/raw/master/software/examples/vbnet/ExampleStackStatus.vb>`__

.. literalinclude:: Master_Brick_VBNET_ExampleStackStatus.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

.. _master_brick_vbnet_api:

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


.. vbnet:function:: Class BrickMaster(ByVal uid As String, ByVal ipcon As IPConnection)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: vbnet

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

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <master_brick_vbnet_examples>`).


.. vbnet:function:: 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.
 
.. vbnet:function:: 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
^^^^^^^^^^^^^^^^^^

.. vbnet:function:: 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 on on top, 
 if only one extension is present use 0).
 
 Possible extension types:
 
 .. csv-table::
  :header: "Type", "Description"
  :widths: 10, 100
 
  "1",    "Chibi"
  "2",    "RS485"
  "3",    "WIFI"
  "4",    "Ethernet"
 
 The extension type is already set when bought and it can be set with the 
 Brick Viewer, it is unlikely that you need this function.
 
 The 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
 
.. vbnet:function:: Function BrickMaster.GetExtensionType(ByVal extension As Byte) As Long

 Returns the type for a given extension as set by :vbnet:func:`SetExtensionType() <BrickMaster.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
 
.. vbnet:function:: Function BrickMaster.IsChibiPresent() As Boolean

 Returns *true* if a Chibi Extension is available to be used by the Master Brick.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Function BrickMaster.GetChibiAddress() As Byte

 Returns the address as set by :vbnet:func:`SetChibiAddress() <BrickMaster.SetChibiAddress>`.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Function BrickMaster.GetChibiMasterAddress() As Byte

 Returns the address as set by :vbnet:func:`SetChibiMasterAddress() <BrickMaster.SetChibiMasterAddress>`.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Function BrickMaster.GetChibiSlaveAddress(ByVal num As Byte) As Byte

 Returns the slave address for a given ``num`` as set by
 :vbnet:func:`SetChibiSlaveAddress() <BrickMaster.SetChibiSlaveAddress>`.
 
.. vbnet:function:: Function BrickMaster.GetChibiSignalStrength() As Byte

 Returns the signal strength in dBm. The signal strength updates every time a
 packet is received.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Sub BrickMaster.SetChibiFrequency(ByVal frequency As Byte)

 Sets the Chibi frequency range for the Chibi Extension. Possible values are:
 
 .. csv-table::
  :header: "Type", "Description"
  :widths: 10, 100
 
  "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
 
.. vbnet:function:: Function BrickMaster.GetChibiFrequency() As Byte

 Returns the frequency value as set by :vbnet:func:`SetChibiFrequency() <BrickMaster.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
 
.. vbnet:function:: Sub BrickMaster.SetChibiChannel(ByVal channel As Byte)

 Sets the channel used by the Chibi Extension. Possible channels are
 different for different frequencies:
 
 .. csv-table::
  :header: "Frequency",             "Possible Channels"
  :widths: 40, 60
 
  "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.
 
.. vbnet:function:: Function BrickMaster.GetChibiChannel() As Byte

 Returns the channel as set by :vbnet:func:`SetChibiChannel() <BrickMaster.SetChibiChannel>`.
 
.. vbnet:function:: Function BrickMaster.IsRS485Present() As Boolean

 Returns *true* if a RS485 Extension is available to be used by the Master Brick.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Function BrickMaster.GetRS485Address() As Byte

 Returns the address as set by :vbnet:func:`SetRS485Address() <BrickMaster.SetRS485Address>`.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Function BrickMaster.GetRS485SlaveAddress(ByVal num As Byte) As Byte

 Returns the slave address for a given ``num`` as set by
 :vbnet:func:`SetRS485SlaveAddress() <BrickMaster.SetRS485SlaveAddress>`.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: 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
 
.. vbnet:function:: Sub BrickMaster.GetRS485Configuration(ByRef speed As Long, ByRef parity As Char, ByRef stopbits As Byte)

 Returns the configuration as set by :vbnet:func:`SetRS485Configuration() <BrickMaster.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
 
.. vbnet:function:: Function BrickMaster.IsWifiPresent() As Boolean

 Returns *true* if a WIFI Extension is available to be used by the Master Brick.
 
.. vbnet:function:: 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:
 
 .. csv-table::
  :header: "Value", "Description"
  :widths: 10, 90
 
  "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
 
.. vbnet:function:: 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 :vbnet:func:`SetWifiConfiguration() <BrickMaster.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
 
.. vbnet:function:: 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:
 
 .. csv-table::
  :header: "Value", "Description"
  :widths: 10, 90
 
  "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 :vbnet:func:`SetLongWifiKey() <BrickMaster.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 :vbnet:func:`SetWifiCertificate() <BrickMaster.SetWifiCertificate>`. ``eap_options`` consist
 of the outer authentication (bits 1-2), inner authentication (bit 3) and
 certificate type (bits 4-5):
 
 .. csv-table::
  :header: "Option", "Bits", "Description"
  :widths: 20, 10, 70
 
  "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
 
.. vbnet:function:: 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 :vbnet:func:`SetWifiEncryption() <BrickMaster.SetWifiEncryption>`.
 
 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
 
.. vbnet:function:: 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
 :vbnet:func:`RefreshWifiStatus() <BrickMaster.RefreshWifiStatus>` is called.
 
 Possible states are:
 
 .. csv-table::
  :header: "State", "Description"
  :widths: 10, 90
 
  "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
 
.. vbnet:function:: Sub BrickMaster.RefreshWifiStatus()

 Refreshes the Wi-Fi status (see :vbnet:func:`GetWifiStatus() <BrickMaster.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.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: 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 :vbnet:func:`SetWifiCertificate() <BrickMaster.SetWifiCertificate>`.
 
.. vbnet:function:: Sub BrickMaster.SetWifiPowerMode(ByVal mode As Byte)

 Sets the power mode of the WIFI Extension. Possible modes are:
 
 .. csv-table::
  :header: "Mode", "Description"
  :widths: 10, 90
 
  "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
 
.. vbnet:function:: Function BrickMaster.GetWifiPowerMode() As Byte

 Returns the power mode as set by :vbnet:func:`SetWifiPowerMode() <BrickMaster.SetWifiPowerMode>`.
 
 The following constants are available for this function:
 
 * BrickMaster.WIFI_POWER_MODE_FULL_SPEED = 0
 * BrickMaster.WIFI_POWER_MODE_LOW_POWER = 1
 
.. vbnet:function:: 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.
 
.. vbnet:function:: Sub BrickMaster.SetWifiRegulatoryDomain(ByVal domain As Byte)

 Sets the regulatory domain of the WIFI Extension. Possible domains are:
 
 .. csv-table::
  :header: "Domain", "Description"
  :widths: 10, 90
 
  "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
 
.. vbnet:function:: Function BrickMaster.GetWifiRegulatoryDomain() As Byte

 Returns the regulatory domain as set by :vbnet:func:`SetWifiRegulatoryDomain() <BrickMaster.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
 
.. vbnet:function:: Function BrickMaster.GetUSBVoltage() As Integer

 Returns the USB voltage in mV. Does not work with hardware version 2.1.
 
.. vbnet:function:: 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 :vbnet:func:`SetWifiEncryption() <BrickMaster.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.
 
 .. versionadded:: 2.0.2~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetLongWifiKey() As String

 Returns the encryption key as set by :vbnet:func:`SetLongWifiKey() <BrickMaster.SetLongWifiKey>`.
 
 .. versionadded:: 2.0.2~(Firmware)
 
.. vbnet:function:: 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.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetWifiHostname() As String

 Returns the hostname as set by :vbnet:func:`GetWifiHostname() <BrickMaster.GetWifiHostname>`.
 
 An empty String means, that the default hostname is used.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.IsEthernetPresent() As Boolean

 Returns *true* if a Ethernet Extension is available to be used by the Master
 Brick.
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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:
 
 .. csv-table::
  :header: "Value", "Description"
  :widths: 10, 90
 
  "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
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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 :vbnet:func:`SetEthernetConfiguration() <BrickMaster.SetEthernetConfiguration>`.
 
 The following constants are available for this function:
 
 * BrickMaster.ETHERNET_CONNECTION_DHCP = 0
 * BrickMaster.ETHERNET_CONNECTION_STATIC_IP = 1
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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.
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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 :vbnet:func:`GetEthernetStatus() <BrickMaster.GetEthernetStatus>`.
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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 :vbnet:func:`GetEthernetStatus() <BrickMaster.GetEthernetStatus>`.
 
 .. versionadded:: 2.1.0~(Firmware)
 
.. vbnet:function:: 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.
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.GetEthernetWebsocketConfiguration(ByRef sockets As Byte, ByRef port As Integer)

 Returns the configuration as set by :vbnet:func:`SetEthernetConfiguration() <BrickMaster.SetEthernetConfiguration>`.
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: 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 :ref:`authentication tutorial <tutorial_authentication>` 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).
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetEthernetAuthenticationSecret() As String

 Returns the authentication secret as set by :vbnet:func:`SetEthernetAuthenticationSecret() <BrickMaster.SetEthernetAuthenticationSecret>`.
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: 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 :ref:`authentication tutorial <tutorial_authentication>` 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).
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetWifiAuthenticationSecret() As String

 Returns the authentication secret as set by :vbnet:func:`SetWifiAuthenticationSecret() <BrickMaster.SetWifiAuthenticationSecret>`.
 
 .. versionadded:: 2.2.0~(Firmware)
 
.. vbnet:function:: 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.
 
.. vbnet:function:: 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
 :vbnet:func:`SetResponseExpected() <BrickMaster.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 :vbnet:func:`SetResponseExpected() <BrickMaster.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet: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 and callbacks it is always disabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 The following function ID constants are available for this function:
 
 * BrickMaster.FUNCTION_SET_EXTENSION_TYPE = 3
 * BrickMaster.FUNCTION_SET_CHIBI_ADDRESS = 6
 * BrickMaster.FUNCTION_SET_CHIBI_MASTER_ADDRESS = 8
 * BrickMaster.FUNCTION_SET_CHIBI_SLAVE_ADDRESS = 10
 * BrickMaster.FUNCTION_SET_CHIBI_FREQUENCY = 14
 * BrickMaster.FUNCTION_SET_CHIBI_CHANNEL = 16
 * BrickMaster.FUNCTION_SET_RS485_ADDRESS = 19
 * BrickMaster.FUNCTION_SET_RS485_SLAVE_ADDRESS = 21
 * BrickMaster.FUNCTION_SET_RS485_CONFIGURATION = 24
 * BrickMaster.FUNCTION_SET_WIFI_CONFIGURATION = 27
 * BrickMaster.FUNCTION_SET_WIFI_ENCRYPTION = 29
 * BrickMaster.FUNCTION_REFRESH_WIFI_STATUS = 32
 * BrickMaster.FUNCTION_SET_WIFI_CERTIFICATE = 33
 * BrickMaster.FUNCTION_SET_WIFI_POWER_MODE = 35
 * BrickMaster.FUNCTION_SET_WIFI_REGULATORY_DOMAIN = 38
 * BrickMaster.FUNCTION_SET_LONG_WIFI_KEY = 41
 * BrickMaster.FUNCTION_SET_WIFI_HOSTNAME = 43
 * BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD = 45
 * BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD = 47
 * BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD = 49
 * BrickMaster.FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD = 51
 * BrickMaster.FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD = 53
 * BrickMaster.FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD = 55
 * BrickMaster.FUNCTION_SET_DEBOUNCE_PERIOD = 57
 * BrickMaster.FUNCTION_SET_ETHERNET_CONFIGURATION = 66
 * BrickMaster.FUNCTION_SET_ETHERNET_HOSTNAME = 69
 * BrickMaster.FUNCTION_SET_ETHERNET_MAC_ADDRESS = 70
 * BrickMaster.FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION = 71
 * BrickMaster.FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET = 73
 * BrickMaster.FUNCTION_SET_WIFI_AUTHENTICATION_SECRET = 75
 * BrickMaster.FUNCTION_ENABLE_STATUS_LED = 238
 * BrickMaster.FUNCTION_DISABLE_STATUS_LED = 239
 * BrickMaster.FUNCTION_RESET = 243
 
.. vbnet:function:: Sub BrickMaster.SetResponseExpectedAll(ByVal responseExpected As Boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. vbnet:function:: 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.
 
 .. versionadded:: 2.3.2~(Firmware)
 
.. vbnet:function:: 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.
 
 .. versionadded:: 2.3.2~(Firmware)
 
.. vbnet:function:: Function BrickMaster.IsStatusLEDEnabled() As Boolean

 Returns *true* if the status LED is enabled, *false* otherwise.
 
 .. versionadded:: 2.3.2~(Firmware)
 
.. vbnet:function:: 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.
 
.. vbnet:function:: 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.
 
.. vbnet:function:: 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!
 
.. vbnet:function:: 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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. vbnet:function:: Sub BrickMaster.SetStackCurrentCallbackPeriod(ByVal period As Long)

 Sets the period in ms with which the :vbnet:func:`StackCurrent <BrickMaster.StackCurrent>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :vbnet:func:`StackCurrent <BrickMaster.StackCurrent>` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetStackCurrentCallbackPeriod() As Long

 Returns the period as set by :func:`SetCurrentCallbackPeriod`.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetStackVoltageCallbackPeriod(ByVal period As Long)

 Sets the period in ms with which the :vbnet:func:`StackVoltage <BrickMaster.StackVoltage>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :vbnet:func:`StackVoltage <BrickMaster.StackVoltage>` is only triggered if the voltage has changed since the
 last triggering.
 
 The default value is 0.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetStackVoltageCallbackPeriod() As Long

 Returns the period as set by :vbnet:func:`SetStackVoltageCallbackPeriod() <BrickMaster.SetStackVoltageCallbackPeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetUSBVoltageCallbackPeriod(ByVal period As Long)

 Sets the period in ms with which the :vbnet:func:`USBVoltage <BrickMaster.USBVoltage>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :vbnet:func:`USBVoltage <BrickMaster.USBVoltage>` is only triggered if the voltage has changed since the
 last triggering.
 
 The default value is 0.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetUSBVoltageCallbackPeriod() As Long

 Returns the period as set by :vbnet:func:`SetUSBVoltageCallbackPeriod() <BrickMaster.SetUSBVoltageCallbackPeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetStackCurrentCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

 Sets the thresholds for the :vbnet:func:`StackCurrentReached <BrickMaster.StackCurrentReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.GetStackCurrentCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

 Returns the threshold as set by :vbnet:func:`SetStackCurrentCallbackThreshold() <BrickMaster.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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetStackVoltageCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

 Sets the thresholds for the :func:`StackStackVoltageReached` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.GetStackVoltageCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

 Returns the threshold as set by :vbnet:func:`SetStackVoltageCallbackThreshold() <BrickMaster.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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetUSBVoltageCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

 Sets the thresholds for the :vbnet:func:`USBVoltageReached <BrickMaster.USBVoltageReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.GetUSBVoltageCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

 Returns the threshold as set by :vbnet:func:`SetUSBVoltageCallbackThreshold() <BrickMaster.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
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Sub BrickMaster.SetDebouncePeriod(ByVal debounce As Long)

 Sets the period in ms with which the threshold callbacks
 
 * :vbnet:func:`StackCurrentReached <BrickMaster.StackCurrentReached>`,
 * :vbnet:func:`StackVoltageReached <BrickMaster.StackVoltageReached>`,
 * :vbnet:func:`USBVoltageReached <BrickMaster.USBVoltageReached>`
 
 are triggered, if the thresholds
 
 * :vbnet:func:`SetStackCurrentCallbackThreshold() <BrickMaster.SetStackCurrentCallbackThreshold>`,
 * :vbnet:func:`SetStackVoltageCallbackThreshold() <BrickMaster.SetStackVoltageCallbackThreshold>`,
 * :vbnet:func:`SetUSBVoltageCallbackThreshold() <BrickMaster.SetUSBVoltageCallbackThreshold>`
 
 keep being reached.
 
 The default value is 100.
 
 .. versionadded:: 2.0.5~(Firmware)
 
.. vbnet:function:: Function BrickMaster.GetDebouncePeriod() As Long

 Returns the debounce period as set by :vbnet:func:`SetDebouncePeriod() <BrickMaster.SetDebouncePeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 


.. _master_brick_vbnet_callbacks:

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:

 .. code-block:: vbnet

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

    AddHandler master.Example, AddressOf Callback

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.


.. vbnet:function:: Event BrickMaster.StackCurrent(ByVal sender As BrickMaster, ByVal current As Integer)


 This callback is triggered periodically with the period that is set by
 :vbnet:func:`SetStackCurrentCallbackPeriod() <BrickMaster.SetStackCurrentCallbackPeriod>`. The parameter is the current of the
 sensor.
 
 :vbnet:func:`StackCurrent <BrickMaster.StackCurrent>` is only triggered if the current has changed since the
 last triggering.
 
 .. versionadded:: 2.0.5~(Firmware)
 

.. vbnet:function:: Event BrickMaster.StackVoltage(ByVal sender As BrickMaster, ByVal voltage As Integer)


 This callback is triggered periodically with the period that is set by
 :vbnet:func:`SetStackVoltageCallbackPeriod() <BrickMaster.SetStackVoltageCallbackPeriod>`. The parameter is the voltage of the
 sensor.
 
 :vbnet:func:`StackVoltage <BrickMaster.StackVoltage>` is only triggered if the voltage has changed since the
 last triggering.
 
 .. versionadded:: 2.0.5~(Firmware)
 

.. vbnet:function:: Event BrickMaster.USBVoltage(ByVal sender As BrickMaster, ByVal voltage As Integer)


 This callback is triggered periodically with the period that is set by
 :vbnet:func:`SetUSBVoltageCallbackPeriod() <BrickMaster.SetUSBVoltageCallbackPeriod>`. The parameter is the USB voltage
 in mV.
 
 :vbnet:func:`USBVoltage <BrickMaster.USBVoltage>` is only triggered if the USB voltage has changed since the
 last triggering.
 
 Does not work with hardware version 2.1.
 
 .. versionadded:: 2.0.5~(Firmware)
 

.. vbnet:function:: Event BrickMaster.StackCurrentReached(ByVal sender As BrickMaster, ByVal current As Integer)


 This callback is triggered when the threshold as set by
 :vbnet:func:`SetStackCurrentCallbackThreshold() <BrickMaster.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 :vbnet:func:`SetDebouncePeriod() <BrickMaster.SetDebouncePeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 

.. vbnet:function:: Event BrickMaster.StackVoltageReached(ByVal sender As BrickMaster, ByVal voltage As Integer)


 This callback is triggered when the threshold as set by
 :vbnet:func:`SetStackVoltageCallbackThreshold() <BrickMaster.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 :vbnet:func:`SetDebouncePeriod() <BrickMaster.SetDebouncePeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 

.. vbnet:function:: Event BrickMaster.USBVoltageReached(ByVal sender As BrickMaster, ByVal voltage As Integer)


 This callback is triggered when the threshold as set by
 :vbnet:func:`SetUSBVoltageCallbackThreshold() <BrickMaster.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 :vbnet:func:`SetDebouncePeriod() <BrickMaster.SetDebouncePeriod>`.
 
 .. versionadded:: 2.0.5~(Firmware)
 


.. _master_brick_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickMaster.DEVICE_IDENTIFIER

 This constant is used to identify a Master Brick.

 The :vbnet:func:`GetIdentity() <BrickMaster.GetIdentity>` function and the
 :vbnet:func:`EnumerateCallback <IPConnection.EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

