Tinkerforge::BrickMaster - Basis to build stacks and has 4 Bricklet ports
This constant is used to identify a Master Brick.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a Master Brick.
This constant is used with the register_callback() subroutine to specify the CALLBACK_STACK_CURRENT callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_STACK_VOLTAGE callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_USB_VOLTAGE callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_STACK_CURRENT_REACHED callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_STACK_VOLTAGE_REACHED callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_USB_VOLTAGE_REACHED callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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.
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.
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:
.. csv-table:: :header: "Type", "Description" :widths: 10, 100
"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.
Returns the type for a given extension as set by :func:`SetExtensionType`.
Returns *true* if a Chibi Extension is available to be used by the Master Brick.
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.
Returns the address as set by :func:`SetChibiAddress`.
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).
Returns the address as set by :func:`SetChibiMasterAddress`.
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.
Returns the slave address for a given num as set by :func:`SetChibiSlaveAddress`.
Returns the signal strength in dBm. The signal strength updates every time a packet is received.
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.
Sets the Chibi frequency range for the Chibi Extension. Possible values are:
"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.
Returns the frequency value as set by :func:`SetChibiFrequency`.
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.
Returns the channel as set by :func:`SetChibiChannel`.
Returns *true* if a RS485 Extension is available to be used by the Master Brick.
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.
Returns the address as set by :func:`SetRS485Address`.
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.
Returns the slave address for a given ``num`` as set by :func:`SetRS485SlaveAddress`.
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.
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.
Returns the configuration as set by :func:`SetRS485Configuration`.
Returns *true* if a WIFI Extension is available to be used by the Master Brick.
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.
It is recommended to use the Brick Viewer to set the WIFI configuration.
Returns the configuration as set by :func:`SetWifiConfiguration`.
Sets the encryption of the WIFI Extension. The first parameter is the type of the encryption. Possible values are:
"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 :func:`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 :func:`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)``.
It is recommended to use the Brick Viewer to set the Wi-Fi encryption.
Returns the encryption as set by :func:`SetWifiEncryption`.
Returns the status of the WIFI Extension. The ``state`` is updated automatically, all of the other parameters are updated on startup and every time :func:`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"
Refreshes the Wi-Fi status (see :func:`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.
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.
Returns the certificate for a given index as set by :func:`SetWifiCertificate`.
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).
Returns the power mode as set by :func:`SetWifiPowerMode`.
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.
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).
Returns the regulatory domain as set by :func:`SetWifiRegulatoryDomain`.
Returns the USB voltage in mV. Does not work with hardware version 2.1.
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 :func:`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$nbsp;(Firmware)
Returns the encryption key as set by :func:`SetLongWifiKey`.
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$nbsp;(Firmware)
Returns the hostname as set by :func:`SetWifiHostname`.
An empty String means, that the default hostname is used.
Sets the period in ms with which the :func:`StackCurrent` callback is triggered periodically. A value of 0 turns the callback off.
:func:`StackCurrent` is only triggered if the current has changed since the last triggering.
The default value is 0.
Returns the period as set by :func:`SetCurrentCallbackPeriod`.
Sets the period in ms with which the :func:`StackVoltage` callback is triggered periodically. A value of 0 turns the callback off.
:func:`StackVoltage` is only triggered if the voltage has changed since the last triggering.
Returns the period as set by :func:`SetStackVoltageCallbackPeriod`.
Sets the period in ms with which the :func:`USBVoltage` callback is triggered periodically. A value of 0 turns the callback off.
:func:`USBVoltage` is only triggered if the voltage has changed since the last triggering.
Returns the period as set by :func:`SetUSBVoltageCallbackPeriod`.
Sets the thresholds for the :func:`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).
Returns the threshold as set by :func:`SetStackCurrentCallbackThreshold`.
Sets the thresholds for the :func:`StackStackVoltageReached` callback.
"'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)"
Returns the threshold as set by :func:`SetStackVoltageCallbackThreshold`.
Sets the thresholds for the :func:`USBVoltageReached` callback.
Returns the threshold as set by :func:`SetUSBVoltageCallbackThreshold`.
Sets the period in ms with which the threshold callbacks
* :func:`StackCurrentReached`, * :func:`StackVoltageReached`, * :func:`USBVoltageReached`
are triggered, if the thresholds
* :func:`SetStackCurrentCallbackThreshold`, * :func:`SetStackVoltageCallbackThreshold`, * :func:`SetUSBVoltageCallbackThreshold`
keep being reached.
The default value is 100.
Returns the debounce period as set by :func:`SetDebouncePeriod`.
Returns *true* if a Ethernet Extension is available to be used by the Master Brick.
.. versionadded:: 2.1.0$nbsp;(Firmware)
Sets the configuration of the Ethernet Extension. Possible values for ``connection`` are:
"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.
It is recommended to use the Brick Viewer to set the Ethernet configuration.
Returns the configuration as set by :func:`SetEthernetConfiguration`.
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.
Sets the hostname of the Ethernet Extension. The hostname will be displayed by access points as the hostname in the DHCP clients table.
The current hostname can be discovered with :func:`GetEthernetStatus`.
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 :func:`GetEthernetStatus`.
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 default values are 3 for the socket connections and 4280 for the port.
.. versionadded:: 2.2.0$nbsp;(Firmware)
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).
Returns the authentication secret as set by :func:`SetEthernetAuthenticationSecret`.
Sets the WIFI authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication.
It is recommended to use the Brick Viewer to set the WIFI authentication secret.
Returns the authentication secret as set by :func:`SetWifiAuthenticationSecret`.
Returns the type of the connection over which this function was called.
.. versionadded:: 2.4.0$nbsp;(Firmware)
Returns *true* if a WIFI Extension 2.0 is available to be used by the Master Brick.
Starts the bootloader of the WIFI Extension 2.0. Returns 0 on success. Afterwards the :func:`WriteWifi2SerialPort` and :func:`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 :func:`GetConnectionType` function.
It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0.
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 :func:`StartWifi2Bootloader` function.
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.
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).
To apply configuration changes to the WIFI Extension 2.0 the :func:`SaveWifi2Configuration` function has to be called and the Master Brick has to be restarted afterwards.
Returns the WIFI authentication secret as set by :func:`SetWifi2AuthenticationSecret`.
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`` and ``website`` parameters are currently unused.
Returns the general configuration as set by :func:`SetWifi2Configuration`.
Returns the client and access point status of the WIFI Extension 2.0.
Sets the client specific configuration of the WIFI Extension 2.0.
The ``enable`` parameter enables or disables the client part fo 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``, ``subnet_mask`` and ``gateway`` parameters are set to all zero then 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.
It is recommended to use the Brick Viewer to set the client configuration.
Returns the client configuration as set by :func:`SetWifi2ClientConfiguration`.
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.
It is recommended to use the Brick Viewer to set the client hostname.
Returns the client hostname as set by :func:`SetWifi2ClientHostname`.
Sets the client password (up to 63 chars) for WPA/WPA2 encryption.
It is recommended to use the Brick Viewer to set the client password.
Returns the client password as set by :func:`SetWifi2ClientPassword`.
Sets the access point specific configuration of the WIFI Extension 2.0.
The ``enable`` parameter enables or disables the access point part fo 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``, ``subnet_mask`` and ``gateway`` parameters are set to all zero then a DHCP server is enabled. Otherwise those three parameters can be used to configure a static IP address for the access point. 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 :func:`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.
It is recommended to use the Brick Viewer to set the access point configuration.
Returns the access point configuration as set by :func:`SetWifi2APConfiguration`.
Sets the access point password (up to 63 chars) for the configured encryption mode, see :func:`SetWifi2APConfiguration`.
It is recommended to use the Brick Viewer to set the access point password.
Returns the access point password as set by :func:`SetWifi2APPassword`.
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.
Returns the current version of the WIFI Extension 2.0 firmware (major, minor, revision).
Turns the green status LED of the WIFI Extension 2.0 on.
Turns the green status LED of the WIFI Extension 2.0 off.
Returns *true* if the green status LED of the WIFI Extension 2.0 is turned on.
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$nbsp;(Firmware)
Disables the status LED.
Returns *true* if the status LED is enabled, *false* otherwise.
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.
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.
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!
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|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.