Package com.tinkerforge
Class BrickMaster
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickMaster
-
public class BrickMaster extends Device
Basis to build stacks and has 4 Bricklet ports
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickMaster(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addStackCurrentListener(BrickMaster.StackCurrentListener listener)
Adds a StackCurrent listener.void
addStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
Adds a StackCurrentReached listener.void
addStackVoltageListener(BrickMaster.StackVoltageListener listener)
Adds a StackVoltage listener.void
addStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
Adds a StackVoltageReached listener.void
addUSBVoltageListener(BrickMaster.USBVoltageListener listener)
Adds a USBVoltage listener.void
addUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
Adds a USBVoltageReached listener.void
disableStatusLED()
Disables the status LED.void
disableWifi2StatusLED()
Turns the green status LED of the WIFI Extension 2.0 off.void
enableStatusLED()
Enables the status LED.void
enableWifi2StatusLED()
Turns the green status LED of the WIFI Extension 2.0 on.boolean
getBrickletsEnabled()
Returns *true* if the Bricklets are enabled, *false* otherwise.short
getChibiAddress()
Returns the address as set bysetChibiAddress(short)
.short
getChibiChannel()
Returns the channel as set bysetChibiChannel(short)
.BrickMaster.ChibiErrorLog
getChibiErrorLog()
Returns underrun, CRC error, no ACK and overflow error counts of the Chibi communication.short
getChibiFrequency()
Returns the frequency value as set bysetChibiFrequency(short)
.short
getChibiMasterAddress()
Returns the address as set bysetChibiMasterAddress(short)
.short
getChibiSignalStrength()
Returns the signal strength in dBm.short
getChibiSlaveAddress(short num)
Returns the slave address for a given \c num as set bysetChibiSlaveAddress(short, short)
.short
getChipTemperature()
Returns the temperature as measured inside the microcontroller.short
getConnectionType()
Returns the type of the connection over which this function was called.long
getDebouncePeriod()
Returns the debounce period as set bysetDebouncePeriod(long)
.java.lang.String
getEthernetAuthenticationSecret()
Returns the authentication secret as set bysetEthernetAuthenticationSecret(String)
.BrickMaster.EthernetConfiguration
getEthernetConfiguration()
Returns the configuration as set bysetEthernetConfiguration(short, short[], short[], short[], int)
.BrickMaster.EthernetStatus
getEthernetStatus()
Returns the status of the Ethernet Extension.BrickMaster.EthernetWebsocketConfiguration
getEthernetWebsocketConfiguration()
Returns the configuration as set bysetEthernetConfiguration(short, short[], short[], short[], int)
.long
getExtensionType(short extension)
Returns the type for a given extension as set bysetExtensionType(short, long)
.Device.Identity
getIdentity()
Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.java.lang.String
getLongWifiKey()
Returns the encryption key as set bysetLongWifiKey(String)
.BrickMaster.Protocol1BrickletName
getProtocol1BrickletName(char port)
Returns the firmware and protocol version and the name of the Bricklet for a given port.short
getRS485Address()
Returns the address as set bysetRS485Address(short)
.BrickMaster.RS485Configuration
getRS485Configuration()
Returns the configuration as set bysetRS485Configuration(long, char, short)
.int
getRS485ErrorLog()
Returns CRC error counts of the RS485 communication.short
getRS485SlaveAddress(short num)
Returns the slave address for a given ``num`` as set bysetRS485SlaveAddress(short, short)
.long
getSendTimeoutCount(short communicationMethod)
Returns the timeout count for the different communication methods.long
getSPITFPBaudrate(char brickletPort)
Returns the baudrate for a given Bricklet port, seesetSPITFPBaudrate(char, long)
.BrickMaster.SPITFPBaudrateConfig
getSPITFPBaudrateConfig()
Returns the baudrate config, seesetSPITFPBaudrateConfig(boolean, long)
.BrickMaster.SPITFPErrorCount
getSPITFPErrorCount(char brickletPort)
Returns the error count for the communication between Brick and Bricklet.int
getStackCurrent()
Returns the stack current.long
getStackCurrentCallbackPeriod()
Returns the period as set bysetStackCurrentCallbackPeriod(long)
.BrickMaster.StackCurrentCallbackThreshold
getStackCurrentCallbackThreshold()
Returns the threshold as set bysetStackCurrentCallbackThreshold(char, int, int)
.int
getStackVoltage()
Returns the stack voltage.long
getStackVoltageCallbackPeriod()
Returns the period as set bysetStackVoltageCallbackPeriod(long)
.BrickMaster.StackVoltageCallbackThreshold
getStackVoltageCallbackThreshold()
Returns the threshold as set bysetStackVoltageCallbackThreshold(char, int, int)
.int
getUSBVoltage()
Returns the USB voltage.long
getUSBVoltageCallbackPeriod()
Returns the period as set bysetUSBVoltageCallbackPeriod(long)
.BrickMaster.USBVoltageCallbackThreshold
getUSBVoltageCallbackThreshold()
Returns the threshold as set bysetUSBVoltageCallbackThreshold(char, int, int)
.BrickMaster.Wifi2APConfiguration
getWifi2APConfiguration()
Returns the access point configuration as set bysetWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
.java.lang.String
getWifi2APPassword()
Returns the access point password as set bysetWifi2APPassword(String)
.java.lang.String
getWifi2AuthenticationSecret()
Returns the WIFI authentication secret as set bysetWifi2AuthenticationSecret(String)
.BrickMaster.Wifi2ClientConfiguration
getWifi2ClientConfiguration()
Returns the client configuration as set bysetWifi2ClientConfiguration(boolean, String, short[], short[], short[], short[], short[])
.java.lang.String
getWifi2ClientHostname()
Returns the client hostname as set bysetWifi2ClientHostname(String)
.java.lang.String
getWifi2ClientPassword()
Returns the client password as set bysetWifi2ClientPassword(String)
.BrickMaster.Wifi2Configuration
getWifi2Configuration()
Returns the general configuration as set bysetWifi2Configuration(int, int, int, short, short, short)
.short[]
getWifi2FirmwareVersion()
Returns the current version of the WIFI Extension 2.0 firmware.BrickMaster.Wifi2MeshAPStatus
getWifi2MeshAPStatus()
Requires WIFI Extension 2.0 firmware 2.1.0.BrickMaster.Wifi2MeshClientStatus
getWifi2MeshClientStatus()
Requires WIFI Extension 2.0 firmware 2.1.0.BrickMaster.Wifi2MeshCommonStatus
getWifi2MeshCommonStatus()
Requires WIFI Extension 2.0 firmware 2.1.0.BrickMaster.Wifi2MeshConfiguration
getWifi2MeshConfiguration()
Requires WIFI Extension 2.0 firmware 2.1.0.java.lang.String
getWifi2MeshRouterPassword()
Requires WIFI Extension 2.0 firmware 2.1.0.java.lang.String
getWifi2MeshRouterSSID()
Requires WIFI Extension 2.0 firmware 2.1.0.BrickMaster.Wifi2Status
getWifi2Status()
Returns the client and access point status of the WIFI Extension 2.0.java.lang.String
getWifiAuthenticationSecret()
Returns the authentication secret as set bysetWifiAuthenticationSecret(String)
.BrickMaster.WifiBufferInfo
getWifiBufferInfo()
Returns informations about the Wi-Fi receive buffer.BrickMaster.WifiCertificate
getWifiCertificate(int index)
Returns the certificate for a given index as set bysetWifiCertificate(int, short[], short)
.BrickMaster.WifiConfiguration
getWifiConfiguration()
Returns the configuration as set bysetWifiConfiguration(String, short, short[], short[], short[], int)
.BrickMaster.WifiEncryption
getWifiEncryption()
Returns the encryption as set bysetWifiEncryption(short, String, short, short, int, int, int)
.java.lang.String
getWifiHostname()
Returns the hostname as set bysetWifiHostname(String)
.short
getWifiPowerMode()
Returns the power mode as set bysetWifiPowerMode(short)
.short
getWifiRegulatoryDomain()
Returns the regulatory domain as set bysetWifiRegulatoryDomain(short)
.BrickMaster.WifiStatus
getWifiStatus()
Returns the status of the WIFI Extension.boolean
isChibiPresent()
Returns *true* if the Master Brick is at position 0 in the stack and a Chibi Extension is available.boolean
isEthernetPresent()
Returns *true* if the Master Brick is at position 0 in the stack and an Ethernet Extension is available.boolean
isRS485Present()
Returns *true* if the Master Brick is at position 0 in the stack and a RS485 Extension is available.boolean
isStatusLEDEnabled()
Returns *true* if the status LED is enabled, *false* otherwise.boolean
isWifi2Present()
Returns *true* if the Master Brick is at position 0 in the stack and a WIFI Extension 2.0 is available.boolean
isWifi2StatusLEDEnabled()
Returns *true* if the green status LED of the WIFI Extension 2.0 is turned on.boolean
isWifiPresent()
Returns *true* if the Master Brick is at position 0 in the stack and a WIFI Extension is available.short[]
readBrickletPlugin(char port, short offset)
Reads 32 bytes of firmware from the bricklet attached at the given port.BrickMaster.ReadWifi2SerialPort
readWifi2SerialPort(short length)
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.void
refreshWifiStatus()
Refreshes the Wi-Fi status (seegetWifiStatus()
).void
removeStackCurrentListener(BrickMaster.StackCurrentListener listener)
Removes a StackCurrent listener.void
removeStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
Removes a StackCurrentReached listener.void
removeStackVoltageListener(BrickMaster.StackVoltageListener listener)
Removes a StackVoltage listener.void
removeStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
Removes a StackVoltageReached listener.void
removeUSBVoltageListener(BrickMaster.USBVoltageListener listener)
Removes a USBVoltage listener.void
removeUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
Removes a USBVoltageReached listener.void
reset()
Calling this function will reset the Brick.short
saveWifi2Configuration()
All configuration functions for the WIFI Extension 2.0 do not change the values permanently.void
setBrickletsEnabled(boolean brickletsEnabled)
This function is only available in Master Brick hardware version >= 3.0.BrickMaster.SetBrickletXMCFlashConfig
setBrickletXMCFlashConfig(long config, long parameter1, long parameter2, short[] data)
This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets.long
setBrickletXMCFlashData(short[] data)
This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets.void
setChibiAddress(short address)
Sets the address belonging to the Chibi Extension.void
setChibiChannel(short channel)
Sets the channel used by the Chibi Extension.void
setChibiFrequency(short frequency)
Sets the Chibi frequency range for the Chibi Extension.void
setChibiMasterAddress(short address)
Sets the address of the Chibi Master.void
setChibiSlaveAddress(short num, short address)
Sets up to 254 slave addresses.void
setDebouncePeriod(long debounce)
Sets the period with which the threshold listeners *BrickMaster.StackCurrentReachedListener
, *BrickMaster.StackVoltageReachedListener
, *BrickMaster.USBVoltageReachedListener
are triggered, if the thresholds *setStackCurrentCallbackThreshold(char, int, int)
, *setStackVoltageCallbackThreshold(char, int, int)
, *setUSBVoltageCallbackThreshold(char, int, int)
keep being reached.void
setEthernetAuthenticationSecret(java.lang.String secret)
Sets the Ethernet authentication secret.void
setEthernetConfiguration(short connection, short[] ip, short[] subnetMask, short[] gateway, int port)
Sets the configuration of the Ethernet Extension.void
setEthernetHostname(java.lang.String hostname)
Sets the hostname of the Ethernet Extension.void
setEthernetMACAddress(short[] macAddress)
Sets the MAC address of the Ethernet Extension.void
setEthernetWebsocketConfiguration(short sockets, int port)
Sets the Ethernet WebSocket configuration.void
setExtensionType(short extension, long exttype)
Writes the extension type to the EEPROM of a specified extension.void
setLongWifiKey(java.lang.String key)
Sets a long Wi-Fi key (up to 63 chars, at least 8 chars) for WPA encryption.void
setRS485Address(short address)
Sets the address (0-255) belonging to the RS485 Extension.void
setRS485Configuration(long speed, char parity, short stopbits)
Sets the configuration of the RS485 Extension.void
setRS485SlaveAddress(short num, short address)
Sets up to 255 slave addresses.void
setSPITFPBaudrate(char brickletPort, long baudrate)
Sets the baudrate for a specific Bricklet port.void
setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)
The SPITF protocol can be used with a dynamic baudrate.void
setStackCurrentCallbackPeriod(long period)
Sets the period with which theBrickMaster.StackCurrentListener
listener is triggered periodically.void
setStackCurrentCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickMaster.StackCurrentReachedListener
listener.void
setStackVoltageCallbackPeriod(long period)
Sets the period with which theBrickMaster.StackVoltageListener
listener is triggered periodically.void
setStackVoltageCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickMaster.StackVoltageReachedListener
listener.void
setUSBVoltageCallbackPeriod(long period)
Sets the period with which theBrickMaster.USBVoltageListener
listener is triggered periodically.void
setUSBVoltageCallbackThreshold(char option, int min, int max)
Sets the thresholds for theBrickMaster.USBVoltageReachedListener
listener.void
setWifi2APConfiguration(boolean enable, java.lang.String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel, short[] macAddress)
Sets the access point specific configuration of the WIFI Extension 2.0.void
setWifi2APPassword(java.lang.String password)
Sets the access point password (at least 8 and up to 63 chars) for the configured encryption mode, seesetWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
.void
setWifi2AuthenticationSecret(java.lang.String secret)
Sets the WIFI authentication secret.void
setWifi2ClientConfiguration(boolean enable, java.lang.String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress, short[] bssid)
Sets the client specific configuration of the WIFI Extension 2.0.void
setWifi2ClientHostname(java.lang.String hostname)
Sets the client hostname (up to 32 characters) of the WIFI Extension 2.0.void
setWifi2ClientPassword(java.lang.String password)
Sets the client password (up to 63 chars) for WPA/WPA2 encryption.void
setWifi2Configuration(int port, int websocketPort, int websitePort, short phyMode, short sleepMode, short website)
Sets the general configuration of the WIFI Extension 2.0.void
setWifi2MeshConfiguration(boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, java.lang.String groupSSIDPrefix, short[] gatewayIP, int gatewayPort)
Requires WIFI Extension 2.0 firmware 2.1.0.void
setWifi2MeshRouterPassword(java.lang.String password)
Requires WIFI Extension 2.0 firmware 2.1.0.void
setWifi2MeshRouterSSID(java.lang.String ssid)
Requires WIFI Extension 2.0 firmware 2.1.0.void
setWifiAuthenticationSecret(java.lang.String secret)
Sets the WIFI authentication secret.void
setWifiCertificate(int index, short[] data, short dataLength)
This function is used to set the certificate as well as password and username for WPA Enterprise.void
setWifiConfiguration(java.lang.String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway, int port)
Sets the configuration of the WIFI Extension.void
setWifiEncryption(short encryption, java.lang.String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength, int privateKeyLength)
Sets the encryption of the WIFI Extension.void
setWifiHostname(java.lang.String hostname)
Sets the hostname of the WIFI Extension.void
setWifiPowerMode(short mode)
Sets the power mode of the WIFI Extension.void
setWifiRegulatoryDomain(short domain)
Sets the regulatory domain of the WIFI Extension.byte
startWifi2Bootloader()
Starts the bootloader of the WIFI Extension 2.0.void
writeBrickletPlugin(char port, short offset, short[] chunk)
Writes 32 bytes of firmware to the bricklet attached at the given port.byte
writeWifi2SerialPort(short[] data, short length)
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.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_VOLTAGE
public static final byte FUNCTION_GET_STACK_VOLTAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_CURRENT
public static final byte FUNCTION_GET_STACK_CURRENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_EXTENSION_TYPE
public static final byte FUNCTION_SET_EXTENSION_TYPE
- See Also:
- Constant Field Values
-
FUNCTION_GET_EXTENSION_TYPE
public static final byte FUNCTION_GET_EXTENSION_TYPE
- See Also:
- Constant Field Values
-
FUNCTION_IS_CHIBI_PRESENT
public static final byte FUNCTION_IS_CHIBI_PRESENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHIBI_ADDRESS
public static final byte FUNCTION_SET_CHIBI_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_ADDRESS
public static final byte FUNCTION_GET_CHIBI_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHIBI_MASTER_ADDRESS
public static final byte FUNCTION_SET_CHIBI_MASTER_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_MASTER_ADDRESS
public static final byte FUNCTION_GET_CHIBI_MASTER_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHIBI_SLAVE_ADDRESS
public static final byte FUNCTION_SET_CHIBI_SLAVE_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_SLAVE_ADDRESS
public static final byte FUNCTION_GET_CHIBI_SLAVE_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_SIGNAL_STRENGTH
public static final byte FUNCTION_GET_CHIBI_SIGNAL_STRENGTH
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_ERROR_LOG
public static final byte FUNCTION_GET_CHIBI_ERROR_LOG
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHIBI_FREQUENCY
public static final byte FUNCTION_SET_CHIBI_FREQUENCY
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_FREQUENCY
public static final byte FUNCTION_GET_CHIBI_FREQUENCY
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHIBI_CHANNEL
public static final byte FUNCTION_SET_CHIBI_CHANNEL
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIBI_CHANNEL
public static final byte FUNCTION_GET_CHIBI_CHANNEL
- See Also:
- Constant Field Values
-
FUNCTION_IS_RS485_PRESENT
public static final byte FUNCTION_IS_RS485_PRESENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_RS485_ADDRESS
public static final byte FUNCTION_SET_RS485_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_RS485_ADDRESS
public static final byte FUNCTION_GET_RS485_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_SET_RS485_SLAVE_ADDRESS
public static final byte FUNCTION_SET_RS485_SLAVE_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_RS485_SLAVE_ADDRESS
public static final byte FUNCTION_GET_RS485_SLAVE_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_RS485_ERROR_LOG
public static final byte FUNCTION_GET_RS485_ERROR_LOG
- See Also:
- Constant Field Values
-
FUNCTION_SET_RS485_CONFIGURATION
public static final byte FUNCTION_SET_RS485_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_RS485_CONFIGURATION
public static final byte FUNCTION_GET_RS485_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_IS_WIFI_PRESENT
public static final byte FUNCTION_IS_WIFI_PRESENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_CONFIGURATION
public static final byte FUNCTION_SET_WIFI_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_CONFIGURATION
public static final byte FUNCTION_GET_WIFI_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_ENCRYPTION
public static final byte FUNCTION_SET_WIFI_ENCRYPTION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_ENCRYPTION
public static final byte FUNCTION_GET_WIFI_ENCRYPTION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_STATUS
public static final byte FUNCTION_GET_WIFI_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_REFRESH_WIFI_STATUS
public static final byte FUNCTION_REFRESH_WIFI_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_CERTIFICATE
public static final byte FUNCTION_SET_WIFI_CERTIFICATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_CERTIFICATE
public static final byte FUNCTION_GET_WIFI_CERTIFICATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_POWER_MODE
public static final byte FUNCTION_SET_WIFI_POWER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_POWER_MODE
public static final byte FUNCTION_GET_WIFI_POWER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_BUFFER_INFO
public static final byte FUNCTION_GET_WIFI_BUFFER_INFO
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_REGULATORY_DOMAIN
public static final byte FUNCTION_SET_WIFI_REGULATORY_DOMAIN
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_REGULATORY_DOMAIN
public static final byte FUNCTION_GET_WIFI_REGULATORY_DOMAIN
- See Also:
- Constant Field Values
-
FUNCTION_GET_USB_VOLTAGE
public static final byte FUNCTION_GET_USB_VOLTAGE
- See Also:
- Constant Field Values
-
FUNCTION_SET_LONG_WIFI_KEY
public static final byte FUNCTION_SET_LONG_WIFI_KEY
- See Also:
- Constant Field Values
-
FUNCTION_GET_LONG_WIFI_KEY
public static final byte FUNCTION_GET_LONG_WIFI_KEY
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_HOSTNAME
public static final byte FUNCTION_SET_WIFI_HOSTNAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_HOSTNAME
public static final byte FUNCTION_GET_WIFI_HOSTNAME
- See Also:
- Constant Field Values
-
FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_CURRENT_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STACK_CURRENT_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STACK_VOLTAGE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_USB_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_USB_VOLTAGE_CALLBACK_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_CURRENT_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_STACK_CURRENT_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_STACK_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_STACK_VOLTAGE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_GET_USB_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_USB_VOLTAGE_CALLBACK_THRESHOLD
- See Also:
- Constant Field Values
-
FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_IS_ETHERNET_PRESENT
public static final byte FUNCTION_IS_ETHERNET_PRESENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_ETHERNET_CONFIGURATION
public static final byte FUNCTION_SET_ETHERNET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ETHERNET_CONFIGURATION
public static final byte FUNCTION_GET_ETHERNET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ETHERNET_STATUS
public static final byte FUNCTION_GET_ETHERNET_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_ETHERNET_HOSTNAME
public static final byte FUNCTION_SET_ETHERNET_HOSTNAME
- See Also:
- Constant Field Values
-
FUNCTION_SET_ETHERNET_MAC_ADDRESS
public static final byte FUNCTION_SET_ETHERNET_MAC_ADDRESS
- See Also:
- Constant Field Values
-
FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION
public static final byte FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ETHERNET_WEBSOCKET_CONFIGURATION
public static final byte FUNCTION_GET_ETHERNET_WEBSOCKET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET
public static final byte FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_GET_ETHERNET_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_ETHERNET_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI_AUTHENTICATION_SECRET
public static final byte FUNCTION_SET_WIFI_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_WIFI_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONNECTION_TYPE
public static final byte FUNCTION_GET_CONNECTION_TYPE
- See Also:
- Constant Field Values
-
FUNCTION_IS_WIFI2_PRESENT
public static final byte FUNCTION_IS_WIFI2_PRESENT
- See Also:
- Constant Field Values
-
FUNCTION_START_WIFI2_BOOTLOADER
public static final byte FUNCTION_START_WIFI2_BOOTLOADER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_WIFI2_SERIAL_PORT
public static final byte FUNCTION_WRITE_WIFI2_SERIAL_PORT
- See Also:
- Constant Field Values
-
FUNCTION_READ_WIFI2_SERIAL_PORT
public static final byte FUNCTION_READ_WIFI2_SERIAL_PORT
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET
public static final byte FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_WIFI2_AUTHENTICATION_SECRET
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_STATUS
public static final byte FUNCTION_GET_WIFI2_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_CLIENT_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_CLIENT_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_CLIENT_HOSTNAME
public static final byte FUNCTION_SET_WIFI2_CLIENT_HOSTNAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_CLIENT_HOSTNAME
public static final byte FUNCTION_GET_WIFI2_CLIENT_HOSTNAME
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_CLIENT_PASSWORD
public static final byte FUNCTION_SET_WIFI2_CLIENT_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_CLIENT_PASSWORD
public static final byte FUNCTION_GET_WIFI2_CLIENT_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_AP_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_AP_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_AP_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_AP_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_AP_PASSWORD
public static final byte FUNCTION_SET_WIFI2_AP_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_AP_PASSWORD
public static final byte FUNCTION_GET_WIFI2_AP_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_SAVE_WIFI2_CONFIGURATION
public static final byte FUNCTION_SAVE_WIFI2_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_FIRMWARE_VERSION
public static final byte FUNCTION_GET_WIFI2_FIRMWARE_VERSION
- See Also:
- Constant Field Values
-
FUNCTION_ENABLE_WIFI2_STATUS_LED
public static final byte FUNCTION_ENABLE_WIFI2_STATUS_LED
- See Also:
- Constant Field Values
-
FUNCTION_DISABLE_WIFI2_STATUS_LED
public static final byte FUNCTION_DISABLE_WIFI2_STATUS_LED
- See Also:
- Constant Field Values
-
FUNCTION_IS_WIFI2_STATUS_LED_ENABLED
public static final byte FUNCTION_IS_WIFI2_STATUS_LED_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_MESH_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_MESH_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_MESH_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_MESH_ROUTER_SSID
public static final byte FUNCTION_SET_WIFI2_MESH_ROUTER_SSID
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_ROUTER_SSID
public static final byte FUNCTION_GET_WIFI2_MESH_ROUTER_SSID
- See Also:
- Constant Field Values
-
FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD
public static final byte FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_ROUTER_PASSWORD
public static final byte FUNCTION_GET_WIFI2_MESH_ROUTER_PASSWORD
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_COMMON_STATUS
public static final byte FUNCTION_GET_WIFI2_MESH_COMMON_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_CLIENT_STATUS
public static final byte FUNCTION_GET_WIFI2_MESH_CLIENT_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_GET_WIFI2_MESH_AP_STATUS
public static final byte FUNCTION_GET_WIFI2_MESH_AP_STATUS
- See Also:
- Constant Field Values
-
FUNCTION_SET_BRICKLET_XMC_FLASH_CONFIG
public static final byte FUNCTION_SET_BRICKLET_XMC_FLASH_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_SET_BRICKLET_XMC_FLASH_DATA
public static final byte FUNCTION_SET_BRICKLET_XMC_FLASH_DATA
- See Also:
- Constant Field Values
-
FUNCTION_SET_BRICKLETS_ENABLED
public static final byte FUNCTION_SET_BRICKLETS_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_GET_BRICKLETS_ENABLED
public static final byte FUNCTION_GET_BRICKLETS_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SEND_TIMEOUT_COUNT
public static final byte FUNCTION_GET_SEND_TIMEOUT_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_SPITFP_BAUDRATE
public static final byte FUNCTION_SET_SPITFP_BAUDRATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_SPITFP_BAUDRATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_ENABLE_STATUS_LED
public static final byte FUNCTION_ENABLE_STATUS_LED
- See Also:
- Constant Field Values
-
FUNCTION_DISABLE_STATUS_LED
public static final byte FUNCTION_DISABLE_STATUS_LED
- See Also:
- Constant Field Values
-
FUNCTION_IS_STATUS_LED_ENABLED
public static final byte FUNCTION_IS_STATUS_LED_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_GET_PROTOCOL1_BRICKLET_NAME
public static final byte FUNCTION_GET_PROTOCOL1_BRICKLET_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_BRICKLET_PLUGIN
public static final byte FUNCTION_WRITE_BRICKLET_PLUGIN
- See Also:
- Constant Field Values
-
FUNCTION_READ_BRICKLET_PLUGIN
public static final byte FUNCTION_READ_BRICKLET_PLUGIN
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
EXTENSION_TYPE_CHIBI
public static final long EXTENSION_TYPE_CHIBI
- See Also:
- Constant Field Values
-
EXTENSION_TYPE_RS485
public static final long EXTENSION_TYPE_RS485
- See Also:
- Constant Field Values
-
EXTENSION_TYPE_WIFI
public static final long EXTENSION_TYPE_WIFI
- See Also:
- Constant Field Values
-
EXTENSION_TYPE_ETHERNET
public static final long EXTENSION_TYPE_ETHERNET
- See Also:
- Constant Field Values
-
EXTENSION_TYPE_WIFI2
public static final long EXTENSION_TYPE_WIFI2
- See Also:
- Constant Field Values
-
CHIBI_FREQUENCY_OQPSK_868_MHZ
public static final short CHIBI_FREQUENCY_OQPSK_868_MHZ
- See Also:
- Constant Field Values
-
CHIBI_FREQUENCY_OQPSK_915_MHZ
public static final short CHIBI_FREQUENCY_OQPSK_915_MHZ
- See Also:
- Constant Field Values
-
CHIBI_FREQUENCY_OQPSK_780_MHZ
public static final short CHIBI_FREQUENCY_OQPSK_780_MHZ
- See Also:
- Constant Field Values
-
CHIBI_FREQUENCY_BPSK40_915_MHZ
public static final short CHIBI_FREQUENCY_BPSK40_915_MHZ
- See Also:
- Constant Field Values
-
RS485_PARITY_NONE
public static final char RS485_PARITY_NONE
- See Also:
- Constant Field Values
-
RS485_PARITY_EVEN
public static final char RS485_PARITY_EVEN
- See Also:
- Constant Field Values
-
RS485_PARITY_ODD
public static final char RS485_PARITY_ODD
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_DHCP
public static final short WIFI_CONNECTION_DHCP
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_STATIC_IP
public static final short WIFI_CONNECTION_STATIC_IP
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_ACCESS_POINT_DHCP
public static final short WIFI_CONNECTION_ACCESS_POINT_DHCP
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_ACCESS_POINT_STATIC_IP
public static final short WIFI_CONNECTION_ACCESS_POINT_STATIC_IP
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_AD_HOC_DHCP
public static final short WIFI_CONNECTION_AD_HOC_DHCP
- See Also:
- Constant Field Values
-
WIFI_CONNECTION_AD_HOC_STATIC_IP
public static final short WIFI_CONNECTION_AD_HOC_STATIC_IP
- See Also:
- Constant Field Values
-
WIFI_ENCRYPTION_WPA_WPA2
public static final short WIFI_ENCRYPTION_WPA_WPA2
- See Also:
- Constant Field Values
-
WIFI_ENCRYPTION_WPA_ENTERPRISE
public static final short WIFI_ENCRYPTION_WPA_ENTERPRISE
- See Also:
- Constant Field Values
-
WIFI_ENCRYPTION_WEP
public static final short WIFI_ENCRYPTION_WEP
- See Also:
- Constant Field Values
-
WIFI_ENCRYPTION_NO_ENCRYPTION
public static final short WIFI_ENCRYPTION_NO_ENCRYPTION
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP
public static final short WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC
public static final short WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_CERT_TYPE_CA_CERT
public static final short WIFI_EAP_OPTION_CERT_TYPE_CA_CERT
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT
public static final short WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT
- See Also:
- Constant Field Values
-
WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY
public static final short WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY
- See Also:
- Constant Field Values
-
WIFI_STATE_DISASSOCIATED
public static final short WIFI_STATE_DISASSOCIATED
- See Also:
- Constant Field Values
-
WIFI_STATE_ASSOCIATED
public static final short WIFI_STATE_ASSOCIATED
- See Also:
- Constant Field Values
-
WIFI_STATE_ASSOCIATING
public static final short WIFI_STATE_ASSOCIATING
- See Also:
- Constant Field Values
-
WIFI_STATE_ERROR
public static final short WIFI_STATE_ERROR
- See Also:
- Constant Field Values
-
WIFI_STATE_NOT_INITIALIZED_YET
public static final short WIFI_STATE_NOT_INITIALIZED_YET
- See Also:
- Constant Field Values
-
WIFI_POWER_MODE_FULL_SPEED
public static final short WIFI_POWER_MODE_FULL_SPEED
- See Also:
- Constant Field Values
-
WIFI_POWER_MODE_LOW_POWER
public static final short WIFI_POWER_MODE_LOW_POWER
- See Also:
- Constant Field Values
-
WIFI_DOMAIN_CHANNEL_1TO11
public static final short WIFI_DOMAIN_CHANNEL_1TO11
- See Also:
- Constant Field Values
-
WIFI_DOMAIN_CHANNEL_1TO13
public static final short WIFI_DOMAIN_CHANNEL_1TO13
- See Also:
- Constant Field Values
-
WIFI_DOMAIN_CHANNEL_1TO14
public static final short WIFI_DOMAIN_CHANNEL_1TO14
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
ETHERNET_CONNECTION_DHCP
public static final short ETHERNET_CONNECTION_DHCP
- See Also:
- Constant Field Values
-
ETHERNET_CONNECTION_STATIC_IP
public static final short ETHERNET_CONNECTION_STATIC_IP
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_NONE
public static final short CONNECTION_TYPE_NONE
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_USB
public static final short CONNECTION_TYPE_USB
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_SPI_STACK
public static final short CONNECTION_TYPE_SPI_STACK
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_CHIBI
public static final short CONNECTION_TYPE_CHIBI
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_RS485
public static final short CONNECTION_TYPE_RS485
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_WIFI
public static final short CONNECTION_TYPE_WIFI
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_ETHERNET
public static final short CONNECTION_TYPE_ETHERNET
- See Also:
- Constant Field Values
-
CONNECTION_TYPE_WIFI2
public static final short CONNECTION_TYPE_WIFI2
- See Also:
- Constant Field Values
-
WIFI2_PHY_MODE_B
public static final short WIFI2_PHY_MODE_B
- See Also:
- Constant Field Values
-
WIFI2_PHY_MODE_G
public static final short WIFI2_PHY_MODE_G
- See Also:
- Constant Field Values
-
WIFI2_PHY_MODE_N
public static final short WIFI2_PHY_MODE_N
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_IDLE
public static final short WIFI2_CLIENT_STATUS_IDLE
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_CONNECTING
public static final short WIFI2_CLIENT_STATUS_CONNECTING
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_WRONG_PASSWORD
public static final short WIFI2_CLIENT_STATUS_WRONG_PASSWORD
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_NO_AP_FOUND
public static final short WIFI2_CLIENT_STATUS_NO_AP_FOUND
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_CONNECT_FAILED
public static final short WIFI2_CLIENT_STATUS_CONNECT_FAILED
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_GOT_IP
public static final short WIFI2_CLIENT_STATUS_GOT_IP
- See Also:
- Constant Field Values
-
WIFI2_CLIENT_STATUS_UNKNOWN
public static final short WIFI2_CLIENT_STATUS_UNKNOWN
- See Also:
- Constant Field Values
-
WIFI2_AP_ENCRYPTION_OPEN
public static final short WIFI2_AP_ENCRYPTION_OPEN
- See Also:
- Constant Field Values
-
WIFI2_AP_ENCRYPTION_WEP
public static final short WIFI2_AP_ENCRYPTION_WEP
- See Also:
- Constant Field Values
-
WIFI2_AP_ENCRYPTION_WPA_PSK
public static final short WIFI2_AP_ENCRYPTION_WPA_PSK
- See Also:
- Constant Field Values
-
WIFI2_AP_ENCRYPTION_WPA2_PSK
public static final short WIFI2_AP_ENCRYPTION_WPA2_PSK
- See Also:
- Constant Field Values
-
WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK
public static final short WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_DISABLED
public static final short WIFI2_MESH_STATUS_DISABLED
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_WIFI_CONNECTING
public static final short WIFI2_MESH_STATUS_WIFI_CONNECTING
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_GOT_IP
public static final short WIFI2_MESH_STATUS_GOT_IP
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_MESH_LOCAL
public static final short WIFI2_MESH_STATUS_MESH_LOCAL
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_MESH_ONLINE
public static final short WIFI2_MESH_STATUS_MESH_ONLINE
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_AP_AVAILABLE
public static final short WIFI2_MESH_STATUS_AP_AVAILABLE
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_AP_SETUP
public static final short WIFI2_MESH_STATUS_AP_SETUP
- See Also:
- Constant Field Values
-
WIFI2_MESH_STATUS_LEAF_AVAILABLE
public static final short WIFI2_MESH_STATUS_LEAF_AVAILABLE
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_NONE
public static final short COMMUNICATION_METHOD_NONE
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_USB
public static final short COMMUNICATION_METHOD_USB
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_SPI_STACK
public static final short COMMUNICATION_METHOD_SPI_STACK
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_CHIBI
public static final short COMMUNICATION_METHOD_CHIBI
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_RS485
public static final short COMMUNICATION_METHOD_RS485
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_WIFI
public static final short COMMUNICATION_METHOD_WIFI
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_ETHERNET
public static final short COMMUNICATION_METHOD_ETHERNET
- See Also:
- Constant Field Values
-
COMMUNICATION_METHOD_WIFI_V2
public static final short COMMUNICATION_METHOD_WIFI_V2
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickMaster
public BrickMaster(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getStackVoltage
public int getStackVoltage() throws TinkerforgeException
Returns the stack voltage. The stack voltage is the voltage that is supplied via the stack, i.e. it is given by a Step-Down or Step-Up Power Supply. \note It is not possible to measure voltages supplied per PoE or USB with this function.- Throws:
TinkerforgeException
-
getStackCurrent
public int getStackCurrent() throws TinkerforgeException
Returns the stack current. The stack current is the current that is drawn via the stack, i.e. it is given by a Step-Down or Step-Up Power Supply. \note It is not possible to measure the current drawn via PoE or USB with this function.- Throws:
TinkerforgeException
-
setExtensionType
public void setExtensionType(short extension, long exttype) throws TinkerforgeException
Writes the extension type to the EEPROM of a specified extension. The extension is either 0 or 1 (0 is the lower one, 1 is the upper one, if only one extension is present use 0). Possible extension types: \verbatim "Type", "Description" "1", "Chibi" "2", "RS485" "3", "WIFI" "4", "Ethernet" "5", "WIFI 2.0" \endverbatim 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.- Throws:
TinkerforgeException
-
getExtensionType
public long getExtensionType(short extension) throws TinkerforgeException
Returns the type for a given extension as set bysetExtensionType(short, long)
.- Throws:
TinkerforgeException
-
isChibiPresent
public boolean isChibiPresent() throws TinkerforgeException
Returns *true* if the Master Brick is at position 0 in the stack and a Chibi Extension is available.- Throws:
TinkerforgeException
-
setChibiAddress
public void setChibiAddress(short address) throws TinkerforgeException
Sets the address belonging to the Chibi Extension. It is possible to set the address with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.- Throws:
TinkerforgeException
-
getChibiAddress
public short getChibiAddress() throws TinkerforgeException
Returns the address as set bysetChibiAddress(short)
.- Throws:
TinkerforgeException
-
setChibiMasterAddress
public void setChibiMasterAddress(short address) throws TinkerforgeException
Sets the address of the Chibi Master. This address is used if the Chibi Extension is used as slave (i.e. it does not have a USB connection). It is possible to set the address with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.- Throws:
TinkerforgeException
-
getChibiMasterAddress
public short getChibiMasterAddress() throws TinkerforgeException
Returns the address as set bysetChibiMasterAddress(short)
.- Throws:
TinkerforgeException
-
setChibiSlaveAddress
public void setChibiSlaveAddress(short num, short address) throws TinkerforgeException
Sets up to 254 slave addresses. 0 has a special meaning, it is used as list terminator and not allowed as normal slave address. The address numeration (via \c 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.- Throws:
TinkerforgeException
-
getChibiSlaveAddress
public short getChibiSlaveAddress(short num) throws TinkerforgeException
Returns the slave address for a given \c num as set bysetChibiSlaveAddress(short, short)
.- Throws:
TinkerforgeException
-
getChibiSignalStrength
public short getChibiSignalStrength() throws TinkerforgeException
Returns the signal strength in dBm. The signal strength updates every time a packet is received.- Throws:
TinkerforgeException
-
getChibiErrorLog
public BrickMaster.ChibiErrorLog getChibiErrorLog() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setChibiFrequency
public void setChibiFrequency(short frequency) throws TinkerforgeException
Sets the Chibi frequency range for the Chibi Extension. Possible values are: \verbatim "Type", "Description" "0", "OQPSK 868MHz (Europe)" "1", "OQPSK 915MHz (US)" "2", "OQPSK 780MHz (China)" "3", "BPSK40 915MHz" \endverbatim 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.- Throws:
TinkerforgeException
-
getChibiFrequency
public short getChibiFrequency() throws TinkerforgeException
Returns the frequency value as set bysetChibiFrequency(short)
.- Throws:
TinkerforgeException
-
setChibiChannel
public void setChibiChannel(short channel) throws TinkerforgeException
Sets the channel used by the Chibi Extension. Possible channels are different for different frequencies: \verbatim "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" \endverbatim 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.- Throws:
TinkerforgeException
-
getChibiChannel
public short getChibiChannel() throws TinkerforgeException
Returns the channel as set bysetChibiChannel(short)
.- Throws:
TinkerforgeException
-
isRS485Present
public boolean isRS485Present() throws TinkerforgeException
Returns *true* if the Master Brick is at position 0 in the stack and a RS485 Extension is available.- Throws:
TinkerforgeException
-
setRS485Address
public void setRS485Address(short address) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getRS485Address
public short getRS485Address() throws TinkerforgeException
Returns the address as set bysetRS485Address(short)
.- Throws:
TinkerforgeException
-
setRS485SlaveAddress
public void setRS485SlaveAddress(short num, short address) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getRS485SlaveAddress
public short getRS485SlaveAddress(short num) throws TinkerforgeException
Returns the slave address for a given ``num`` as set bysetRS485SlaveAddress(short, short)
.- Throws:
TinkerforgeException
-
getRS485ErrorLog
public int getRS485ErrorLog() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setRS485Configuration
public void setRS485Configuration(long speed, char parity, short stopbits) throws TinkerforgeException
Sets the configuration of the RS485 Extension. The Master Brick will try to match the given baud rate as exactly as possible. The maximum recommended baud rate is 2000000 (2MBd). Possible values for parity are 'n' (none), 'e' (even) and 'o' (odd). If your RS485 is unstable (lost messages etc.), the first thing you should try is to decrease the speed. On very large bus (e.g. 1km), you probably should use a value in the range of 100000 (100kBd). The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration.- Throws:
TinkerforgeException
-
getRS485Configuration
public BrickMaster.RS485Configuration getRS485Configuration() throws TinkerforgeException
Returns the configuration as set bysetRS485Configuration(long, char, short)
.- Throws:
TinkerforgeException
-
isWifiPresent
public boolean isWifiPresent() throws TinkerforgeException
Returns *true* if the Master Brick is at position 0 in the stack and a WIFI Extension is available.- Throws:
TinkerforgeException
-
setWifiConfiguration
public void setWifiConfiguration(java.lang.String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway, int port) throws TinkerforgeException
Sets the configuration of the WIFI Extension. The ``ssid`` can have a max length of 32 characters. Possible values for ``connection`` are: \verbatim "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" \endverbatim If you set ``connection`` to one of the static IP options then you have to supply ``ip``, ``subnet_mask`` and ``gateway`` as an array of size 4 (first element of the array is the least significant byte of the address). If ``connection`` is set to one of the DHCP options then ``ip``, ``subnet_mask`` and ``gateway`` are ignored, you can set them to 0. The last parameter is the port that your program will connect to. The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration. It is recommended to use the Brick Viewer to set the WIFI configuration.- Throws:
TinkerforgeException
-
getWifiConfiguration
public BrickMaster.WifiConfiguration getWifiConfiguration() throws TinkerforgeException
Returns the configuration as set bysetWifiConfiguration(String, short, short[], short[], short[], int)
.- Throws:
TinkerforgeException
-
setWifiEncryption
public void setWifiEncryption(short encryption, java.lang.String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength, int privateKeyLength) throws TinkerforgeException
Sets the encryption of the WIFI Extension. The first parameter is the type of the encryption. Possible values are: \verbatim "Value", "Description" "0", "WPA/WPA2" "1", "WPA Enterprise (EAP-FAST, EAP-TLS, EAP-TTLS, PEAP)" "2", "WEP" "3", "No Encryption" \endverbatim 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, seesetLongWifiKey(String)
. For WEP the key has to be either 10 or 26 hexadecimal digits long. It is possible to set the WEP ``key_index`` (1-4). If you don't know your ``key_index``, it is likely 1. If you choose WPA Enterprise as encryption, you have to set ``eap_options`` and the length of the certificates (for other encryption types these parameters are ignored). The certificates themselves can be set withsetWifiCertificate(int, short[], short)
. ``eap_options`` consist of the outer authentication (bits 1-2), inner authentication (bit 3) and certificate type (bits 4-5): \verbatim "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" \endverbatim 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.- Throws:
TinkerforgeException
-
getWifiEncryption
public BrickMaster.WifiEncryption getWifiEncryption() throws TinkerforgeException
Returns the encryption as set bysetWifiEncryption(short, String, short, short, int, int, int)
. \note Since Master Brick Firmware version 2.4.4 the key is not returned anymore.- Throws:
TinkerforgeException
-
getWifiStatus
public BrickMaster.WifiStatus getWifiStatus() throws TinkerforgeException
Returns the status of the WIFI Extension. The ``state`` is updated automatically, all of the other parameters are updated on startup and every timerefreshWifiStatus()
is called. Possible states are: \verbatim "State", "Description" "0", "Disassociated" "1", "Associated" "2", "Associating" "3", "Error" "255", "Not initialized yet" \endverbatim- Throws:
TinkerforgeException
-
refreshWifiStatus
public void refreshWifiStatus() throws TinkerforgeException
Refreshes the Wi-Fi status (seegetWifiStatus()
). 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.- Throws:
TinkerforgeException
-
setWifiCertificate
public void setWifiCertificate(int index, short[] data, short dataLength) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getWifiCertificate
public BrickMaster.WifiCertificate getWifiCertificate(int index) throws TinkerforgeException
Returns the certificate for a given index as set bysetWifiCertificate(int, short[], short)
.- Throws:
TinkerforgeException
-
setWifiPowerMode
public void setWifiPowerMode(short mode) throws TinkerforgeException
Sets the power mode of the WIFI Extension. Possible modes are: \verbatim "Mode", "Description" "0", "Full Speed (high power consumption, high throughput)" "1", "Low Power (low power consumption, low throughput)" \endverbatim- Throws:
TinkerforgeException
-
getWifiPowerMode
public short getWifiPowerMode() throws TinkerforgeException
Returns the power mode as set bysetWifiPowerMode(short)
.- Throws:
TinkerforgeException
-
getWifiBufferInfo
public BrickMaster.WifiBufferInfo getWifiBufferInfo() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setWifiRegulatoryDomain
public void setWifiRegulatoryDomain(short domain) throws TinkerforgeException
Sets the regulatory domain of the WIFI Extension. Possible domains are: \verbatim "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)" \endverbatim- Throws:
TinkerforgeException
-
getWifiRegulatoryDomain
public short getWifiRegulatoryDomain() throws TinkerforgeException
Returns the regulatory domain as set bysetWifiRegulatoryDomain(short)
.- Throws:
TinkerforgeException
-
getUSBVoltage
public int getUSBVoltage() throws TinkerforgeException
Returns the USB voltage. Does not work with hardware version 2.1 or newer.- Throws:
TinkerforgeException
-
setLongWifiKey
public void setLongWifiKey(java.lang.String key) throws TinkerforgeException
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 insetWifiEncryption(short, String, short, short, int, int, int)
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)- Throws:
TinkerforgeException
-
getLongWifiKey
public java.lang.String getLongWifiKey() throws TinkerforgeException
Returns the encryption key as set bysetLongWifiKey(String)
. \note Since Master Brick firmware version 2.4.4 the key is not returned anymore. .. versionadded:: 2.0.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifiHostname
public void setWifiHostname(java.lang.String hostname) throws TinkerforgeException
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)- Throws:
TinkerforgeException
-
getWifiHostname
public java.lang.String getWifiHostname() throws TinkerforgeException
Returns the hostname as set bysetWifiHostname(String)
. An empty String means, that the default hostname is used. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setStackCurrentCallbackPeriod
public void setStackCurrentCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickMaster.StackCurrentListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickMaster.StackCurrentListener
listener is only triggered if the current has changed since the last triggering. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getStackCurrentCallbackPeriod
public long getStackCurrentCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetStackCurrentCallbackPeriod(long)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setStackVoltageCallbackPeriod
public void setStackVoltageCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickMaster.StackVoltageListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickMaster.StackVoltageListener
listener is only triggered if the voltage has changed since the last triggering. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getStackVoltageCallbackPeriod
public long getStackVoltageCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetStackVoltageCallbackPeriod(long)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setUSBVoltageCallbackPeriod
public void setUSBVoltageCallbackPeriod(long period) throws TinkerforgeException
Sets the period with which theBrickMaster.USBVoltageListener
listener is triggered periodically. A value of 0 turns the listener off. TheBrickMaster.USBVoltageListener
listener is only triggered if the voltage has changed since the last triggering. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getUSBVoltageCallbackPeriod
public long getUSBVoltageCallbackPeriod() throws TinkerforgeException
Returns the period as set bysetUSBVoltageCallbackPeriod(long)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setStackCurrentCallbackThreshold
public void setStackCurrentCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickMaster.StackCurrentReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the current is *outside* the min and max values" "'i'", "Listener is triggered when the current is *inside* the min and max values" "'<'", "Listener is triggered when the current is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the current is greater than the min value (max is ignored)" \endverbatim .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getStackCurrentCallbackThreshold
public BrickMaster.StackCurrentCallbackThreshold getStackCurrentCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetStackCurrentCallbackThreshold(char, int, int)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setStackVoltageCallbackThreshold
public void setStackVoltageCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickMaster.StackVoltageReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the voltage is *outside* the min and max values" "'i'", "Listener is triggered when the voltage is *inside* the min and max values" "'<'", "Listener is triggered when the voltage is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the voltage is greater than the min value (max is ignored)" \endverbatim .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getStackVoltageCallbackThreshold
public BrickMaster.StackVoltageCallbackThreshold getStackVoltageCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetStackVoltageCallbackThreshold(char, int, int)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setUSBVoltageCallbackThreshold
public void setUSBVoltageCallbackThreshold(char option, int min, int max) throws TinkerforgeException
Sets the thresholds for theBrickMaster.USBVoltageReachedListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Listener is turned off" "'o'", "Listener is triggered when the voltage is *outside* the min and max values" "'i'", "Listener is triggered when the voltage is *inside* the min and max values" "'<'", "Listener is triggered when the voltage is smaller than the min value (max is ignored)" "'>'", "Listener is triggered when the voltage is greater than the min value (max is ignored)" \endverbatim .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getUSBVoltageCallbackThreshold
public BrickMaster.USBVoltageCallbackThreshold getUSBVoltageCallbackThreshold() throws TinkerforgeException
Returns the threshold as set bysetUSBVoltageCallbackThreshold(char, int, int)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the period with which the threshold listeners *BrickMaster.StackCurrentReachedListener
, *BrickMaster.StackVoltageReachedListener
, *BrickMaster.USBVoltageReachedListener
are triggered, if the thresholds *setStackCurrentCallbackThreshold(char, int, int)
, *setStackVoltageCallbackThreshold(char, int, int)
, *setUSBVoltageCallbackThreshold(char, int, int)
keep being reached. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getDebouncePeriod
public long getDebouncePeriod() throws TinkerforgeException
Returns the debounce period as set bysetDebouncePeriod(long)
. .. versionadded:: 2.0.5$nbsp;(Firmware)- Throws:
TinkerforgeException
-
isEthernetPresent
public boolean isEthernetPresent() throws TinkerforgeException
Returns *true* if the Master Brick is at position 0 in the stack and an Ethernet Extension is available. .. versionadded:: 2.1.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setEthernetConfiguration
public void setEthernetConfiguration(short connection, short[] ip, short[] subnetMask, short[] gateway, int port) throws TinkerforgeException
Sets the configuration of the Ethernet Extension. Possible values for ``connection`` are: \verbatim "Value", "Description" "0", "DHCP" "1", "Static IP" \endverbatim If you set ``connection`` to static IP options then you have to supply ``ip``, ``subnet_mask`` and ``gateway`` as an array of size 4 (first element of the array is the least significant byte of the address). If ``connection`` is set to the DHCP options then ``ip``, ``subnet_mask`` and ``gateway`` are ignored, you can set them to 0. The last parameter is the port that your program will connect to. The values are stored in the EEPROM and only applied on startup. That means you have to restart the Master Brick after configuration. It is recommended to use the Brick Viewer to set the Ethernet configuration. .. versionadded:: 2.1.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getEthernetConfiguration
public BrickMaster.EthernetConfiguration getEthernetConfiguration() throws TinkerforgeException
Returns the configuration as set bysetEthernetConfiguration(short, short[], short[], short[], int)
. .. versionadded:: 2.1.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getEthernetStatus
public BrickMaster.EthernetStatus getEthernetStatus() throws TinkerforgeException
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$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setEthernetHostname
public void setEthernetHostname(java.lang.String hostname) throws TinkerforgeException
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 withgetEthernetStatus()
. .. versionadded:: 2.1.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setEthernetMACAddress
public void setEthernetMACAddress(short[] macAddress) throws TinkerforgeException
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 withgetEthernetStatus()
. .. versionadded:: 2.1.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setEthernetWebsocketConfiguration
public void setEthernetWebsocketConfiguration(short sockets, int port) throws TinkerforgeException
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. .. versionadded:: 2.2.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getEthernetWebsocketConfiguration
public BrickMaster.EthernetWebsocketConfiguration getEthernetWebsocketConfiguration() throws TinkerforgeException
Returns the configuration as set bysetEthernetConfiguration(short, short[], short[], short[], int)
. .. versionadded:: 2.2.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setEthernetAuthenticationSecret
public void setEthernetAuthenticationSecret(java.lang.String secret) throws TinkerforgeException
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$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getEthernetAuthenticationSecret
public java.lang.String getEthernetAuthenticationSecret() throws TinkerforgeException
Returns the authentication secret as set bysetEthernetAuthenticationSecret(String)
. .. versionadded:: 2.2.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifiAuthenticationSecret
public void setWifiAuthenticationSecret(java.lang.String secret) throws TinkerforgeException
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$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifiAuthenticationSecret
public java.lang.String getWifiAuthenticationSecret() throws TinkerforgeException
Returns the authentication secret as set bysetWifiAuthenticationSecret(String)
. .. versionadded:: 2.2.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getConnectionType
public short getConnectionType() throws TinkerforgeException
Returns the type of the connection over which this function was called. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
isWifi2Present
public boolean isWifi2Present() throws TinkerforgeException
Returns *true* if the Master Brick is at position 0 in the stack and a WIFI Extension 2.0 is available. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
startWifi2Bootloader
public byte startWifi2Bootloader() throws TinkerforgeException
Starts the bootloader of the WIFI Extension 2.0. Returns 0 on success. Afterwards thewriteWifi2SerialPort(short[], short)
andreadWifi2SerialPort(short)
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 thegetConnectionType()
function. It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
writeWifi2SerialPort
public byte writeWifi2SerialPort(short[] data, short length) throws TinkerforgeException
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 thestartWifi2Bootloader()
function. It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
readWifi2SerialPort
public BrickMaster.ReadWifi2SerialPort readWifi2SerialPort(short length) throws TinkerforgeException
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 thestartWifi2Bootloader()
function. It is recommended to use the Brick Viewer to update the firmware of the WIFI Extension 2.0. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2AuthenticationSecret
public void setWifi2AuthenticationSecret(java.lang.String secret) throws TinkerforgeException
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 :ref:`authentication tutorial <tutorial_authentication>` for more information. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2AuthenticationSecret
public java.lang.String getWifi2AuthenticationSecret() throws TinkerforgeException
Returns the WIFI authentication secret as set bysetWifi2AuthenticationSecret(String)
. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2Configuration
public void setWifi2Configuration(int port, int websocketPort, int websitePort, short phyMode, short sleepMode, short website) throws TinkerforgeException
Sets the general configuration of the WIFI Extension 2.0. The ``port`` parameter sets the port number that your programm will connect to. The ``websocket_port`` parameter sets the WebSocket port number that your JavaScript programm will connect to. The ``website_port`` parameter sets the port number for the website of the WIFI Extension 2.0. The ``phy_mode`` parameter sets the specific wireless network mode to be used. Possible values are B, G and N. The ``sleep_mode`` parameter is currently unused. The ``website`` parameter is used to enable or disable the web interface of the WIFI Extension 2.0, which is available from firmware version 2.0.1. Note that, for firmware version 2.0.3 and older, to disable the the web interface the ``website_port`` parameter must be set to 1 and greater than 1 to enable the web interface. For firmware version 2.0.4 and later, setting this parameter to 1 will enable the web interface and setting it to 0 will disable the web interface. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2Configuration
public BrickMaster.Wifi2Configuration getWifi2Configuration() throws TinkerforgeException
Returns the general configuration as set bysetWifi2Configuration(int, int, int, short, short, short)
. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2Status
public BrickMaster.Wifi2Status getWifi2Status() throws TinkerforgeException
Returns the client and access point status of the WIFI Extension 2.0. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2ClientConfiguration
public void setWifi2ClientConfiguration(boolean enable, java.lang.String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress, short[] bssid) throws TinkerforgeException
Sets the client specific configuration of the WIFI Extension 2.0. The ``enable`` parameter enables or disables the client part of the WIFI Extension 2.0. The ``ssid`` parameter sets the SSID (up to 32 characters) of the access point to connect to. If the ``ip`` parameter is set to all zero then ``subnet_mask`` and ``gateway`` parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP. If the ``mac_address`` parameter is set to all zero then the factory MAC address is used. Otherwise this parameter can be used to set a custom MAC address. If the ``bssid`` parameter is set to all zero then WIFI Extension 2.0 will connect to any access point that matches the configured SSID. Otherwise this parameter can be used to make the WIFI Extension 2.0 only connect to an access point if SSID and BSSID match. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2ClientConfiguration
public BrickMaster.Wifi2ClientConfiguration getWifi2ClientConfiguration() throws TinkerforgeException
Returns the client configuration as set bysetWifi2ClientConfiguration(boolean, String, short[], short[], short[], short[], short[])
. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2ClientHostname
public void setWifi2ClientHostname(java.lang.String hostname) throws TinkerforgeException
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 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2ClientHostname
public java.lang.String getWifi2ClientHostname() throws TinkerforgeException
Returns the client hostname as set bysetWifi2ClientHostname(String)
. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2ClientPassword
public void setWifi2ClientPassword(java.lang.String password) throws TinkerforgeException
Sets the client password (up to 63 chars) for WPA/WPA2 encryption. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2ClientPassword
public java.lang.String getWifi2ClientPassword() throws TinkerforgeException
Returns the client password as set bysetWifi2ClientPassword(String)
. \note Since WIFI Extension 2.0 firmware version 2.1.3 the password is not returned anymore. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2APConfiguration
public void setWifi2APConfiguration(boolean enable, java.lang.String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel, short[] macAddress) throws TinkerforgeException
Sets the access point specific configuration of the WIFI Extension 2.0. The ``enable`` parameter enables or disables the access point part of the WIFI Extension 2.0. The ``ssid`` parameter sets the SSID (up to 32 characters) of the access point. If the ``ip`` parameter is set to all zero then ``subnet_mask`` and ``gateway`` parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP. The ``encryption`` parameter sets the encryption mode to be used. Possible values are Open (no encryption), WEP or WPA/WPA2 PSK. Use thesetWifi2APPassword(String)
function to set the encryption password. The ``hidden`` parameter makes the access point hide or show its SSID. The ``channel`` parameter sets the channel (1 to 13) of the access point. If the ``mac_address`` parameter is set to all zero then the factory MAC address is used. Otherwise this parameter can be used to set a custom MAC address. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2APConfiguration
public BrickMaster.Wifi2APConfiguration getWifi2APConfiguration() throws TinkerforgeException
Returns the access point configuration as set bysetWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2APPassword
public void setWifi2APPassword(java.lang.String password) throws TinkerforgeException
Sets the access point password (at least 8 and up to 63 chars) for the configured encryption mode, seesetWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
. To apply configuration changes to the WIFI Extension 2.0 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2APPassword
public java.lang.String getWifi2APPassword() throws TinkerforgeException
Returns the access point password as set bysetWifi2APPassword(String)
. \note Since WIFI Extension 2.0 firmware version 2.1.3 the password is not returned anymore. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
saveWifi2Configuration
public short saveWifi2Configuration() throws TinkerforgeException
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. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2FirmwareVersion
public short[] getWifi2FirmwareVersion() throws TinkerforgeException
Returns the current version of the WIFI Extension 2.0 firmware. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
enableWifi2StatusLED
public void enableWifi2StatusLED() throws TinkerforgeException
Turns the green status LED of the WIFI Extension 2.0 on. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
disableWifi2StatusLED
public void disableWifi2StatusLED() throws TinkerforgeException
Turns the green status LED of the WIFI Extension 2.0 off. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
isWifi2StatusLEDEnabled
public boolean isWifi2StatusLEDEnabled() throws TinkerforgeException
Returns *true* if the green status LED of the WIFI Extension 2.0 is turned on. .. versionadded:: 2.4.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2MeshConfiguration
public void setWifi2MeshConfiguration(boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, java.lang.String groupSSIDPrefix, short[] gatewayIP, int gatewayPort) throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Sets the mesh specific configuration of the WIFI Extension 2.0. The ``enable`` parameter enables or disables the mesh part of the WIFI Extension 2.0. The mesh part cannot be enabled together with the client and access-point part. If the ``root_ip`` parameter is set to all zero then ``root_subnet_mask`` and ``root_gateway`` parameters are also set to all zero and DHCP is used for IP address configuration. Otherwise those three parameters can be used to configure a static IP address. The default configuration is DHCP. If the ``router_bssid`` parameter is set to all zero then the information is taken from Wi-Fi scan when connecting the SSID as set bysetWifi2MeshRouterSSID(String)
. 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 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshConfiguration
public BrickMaster.Wifi2MeshConfiguration getWifi2MeshConfiguration() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the mesh configuration as set bysetWifi2MeshConfiguration(boolean, short[], short[], short[], short[], short[], String, short[], int)
. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2MeshRouterSSID
public void setWifi2MeshRouterSSID(java.lang.String ssid) throws TinkerforgeException
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 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshRouterSSID
public java.lang.String getWifi2MeshRouterSSID() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the mesh router SSID as set bysetWifi2MeshRouterSSID(String)
. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setWifi2MeshRouterPassword
public void setWifi2MeshRouterPassword(java.lang.String password) throws TinkerforgeException
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 thesaveWifi2Configuration()
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. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshRouterPassword
public java.lang.String getWifi2MeshRouterPassword() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the mesh router password as set bysetWifi2MeshRouterPassword(String)
. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshCommonStatus
public BrickMaster.Wifi2MeshCommonStatus getWifi2MeshCommonStatus() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the common mesh status of the WIFI Extension 2.0. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshClientStatus
public BrickMaster.Wifi2MeshClientStatus getWifi2MeshClientStatus() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the mesh client status of the WIFI Extension 2.0. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getWifi2MeshAPStatus
public BrickMaster.Wifi2MeshAPStatus getWifi2MeshAPStatus() throws TinkerforgeException
Requires WIFI Extension 2.0 firmware 2.1.0. Returns the mesh AP status of the WIFI Extension 2.0. .. versionadded:: 2.4.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setBrickletXMCFlashConfig
public BrickMaster.SetBrickletXMCFlashConfig setBrickletXMCFlashConfig(long config, long parameter1, long parameter2, short[] data) throws TinkerforgeException
This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets. If you need to flash a boostrapper/bootloader (for exmaple because you made your own Bricklet from scratch) please take a look at our open source flash and test tool at `https://github.com/Tinkerforge/flash-test <https://github.com/Tinkerforge/flash-test>`__ Don't use this function directly. .. versionadded:: 2.5.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setBrickletXMCFlashData
public long setBrickletXMCFlashData(short[] data) throws TinkerforgeException
This function is for internal use to flash the initial bootstrapper and bootloader to the Bricklets. If you need to flash a boostrapper/bootloader (for exmaple because you made your own Bricklet from scratch) please take a look at our open source flash and test tool at `https://github.com/Tinkerforge/flash-test <https://github.com/Tinkerforge/flash-test>`__ Don't use this function directly. .. versionadded:: 2.5.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setBrickletsEnabled
public void setBrickletsEnabled(boolean brickletsEnabled) throws TinkerforgeException
This function is only available in Master Brick hardware version >= 3.0. Enables/disables all four Bricklets if set to true/false. If you disable the Bricklets the power supply to the Bricklets will be disconnected. The Bricklets will lose all configurations if disabled. .. versionadded:: 2.5.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getBrickletsEnabled
public boolean getBrickletsEnabled() throws TinkerforgeException
Returns *true* if the Bricklets are enabled, *false* otherwise. .. versionadded:: 2.5.0$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setSPITFPBaudrateConfig
public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate) throws TinkerforgeException
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 sent/received and decreased linearly if little data is sent/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 functionsetSPITFPBaudrate(char, long)
. If the dynamic baudrate is disabled, the baudrate as set bysetSPITFPBaudrate(char, long)
will be used statically. .. versionadded:: 2.4.6$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getSPITFPBaudrateConfig
public BrickMaster.SPITFPBaudrateConfig getSPITFPBaudrateConfig() throws TinkerforgeException
Returns the baudrate config, seesetSPITFPBaudrateConfig(boolean, long)
. .. versionadded:: 2.4.6$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getSendTimeoutCount
public long getSendTimeoutCount(short communicationMethod) throws TinkerforgeException
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. .. versionadded:: 2.4.3$nbsp;(Firmware)- Throws:
TinkerforgeException
-
setSPITFPBaudrate
public void setSPITFPBaudrate(char brickletPort, long baudrate) throws TinkerforgeException
Sets the baudrate for a specific Bricklet port. If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (seegetSPITFPErrorCount(char)
) you can decrease the baudrate. If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (seesetSPITFPBaudrateConfig(boolean, long)
). Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate. .. versionadded:: 2.4.3$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getSPITFPBaudrate
public long getSPITFPBaudrate(char brickletPort) throws TinkerforgeException
Returns the baudrate for a given Bricklet port, seesetSPITFPBaudrate(char, long)
. .. versionadded:: 2.4.3$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickMaster.SPITFPErrorCount getSPITFPErrorCount(char brickletPort) throws TinkerforgeException
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. .. versionadded:: 2.4.3$nbsp;(Firmware)- Throws:
TinkerforgeException
-
enableStatusLED
public void enableStatusLED() throws TinkerforgeException
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)- Throws:
TinkerforgeException
-
disableStatusLED
public void disableStatusLED() throws TinkerforgeException
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$nbsp;(Firmware)- Throws:
TinkerforgeException
-
isStatusLEDEnabled
public boolean isStatusLEDEnabled() throws TinkerforgeException
Returns *true* if the status LED is enabled, *false* otherwise. .. versionadded:: 2.3.2$nbsp;(Firmware)- Throws:
TinkerforgeException
-
getProtocol1BrickletName
public BrickMaster.Protocol1BrickletName getProtocol1BrickletName(char port) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getChipTemperature
public short getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has an accuracy of ±15%. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeBrickletPlugin
public void writeBrickletPlugin(char port, short offset, short[] chunk) throws TinkerforgeException
Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
readBrickletPlugin
public short[] readBrickletPlugin(char port, short offset) throws TinkerforgeException
Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier. The position is the position in the stack from '0' (bottom) to '8' (top). The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addStackCurrentListener
public void addStackCurrentListener(BrickMaster.StackCurrentListener listener)
Adds a StackCurrent listener.
-
removeStackCurrentListener
public void removeStackCurrentListener(BrickMaster.StackCurrentListener listener)
Removes a StackCurrent listener.
-
addStackVoltageListener
public void addStackVoltageListener(BrickMaster.StackVoltageListener listener)
Adds a StackVoltage listener.
-
removeStackVoltageListener
public void removeStackVoltageListener(BrickMaster.StackVoltageListener listener)
Removes a StackVoltage listener.
-
addUSBVoltageListener
public void addUSBVoltageListener(BrickMaster.USBVoltageListener listener)
Adds a USBVoltage listener.
-
removeUSBVoltageListener
public void removeUSBVoltageListener(BrickMaster.USBVoltageListener listener)
Removes a USBVoltage listener.
-
addStackCurrentReachedListener
public void addStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
Adds a StackCurrentReached listener.
-
removeStackCurrentReachedListener
public void removeStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
Removes a StackCurrentReached listener.
-
addStackVoltageReachedListener
public void addStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
Adds a StackVoltageReached listener.
-
removeStackVoltageReachedListener
public void removeStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
Removes a StackVoltageReached listener.
-
addUSBVoltageReachedListener
public void addUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
Adds a USBVoltageReached listener.
-
removeUSBVoltageReachedListener
public void removeUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
Removes a USBVoltageReached listener.
-
-