Package com.tinkerforge
Class BrickletOutdoorWeather
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletOutdoorWeather
-
public class BrickletOutdoorWeather extends Device
433MHz receiver for outdoor weather station
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletOutdoorWeather.SensorData
static interface
BrickletOutdoorWeather.SensorDataListener
Reports the sensor data every time a new data packet is received.class
BrickletOutdoorWeather.SensorIdentifiersLowLevel
class
BrickletOutdoorWeather.SPITFPErrorCount
class
BrickletOutdoorWeather.StationData
static interface
BrickletOutdoorWeather.StationDataListener
Reports the station data every time a new data packet is received.class
BrickletOutdoorWeather.StationIdentifiersLowLevel
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletOutdoorWeather(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSensorDataListener(BrickletOutdoorWeather.SensorDataListener listener)
Adds a SensorData listener.void
addStationDataListener(BrickletOutdoorWeather.StationDataListener listener)
Adds a StationData listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.boolean
getSensorCallbackConfiguration()
Returns the configuration as set bysetSensorCallbackConfiguration(boolean)
.BrickletOutdoorWeather.SensorData
getSensorData(int identifier)
Returns the last measured data for a sensor with the given identifier.int[]
getSensorIdentifiers()
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.BrickletOutdoorWeather.SensorIdentifiersLowLevel
getSensorIdentifiersLowLevel()
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.BrickletOutdoorWeather.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.boolean
getStationCallbackConfiguration()
Returns the configuration as set bysetStationCallbackConfiguration(boolean)
.BrickletOutdoorWeather.StationData
getStationData(int identifier)
Returns the last received data for a station with the given identifier.int[]
getStationIdentifiers()
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.BrickletOutdoorWeather.StationIdentifiersLowLevel
getStationIdentifiersLowLevel()
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.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeSensorDataListener(BrickletOutdoorWeather.SensorDataListener listener)
Removes a SensorData listener.void
removeStationDataListener(BrickletOutdoorWeather.StationDataListener listener)
Removes a StationData listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setSensorCallbackConfiguration(boolean enableCallback)
Turns listener for sensor data on or off.void
setStationCallbackConfiguration(boolean enableCallback)
Turns listener for station data on or off.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATION_IDENTIFIERS_LOW_LEVEL
public static final byte FUNCTION_GET_STATION_IDENTIFIERS_LOW_LEVEL
- See Also:
- Constant Field Values
-
FUNCTION_GET_SENSOR_IDENTIFIERS_LOW_LEVEL
public static final byte FUNCTION_GET_SENSOR_IDENTIFIERS_LOW_LEVEL
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATION_DATA
public static final byte FUNCTION_GET_STATION_DATA
- See Also:
- Constant Field Values
-
FUNCTION_GET_SENSOR_DATA
public static final byte FUNCTION_GET_SENSOR_DATA
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_STATION_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATION_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_STATION_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
WIND_DIRECTION_N
public static final int WIND_DIRECTION_N
- See Also:
- Constant Field Values
-
WIND_DIRECTION_NNE
public static final int WIND_DIRECTION_NNE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_NE
public static final int WIND_DIRECTION_NE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_ENE
public static final int WIND_DIRECTION_ENE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_E
public static final int WIND_DIRECTION_E
- See Also:
- Constant Field Values
-
WIND_DIRECTION_ESE
public static final int WIND_DIRECTION_ESE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_SE
public static final int WIND_DIRECTION_SE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_SSE
public static final int WIND_DIRECTION_SSE
- See Also:
- Constant Field Values
-
WIND_DIRECTION_S
public static final int WIND_DIRECTION_S
- See Also:
- Constant Field Values
-
WIND_DIRECTION_SSW
public static final int WIND_DIRECTION_SSW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_SW
public static final int WIND_DIRECTION_SW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_WSW
public static final int WIND_DIRECTION_WSW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_W
public static final int WIND_DIRECTION_W
- See Also:
- Constant Field Values
-
WIND_DIRECTION_WNW
public static final int WIND_DIRECTION_WNW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_NW
public static final int WIND_DIRECTION_NW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_NNW
public static final int WIND_DIRECTION_NNW
- See Also:
- Constant Field Values
-
WIND_DIRECTION_ERROR
public static final int WIND_DIRECTION_ERROR
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletOutdoorWeather
public BrickletOutdoorWeather(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getStationIdentifiersLowLevel
public BrickletOutdoorWeather.StationIdentifiersLowLevel getStationIdentifiersLowLevel() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getSensorIdentifiersLowLevel
public BrickletOutdoorWeather.SensorIdentifiersLowLevel getSensorIdentifiersLowLevel() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStationData
public BrickletOutdoorWeather.StationData getStationData(int identifier) throws TinkerforgeException
Returns the last received data for a station with the given identifier. CallgetStationIdentifiers()
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).- Throws:
TinkerforgeException
-
getSensorData
public BrickletOutdoorWeather.SensorData getSensorData(int identifier) throws TinkerforgeException
Returns the last measured data for a sensor with the given identifier. CallgetSensorIdentifiers()
for a list of all available identifiers. The return values are: * Temperature, * Humidity and * Last Change (seconds since the last reception of data).- Throws:
TinkerforgeException
-
setStationCallbackConfiguration
public void setStationCallbackConfiguration(boolean enableCallback) throws TinkerforgeException
Turns listener for station data on or off.- Throws:
TinkerforgeException
-
getStationCallbackConfiguration
public boolean getStationCallbackConfiguration() throws TinkerforgeException
Returns the configuration as set bysetStationCallbackConfiguration(boolean)
.- Throws:
TinkerforgeException
-
setSensorCallbackConfiguration
public void setSensorCallbackConfiguration(boolean enableCallback) throws TinkerforgeException
Turns listener for sensor data on or off.- Throws:
TinkerforgeException
-
getSensorCallbackConfiguration
public boolean getSensorCallbackConfiguration() throws TinkerforgeException
Returns the configuration as set bysetSensorCallbackConfiguration(boolean)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletOutdoorWeather.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. 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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
getStationIdentifiers
public int[] getStationIdentifiers() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getSensorIdentifiers
public int[] getSensorIdentifiers() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
addStationDataListener
public void addStationDataListener(BrickletOutdoorWeather.StationDataListener listener)
Adds a StationData listener.
-
removeStationDataListener
public void removeStationDataListener(BrickletOutdoorWeather.StationDataListener listener)
Removes a StationData listener.
-
addSensorDataListener
public void addSensorDataListener(BrickletOutdoorWeather.SensorDataListener listener)
Adds a SensorData listener.
-
removeSensorDataListener
public void removeSensorDataListener(BrickletOutdoorWeather.SensorDataListener listener)
Removes a SensorData listener.
-
-