master_brick

package
Version: v0.0.0-...-57cfa29 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2022 License: CC0-1.0 Imports: 5 Imported by: 1

Documentation

Overview

Basis to build stacks and has 4 Bricklet ports.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricks/Master_Brick_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Master Brick"
View Source
const DeviceIdentifier = 13

Variables

This section is empty.

Functions

This section is empty.

Types

type ChibiFrequency

type ChibiFrequency = uint8
const (
	ChibiFrequencyOQPSK868MHz ChibiFrequency = 0
	ChibiFrequencyOQPSK915MHz ChibiFrequency = 1
	ChibiFrequencyOQPSK780MHz ChibiFrequency = 2
	//Deprecated: Use BPSK40_915MHz instead.
	ChibiFrequencyBPSK40915MHz  ChibiFrequency = 3
	ChibiFrequencyBPSK40_915MHz ChibiFrequency = 3
)

type CommunicationMethod

type CommunicationMethod = uint8
const (
	CommunicationMethodNone     CommunicationMethod = 0
	CommunicationMethodUSB      CommunicationMethod = 1
	CommunicationMethodSPIStack CommunicationMethod = 2
	CommunicationMethodChibi    CommunicationMethod = 3
	CommunicationMethodRS485    CommunicationMethod = 4
	CommunicationMethodWIFI     CommunicationMethod = 5
	CommunicationMethodEthernet CommunicationMethod = 6
	CommunicationMethodWIFIV2   CommunicationMethod = 7
)

type ConnectionType

type ConnectionType = uint8
const (
	ConnectionTypeNone     ConnectionType = 0
	ConnectionTypeUSB      ConnectionType = 1
	ConnectionTypeSPIStack ConnectionType = 2
	ConnectionTypeChibi    ConnectionType = 3
	ConnectionTypeRS485    ConnectionType = 4
	ConnectionTypeWifi     ConnectionType = 5
	ConnectionTypeEthernet ConnectionType = 6
	ConnectionTypeWifi2    ConnectionType = 7
)

type EthernetConnection

type EthernetConnection = uint8
const (
	EthernetConnectionDHCP     EthernetConnection = 0
	EthernetConnectionStaticIP EthernetConnection = 1
)

type ExtensionType

type ExtensionType = uint32
const (
	ExtensionTypeChibi    ExtensionType = 1
	ExtensionTypeRS485    ExtensionType = 2
	ExtensionTypeWifi     ExtensionType = 3
	ExtensionTypeEthernet ExtensionType = 4
	ExtensionTypeWifi2    ExtensionType = 5
)

type Function

type Function = uint8
const (
	FunctionGetStackVoltage                   Function = 1
	FunctionGetStackCurrent                   Function = 2
	FunctionSetExtensionType                  Function = 3
	FunctionGetExtensionType                  Function = 4
	FunctionIsChibiPresent                    Function = 5
	FunctionSetChibiAddress                   Function = 6
	FunctionGetChibiAddress                   Function = 7
	FunctionSetChibiMasterAddress             Function = 8
	FunctionGetChibiMasterAddress             Function = 9
	FunctionSetChibiSlaveAddress              Function = 10
	FunctionGetChibiSlaveAddress              Function = 11
	FunctionGetChibiSignalStrength            Function = 12
	FunctionGetChibiErrorLog                  Function = 13
	FunctionSetChibiFrequency                 Function = 14
	FunctionGetChibiFrequency                 Function = 15
	FunctionSetChibiChannel                   Function = 16
	FunctionGetChibiChannel                   Function = 17
	FunctionIsRS485Present                    Function = 18
	FunctionSetRS485Address                   Function = 19
	FunctionGetRS485Address                   Function = 20
	FunctionSetRS485SlaveAddress              Function = 21
	FunctionGetRS485SlaveAddress              Function = 22
	FunctionGetRS485ErrorLog                  Function = 23
	FunctionSetRS485Configuration             Function = 24
	FunctionGetRS485Configuration             Function = 25
	FunctionIsWifiPresent                     Function = 26
	FunctionSetWifiConfiguration              Function = 27
	FunctionGetWifiConfiguration              Function = 28
	FunctionSetWifiEncryption                 Function = 29
	FunctionGetWifiEncryption                 Function = 30
	FunctionGetWifiStatus                     Function = 31
	FunctionRefreshWifiStatus                 Function = 32
	FunctionSetWifiCertificate                Function = 33
	FunctionGetWifiCertificate                Function = 34
	FunctionSetWifiPowerMode                  Function = 35
	FunctionGetWifiPowerMode                  Function = 36
	FunctionGetWifiBufferInfo                 Function = 37
	FunctionSetWifiRegulatoryDomain           Function = 38
	FunctionGetWifiRegulatoryDomain           Function = 39
	FunctionGetUSBVoltage                     Function = 40
	FunctionSetLongWifiKey                    Function = 41
	FunctionGetLongWifiKey                    Function = 42
	FunctionSetWifiHostname                   Function = 43
	FunctionGetWifiHostname                   Function = 44
	FunctionSetStackCurrentCallbackPeriod     Function = 45
	FunctionGetStackCurrentCallbackPeriod     Function = 46
	FunctionSetStackVoltageCallbackPeriod     Function = 47
	FunctionGetStackVoltageCallbackPeriod     Function = 48
	FunctionSetUSBVoltageCallbackPeriod       Function = 49
	FunctionGetUSBVoltageCallbackPeriod       Function = 50
	FunctionSetStackCurrentCallbackThreshold  Function = 51
	FunctionGetStackCurrentCallbackThreshold  Function = 52
	FunctionSetStackVoltageCallbackThreshold  Function = 53
	FunctionGetStackVoltageCallbackThreshold  Function = 54
	FunctionSetUSBVoltageCallbackThreshold    Function = 55
	FunctionGetUSBVoltageCallbackThreshold    Function = 56
	FunctionSetDebouncePeriod                 Function = 57
	FunctionGetDebouncePeriod                 Function = 58
	FunctionIsEthernetPresent                 Function = 65
	FunctionSetEthernetConfiguration          Function = 66
	FunctionGetEthernetConfiguration          Function = 67
	FunctionGetEthernetStatus                 Function = 68
	FunctionSetEthernetHostname               Function = 69
	FunctionSetEthernetMACAddress             Function = 70
	FunctionSetEthernetWebsocketConfiguration Function = 71
	FunctionGetEthernetWebsocketConfiguration Function = 72
	FunctionSetEthernetAuthenticationSecret   Function = 73
	FunctionGetEthernetAuthenticationSecret   Function = 74
	FunctionSetWifiAuthenticationSecret       Function = 75
	FunctionGetWifiAuthenticationSecret       Function = 76
	FunctionGetConnectionType                 Function = 77
	FunctionIsWifi2Present                    Function = 78
	FunctionStartWifi2Bootloader              Function = 79
	FunctionWriteWifi2SerialPort              Function = 80
	FunctionReadWifi2SerialPort               Function = 81
	FunctionSetWifi2AuthenticationSecret      Function = 82
	FunctionGetWifi2AuthenticationSecret      Function = 83
	FunctionSetWifi2Configuration             Function = 84
	FunctionGetWifi2Configuration             Function = 85
	FunctionGetWifi2Status                    Function = 86
	FunctionSetWifi2ClientConfiguration       Function = 87
	FunctionGetWifi2ClientConfiguration       Function = 88
	FunctionSetWifi2ClientHostname            Function = 89
	FunctionGetWifi2ClientHostname            Function = 90
	FunctionSetWifi2ClientPassword            Function = 91
	FunctionGetWifi2ClientPassword            Function = 92
	FunctionSetWifi2APConfiguration           Function = 93
	FunctionGetWifi2APConfiguration           Function = 94
	FunctionSetWifi2APPassword                Function = 95
	FunctionGetWifi2APPassword                Function = 96
	FunctionSaveWifi2Configuration            Function = 97
	FunctionGetWifi2FirmwareVersion           Function = 98
	FunctionEnableWifi2StatusLED              Function = 99
	FunctionDisableWifi2StatusLED             Function = 100
	FunctionIsWifi2StatusLEDEnabled           Function = 101
	FunctionSetWifi2MeshConfiguration         Function = 102
	FunctionGetWifi2MeshConfiguration         Function = 103
	FunctionSetWifi2MeshRouterSSID            Function = 104
	FunctionGetWifi2MeshRouterSSID            Function = 105
	FunctionSetWifi2MeshRouterPassword        Function = 106
	FunctionGetWifi2MeshRouterPassword        Function = 107
	FunctionGetWifi2MeshCommonStatus          Function = 108
	FunctionGetWifi2MeshClientStatus          Function = 109
	FunctionGetWifi2MeshAPStatus              Function = 110
	FunctionSetBrickletXMCFlashConfig         Function = 111
	FunctionSetBrickletXMCFlashData           Function = 112
	FunctionSetBrickletsEnabled               Function = 113
	FunctionGetBrickletsEnabled               Function = 114
	FunctionSetSPITFPBaudrateConfig           Function = 231
	FunctionGetSPITFPBaudrateConfig           Function = 232
	FunctionGetSendTimeoutCount               Function = 233
	FunctionSetSPITFPBaudrate                 Function = 234
	FunctionGetSPITFPBaudrate                 Function = 235
	FunctionGetSPITFPErrorCount               Function = 237
	FunctionEnableStatusLED                   Function = 238
	FunctionDisableStatusLED                  Function = 239
	FunctionIsStatusLEDEnabled                Function = 240
	FunctionGetProtocol1BrickletName          Function = 241
	FunctionGetChipTemperature                Function = 242
	FunctionReset                             Function = 243
	FunctionWriteBrickletPlugin               Function = 246
	FunctionReadBrickletPlugin                Function = 247
	FunctionGetIdentity                       Function = 255
	FunctionCallbackStackCurrent              Function = 59
	FunctionCallbackStackVoltage              Function = 60
	FunctionCallbackUSBVoltage                Function = 61
	FunctionCallbackStackCurrentReached       Function = 62
	FunctionCallbackStackVoltageReached       Function = 63
	FunctionCallbackUSBVoltageReached         Function = 64
)

type MasterBrick

type MasterBrick struct {
	// contains filtered or unexported fields
}

func New

func New(uid string, ipcon *ipconnection.IPConnection) (MasterBrick, error)

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*MasterBrick) DeregisterStackCurrentCallback

func (device *MasterBrick) DeregisterStackCurrentCallback(registrationId uint64)

Remove a registered Stack Current callback.

func (*MasterBrick) DeregisterStackCurrentReachedCallback

func (device *MasterBrick) DeregisterStackCurrentReachedCallback(registrationId uint64)

Remove a registered Stack Current Reached callback.

func (*MasterBrick) DeregisterStackVoltageCallback

func (device *MasterBrick) DeregisterStackVoltageCallback(registrationId uint64)

Remove a registered Stack Voltage callback.

func (*MasterBrick) DeregisterStackVoltageReachedCallback

func (device *MasterBrick) DeregisterStackVoltageReachedCallback(registrationId uint64)

Remove a registered Stack Voltage Reached callback.

func (*MasterBrick) DeregisterUSBVoltageCallback

func (device *MasterBrick) DeregisterUSBVoltageCallback(registrationId uint64)

Remove a registered USB Voltage callback.

func (*MasterBrick) DeregisterUSBVoltageReachedCallback

func (device *MasterBrick) DeregisterUSBVoltageReachedCallback(registrationId uint64)

Remove a registered USB Voltage Reached callback.

func (*MasterBrick) DisableStatusLED

func (device *MasterBrick) DisableStatusLED() (err error)

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)

func (*MasterBrick) DisableWifi2StatusLED

func (device *MasterBrick) DisableWifi2StatusLED() (err error)

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) EnableStatusLED

func (device *MasterBrick) EnableStatusLED() (err error)

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)

func (*MasterBrick) EnableWifi2StatusLED

func (device *MasterBrick) EnableWifi2StatusLED() (err error)

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetAPIVersion

func (device *MasterBrick) GetAPIVersion() [3]uint8

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

func (*MasterBrick) GetBrickletsEnabled

func (device *MasterBrick) GetBrickletsEnabled() (brickletsEnabled bool, err error)

Returns *true* if the Bricklets are enabled, *false* otherwise.

.. versionadded:: 2.5.0$nbsp;(Firmware)

func (*MasterBrick) GetChibiAddress

func (device *MasterBrick) GetChibiAddress() (address uint8, err error)

Returns the address as set by SetChibiAddress.

func (*MasterBrick) GetChibiChannel

func (device *MasterBrick) GetChibiChannel() (channel uint8, err error)

Returns the channel as set by SetChibiChannel.

func (*MasterBrick) GetChibiErrorLog

func (device *MasterBrick) GetChibiErrorLog() (underrun uint16, crcError uint16, noAck uint16, overflow uint16, err error)

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.

func (*MasterBrick) GetChibiFrequency

func (device *MasterBrick) GetChibiFrequency() (frequency ChibiFrequency, err error)

Returns the frequency value as set by SetChibiFrequency.

Associated constants:

  • ChibiFrequencyOQPSK868MHz
  • ChibiFrequencyOQPSK915MHz
  • ChibiFrequencyOQPSK780MHz
  • ChibiFrequencyBPSK40915MHz

func (*MasterBrick) GetChibiMasterAddress

func (device *MasterBrick) GetChibiMasterAddress() (address uint8, err error)

Returns the address as set by SetChibiMasterAddress.

func (*MasterBrick) GetChibiSignalStrength

func (device *MasterBrick) GetChibiSignalStrength() (signalStrength uint8, err error)

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

func (*MasterBrick) GetChibiSlaveAddress

func (device *MasterBrick) GetChibiSlaveAddress(num uint8) (address uint8, err error)

Returns the slave address for a given \c num as set by SetChibiSlaveAddress.

func (*MasterBrick) GetChipTemperature

func (device *MasterBrick) GetChipTemperature() (temperature int16, err error)

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.

func (*MasterBrick) GetConnectionType

func (device *MasterBrick) GetConnectionType() (connectionType ConnectionType, err error)

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

Associated constants:

  • ConnectionTypeNone
  • ConnectionTypeUSB
  • ConnectionTypeSPIStack
  • ConnectionTypeChibi
  • ConnectionTypeRS485
  • ConnectionTypeWifi
  • ConnectionTypeEthernet
  • ConnectionTypeWifi2

func (*MasterBrick) GetDebouncePeriod

func (device *MasterBrick) GetDebouncePeriod() (debounce uint32, err error)

Returns the debounce period as set by SetDebouncePeriod.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) GetEthernetAuthenticationSecret

func (device *MasterBrick) GetEthernetAuthenticationSecret() (secret string, err error)

Returns the authentication secret as set by SetEthernetAuthenticationSecret.

.. versionadded:: 2.2.0$nbsp;(Firmware)

func (*MasterBrick) GetEthernetConfiguration

func (device *MasterBrick) GetEthernetConfiguration() (connection EthernetConnection, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, port uint16, err error)

Returns the configuration as set by SetEthernetConfiguration.

.. versionadded:: 2.1.0$nbsp;(Firmware)

Associated constants:

  • EthernetConnectionDHCP
  • EthernetConnectionStaticIP

func (*MasterBrick) GetEthernetStatus

func (device *MasterBrick) GetEthernetStatus() (macAddress [6]uint8, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, rxCount uint32, txCount uint32, hostname string, err error)

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)

func (*MasterBrick) GetEthernetWebsocketConfiguration

func (device *MasterBrick) GetEthernetWebsocketConfiguration() (sockets uint8, port uint16, err error)

Returns the configuration as set by SetEthernetConfiguration.

.. versionadded:: 2.2.0$nbsp;(Firmware)

func (*MasterBrick) GetExtensionType

func (device *MasterBrick) GetExtensionType(extension uint8) (exttype ExtensionType, err error)

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

Associated constants:

  • ExtensionTypeChibi
  • ExtensionTypeRS485
  • ExtensionTypeWifi
  • ExtensionTypeEthernet
  • ExtensionTypeWifi2

func (*MasterBrick) GetIdentity

func (device *MasterBrick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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 `here <device_identifier>`. |device_identifier_constant|

func (*MasterBrick) GetLongWifiKey

func (device *MasterBrick) GetLongWifiKey() (key string, err error)

Returns the encryption key as set by SetLongWifiKey.

Note

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

.. versionadded:: 2.0.2$nbsp;(Firmware)

func (*MasterBrick) GetProtocol1BrickletName

func (device *MasterBrick) GetProtocol1BrickletName(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)

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.

func (*MasterBrick) GetRS485Address

func (device *MasterBrick) GetRS485Address() (address uint8, err error)

Returns the address as set by SetRS485Address.

func (*MasterBrick) GetRS485Configuration

func (device *MasterBrick) GetRS485Configuration() (speed uint32, parity RS485Parity, stopbits uint8, err error)

Returns the configuration as set by SetRS485Configuration.

Associated constants:

  • RS485ParityNone
  • RS485ParityEven
  • RS485ParityOdd

func (*MasterBrick) GetRS485ErrorLog

func (device *MasterBrick) GetRS485ErrorLog() (crcError uint16, err error)

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.

func (*MasterBrick) GetRS485SlaveAddress

func (device *MasterBrick) GetRS485SlaveAddress(num uint8) (address uint8, err error)

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

func (*MasterBrick) GetResponseExpected

func (device *MasterBrick) GetResponseExpected(functionID Function) (bool, error)

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

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

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

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

func (*MasterBrick) GetSPITFPBaudrate

func (device *MasterBrick) GetSPITFPBaudrate(brickletPort rune) (baudrate uint32, err error)

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

.. versionadded:: 2.4.3$nbsp;(Firmware)

func (*MasterBrick) GetSPITFPBaudrateConfig

func (device *MasterBrick) GetSPITFPBaudrateConfig() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)

Returns the baudrate config, see SetSPITFPBaudrateConfig.

.. versionadded:: 2.4.6$nbsp;(Firmware)

func (*MasterBrick) GetSPITFPErrorCount

func (device *MasterBrick) GetSPITFPErrorCount(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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)

func (*MasterBrick) GetSendTimeoutCount

func (device *MasterBrick) GetSendTimeoutCount(communicationMethod CommunicationMethod) (timeoutCount uint32, err error)

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)

Associated constants:

  • CommunicationMethodNone
  • CommunicationMethodUSB
  • CommunicationMethodSPIStack
  • CommunicationMethodChibi
  • CommunicationMethodRS485
  • CommunicationMethodWIFI
  • CommunicationMethodEthernet
  • CommunicationMethodWIFIV2

func (*MasterBrick) GetStackCurrent

func (device *MasterBrick) GetStackCurrent() (current uint16, err error)

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.

func (*MasterBrick) GetStackCurrentCallbackPeriod

func (device *MasterBrick) GetStackCurrentCallbackPeriod() (period uint32, err error)

Returns the period as set by SetStackCurrentCallbackPeriod.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) GetStackCurrentCallbackThreshold

func (device *MasterBrick) GetStackCurrentCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetStackCurrentCallbackThreshold.

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) GetStackVoltage

func (device *MasterBrick) GetStackVoltage() (voltage uint16, err error)

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.

func (*MasterBrick) GetStackVoltageCallbackPeriod

func (device *MasterBrick) GetStackVoltageCallbackPeriod() (period uint32, err error)

Returns the period as set by SetStackVoltageCallbackPeriod.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) GetStackVoltageCallbackThreshold

func (device *MasterBrick) GetStackVoltageCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetStackVoltageCallbackThreshold.

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) GetUSBVoltage

func (device *MasterBrick) GetUSBVoltage() (voltage uint16, err error)

Returns the USB voltage. Does not work with hardware version 2.1 or newer.

func (*MasterBrick) GetUSBVoltageCallbackPeriod

func (device *MasterBrick) GetUSBVoltageCallbackPeriod() (period uint32, err error)

Returns the period as set by SetUSBVoltageCallbackPeriod.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) GetUSBVoltageCallbackThreshold

func (device *MasterBrick) GetUSBVoltageCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetUSBVoltageCallbackThreshold.

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) GetWifi2APConfiguration

func (device *MasterBrick) GetWifi2APConfiguration() (enable bool, ssid string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, encryption Wifi2APEncryption, hidden bool, channel uint8, macAddress [6]uint8, err error)

Returns the access point configuration as set by SetWifi2APConfiguration.

.. versionadded:: 2.4.0$nbsp;(Firmware)

Associated constants:

  • Wifi2APEncryptionOpen
  • Wifi2APEncryptionWEP
  • Wifi2APEncryptionWPAPSK
  • Wifi2APEncryptionWPA2PSK
  • Wifi2APEncryptionWPAWPA2PSK

func (*MasterBrick) GetWifi2APPassword

func (device *MasterBrick) GetWifi2APPassword() (password string, err error)

Returns the access point password as set by SetWifi2APPassword.

Note

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2AuthenticationSecret

func (device *MasterBrick) GetWifi2AuthenticationSecret() (secret string, err error)

Returns the WIFI authentication secret as set by SetWifi2AuthenticationSecret.

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2ClientConfiguration

func (device *MasterBrick) GetWifi2ClientConfiguration() (enable bool, ssid string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, macAddress [6]uint8, bssid [6]uint8, err error)

Returns the client configuration as set by SetWifi2ClientConfiguration.

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2ClientHostname

func (device *MasterBrick) GetWifi2ClientHostname() (hostname string, err error)

Returns the client hostname as set by SetWifi2ClientHostname.

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2ClientPassword

func (device *MasterBrick) GetWifi2ClientPassword() (password string, err error)

Returns the client password as set by SetWifi2ClientPassword.

Note

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2Configuration

func (device *MasterBrick) GetWifi2Configuration() (port uint16, websocketPort uint16, websitePort uint16, phyMode Wifi2PHYMode, sleepMode uint8, website uint8, err error)

Returns the general configuration as set by SetWifi2Configuration.

.. versionadded:: 2.4.0$nbsp;(Firmware)

Associated constants:

  • Wifi2PHYModeB
  • Wifi2PHYModeG
  • Wifi2PHYModeN

func (*MasterBrick) GetWifi2FirmwareVersion

func (device *MasterBrick) GetWifi2FirmwareVersion() (firmwareVersion [3]uint8, err error)

Returns the current version of the WIFI Extension 2.0 firmware.

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) GetWifi2MeshAPStatus

func (device *MasterBrick) GetWifi2MeshAPStatus() (ssid string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, macAddress [6]uint8, err error)

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)

func (*MasterBrick) GetWifi2MeshClientStatus

func (device *MasterBrick) GetWifi2MeshClientStatus() (hostname string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, macAddress [6]uint8, err error)

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)

func (*MasterBrick) GetWifi2MeshCommonStatus

func (device *MasterBrick) GetWifi2MeshCommonStatus() (status Wifi2MeshStatus, rootNode bool, rootCandidate bool, connectedNodes uint16, rxCount uint32, txCount uint32, err error)

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)

Associated constants:

  • Wifi2MeshStatusDisabled
  • Wifi2MeshStatusWIFIConnecting
  • Wifi2MeshStatusGotIP
  • Wifi2MeshStatusMeshLocal
  • Wifi2MeshStatusMeshOnline
  • Wifi2MeshStatusAPAvailable
  • Wifi2MeshStatusAPSetup
  • Wifi2MeshStatusLeafAvailable

func (*MasterBrick) GetWifi2MeshConfiguration

func (device *MasterBrick) GetWifi2MeshConfiguration() (enable bool, rootIP [4]uint8, rootSubnetMask [4]uint8, rootGateway [4]uint8, routerBSSID [6]uint8, groupID [6]uint8, groupSSIDPrefix string, gatewayIP [4]uint8, gatewayPort uint16, err error)

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh configuration as set by SetWifi2MeshConfiguration.

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) GetWifi2MeshRouterPassword

func (device *MasterBrick) GetWifi2MeshRouterPassword() (password string, err error)

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router password as set by SetWifi2MeshRouterPassword.

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) GetWifi2MeshRouterSSID

func (device *MasterBrick) GetWifi2MeshRouterSSID() (ssid string, err error)

Requires WIFI Extension 2.0 firmware 2.1.0.

Returns the mesh router SSID as set by SetWifi2MeshRouterSSID.

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) GetWifi2Status

func (device *MasterBrick) GetWifi2Status() (clientEnabled bool, clientStatus Wifi2ClientStatus, clientIP [4]uint8, clientSubnetMask [4]uint8, clientGateway [4]uint8, clientMACAddress [6]uint8, clientRXCount uint32, clientTXCount uint32, clientRSSI int8, apEnabled bool, apIP [4]uint8, apSubnetMask [4]uint8, apGateway [4]uint8, apMACAddress [6]uint8, apRXCount uint32, apTXCount uint32, apConnectedCount uint8, err error)

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

Associated constants:

  • Wifi2ClientStatusIdle
  • Wifi2ClientStatusConnecting
  • Wifi2ClientStatusWrongPassword
  • Wifi2ClientStatusNoAPFound
  • Wifi2ClientStatusConnectFailed
  • Wifi2ClientStatusGotIP
  • Wifi2ClientStatusUnknown

func (*MasterBrick) GetWifiAuthenticationSecret

func (device *MasterBrick) GetWifiAuthenticationSecret() (secret string, err error)

Returns the authentication secret as set by SetWifiAuthenticationSecret.

.. versionadded:: 2.2.0$nbsp;(Firmware)

func (*MasterBrick) GetWifiBufferInfo

func (device *MasterBrick) GetWifiBufferInfo() (overflow uint32, lowWatermark uint16, used uint16, err error)

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.

func (*MasterBrick) GetWifiCertificate

func (device *MasterBrick) GetWifiCertificate(index uint16) (data [32]uint8, dataLength uint8, err error)

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

func (*MasterBrick) GetWifiConfiguration

func (device *MasterBrick) GetWifiConfiguration() (ssid string, connection WifiConnection, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, port uint16, err error)

Returns the configuration as set by SetWifiConfiguration.

Associated constants:

  • WifiConnectionDHCP
  • WifiConnectionStaticIP
  • WifiConnectionAccessPointDHCP
  • WifiConnectionAccessPointStaticIP
  • WifiConnectionAdHocDHCP
  • WifiConnectionAdHocStaticIP

func (*MasterBrick) GetWifiEncryption

func (device *MasterBrick) GetWifiEncryption() (encryption WifiEncryption, key string, keyIndex uint8, eapOptions WifiEAPOption, caCertificateLength uint16, clientCertificateLength uint16, privateKeyLength uint16, err error)

Returns the encryption as set by SetWifiEncryption.

Note

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

Associated constants:

  • WifiEncryptionWPAWPA2
  • WifiEncryptionWPAEnterprise
  • WifiEncryptionWEP
  • WifiEncryptionNoEncryption
  • WifiEAPOptionOuterAuthEAPFAST
  • WifiEAPOptionOuterAuthEAPTLS
  • WifiEAPOptionOuterAuthEAPTTLS
  • WifiEAPOptionOuterAuthEAPPEAP
  • WifiEAPOptionInnerAuthEAPMSCHAP
  • WifiEAPOptionInnerAuthEAPGTC
  • WifiEAPOptionCertTypeCACert
  • WifiEAPOptionCertTypeClientCert
  • WifiEAPOptionCertTypePrivateKey

func (*MasterBrick) GetWifiHostname

func (device *MasterBrick) GetWifiHostname() (hostname string, err error)

Returns the hostname as set by SetWifiHostname.

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) GetWifiPowerMode

func (device *MasterBrick) GetWifiPowerMode() (mode WifiPowerMode, err error)

Returns the power mode as set by SetWifiPowerMode.

Associated constants:

  • WifiPowerModeFullSpeed
  • WifiPowerModeLowPower

func (*MasterBrick) GetWifiRegulatoryDomain

func (device *MasterBrick) GetWifiRegulatoryDomain() (domain WifiDomain, err error)

Returns the regulatory domain as set by SetWifiRegulatoryDomain.

Associated constants:

  • WifiDomainChannel1To11
  • WifiDomainChannel1To13
  • WifiDomainChannel1To14

func (*MasterBrick) GetWifiStatus

func (device *MasterBrick) GetWifiStatus() (macAddress [6]uint8, bssid [6]uint8, channel uint8, rssi int16, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, rxCount uint32, txCount uint32, state WifiState, err error)

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

Possible states are:

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

Associated constants:

  • WifiStateDisassociated
  • WifiStateAssociated
  • WifiStateAssociating
  • WifiStateError
  • WifiStateNotInitializedYet

func (*MasterBrick) IsChibiPresent

func (device *MasterBrick) IsChibiPresent() (present bool, err error)

Returns *true* if the Master Brick is at position 0 in the stack and a Chibi Extension is available.

func (*MasterBrick) IsEthernetPresent

func (device *MasterBrick) IsEthernetPresent() (present bool, err error)

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)

func (*MasterBrick) IsRS485Present

func (device *MasterBrick) IsRS485Present() (present bool, err error)

Returns *true* if the Master Brick is at position 0 in the stack and a RS485 Extension is available.

func (*MasterBrick) IsStatusLEDEnabled

func (device *MasterBrick) IsStatusLEDEnabled() (enabled bool, err error)

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

.. versionadded:: 2.3.2$nbsp;(Firmware)

func (*MasterBrick) IsWifi2Present

func (device *MasterBrick) IsWifi2Present() (present bool, err error)

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)

func (*MasterBrick) IsWifi2StatusLEDEnabled

func (device *MasterBrick) IsWifi2StatusLEDEnabled() (enabled bool, err error)

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) IsWifiPresent

func (device *MasterBrick) IsWifiPresent() (present bool, err error)

Returns *true* if the Master Brick is at position 0 in the stack and a WIFI Extension is available.

func (*MasterBrick) ReadBrickletPlugin

func (device *MasterBrick) ReadBrickletPlugin(port rune, offset uint8) (chunk [32]uint8, err error)

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.

func (*MasterBrick) ReadWifi2SerialPort

func (device *MasterBrick) ReadWifi2SerialPort(length uint8) (data [60]uint8, result uint8, err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) RefreshWifiStatus

func (device *MasterBrick) RefreshWifiStatus() (err error)

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

func (*MasterBrick) RegisterStackCurrentCallback

func (device *MasterBrick) RegisterStackCurrentCallback(fn func(uint16)) uint64

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) RegisterStackCurrentReachedCallback

func (device *MasterBrick) RegisterStackCurrentReachedCallback(fn func(uint16)) uint64

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) RegisterStackVoltageCallback

func (device *MasterBrick) RegisterStackVoltageCallback(fn func(uint16)) uint64

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) RegisterStackVoltageReachedCallback

func (device *MasterBrick) RegisterStackVoltageReachedCallback(fn func(uint16)) uint64

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) RegisterUSBVoltageCallback

func (device *MasterBrick) RegisterUSBVoltageCallback(fn func(uint16)) uint64

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

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

Does not work with hardware version 2.1 or newer.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) RegisterUSBVoltageReachedCallback

func (device *MasterBrick) RegisterUSBVoltageReachedCallback(fn func(uint16)) uint64

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) Reset

func (device *MasterBrick) Reset() (err error)

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!

func (*MasterBrick) SaveWifi2Configuration

func (device *MasterBrick) SaveWifi2Configuration() (result uint8, err error)

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)

func (*MasterBrick) SetBrickletXMCFlashConfig

func (device *MasterBrick) SetBrickletXMCFlashConfig(config uint32, parameter1 uint32, parameter2 uint32, data [52]uint8) (returnValue uint32, returnData [60]uint8, err error)

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

Don't use this function directly.

.. versionadded:: 2.5.0$nbsp;(Firmware)

func (*MasterBrick) SetBrickletXMCFlashData

func (device *MasterBrick) SetBrickletXMCFlashData(data [64]uint8) (returnData uint32, err error)

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

Don't use this function directly.

.. versionadded:: 2.5.0$nbsp;(Firmware)

func (*MasterBrick) SetBrickletsEnabled

func (device *MasterBrick) SetBrickletsEnabled(brickletsEnabled bool) (err error)

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)

func (*MasterBrick) SetChibiAddress

func (device *MasterBrick) SetChibiAddress(address uint8) (err error)

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.

func (*MasterBrick) SetChibiChannel

func (device *MasterBrick) SetChibiChannel(channel uint8) (err error)

Sets the channel used by the Chibi Extension. Possible channels are different for different frequencies:

Frequency| Possible Channels
--- | ---
OQPSK 868MHz (Europe)| 0
OQPSK 915MHz (US)|     1| 2| 3| 4| 5| 6| 7| 8| 9| 10
OQPSK 780MHz (China)|  0| 1| 2| 3
BPSK40 915MHz|         1| 2| 3| 4| 5| 6| 7| 8| 9| 10

It is possible to set the channel with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

func (*MasterBrick) SetChibiFrequency

func (device *MasterBrick) SetChibiFrequency(frequency ChibiFrequency) (err error)

Sets the Chibi frequency range for the Chibi Extension. Possible values are:

Type| Description
--- | ---
0|    OQPSK 868MHz (Europe)
1|    OQPSK 915MHz (US)
2|    OQPSK 780MHz (China)
3|    BPSK40 915MHz

It is possible to set the frequency with the Brick Viewer and it will be saved in the EEPROM of the Chibi Extension, it does not have to be set on every startup.

Associated constants:

  • ChibiFrequencyOQPSK868MHz
  • ChibiFrequencyOQPSK915MHz
  • ChibiFrequencyOQPSK780MHz
  • ChibiFrequencyBPSK40915MHz

func (*MasterBrick) SetChibiMasterAddress

func (device *MasterBrick) SetChibiMasterAddress(address uint8) (err error)

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.

func (*MasterBrick) SetChibiSlaveAddress

func (device *MasterBrick) SetChibiSlaveAddress(num uint8, address uint8) (err error)

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.

func (*MasterBrick) SetDebouncePeriod

func (device *MasterBrick) SetDebouncePeriod(debounce uint32) (err error)

Sets the period with which the threshold callbacks

* RegisterStackCurrentReachedCallback, * RegisterStackVoltageReachedCallback, * RegisterUSBVoltageReachedCallback

are triggered, if the thresholds

* SetStackCurrentCallbackThreshold, * SetStackVoltageCallbackThreshold, * SetUSBVoltageCallbackThreshold

keep being reached.

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) SetEthernetAuthenticationSecret

func (device *MasterBrick) SetEthernetAuthenticationSecret(secret string) (err error)

Sets the Ethernet authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication.

See the `authentication tutorial <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)

func (*MasterBrick) SetEthernetConfiguration

func (device *MasterBrick) SetEthernetConfiguration(connection EthernetConnection, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, port uint16) (err error)

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

Value| Description
--- | ---
0| DHCP
1| Static IP

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

The last parameter is the port that your program will connect to.

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

Associated constants:

  • EthernetConnectionDHCP
  • EthernetConnectionStaticIP

func (*MasterBrick) SetEthernetHostname

func (device *MasterBrick) SetEthernetHostname(hostname string) (err error)

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

Setting an empty String will restore the default hostname.

The current hostname can be discovered with GetEthernetStatus.

.. versionadded:: 2.1.0$nbsp;(Firmware)

func (*MasterBrick) SetEthernetMACAddress

func (device *MasterBrick) SetEthernetMACAddress(macAddress [6]uint8) (err error)

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

The MAC address can be read out again with GetEthernetStatus.

.. versionadded:: 2.1.0$nbsp;(Firmware)

func (*MasterBrick) SetEthernetWebsocketConfiguration

func (device *MasterBrick) SetEthernetWebsocketConfiguration(sockets uint8, port uint16) (err error)

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)

func (*MasterBrick) SetExtensionType

func (device *MasterBrick) SetExtensionType(extension uint8, exttype ExtensionType) (err error)

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:

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

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

Associated constants:

  • ExtensionTypeChibi
  • ExtensionTypeRS485
  • ExtensionTypeWifi
  • ExtensionTypeEthernet
  • ExtensionTypeWifi2

func (*MasterBrick) SetLongWifiKey

func (device *MasterBrick) SetLongWifiKey(key string) (err error)

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

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

.. versionadded:: 2.0.2$nbsp;(Firmware)

func (*MasterBrick) SetRS485Address

func (device *MasterBrick) SetRS485Address(address uint8) (err error)

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.

func (*MasterBrick) SetRS485Configuration

func (device *MasterBrick) SetRS485Configuration(speed uint32, parity RS485Parity, stopbits uint8) (err error)

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.

Associated constants:

  • RS485ParityNone
  • RS485ParityEven
  • RS485ParityOdd

func (*MasterBrick) SetRS485SlaveAddress

func (device *MasterBrick) SetRS485SlaveAddress(num uint8, address uint8) (err error)

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.

func (*MasterBrick) SetResponseExpected

func (device *MasterBrick) SetResponseExpected(functionID Function, responseExpected bool) error

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

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

func (*MasterBrick) SetResponseExpectedAll

func (device *MasterBrick) SetResponseExpectedAll(responseExpected bool)

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

func (*MasterBrick) SetSPITFPBaudrate

func (device *MasterBrick) SetSPITFPBaudrate(brickletPort rune, baudrate uint32) (err error)

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 (see GetSPITFPErrorCount) you can decrease the baudrate.

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

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

.. versionadded:: 2.4.3$nbsp;(Firmware)

func (*MasterBrick) SetSPITFPBaudrateConfig

func (device *MasterBrick) SetSPITFPBaudrateConfig(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)

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 function SetSPITFPBaudrate. If the dynamic baudrate is disabled, the baudrate as set by SetSPITFPBaudrate will be used statically.

.. versionadded:: 2.4.6$nbsp;(Firmware)

func (*MasterBrick) SetStackCurrentCallbackPeriod

func (device *MasterBrick) SetStackCurrentCallbackPeriod(period uint32) (err error)

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) SetStackCurrentCallbackThreshold

func (device *MasterBrick) SetStackCurrentCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterStackCurrentReachedCallback callback.

The following options are possible:

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) SetStackVoltageCallbackPeriod

func (device *MasterBrick) SetStackVoltageCallbackPeriod(period uint32) (err error)

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) SetStackVoltageCallbackThreshold

func (device *MasterBrick) SetStackVoltageCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterStackVoltageReachedCallback callback.

The following options are possible:

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) SetUSBVoltageCallbackPeriod

func (device *MasterBrick) SetUSBVoltageCallbackPeriod(period uint32) (err error)

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

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

func (*MasterBrick) SetUSBVoltageCallbackThreshold

func (device *MasterBrick) SetUSBVoltageCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterUSBVoltageReachedCallback callback.

The following options are possible:

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

.. versionadded:: 2.0.5$nbsp;(Firmware)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*MasterBrick) SetWifi2APConfiguration

func (device *MasterBrick) SetWifi2APConfiguration(enable bool, ssid string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, encryption Wifi2APEncryption, hidden bool, channel uint8, macAddress [6]uint8) (err error)

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 the SetWifi2APPassword 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)

Associated constants:

  • Wifi2APEncryptionOpen
  • Wifi2APEncryptionWEP
  • Wifi2APEncryptionWPAPSK
  • Wifi2APEncryptionWPA2PSK
  • Wifi2APEncryptionWPAWPA2PSK

func (*MasterBrick) SetWifi2APPassword

func (device *MasterBrick) SetWifi2APPassword(password string) (err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) SetWifi2AuthenticationSecret

func (device *MasterBrick) SetWifi2AuthenticationSecret(secret string) (err error)

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

See the `authentication tutorial <tutorial_authentication>` for more information.

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) SetWifi2ClientConfiguration

func (device *MasterBrick) SetWifi2ClientConfiguration(enable bool, ssid string, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, macAddress [6]uint8, bssid [6]uint8) (err error)

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

func (*MasterBrick) SetWifi2ClientHostname

func (device *MasterBrick) SetWifi2ClientHostname(hostname string) (err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) SetWifi2ClientPassword

func (device *MasterBrick) SetWifi2ClientPassword(password string) (err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) SetWifi2Configuration

func (device *MasterBrick) SetWifi2Configuration(port uint16, websocketPort uint16, websitePort uint16, phyMode Wifi2PHYMode, sleepMode uint8, website uint8) (err error)

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

Associated constants:

  • Wifi2PHYModeB
  • Wifi2PHYModeG
  • Wifi2PHYModeN

func (*MasterBrick) SetWifi2MeshConfiguration

func (device *MasterBrick) SetWifi2MeshConfiguration(enable bool, rootIP [4]uint8, rootSubnetMask [4]uint8, rootGateway [4]uint8, routerBSSID [6]uint8, groupID [6]uint8, groupSSIDPrefix string, gatewayIP [4]uint8, gatewayPort uint16) (err error)

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 by SetWifi2MeshRouterSSID. This only works if the the SSID is not hidden. In case the router has hidden SSID this parameter must be specified, otherwise the node will not be able to reach the mesh router.

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

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

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

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

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) SetWifi2MeshRouterPassword

func (device *MasterBrick) SetWifi2MeshRouterPassword(password string) (err error)

Requires WIFI Extension 2.0 firmware 2.1.0.

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

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

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

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) SetWifi2MeshRouterSSID

func (device *MasterBrick) SetWifi2MeshRouterSSID(ssid string) (err error)

Requires WIFI Extension 2.0 firmware 2.1.0.

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

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

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

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

.. versionadded:: 2.4.2$nbsp;(Firmware)

func (*MasterBrick) SetWifiAuthenticationSecret

func (device *MasterBrick) SetWifiAuthenticationSecret(secret string) (err error)

Sets the WIFI authentication secret. The secret can be a string of up to 64 characters. An empty string disables the authentication.

See the `authentication tutorial <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)

func (*MasterBrick) SetWifiCertificate

func (device *MasterBrick) SetWifiCertificate(index uint16, data [32]uint8, dataLength uint8) (err error)

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.

func (*MasterBrick) SetWifiConfiguration

func (device *MasterBrick) SetWifiConfiguration(ssid string, connection WifiConnection, ip [4]uint8, subnetMask [4]uint8, gateway [4]uint8, port uint16) (err error)

Sets the configuration of the WIFI Extension. The “ssid“ can have a max length of 32 characters. Possible values for “connection“ are:

Value| Description
--- | ---
0| DHCP
1| Static IP
2| Access Point: DHCP
3| Access Point: Static IP
4| Ad Hoc: DHCP
5| Ad Hoc: Static IP

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

The last parameter is the port that your program will connect to.

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

Associated constants:

  • WifiConnectionDHCP
  • WifiConnectionStaticIP
  • WifiConnectionAccessPointDHCP
  • WifiConnectionAccessPointStaticIP
  • WifiConnectionAdHocDHCP
  • WifiConnectionAdHocStaticIP

func (*MasterBrick) SetWifiEncryption

func (device *MasterBrick) SetWifiEncryption(encryption WifiEncryption, key string, keyIndex uint8, eapOptions WifiEAPOption, caCertificateLength uint16, clientCertificateLength uint16, privateKeyLength uint16) (err error)

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

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

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

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

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

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

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

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

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

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

Associated constants:

  • WifiEncryptionWPAWPA2
  • WifiEncryptionWPAEnterprise
  • WifiEncryptionWEP
  • WifiEncryptionNoEncryption
  • WifiEAPOptionOuterAuthEAPFAST
  • WifiEAPOptionOuterAuthEAPTLS
  • WifiEAPOptionOuterAuthEAPTTLS
  • WifiEAPOptionOuterAuthEAPPEAP
  • WifiEAPOptionInnerAuthEAPMSCHAP
  • WifiEAPOptionInnerAuthEAPGTC
  • WifiEAPOptionCertTypeCACert
  • WifiEAPOptionCertTypeClientCert
  • WifiEAPOptionCertTypePrivateKey

func (*MasterBrick) SetWifiHostname

func (device *MasterBrick) SetWifiHostname(hostname string) (err error)

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)

func (*MasterBrick) SetWifiPowerMode

func (device *MasterBrick) SetWifiPowerMode(mode WifiPowerMode) (err error)

Sets the power mode of the WIFI Extension. Possible modes are:

Mode| Description
--- | ---
0| Full Speed (high power consumption| high throughput)
1| Low Power (low power consumption| low throughput)

Associated constants:

  • WifiPowerModeFullSpeed
  • WifiPowerModeLowPower

func (*MasterBrick) SetWifiRegulatoryDomain

func (device *MasterBrick) SetWifiRegulatoryDomain(domain WifiDomain) (err error)

Sets the regulatory domain of the WIFI Extension. Possible domains are:

Domain| Description
--- | ---
0| FCC: Channel 1-11 (N/S America| Australia| New Zealand)
1| ETSI: Channel 1-13 (Europe| Middle East| Africa)
2| TELEC: Channel 1-14 (Japan)

Associated constants:

  • WifiDomainChannel1To11
  • WifiDomainChannel1To13
  • WifiDomainChannel1To14

func (*MasterBrick) StartWifi2Bootloader

func (device *MasterBrick) StartWifi2Bootloader() (result int8, err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

func (*MasterBrick) WriteBrickletPlugin

func (device *MasterBrick) WriteBrickletPlugin(port rune, offset uint8, chunk [32]uint8) (err error)

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.

func (*MasterBrick) WriteWifi2SerialPort

func (device *MasterBrick) WriteWifi2SerialPort(data [60]uint8, length uint8) (result int8, err error)

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

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

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

.. versionadded:: 2.4.0$nbsp;(Firmware)

type RS485Parity

type RS485Parity = rune
const (
	RS485ParityNone RS485Parity = 'n'
	RS485ParityEven RS485Parity = 'e'
	RS485ParityOdd  RS485Parity = 'o'
)

type ThresholdOption

type ThresholdOption = rune
const (
	ThresholdOptionOff     ThresholdOption = 'x'
	ThresholdOptionOutside ThresholdOption = 'o'
	ThresholdOptionInside  ThresholdOption = 'i'
	ThresholdOptionSmaller ThresholdOption = '<'
	ThresholdOptionGreater ThresholdOption = '>'
)

type Wifi2APEncryption

type Wifi2APEncryption = uint8
const (
	Wifi2APEncryptionOpen       Wifi2APEncryption = 0
	Wifi2APEncryptionWEP        Wifi2APEncryption = 1
	Wifi2APEncryptionWPAPSK     Wifi2APEncryption = 2
	Wifi2APEncryptionWPA2PSK    Wifi2APEncryption = 3
	Wifi2APEncryptionWPAWPA2PSK Wifi2APEncryption = 4
)

type Wifi2ClientStatus

type Wifi2ClientStatus = uint8
const (
	Wifi2ClientStatusIdle          Wifi2ClientStatus = 0
	Wifi2ClientStatusConnecting    Wifi2ClientStatus = 1
	Wifi2ClientStatusWrongPassword Wifi2ClientStatus = 2
	Wifi2ClientStatusNoAPFound     Wifi2ClientStatus = 3
	Wifi2ClientStatusConnectFailed Wifi2ClientStatus = 4
	Wifi2ClientStatusGotIP         Wifi2ClientStatus = 5
	Wifi2ClientStatusUnknown       Wifi2ClientStatus = 255
)

type Wifi2MeshStatus

type Wifi2MeshStatus = uint8
const (
	Wifi2MeshStatusDisabled       Wifi2MeshStatus = 0
	Wifi2MeshStatusWIFIConnecting Wifi2MeshStatus = 1
	Wifi2MeshStatusGotIP          Wifi2MeshStatus = 2
	Wifi2MeshStatusMeshLocal      Wifi2MeshStatus = 3
	Wifi2MeshStatusMeshOnline     Wifi2MeshStatus = 4
	Wifi2MeshStatusAPAvailable    Wifi2MeshStatus = 5
	Wifi2MeshStatusAPSetup        Wifi2MeshStatus = 6
	Wifi2MeshStatusLeafAvailable  Wifi2MeshStatus = 7
)

type Wifi2PHYMode

type Wifi2PHYMode = uint8
const (
	Wifi2PHYModeB Wifi2PHYMode = 0
	Wifi2PHYModeG Wifi2PHYMode = 1
	Wifi2PHYModeN Wifi2PHYMode = 2
)

type WifiConnection

type WifiConnection = uint8
const (
	WifiConnectionDHCP                WifiConnection = 0
	WifiConnectionStaticIP            WifiConnection = 1
	WifiConnectionAccessPointDHCP     WifiConnection = 2
	WifiConnectionAccessPointStaticIP WifiConnection = 3
	WifiConnectionAdHocDHCP           WifiConnection = 4
	WifiConnectionAdHocStaticIP       WifiConnection = 5
)

type WifiDomain

type WifiDomain = uint8
const (
	WifiDomainChannel1To11 WifiDomain = 0
	WifiDomainChannel1To13 WifiDomain = 1
	WifiDomainChannel1To14 WifiDomain = 2
)

type WifiEAPOption

type WifiEAPOption = uint8
const (
	WifiEAPOptionOuterAuthEAPFAST   WifiEAPOption = 0
	WifiEAPOptionOuterAuthEAPTLS    WifiEAPOption = 1
	WifiEAPOptionOuterAuthEAPTTLS   WifiEAPOption = 2
	WifiEAPOptionOuterAuthEAPPEAP   WifiEAPOption = 3
	WifiEAPOptionInnerAuthEAPMSCHAP WifiEAPOption = 0
	WifiEAPOptionInnerAuthEAPGTC    WifiEAPOption = 4
	WifiEAPOptionCertTypeCACert     WifiEAPOption = 0
	WifiEAPOptionCertTypeClientCert WifiEAPOption = 8
	WifiEAPOptionCertTypePrivateKey WifiEAPOption = 16
)

type WifiEncryption

type WifiEncryption = uint8
const (
	WifiEncryptionWPAWPA2       WifiEncryption = 0
	WifiEncryptionWPAEnterprise WifiEncryption = 1
	WifiEncryptionWEP           WifiEncryption = 2
	WifiEncryptionNoEncryption  WifiEncryption = 3
)

type WifiPowerMode

type WifiPowerMode = uint8
const (
	WifiPowerModeFullSpeed WifiPowerMode = 0
	WifiPowerModeLowPower  WifiPowerMode = 1
)

type WifiState

type WifiState = uint8
const (
	WifiStateDisassociated     WifiState = 0
	WifiStateAssociated        WifiState = 1
	WifiStateAssociating       WifiState = 2
	WifiStateError             WifiState = 3
	WifiStateNotInitializedYet WifiState = 255
)

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL