Documentation
¶
Overview ¶
ESP32 microcontroller based Brick with 6 Bricklet ports.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricks/ESP32_Brick_Go.html.
Index ¶
- Constants
- type ESP32Brick
- func (device *ESP32Brick) GetAPIVersion() [3]uint8
- func (device *ESP32Brick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *ESP32Brick) GetResponseExpected(functionID Function) (bool, error)
- func (device *ESP32Brick) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *ESP32Brick) SetResponseExpectedAll(responseExpected bool)
- type Function
Constants ¶
const DeviceDisplayName = "ESP32 Brick"
const DeviceIdentifier = 113
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ESP32Brick ¶
type ESP32Brick struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (ESP32Brick, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*ESP32Brick) GetAPIVersion ¶
func (device *ESP32Brick) 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 (*ESP32Brick) GetIdentity ¶
func (device *ESP32Brick) 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 (*ESP32Brick) GetResponseExpected ¶
func (device *ESP32Brick) 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 (*ESP32Brick) SetResponseExpected ¶
func (device *ESP32Brick) 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 (*ESP32Brick) SetResponseExpectedAll ¶
func (device *ESP32Brick) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
Source Files