outdoor_weather_bricklet

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

433MHz receiver for outdoor weather station.

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

Index

Constants

View Source 
const DeviceDisplayName = "Outdoor Weather Bricklet"
View Source 
const DeviceIdentifier = 288

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 (
	FunctionGetStationIdentifiersLowLevel   Function = 1
	FunctionGetSensorIdentifiersLowLevel    Function = 2
	FunctionGetStationData                  Function = 3
	FunctionGetSensorData                   Function = 4
	FunctionSetStationCallbackConfiguration Function = 5
	FunctionGetStationCallbackConfiguration Function = 6
	FunctionSetSensorCallbackConfiguration  Function = 7
	FunctionGetSensorCallbackConfiguration  Function = 8
	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
	FunctionCallbackStationData             Function = 9
	FunctionCallbackSensorData              Function = 10
)

type OutdoorWeatherBricklet 

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

func New 

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

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

func (*OutdoorWeatherBricklet) DeregisterSensorDataCallback 

func (device *OutdoorWeatherBricklet) DeregisterSensorDataCallback(registrationId uint64)

Remove a registered Sensor Data callback.

func (*OutdoorWeatherBricklet) DeregisterStationDataCallback 

func (device *OutdoorWeatherBricklet) DeregisterStationDataCallback(registrationId uint64)

Remove a registered Station Data callback.

func (*OutdoorWeatherBricklet) GetAPIVersion 

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

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*OutdoorWeatherBricklet) GetChipTemperature 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) GetIdentity 

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

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

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

func (*OutdoorWeatherBricklet) GetResponseExpected 

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

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) GetSensorCallbackConfiguration 

func (device *OutdoorWeatherBricklet) GetSensorCallbackConfiguration() (enableCallback bool, err error)

Returns the configuration as set by SetSensorCallbackConfiguration.

func (*OutdoorWeatherBricklet) GetSensorData 

func (device *OutdoorWeatherBricklet) GetSensorData(identifier uint8) (temperature int16, humidity uint8, lastChange uint16, err error)

Returns the last measured data for a sensor with the given identifier. Call GetSensorIdentifiers for a list of all available identifiers.

The return values are:

* Temperature, * Humidity and * Last Change (seconds since the last reception of data).

func (*OutdoorWeatherBricklet) GetSensorIdentifiers 

func (device *OutdoorWeatherBricklet) GetSensorIdentifiers() (identifiers []uint8, err error)

Returns the identifiers (number between 0 and 255) of all `sensors <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

func (*OutdoorWeatherBricklet) GetSensorIdentifiersLowLevel 

func (device *OutdoorWeatherBricklet) GetSensorIdentifiersLowLevel() (identifiersLength uint16, identifiersChunkOffset uint16, identifiersChunkData [60]uint8, err error)

Returns the identifiers (number between 0 and 255) of all `sensors <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

func (*OutdoorWeatherBricklet) GetStationCallbackConfiguration 

func (device *OutdoorWeatherBricklet) GetStationCallbackConfiguration() (enableCallback bool, err error)

Returns the configuration as set by SetStationCallbackConfiguration.

func (*OutdoorWeatherBricklet) GetStationData 

func (device *OutdoorWeatherBricklet) GetStationData(identifier uint8) (temperature int16, humidity uint8, windSpeed uint32, gustSpeed uint32, rain uint32, windDirection WindDirection, batteryLow bool, lastChange uint16, err error)

Returns the last received data for a station with the given identifier. Call GetStationIdentifiers for a list of all available identifiers.

The return values are:

* Temperature, * Humidity, * Wind Speed, * Gust Speed, * Rain Fall (accumulated since station power-up), * Wind Direction, * Battery Low (true if battery is low) and * Last Change (seconds since the reception of this data).

Associated constants:

  • WindDirectionN
  • WindDirectionNNE
  • WindDirectionNE
  • WindDirectionENE
  • WindDirectionE
  • WindDirectionESE
  • WindDirectionSE
  • WindDirectionSSE
  • WindDirectionS
  • WindDirectionSSW
  • WindDirectionSW
  • WindDirectionWSW
  • WindDirectionW
  • WindDirectionWNW
  • WindDirectionNW
  • WindDirectionNNW
  • WindDirectionError

func (*OutdoorWeatherBricklet) GetStationIdentifiers 

func (device *OutdoorWeatherBricklet) GetStationIdentifiers() (identifiers []uint8, err error)

Returns the identifiers (number between 0 and 255) of all `stations <https://www.tinkerforge.com/en/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

func (*OutdoorWeatherBricklet) GetStationIdentifiersLowLevel 

func (device *OutdoorWeatherBricklet) GetStationIdentifiersLowLevel() (identifiersLength uint16, identifiersChunkOffset uint16, identifiersChunkData [60]uint8, err error)

Returns the identifiers (number between 0 and 255) of all `stations <https://www.tinkerforge.com/en/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

func (*OutdoorWeatherBricklet) GetStatusLEDConfig 

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*OutdoorWeatherBricklet) ReadUID 

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

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

func (*OutdoorWeatherBricklet) RegisterSensorDataCallback 

func (device *OutdoorWeatherBricklet) RegisterSensorDataCallback(fn func(uint8, int16, uint8)) uint64

Reports the sensor data every time a new data packet is received. See GetSensorData for information about the data.

For each sensor the callback will be called about every 45 seconds.

Turn the callback on/off with SetSensorCallbackConfiguration (by default it is turned off).

func (*OutdoorWeatherBricklet) RegisterStationDataCallback 

func (device *OutdoorWeatherBricklet) RegisterStationDataCallback(fn func(uint8, int16, uint8, uint32, uint32, uint32, WindDirection, bool)) uint64

Reports the station data every time a new data packet is received. See GetStationData for information about the data.

For each station the callback will be triggered about every 45 seconds.

Turn the callback on/off with SetStationCallbackConfiguration (by default it is turned off).

func (*OutdoorWeatherBricklet) Reset 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) SetBootloaderMode 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) SetResponseExpected 

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

func (device *OutdoorWeatherBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*OutdoorWeatherBricklet) SetSensorCallbackConfiguration 

func (device *OutdoorWeatherBricklet) SetSensorCallbackConfiguration(enableCallback bool) (err error)

Turns callback for sensor data on or off.

func (*OutdoorWeatherBricklet) SetStationCallbackConfiguration 

func (device *OutdoorWeatherBricklet) SetStationCallbackConfiguration(enableCallback bool) (err error)

Turns callback for station data on or off.

func (*OutdoorWeatherBricklet) SetStatusLEDConfig 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) SetWriteFirmwarePointer 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) WriteFirmware 

func (device *OutdoorWeatherBricklet) 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 (*OutdoorWeatherBricklet) WriteUID 

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

type WindDirection 

type WindDirection = uint8
const (
	WindDirectionN     WindDirection = 0
	WindDirectionNNE   WindDirection = 1
	WindDirectionNE    WindDirection = 2
	WindDirectionENE   WindDirection = 3
	WindDirectionE     WindDirection = 4
	WindDirectionESE   WindDirection = 5
	WindDirectionSE    WindDirection = 6
	WindDirectionSSE   WindDirection = 7
	WindDirectionS     WindDirection = 8
	WindDirectionSSW   WindDirection = 9
	WindDirectionSW    WindDirection = 10
	WindDirectionWSW   WindDirection = 11
	WindDirectionW     WindDirection = 12
	WindDirectionWNW   WindDirection = 13
	WindDirectionNW    WindDirection = 14
	WindDirectionNNW   WindDirection = 15
	WindDirectionError WindDirection = 255
)

Source Files

View all

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.