pub struct OutdoorWeatherBricklet { /* private fields */ }
Expand description
433MHz receiver for outdoor weather station
Implementations§
source§impl OutdoorWeatherBricklet
impl OutdoorWeatherBricklet
pub const DEVICE_IDENTIFIER: u16 = 288u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Outdoor Weather Bricklet"
sourcepub fn new<T: GetRequestSender>(
uid: &str,
req_sender: T
) -> OutdoorWeatherBricklet
pub fn new<T: GetRequestSender>( uid: &str, req_sender: T ) -> OutdoorWeatherBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: OutdoorWeatherBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: OutdoorWeatherBrickletFunction ) -> Result<bool, GetResponseExpectedError>
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 set_response_expected
.
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 set_response_expected
for the list of function ID constants available for this function.
sourcepub fn set_response_expected(
&mut self,
fun: OutdoorWeatherBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: OutdoorWeatherBrickletFunction, response_expected: bool ) -> Result<(), SetResponseExpectedError>
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.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
pub fn set_response_expected_all(&mut self, response_expected: bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
sourcepub fn get_api_version(&self) -> [u8; 3]
pub fn get_api_version(&self) -> [u8; 3]
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.
sourcepub fn get_station_data_callback_receiver(
&self
) -> ConvertingCallbackReceiver<StationDataEvent>
pub fn get_station_data_callback_receiver( &self ) -> ConvertingCallbackReceiver<StationDataEvent>
Reports the station data every time a new data packet is received.
See get_station_data
for information about the data.
For each station the receiver will be triggered about every 45 seconds.
Turn the receiver on/off with set_station_callback_configuration
(by default it is turned off).
sourcepub fn get_sensor_data_callback_receiver(
&self
) -> ConvertingCallbackReceiver<SensorDataEvent>
pub fn get_sensor_data_callback_receiver( &self ) -> ConvertingCallbackReceiver<SensorDataEvent>
Reports the sensor data every time a new data packet is received.
See [get_sensor_data
] for information about the data.
For each sensor the receiver will be called about every 45 seconds.
Turn the receiver on/off with [set_sensor_callback_configuration
]
(by default it is turned off).
sourcepub fn get_station_identifiers_low_level(
&self
) -> ConvertingReceiver<StationIdentifiersLowLevel>
pub fn get_station_identifiers_low_level( &self ) -> ConvertingReceiver<StationIdentifiersLowLevel>
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.
sourcepub fn get_station_identifiers(
&self
) -> Result<Vec<u8>, BrickletRecvTimeoutError>
pub fn get_station_identifiers( &self ) -> Result<Vec<u8>, BrickletRecvTimeoutError>
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.
sourcepub fn get_sensor_identifiers_low_level(
&self
) -> ConvertingReceiver<SensorIdentifiersLowLevel>
pub fn get_sensor_identifiers_low_level( &self ) -> ConvertingReceiver<SensorIdentifiersLowLevel>
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.
sourcepub fn get_sensor_identifiers(
&self
) -> Result<Vec<u8>, BrickletRecvTimeoutError>
pub fn get_sensor_identifiers( &self ) -> Result<Vec<u8>, BrickletRecvTimeoutError>
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.
sourcepub fn get_station_data(
&self,
identifier: u8
) -> ConvertingReceiver<StationData>
pub fn get_station_data( &self, identifier: u8 ) -> ConvertingReceiver<StationData>
Returns the last received data for a station with the given identifier.
Call [get_station_identifiers
] 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:
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW
- OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR
sourcepub fn get_sensor_data(&self, identifier: u8) -> ConvertingReceiver<SensorData>
pub fn get_sensor_data(&self, identifier: u8) -> ConvertingReceiver<SensorData>
Returns the last measured data for a sensor with the given identifier.
Call [get_sensor_identifiers
] for a list of all available identifiers.
The return values are:
- Temperature,
- Humidity and
- Last Change (seconds since the last reception of data).
sourcepub fn set_station_callback_configuration(
&self,
enable_callback: bool
) -> ConvertingReceiver<()>
pub fn set_station_callback_configuration( &self, enable_callback: bool ) -> ConvertingReceiver<()>
Turns receiver for station data on or off.
sourcepub fn get_station_callback_configuration(&self) -> ConvertingReceiver<bool>
pub fn get_station_callback_configuration(&self) -> ConvertingReceiver<bool>
Returns the configuration as set by [set_station_callback_configuration
].
sourcepub fn set_sensor_callback_configuration(
&self,
enable_callback: bool
) -> ConvertingReceiver<()>
pub fn set_sensor_callback_configuration( &self, enable_callback: bool ) -> ConvertingReceiver<()>
Turns receiver for sensor data on or off.
sourcepub fn get_sensor_callback_configuration(&self) -> ConvertingReceiver<bool>
pub fn get_sensor_callback_configuration(&self) -> ConvertingReceiver<bool>
Returns the configuration as set by [set_sensor_callback_configuration
].
sourcepub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
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.
sourcepub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
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:
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_OK
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
sourcepub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
Returns the current bootloader mode, see [set_bootloader_mode
].
Associated constants:
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
sourcepub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
Sets the firmware pointer for [write_firmware
]. 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.
sourcepub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
Writes 64 Bytes of firmware at the position as written by
[set_write_firmware_pointer
] 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.
sourcepub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
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:
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
Returns the configuration as set by [set_status_led_config
]
Associated constants:
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
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.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
pub fn reset(&self) -> ConvertingReceiver<()>
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!
sourcepub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
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.
sourcepub fn read_uid(&self) -> ConvertingReceiver<u32>
pub fn read_uid(&self) -> ConvertingReceiver<u32>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
pub fn get_identity(&self) -> ConvertingReceiver<Identity>
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 is always at position ‘z’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations§
source§impl Clone for OutdoorWeatherBricklet
impl Clone for OutdoorWeatherBricklet
source§fn clone(&self) -> OutdoorWeatherBricklet
fn clone(&self) -> OutdoorWeatherBricklet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more