Documentation

Overview

    HAT for Raspberry Pi with 8 Bricklets ports and real-time clock.

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

    Index

    Constants

    View Source
    const DeviceDisplayName = "HAT Brick"
    View Source
    const DeviceIdentifier = 111

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type BootloaderMode

    type BootloaderMode = uint8
    const (
    	BootloaderModeBootloader                    BootloaderMode = 0
    	BootloaderModeFirmware                      BootloaderMode = 1
    	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
    	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
    	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
    )

    type BootloaderStatus

    type BootloaderStatus = uint8
    const (
    	BootloaderStatusOK                        BootloaderStatus = 0
    	BootloaderStatusInvalidMode               BootloaderStatus = 1
    	BootloaderStatusNoChange                  BootloaderStatus = 2
    	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
    	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
    	BootloaderStatusCRCMismatch               BootloaderStatus = 5
    )

    type Function

    type Function = uint8
    const (
    	FunctionSetSleepMode                     Function = 1
    	FunctionGetSleepMode                     Function = 2
    	FunctionSetBrickletPower                 Function = 3
    	FunctionGetBrickletPower                 Function = 4
    	FunctionGetVoltages                      Function = 5
    	FunctionSetVoltagesCallbackConfiguration Function = 6
    	FunctionGetVoltagesCallbackConfiguration Function = 7
    	FunctionGetSPITFPErrorCount              Function = 234
    	FunctionSetBootloaderMode                Function = 235
    	FunctionGetBootloaderMode                Function = 236
    	FunctionSetWriteFirmwarePointer          Function = 237
    	FunctionWriteFirmware                    Function = 238
    	FunctionSetStatusLEDConfig               Function = 239
    	FunctionGetStatusLEDConfig               Function = 240
    	FunctionGetChipTemperature               Function = 242
    	FunctionReset                            Function = 243
    	FunctionWriteUID                         Function = 248
    	FunctionReadUID                          Function = 249
    	FunctionGetIdentity                      Function = 255
    	FunctionCallbackVoltages                 Function = 8
    )

    type HATBrick

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

    func New

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

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

      func (*HATBrick) DeregisterVoltagesCallback

      func (device *HATBrick) DeregisterVoltagesCallback(registrationId uint64)

        Remove a registered Voltages callback.

        func (*HATBrick) GetAPIVersion

        func (device *HATBrick) 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 (*HATBrick) GetBootloaderMode

          func (device *HATBrick) GetBootloaderMode() (mode BootloaderMode, err error)

            Returns the current bootloader mode, see SetBootloaderMode.

            Associated constants:

            * BootloaderModeBootloader
            * BootloaderModeFirmware
            * BootloaderModeBootloaderWaitForReboot
            * BootloaderModeFirmwareWaitForReboot
            * BootloaderModeFirmwareWaitForEraseAndReboot
            

            func (*HATBrick) GetBrickletPower

            func (device *HATBrick) GetBrickletPower() (brickletPower bool, err error)

              Returns the power status of the connected Bricklets as set by SetBrickletPower.

              func (*HATBrick) GetChipTemperature

              func (device *HATBrick) 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 bad accuracy. Practically it is only useful as an indicator for temperature changes.

                func (*HATBrick) GetIdentity

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

                  Returns the UID, the UID where the HAT is connected to (typically '0' as the HAT is the root device in the topology), the position, the hardware and firmware version as well as the device identifier.

                  The HAT (Zero) Brick is always at position 'i'.

                  The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

                  func (*HATBrick) GetResponseExpected

                  func (device *HATBrick) 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 (*HATBrick) GetSPITFPErrorCount

                    func (device *HATBrick) GetSPITFPErrorCount() (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 Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

                    func (*HATBrick) GetSleepMode

                    func (device *HATBrick) GetSleepMode() (powerOffDelay uint32, powerOffDuration uint32, raspberryPiOff bool, brickletsOff bool, enableSleepIndicator bool, err error)

                      Returns the sleep mode settings as set by SetSleepMode.

                      func (*HATBrick) GetStatusLEDConfig

                      func (device *HATBrick) GetStatusLEDConfig() (config StatusLEDConfig, err error)

                        Returns the configuration as set by SetStatusLEDConfig

                        Associated constants:

                        * StatusLEDConfigOff
                        * StatusLEDConfigOn
                        * StatusLEDConfigShowHeartbeat
                        * StatusLEDConfigShowStatus
                        

                        func (*HATBrick) GetVoltages

                        func (device *HATBrick) GetVoltages() (voltageUSB uint16, voltageDC uint16, err error)

                          Returns the USB supply voltage and the DC input supply voltage.

                          There are three possible combinations:

                          * Only USB connected: The USB supply voltage will be fed back to the

                          DC input connector. You will read the USB voltage and a slightly lower
                          voltage on the DC input.
                          

                          * Only DC input connected: The DC voltage will not be fed back to the

                          USB connector. You will read the DC input voltage and the USB voltage
                          will be 0.
                          

                          * USB and DC input connected: You will read both voltages. In this case

                          the USB supply will be without load, but it will work as backup if you
                          disconnect the DC input (or if the DC input voltage falls below the
                          USB voltage).
                          

                          func (*HATBrick) GetVoltagesCallbackConfiguration

                          func (device *HATBrick) GetVoltagesCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

                            Returns the callback configuration as set by SetVoltagesCallbackConfiguration.

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

                            func (*HATBrick) ReadUID

                            func (device *HATBrick) ReadUID() (uid uint32, err error)

                              Returns the current UID as an integer. Encode as Base58 to get the usual string version.

                              func (*HATBrick) RegisterVoltagesCallback

                              func (device *HATBrick) RegisterVoltagesCallback(fn func(uint16, uint16)) uint64

                                This callback is triggered periodically according to the configuration set by SetVoltagesCallbackConfiguration.

                                The parameters are the same as GetVoltages.

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

                                func (*HATBrick) Reset

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

                                  Calling this function will reset the Bricklet. All configurations will be lost.

                                  After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

                                  func (*HATBrick) SetBootloaderMode

                                  func (device *HATBrick) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

                                    Sets the bootloader mode and returns the status after the requested mode change was instigated.

                                    You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

                                    This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

                                    Associated constants:

                                    * BootloaderModeBootloader
                                    * BootloaderModeFirmware
                                    * BootloaderModeBootloaderWaitForReboot
                                    * BootloaderModeFirmwareWaitForReboot
                                    * BootloaderModeFirmwareWaitForEraseAndReboot
                                    * BootloaderStatusOK
                                    * BootloaderStatusInvalidMode
                                    * BootloaderStatusNoChange
                                    * BootloaderStatusEntryFunctionNotPresent
                                    * BootloaderStatusDeviceIdentifierIncorrect
                                    * BootloaderStatusCRCMismatch
                                    

                                    func (*HATBrick) SetBrickletPower

                                    func (device *HATBrick) SetBrickletPower(brickletPower bool) (err error)

                                      Set to true/false to turn the power supply of the connected Bricklets on/off.

                                      func (*HATBrick) SetResponseExpected

                                      func (device *HATBrick) 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 (*HATBrick) SetResponseExpectedAll

                                        func (device *HATBrick) SetResponseExpectedAll(responseExpected bool)

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

                                          func (*HATBrick) SetSleepMode

                                          func (device *HATBrick) SetSleepMode(powerOffDelay uint32, powerOffDuration uint32, raspberryPiOff bool, brickletsOff bool, enableSleepIndicator bool) (err error)

                                            Sets the sleep mode.

                                            Note

                                            Calling this function will cut the Raspberry Pi's power after Power Off Delay seconds.
                                            You have to shut down the operating system yourself, e.g. by calling 'sudo shutdown -h now'.
                                            

                                            Parameters:

                                            * Power Off Delay: Time before the RPi/Bricklets are powered off. * Power Off Duration: Duration that the RPi/Bricklets stay powered off. * Raspberry Pi Off: RPi is powered off if set to true. * Bricklets Off: Bricklets are powered off if set to true. * Enable Sleep Indicator: If set to true, the status LED will blink in a 1s interval

                                            during the whole power off duration. This will draw additional 0.3mA.
                                            

                                            Example: To turn RPi and Bricklets off in 5 seconds for 10 minutes with sleep indicator enabled, call (5, 60*10, true, true, true).

                                            This function can also be used to implement a watchdog. To do this you can write a program that calls this function once per second in a loop with (10, 2, true, false, false). If the RPi crashes or gets stuck the HAT will reset the RPi after 10 seconds.

                                            func (*HATBrick) SetStatusLEDConfig

                                            func (device *HATBrick) SetStatusLEDConfig(config StatusLEDConfig) (err error)

                                              Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

                                              You can also turn the LED permanently on/off or show a heartbeat.

                                              If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

                                              Associated constants:

                                              * StatusLEDConfigOff
                                              * StatusLEDConfigOn
                                              * StatusLEDConfigShowHeartbeat
                                              * StatusLEDConfigShowStatus
                                              

                                              func (*HATBrick) SetVoltagesCallbackConfiguration

                                              func (device *HATBrick) SetVoltagesCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

                                                The period is the period with which the RegisterVoltagesCallback callback is triggered periodically. A value of 0 turns the callback off.

                                                If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

                                                If it is set to false, the callback is continuously triggered with the period, independent of the value.

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

                                                func (*HATBrick) SetWriteFirmwarePointer

                                                func (device *HATBrick) SetWriteFirmwarePointer(pointer uint32) (err error)

                                                  Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

                                                  This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

                                                  func (*HATBrick) WriteFirmware

                                                  func (device *HATBrick) WriteFirmware(data [64]uint8) (status uint8, err error)

                                                    Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

                                                    You can only write firmware in bootloader mode.

                                                    This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

                                                    func (*HATBrick) WriteUID

                                                    func (device *HATBrick) WriteUID(uid uint32) (err error)

                                                      Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

                                                      We recommend that you use Brick Viewer to change the UID.

                                                      type StatusLEDConfig

                                                      type StatusLEDConfig = uint8
                                                      const (
                                                      	StatusLEDConfigOff           StatusLEDConfig = 0
                                                      	StatusLEDConfigOn            StatusLEDConfig = 1
                                                      	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
                                                      	StatusLEDConfigShowStatus    StatusLEDConfig = 3
                                                      )

                                                      Source Files