public class BrickMaster extends Device
Device.Identity
Constructor and Description |
---|
BrickMaster(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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 by
setChibiAddress(short) . |
short |
getChibiChannel()
Returns the channel as set by
setChibiChannel(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 by
setChibiFrequency(short) . |
short |
getChibiMasterAddress()
Returns the address as set by
setChibiMasterAddress(short) . |
short |
getChibiSignalStrength()
Returns the signal strength in dBm.
|
short |
getChibiSlaveAddress(short num)
Returns the slave address for a given \c num as set by
setChibiSlaveAddress(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 by
setDebouncePeriod(long) . |
String |
getEthernetAuthenticationSecret()
Returns the authentication secret as set by
setEthernetAuthenticationSecret(String) . |
BrickMaster.EthernetConfiguration |
getEthernetConfiguration()
Returns the configuration as set by
setEthernetConfiguration(short, short[], short[], short[], int) . |
BrickMaster.EthernetStatus |
getEthernetStatus()
Returns the status of the Ethernet Extension.
|
BrickMaster.EthernetWebsocketConfiguration |
getEthernetWebsocketConfiguration()
Returns the configuration as set by
setEthernetConfiguration(short, short[], short[], short[], int) . |
long |
getExtensionType(short extension)
Returns the type for a given extension as set by
setExtensionType(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.
|
String |
getLongWifiKey()
Returns the encryption key as set by
setLongWifiKey(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 by
setRS485Address(short) . |
BrickMaster.RS485Configuration |
getRS485Configuration()
Returns the configuration as set by
setRS485Configuration(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 by
setRS485SlaveAddress(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, see
setSPITFPBaudrate(char, long) . |
BrickMaster.SPITFPBaudrateConfig |
getSPITFPBaudrateConfig()
Returns the baudrate config, see
setSPITFPBaudrateConfig(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 by
setStackCurrentCallbackPeriod(long) . |
BrickMaster.StackCurrentCallbackThreshold |
getStackCurrentCallbackThreshold()
Returns the threshold as set by
setStackCurrentCallbackThreshold(char, int, int) . |
int |
getStackVoltage()
Returns the stack voltage.
|
long |
getStackVoltageCallbackPeriod()
Returns the period as set by
setStackVoltageCallbackPeriod(long) . |
BrickMaster.StackVoltageCallbackThreshold |
getStackVoltageCallbackThreshold()
Returns the threshold as set by
setStackVoltageCallbackThreshold(char, int, int) . |
int |
getUSBVoltage()
Returns the USB voltage.
|
long |
getUSBVoltageCallbackPeriod()
Returns the period as set by
setUSBVoltageCallbackPeriod(long) . |
BrickMaster.USBVoltageCallbackThreshold |
getUSBVoltageCallbackThreshold()
Returns the threshold as set by
setUSBVoltageCallbackThreshold(char, int, int) . |
BrickMaster.Wifi2APConfiguration |
getWifi2APConfiguration()
Returns the access point configuration as set by
setWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[]) . |
String |
getWifi2APPassword()
Returns the access point password as set by
setWifi2APPassword(String) . |
String |
getWifi2AuthenticationSecret()
Returns the WIFI authentication secret as set by
setWifi2AuthenticationSecret(String) . |
BrickMaster.Wifi2ClientConfiguration |
getWifi2ClientConfiguration()
Returns the client configuration as set by
setWifi2ClientConfiguration(boolean, String, short[], short[], short[], short[], short[]) . |
String |
getWifi2ClientHostname()
Returns the client hostname as set by
setWifi2ClientHostname(String) . |
String |
getWifi2ClientPassword()
Returns the client password as set by
setWifi2ClientPassword(String) . |
BrickMaster.Wifi2Configuration |
getWifi2Configuration()
Returns the general configuration as set by
setWifi2Configuration(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.
|
String |
getWifi2MeshRouterPassword()
Requires WIFI Extension 2.0 firmware 2.1.0.
|
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.
|
String |
getWifiAuthenticationSecret()
Returns the authentication secret as set by
setWifiAuthenticationSecret(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 by
setWifiCertificate(int, short[], short) . |
BrickMaster.WifiConfiguration |
getWifiConfiguration()
Returns the configuration as set by
setWifiConfiguration(String, short, short[], short[], short[], int) . |
BrickMaster.WifiEncryption |
getWifiEncryption()
Returns the encryption as set by
setWifiEncryption(short, String, short, short, int, int, int) . |
String |
getWifiHostname()
Returns the hostname as set by
setWifiHostname(String) . |
short |
getWifiPowerMode()
Returns the power mode as set by
setWifiPowerMode(short) . |
short |
getWifiRegulatoryDomain()
Returns the regulatory domain as set by
setWifiRegulatoryDomain(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 (see
getWifiStatus() ). |
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(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(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(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 the
BrickMaster.StackCurrentListener listener is triggered
periodically. |
void |
setStackCurrentCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickMaster.StackCurrentReachedListener listener. |
void |
setStackVoltageCallbackPeriod(long period)
Sets the period with which the
BrickMaster.StackVoltageListener listener is triggered
periodically. |
void |
setStackVoltageCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickMaster.StackVoltageReachedListener listener. |
void |
setUSBVoltageCallbackPeriod(long period)
Sets the period with which the
BrickMaster.USBVoltageListener listener is triggered
periodically. |
void |
setUSBVoltageCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickMaster.USBVoltageReachedListener listener. |
void |
setWifi2APConfiguration(boolean enable,
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(String password)
Sets the access point password (at least 8 and up to 63 chars) for the configured encryption
mode, see
setWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[]) . |
void |
setWifi2AuthenticationSecret(String secret)
Sets the WIFI authentication secret.
|
void |
setWifi2ClientConfiguration(boolean enable,
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(String hostname)
Sets the client hostname (up to 32 characters) of the WIFI Extension 2.0.
|
void |
setWifi2ClientPassword(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,
String groupSSIDPrefix,
short[] gatewayIP,
int gatewayPort)
Requires WIFI Extension 2.0 firmware 2.1.0.
|
void |
setWifi2MeshRouterPassword(String password)
Requires WIFI Extension 2.0 firmware 2.1.0.
|
void |
setWifi2MeshRouterSSID(String ssid)
Requires WIFI Extension 2.0 firmware 2.1.0.
|
void |
setWifiAuthenticationSecret(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(String ssid,
short connection,
short[] ip,
short[] subnetMask,
short[] gateway,
int port)
Sets the configuration of the WIFI Extension.
|
void |
setWifiEncryption(short encryption,
String key,
short keyIndex,
short eapOptions,
int caCertificateLength,
int clientCertificateLength,
int privateKeyLength)
Sets the encryption of the WIFI Extension.
|
void |
setWifiHostname(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.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_STACK_VOLTAGE
public static final byte FUNCTION_GET_STACK_CURRENT
public static final byte FUNCTION_SET_EXTENSION_TYPE
public static final byte FUNCTION_GET_EXTENSION_TYPE
public static final byte FUNCTION_IS_CHIBI_PRESENT
public static final byte FUNCTION_SET_CHIBI_ADDRESS
public static final byte FUNCTION_GET_CHIBI_ADDRESS
public static final byte FUNCTION_SET_CHIBI_MASTER_ADDRESS
public static final byte FUNCTION_GET_CHIBI_MASTER_ADDRESS
public static final byte FUNCTION_SET_CHIBI_SLAVE_ADDRESS
public static final byte FUNCTION_GET_CHIBI_SLAVE_ADDRESS
public static final byte FUNCTION_GET_CHIBI_SIGNAL_STRENGTH
public static final byte FUNCTION_GET_CHIBI_ERROR_LOG
public static final byte FUNCTION_SET_CHIBI_FREQUENCY
public static final byte FUNCTION_GET_CHIBI_FREQUENCY
public static final byte FUNCTION_SET_CHIBI_CHANNEL
public static final byte FUNCTION_GET_CHIBI_CHANNEL
public static final byte FUNCTION_IS_RS485_PRESENT
public static final byte FUNCTION_SET_RS485_ADDRESS
public static final byte FUNCTION_GET_RS485_ADDRESS
public static final byte FUNCTION_SET_RS485_SLAVE_ADDRESS
public static final byte FUNCTION_GET_RS485_SLAVE_ADDRESS
public static final byte FUNCTION_GET_RS485_ERROR_LOG
public static final byte FUNCTION_SET_RS485_CONFIGURATION
public static final byte FUNCTION_GET_RS485_CONFIGURATION
public static final byte FUNCTION_IS_WIFI_PRESENT
public static final byte FUNCTION_SET_WIFI_CONFIGURATION
public static final byte FUNCTION_GET_WIFI_CONFIGURATION
public static final byte FUNCTION_SET_WIFI_ENCRYPTION
public static final byte FUNCTION_GET_WIFI_ENCRYPTION
public static final byte FUNCTION_GET_WIFI_STATUS
public static final byte FUNCTION_REFRESH_WIFI_STATUS
public static final byte FUNCTION_SET_WIFI_CERTIFICATE
public static final byte FUNCTION_GET_WIFI_CERTIFICATE
public static final byte FUNCTION_SET_WIFI_POWER_MODE
public static final byte FUNCTION_GET_WIFI_POWER_MODE
public static final byte FUNCTION_GET_WIFI_BUFFER_INFO
public static final byte FUNCTION_SET_WIFI_REGULATORY_DOMAIN
public static final byte FUNCTION_GET_WIFI_REGULATORY_DOMAIN
public static final byte FUNCTION_GET_USB_VOLTAGE
public static final byte FUNCTION_SET_LONG_WIFI_KEY
public static final byte FUNCTION_GET_LONG_WIFI_KEY
public static final byte FUNCTION_SET_WIFI_HOSTNAME
public static final byte FUNCTION_GET_WIFI_HOSTNAME
public static final byte FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STACK_CURRENT_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_STACK_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_USB_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_STACK_CURRENT_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_STACK_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_USB_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_IS_ETHERNET_PRESENT
public static final byte FUNCTION_SET_ETHERNET_CONFIGURATION
public static final byte FUNCTION_GET_ETHERNET_CONFIGURATION
public static final byte FUNCTION_GET_ETHERNET_STATUS
public static final byte FUNCTION_SET_ETHERNET_HOSTNAME
public static final byte FUNCTION_SET_ETHERNET_MAC_ADDRESS
public static final byte FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION
public static final byte FUNCTION_GET_ETHERNET_WEBSOCKET_CONFIGURATION
public static final byte FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_ETHERNET_AUTHENTICATION_SECRET
public static final byte FUNCTION_SET_WIFI_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_WIFI_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_CONNECTION_TYPE
public static final byte FUNCTION_IS_WIFI2_PRESENT
public static final byte FUNCTION_START_WIFI2_BOOTLOADER
public static final byte FUNCTION_WRITE_WIFI2_SERIAL_PORT
public static final byte FUNCTION_READ_WIFI2_SERIAL_PORT
public static final byte FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET
public static final byte FUNCTION_GET_WIFI2_AUTHENTICATION_SECRET
public static final byte FUNCTION_SET_WIFI2_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_STATUS
public static final byte FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_CLIENT_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_CLIENT_HOSTNAME
public static final byte FUNCTION_GET_WIFI2_CLIENT_HOSTNAME
public static final byte FUNCTION_SET_WIFI2_CLIENT_PASSWORD
public static final byte FUNCTION_GET_WIFI2_CLIENT_PASSWORD
public static final byte FUNCTION_SET_WIFI2_AP_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_AP_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_AP_PASSWORD
public static final byte FUNCTION_GET_WIFI2_AP_PASSWORD
public static final byte FUNCTION_SAVE_WIFI2_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_FIRMWARE_VERSION
public static final byte FUNCTION_ENABLE_WIFI2_STATUS_LED
public static final byte FUNCTION_DISABLE_WIFI2_STATUS_LED
public static final byte FUNCTION_IS_WIFI2_STATUS_LED_ENABLED
public static final byte FUNCTION_SET_WIFI2_MESH_CONFIGURATION
public static final byte FUNCTION_GET_WIFI2_MESH_CONFIGURATION
public static final byte FUNCTION_SET_WIFI2_MESH_ROUTER_SSID
public static final byte FUNCTION_GET_WIFI2_MESH_ROUTER_SSID
public static final byte FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD
public static final byte FUNCTION_GET_WIFI2_MESH_ROUTER_PASSWORD
public static final byte FUNCTION_GET_WIFI2_MESH_COMMON_STATUS
public static final byte FUNCTION_GET_WIFI2_MESH_CLIENT_STATUS
public static final byte FUNCTION_GET_WIFI2_MESH_AP_STATUS
public static final byte FUNCTION_SET_BRICKLET_XMC_FLASH_CONFIG
public static final byte FUNCTION_SET_BRICKLET_XMC_FLASH_DATA
public static final byte FUNCTION_SET_BRICKLETS_ENABLED
public static final byte FUNCTION_GET_BRICKLETS_ENABLED
public static final byte FUNCTION_SET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_GET_SPITFP_BAUDRATE_CONFIG
public static final byte FUNCTION_GET_SEND_TIMEOUT_COUNT
public static final byte FUNCTION_SET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_SPITFP_BAUDRATE
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_ENABLE_STATUS_LED
public static final byte FUNCTION_DISABLE_STATUS_LED
public static final byte FUNCTION_IS_STATUS_LED_ENABLED
public static final byte FUNCTION_GET_PROTOCOL1_BRICKLET_NAME
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_BRICKLET_PLUGIN
public static final byte FUNCTION_READ_BRICKLET_PLUGIN
public static final byte FUNCTION_GET_IDENTITY
public static final long EXTENSION_TYPE_CHIBI
public static final long EXTENSION_TYPE_RS485
public static final long EXTENSION_TYPE_WIFI
public static final long EXTENSION_TYPE_ETHERNET
public static final long EXTENSION_TYPE_WIFI2
public static final short CHIBI_FREQUENCY_OQPSK_868_MHZ
public static final short CHIBI_FREQUENCY_OQPSK_915_MHZ
public static final short CHIBI_FREQUENCY_OQPSK_780_MHZ
public static final short CHIBI_FREQUENCY_BPSK40_915_MHZ
public static final char RS485_PARITY_NONE
public static final char RS485_PARITY_EVEN
public static final char RS485_PARITY_ODD
public static final short WIFI_CONNECTION_DHCP
public static final short WIFI_CONNECTION_STATIC_IP
public static final short WIFI_CONNECTION_ACCESS_POINT_DHCP
public static final short WIFI_CONNECTION_ACCESS_POINT_STATIC_IP
public static final short WIFI_CONNECTION_AD_HOC_DHCP
public static final short WIFI_CONNECTION_AD_HOC_STATIC_IP
public static final short WIFI_ENCRYPTION_WPA_WPA2
public static final short WIFI_ENCRYPTION_WPA_ENTERPRISE
public static final short WIFI_ENCRYPTION_WEP
public static final short WIFI_ENCRYPTION_NO_ENCRYPTION
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS
public static final short WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP
public static final short WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP
public static final short WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC
public static final short WIFI_EAP_OPTION_CERT_TYPE_CA_CERT
public static final short WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT
public static final short WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY
public static final short WIFI_STATE_DISASSOCIATED
public static final short WIFI_STATE_ASSOCIATED
public static final short WIFI_STATE_ASSOCIATING
public static final short WIFI_STATE_ERROR
public static final short WIFI_STATE_NOT_INITIALIZED_YET
public static final short WIFI_POWER_MODE_FULL_SPEED
public static final short WIFI_POWER_MODE_LOW_POWER
public static final short WIFI_DOMAIN_CHANNEL_1TO11
public static final short WIFI_DOMAIN_CHANNEL_1TO13
public static final short WIFI_DOMAIN_CHANNEL_1TO14
public static final char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final short ETHERNET_CONNECTION_DHCP
public static final short ETHERNET_CONNECTION_STATIC_IP
public static final short CONNECTION_TYPE_NONE
public static final short CONNECTION_TYPE_USB
public static final short CONNECTION_TYPE_SPI_STACK
public static final short CONNECTION_TYPE_CHIBI
public static final short CONNECTION_TYPE_RS485
public static final short CONNECTION_TYPE_WIFI
public static final short CONNECTION_TYPE_ETHERNET
public static final short CONNECTION_TYPE_WIFI2
public static final short WIFI2_PHY_MODE_B
public static final short WIFI2_PHY_MODE_G
public static final short WIFI2_PHY_MODE_N
public static final short WIFI2_CLIENT_STATUS_IDLE
public static final short WIFI2_CLIENT_STATUS_CONNECTING
public static final short WIFI2_CLIENT_STATUS_WRONG_PASSWORD
public static final short WIFI2_CLIENT_STATUS_NO_AP_FOUND
public static final short WIFI2_CLIENT_STATUS_CONNECT_FAILED
public static final short WIFI2_CLIENT_STATUS_GOT_IP
public static final short WIFI2_CLIENT_STATUS_UNKNOWN
public static final short WIFI2_AP_ENCRYPTION_OPEN
public static final short WIFI2_AP_ENCRYPTION_WEP
public static final short WIFI2_AP_ENCRYPTION_WPA_PSK
public static final short WIFI2_AP_ENCRYPTION_WPA2_PSK
public static final short WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK
public static final short WIFI2_MESH_STATUS_DISABLED
public static final short WIFI2_MESH_STATUS_WIFI_CONNECTING
public static final short WIFI2_MESH_STATUS_GOT_IP
public static final short WIFI2_MESH_STATUS_MESH_LOCAL
public static final short WIFI2_MESH_STATUS_MESH_ONLINE
public static final short WIFI2_MESH_STATUS_AP_AVAILABLE
public static final short WIFI2_MESH_STATUS_AP_SETUP
public static final short WIFI2_MESH_STATUS_LEAF_AVAILABLE
public static final short COMMUNICATION_METHOD_NONE
public static final short COMMUNICATION_METHOD_USB
public static final short COMMUNICATION_METHOD_SPI_STACK
public static final short COMMUNICATION_METHOD_CHIBI
public static final short COMMUNICATION_METHOD_RS485
public static final short COMMUNICATION_METHOD_WIFI
public static final short COMMUNICATION_METHOD_ETHERNET
public static final short COMMUNICATION_METHOD_WIFI_V2
public BrickMaster(String uid, IPConnection ipcon)
public int getStackVoltage() throws TinkerforgeException
TinkerforgeException
public int getStackCurrent() throws TinkerforgeException
TinkerforgeException
public void setExtensionType(short extension, long exttype) throws TinkerforgeException
TinkerforgeException
public long getExtensionType(short extension) throws TinkerforgeException
setExtensionType(short, long)
.TinkerforgeException
public boolean isChibiPresent() throws TinkerforgeException
TinkerforgeException
public void setChibiAddress(short address) throws TinkerforgeException
TinkerforgeException
public short getChibiAddress() throws TinkerforgeException
setChibiAddress(short)
.TinkerforgeException
public void setChibiMasterAddress(short address) throws TinkerforgeException
TinkerforgeException
public short getChibiMasterAddress() throws TinkerforgeException
setChibiMasterAddress(short)
.TinkerforgeException
public void setChibiSlaveAddress(short num, short address) throws TinkerforgeException
TinkerforgeException
public short getChibiSlaveAddress(short num) throws TinkerforgeException
setChibiSlaveAddress(short, short)
.TinkerforgeException
public short getChibiSignalStrength() throws TinkerforgeException
TinkerforgeException
public BrickMaster.ChibiErrorLog getChibiErrorLog() throws TinkerforgeException
TinkerforgeException
public void setChibiFrequency(short frequency) throws TinkerforgeException
TinkerforgeException
public short getChibiFrequency() throws TinkerforgeException
setChibiFrequency(short)
.TinkerforgeException
public void setChibiChannel(short channel) throws TinkerforgeException
TinkerforgeException
public short getChibiChannel() throws TinkerforgeException
setChibiChannel(short)
.TinkerforgeException
public boolean isRS485Present() throws TinkerforgeException
TinkerforgeException
public void setRS485Address(short address) throws TinkerforgeException
TinkerforgeException
public short getRS485Address() throws TinkerforgeException
setRS485Address(short)
.TinkerforgeException
public void setRS485SlaveAddress(short num, short address) throws TinkerforgeException
TinkerforgeException
public short getRS485SlaveAddress(short num) throws TinkerforgeException
setRS485SlaveAddress(short, short)
.TinkerforgeException
public int getRS485ErrorLog() throws TinkerforgeException
TinkerforgeException
public void setRS485Configuration(long speed, char parity, short stopbits) throws TinkerforgeException
TinkerforgeException
public BrickMaster.RS485Configuration getRS485Configuration() throws TinkerforgeException
setRS485Configuration(long, char, short)
.TinkerforgeException
public boolean isWifiPresent() throws TinkerforgeException
TinkerforgeException
public void setWifiConfiguration(String ssid, short connection, short[] ip, short[] subnetMask, short[] gateway, int port) throws TinkerforgeException
TinkerforgeException
public BrickMaster.WifiConfiguration getWifiConfiguration() throws TinkerforgeException
setWifiConfiguration(String, short, short[], short[], short[], int)
.TinkerforgeException
public void setWifiEncryption(short encryption, String key, short keyIndex, short eapOptions, int caCertificateLength, int clientCertificateLength, int privateKeyLength) throws TinkerforgeException
setLongWifiKey(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 with setWifiCertificate(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.TinkerforgeException
public BrickMaster.WifiEncryption getWifiEncryption() throws TinkerforgeException
setWifiEncryption(short, String, short, short, int, int, int)
.
\note
Since Master Brick Firmware version 2.4.4 the key is not returned anymore.TinkerforgeException
public BrickMaster.WifiStatus getWifiStatus() throws TinkerforgeException
refreshWifiStatus()
is called.
Possible states are:
\verbatim
"State", "Description"
"0", "Disassociated"
"1", "Associated"
"2", "Associating"
"3", "Error"
"255", "Not initialized yet"
\endverbatimTinkerforgeException
public void refreshWifiStatus() throws TinkerforgeException
getWifiStatus()
). To read the status
of the Wi-Fi module, the Master Brick has to change from data mode to
command mode and back. This transaction and the readout itself is
unfortunately time consuming. This means, that it might take some ms
until the stack with attached WIFI Extension reacts again after this
function is called.TinkerforgeException
public void setWifiCertificate(int index, short[] data, short dataLength) throws TinkerforgeException
TinkerforgeException
public BrickMaster.WifiCertificate getWifiCertificate(int index) throws TinkerforgeException
setWifiCertificate(int, short[], short)
.TinkerforgeException
public void setWifiPowerMode(short mode) throws TinkerforgeException
TinkerforgeException
public short getWifiPowerMode() throws TinkerforgeException
setWifiPowerMode(short)
.TinkerforgeException
public BrickMaster.WifiBufferInfo getWifiBufferInfo() throws TinkerforgeException
TinkerforgeException
public void setWifiRegulatoryDomain(short domain) throws TinkerforgeException
TinkerforgeException
public short getWifiRegulatoryDomain() throws TinkerforgeException
setWifiRegulatoryDomain(short)
.TinkerforgeException
public int getUSBVoltage() throws TinkerforgeException
TinkerforgeException
public void setLongWifiKey(String key) throws TinkerforgeException
setWifiEncryption(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)TinkerforgeException
public String getLongWifiKey() throws TinkerforgeException
setLongWifiKey(String)
.
\note
Since Master Brick firmware version 2.4.4 the key is not returned anymore.
.. versionadded:: 2.0.2$nbsp;(Firmware)TinkerforgeException
public void setWifiHostname(String hostname) throws TinkerforgeException
TinkerforgeException
public String getWifiHostname() throws TinkerforgeException
setWifiHostname(String)
.
An empty String means, that the default hostname is used.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setStackCurrentCallbackPeriod(long period) throws TinkerforgeException
BrickMaster.StackCurrentListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickMaster.StackCurrentListener
listener is only triggered if the current has changed
since the last triggering.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public long getStackCurrentCallbackPeriod() throws TinkerforgeException
setStackCurrentCallbackPeriod(long)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setStackVoltageCallbackPeriod(long period) throws TinkerforgeException
BrickMaster.StackVoltageListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickMaster.StackVoltageListener
listener is only triggered if the voltage has changed
since the last triggering.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public long getStackVoltageCallbackPeriod() throws TinkerforgeException
setStackVoltageCallbackPeriod(long)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setUSBVoltageCallbackPeriod(long period) throws TinkerforgeException
BrickMaster.USBVoltageListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickMaster.USBVoltageListener
listener is only triggered if the voltage has changed
since the last triggering.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public long getUSBVoltageCallbackPeriod() throws TinkerforgeException
setUSBVoltageCallbackPeriod(long)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setStackCurrentCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickMaster.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)TinkerforgeException
public BrickMaster.StackCurrentCallbackThreshold getStackCurrentCallbackThreshold() throws TinkerforgeException
setStackCurrentCallbackThreshold(char, int, int)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setStackVoltageCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickMaster.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)TinkerforgeException
public BrickMaster.StackVoltageCallbackThreshold getStackVoltageCallbackThreshold() throws TinkerforgeException
setStackVoltageCallbackThreshold(char, int, int)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setUSBVoltageCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickMaster.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)TinkerforgeException
public BrickMaster.USBVoltageCallbackThreshold getUSBVoltageCallbackThreshold() throws TinkerforgeException
setUSBVoltageCallbackThreshold(char, int, int)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
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)TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.
.. versionadded:: 2.0.5$nbsp;(Firmware)TinkerforgeException
public boolean isEthernetPresent() throws TinkerforgeException
TinkerforgeException
public void setEthernetConfiguration(short connection, short[] ip, short[] subnetMask, short[] gateway, int port) throws TinkerforgeException
TinkerforgeException
public BrickMaster.EthernetConfiguration getEthernetConfiguration() throws TinkerforgeException
setEthernetConfiguration(short, short[], short[], short[], int)
.
.. versionadded:: 2.1.0$nbsp;(Firmware)TinkerforgeException
public BrickMaster.EthernetStatus getEthernetStatus() throws TinkerforgeException
TinkerforgeException
public void setEthernetHostname(String hostname) throws TinkerforgeException
getEthernetStatus()
.
.. versionadded:: 2.1.0$nbsp;(Firmware)TinkerforgeException
public void setEthernetMACAddress(short[] macAddress) throws TinkerforgeException
getEthernetStatus()
.
.. versionadded:: 2.1.0$nbsp;(Firmware)TinkerforgeException
public void setEthernetWebsocketConfiguration(short sockets, int port) throws TinkerforgeException
TinkerforgeException
public BrickMaster.EthernetWebsocketConfiguration getEthernetWebsocketConfiguration() throws TinkerforgeException
setEthernetConfiguration(short, short[], short[], short[], int)
.
.. versionadded:: 2.2.0$nbsp;(Firmware)TinkerforgeException
public void setEthernetAuthenticationSecret(String secret) throws TinkerforgeException
TinkerforgeException
public String getEthernetAuthenticationSecret() throws TinkerforgeException
setEthernetAuthenticationSecret(String)
.
.. versionadded:: 2.2.0$nbsp;(Firmware)TinkerforgeException
public void setWifiAuthenticationSecret(String secret) throws TinkerforgeException
TinkerforgeException
public String getWifiAuthenticationSecret() throws TinkerforgeException
setWifiAuthenticationSecret(String)
.
.. versionadded:: 2.2.0$nbsp;(Firmware)TinkerforgeException
public short getConnectionType() throws TinkerforgeException
TinkerforgeException
public boolean isWifi2Present() throws TinkerforgeException
TinkerforgeException
public byte startWifi2Bootloader() throws TinkerforgeException
writeWifi2SerialPort(short[], short)
and readWifi2SerialPort(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 the getConnectionType()
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)TinkerforgeException
public byte writeWifi2SerialPort(short[] data, short length) throws TinkerforgeException
startWifi2Bootloader()
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)TinkerforgeException
public BrickMaster.ReadWifi2SerialPort readWifi2SerialPort(short length) throws TinkerforgeException
startWifi2Bootloader()
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)TinkerforgeException
public void setWifi2AuthenticationSecret(String secret) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public String getWifi2AuthenticationSecret() throws TinkerforgeException
setWifi2AuthenticationSecret(String)
.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public void setWifi2Configuration(int port, int websocketPort, int websitePort, short phyMode, short sleepMode, short website) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2Configuration getWifi2Configuration() throws TinkerforgeException
setWifi2Configuration(int, int, int, short, short, short)
.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2Status getWifi2Status() throws TinkerforgeException
TinkerforgeException
public void setWifi2ClientConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short[] macAddress, short[] bssid) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2ClientConfiguration getWifi2ClientConfiguration() throws TinkerforgeException
setWifi2ClientConfiguration(boolean, String, short[], short[], short[], short[], short[])
.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public void setWifi2ClientHostname(String hostname) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public String getWifi2ClientHostname() throws TinkerforgeException
setWifi2ClientHostname(String)
.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public void setWifi2ClientPassword(String password) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public String getWifi2ClientPassword() throws TinkerforgeException
setWifi2ClientPassword(String)
.
\note
Since WIFI Extension 2.0 firmware version 2.1.3 the password is not
returned anymore.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public void setWifi2APConfiguration(boolean enable, String ssid, short[] ip, short[] subnetMask, short[] gateway, short encryption, boolean hidden, short channel, short[] macAddress) throws TinkerforgeException
setWifi2APPassword(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 the
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2APConfiguration getWifi2APConfiguration() throws TinkerforgeException
setWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public void setWifi2APPassword(String password) throws TinkerforgeException
setWifi2APConfiguration(boolean, String, short[], short[], short[], short, boolean, short, short[])
.
To apply configuration changes to the WIFI Extension 2.0 the
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public String getWifi2APPassword() throws TinkerforgeException
setWifi2APPassword(String)
.
\note
Since WIFI Extension 2.0 firmware version 2.1.3 the password is not
returned anymore.
.. versionadded:: 2.4.0$nbsp;(Firmware)TinkerforgeException
public short saveWifi2Configuration() throws TinkerforgeException
TinkerforgeException
public short[] getWifi2FirmwareVersion() throws TinkerforgeException
TinkerforgeException
public void enableWifi2StatusLED() throws TinkerforgeException
TinkerforgeException
public void disableWifi2StatusLED() throws TinkerforgeException
TinkerforgeException
public boolean isWifi2StatusLEDEnabled() throws TinkerforgeException
TinkerforgeException
public void setWifi2MeshConfiguration(boolean enable, short[] rootIP, short[] rootSubnetMask, short[] rootGateway, short[] routerBSSID, short[] groupID, String groupSSIDPrefix, short[] gatewayIP, int gatewayPort) throws TinkerforgeException
setWifi2MeshRouterSSID(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 the
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2MeshConfiguration getWifi2MeshConfiguration() throws TinkerforgeException
setWifi2MeshConfiguration(boolean, short[], short[], short[], short[], short[], String, short[], int)
.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public void setWifi2MeshRouterSSID(String ssid) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public String getWifi2MeshRouterSSID() throws TinkerforgeException
setWifi2MeshRouterSSID(String)
.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public void setWifi2MeshRouterPassword(String password) throws TinkerforgeException
saveWifi2Configuration()
function has to be called and the Master Brick
has to be restarted afterwards.
It is recommended to use the Brick Viewer to configure the WIFI Extension 2.0.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public String getWifi2MeshRouterPassword() throws TinkerforgeException
setWifi2MeshRouterPassword(String)
.
.. versionadded:: 2.4.2$nbsp;(Firmware)TinkerforgeException
public BrickMaster.Wifi2MeshCommonStatus getWifi2MeshCommonStatus() throws TinkerforgeException
TinkerforgeException
public BrickMaster.Wifi2MeshClientStatus getWifi2MeshClientStatus() throws TinkerforgeException
TinkerforgeException
public BrickMaster.Wifi2MeshAPStatus getWifi2MeshAPStatus() throws TinkerforgeException
TinkerforgeException
public BrickMaster.SetBrickletXMCFlashConfig setBrickletXMCFlashConfig(long config, long parameter1, long parameter2, short[] data) throws TinkerforgeException
TinkerforgeException
public long setBrickletXMCFlashData(short[] data) throws TinkerforgeException
TinkerforgeException
public void setBrickletsEnabled(boolean brickletsEnabled) throws TinkerforgeException
TinkerforgeException
public boolean getBrickletsEnabled() throws TinkerforgeException
TinkerforgeException
public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate) throws TinkerforgeException
setSPITFPBaudrate(char, long)
. If the dynamic baudrate is disabled, the baudrate
as set by setSPITFPBaudrate(char, long)
will be used statically.
.. versionadded:: 2.4.6$nbsp;(Firmware)TinkerforgeException
public BrickMaster.SPITFPBaudrateConfig getSPITFPBaudrateConfig() throws TinkerforgeException
setSPITFPBaudrateConfig(boolean, long)
.
.. versionadded:: 2.4.6$nbsp;(Firmware)TinkerforgeException
public long getSendTimeoutCount(short communicationMethod) throws TinkerforgeException
TinkerforgeException
public void setSPITFPBaudrate(char brickletPort, long baudrate) throws TinkerforgeException
getSPITFPErrorCount(char)
) you can decrease the
baudrate.
If the dynamic baudrate feature is enabled, the baudrate set by this
function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig(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)TinkerforgeException
public long getSPITFPBaudrate(char brickletPort) throws TinkerforgeException
setSPITFPBaudrate(char, long)
.
.. versionadded:: 2.4.3$nbsp;(Firmware)TinkerforgeException
public BrickMaster.SPITFPErrorCount getSPITFPErrorCount(char brickletPort) throws TinkerforgeException
TinkerforgeException
public void enableStatusLED() throws TinkerforgeException
TinkerforgeException
public void disableStatusLED() throws TinkerforgeException
TinkerforgeException
public boolean isStatusLEDEnabled() throws TinkerforgeException
TinkerforgeException
public BrickMaster.Protocol1BrickletName getProtocol1BrickletName(char port) throws TinkerforgeException
TinkerforgeException
public short getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeBrickletPlugin(char port, short offset, short[] chunk) throws TinkerforgeException
TinkerforgeException
public short[] readBrickletPlugin(char port, short offset) throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addStackCurrentListener(BrickMaster.StackCurrentListener listener)
public void removeStackCurrentListener(BrickMaster.StackCurrentListener listener)
public void addStackVoltageListener(BrickMaster.StackVoltageListener listener)
public void removeStackVoltageListener(BrickMaster.StackVoltageListener listener)
public void addUSBVoltageListener(BrickMaster.USBVoltageListener listener)
public void removeUSBVoltageListener(BrickMaster.USBVoltageListener listener)
public void addStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
public void removeStackCurrentReachedListener(BrickMaster.StackCurrentReachedListener listener)
public void addStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
public void removeStackVoltageReachedListener(BrickMaster.StackVoltageReachedListener listener)
public void addUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
public void removeUSBVoltageReachedListener(BrickMaster.USBVoltageReachedListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.