Struct tinkerforge::hall_effect_v2_bricklet::HallEffectV2Bricklet[][src]

pub struct HallEffectV2Bricklet { /* fields omitted */ }
Expand description

Measures magnetic flux density between -7mT and +7mT

Implementations

impl HallEffectV2Bricklet[src]

pub const DEVICE_IDENTIFIER: u16[src]

pub const DEVICE_DISPLAY_NAME: &'static str[src]

pub fn new<T: GetRequestSender>(
    uid: &str,
    req_sender: T
) -> HallEffectV2Bricklet
[src]

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

pub fn get_response_expected(
    &mut self,
    fun: HallEffectV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>
[src]

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.

pub fn set_response_expected(
    &mut self,
    fun: HallEffectV2BrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>
[src]

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.

pub fn set_response_expected_all(&mut self, response_expected: bool)[src]

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

pub fn get_api_version(&self) -> [u8; 3][src]

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.

pub fn get_magnetic_flux_density_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<i16>
[src]

This receiver is triggered periodically according to the configuration set by set_magnetic_flux_density_callback_configuration.

The parameter is the same as get_magnetic_flux_density.

pub fn get_counter_callback_receiver(&self) -> ConvertingCallbackReceiver<u32>[src]

This receiver is triggered periodically according to the configuration set by [set_counter_callback_configuration].

The count is the same as you would get with [get_counter].

pub fn get_magnetic_flux_density(&self) -> ConvertingReceiver<i16>[src]

Returns the magnetic flux density (magnetic induction)__.

If you want to get the value periodically, it is recommended to use the [get_magnetic_flux_density_callback_receiver] receiver. You can set the receiver configuration with [set_magnetic_flux_density_callback_configuration].

pub fn set_magnetic_flux_density_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool,
    option: char,
    min: i16,
    max: i16
) -> ConvertingReceiver<()>
[src]

The period is the period with which the [get_magnetic_flux_density_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the [get_magnetic_flux_density_callback_receiver] receiver.

The following options are possible:

OptionDescription
‘x’Threshold is turned off
‘o’Threshold is triggered when the value is outside the min and max values
‘i’Threshold is triggered when the value is inside or equal to the min and max values
‘<’Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

Associated constants:

  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OFF
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_magnetic_flux_density_callback_configuration(
    &self
) -> ConvertingReceiver<MagneticFluxDensityCallbackConfiguration>
[src]

Returns the receiver configuration as set by [set_magnetic_flux_density_callback_configuration].

Associated constants:

  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OFF
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
  • HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_counter(&self, reset_counter: bool) -> ConvertingReceiver<u32>[src]

Returns the current value of the counter.

You can configure the low/high thresholds and the debounce time with [set_counter_config].

If you set reset counter to true, the count is set back to 0 directly after it is read.

If you want to get the count periodically, it is recommended to use the [get_counter_callback_receiver] receiver. You can set the receiver configuration with [set_counter_callback_configuration].

pub fn set_counter_config(
    &self,
    high_threshold: i16,
    low_threshold: i16,
    debounce: u32
) -> ConvertingReceiver<()>
[src]

Sets a high and a low threshold as well as a debounce time.

If the measured magnetic flux density goes above the high threshold or below the low threshold, the count of the counter is increased by 1.

The debounce time is the minimum time between two count increments.

pub fn get_counter_config(&self) -> ConvertingReceiver<CounterConfig>[src]

Returns the counter config as set by [set_counter_config].

pub fn set_counter_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool
) -> ConvertingReceiver<()>
[src]

The period is the period with which the [get_counter_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after at least one of the values has changed. If the values didn’t change within the period, the receiver is triggered immediately on change.

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

pub fn get_counter_callback_configuration(
    &self
) -> ConvertingReceiver<CounterCallbackConfiguration>
[src]

Returns the receiver configuration as set by [set_counter_callback_configuration].

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>[src]

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.

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>[src]

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:

  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_OK
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>[src]

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
  • HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>[src]

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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>[src]

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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>[src]

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:

  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_OFF
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_ON
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>[src]

Returns the configuration as set by [set_status_led_config]

Associated constants:

  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_OFF
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_ON
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
  • HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>[src]

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.

pub fn reset(&self) -> ConvertingReceiver<()>[src]

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!

pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>[src]

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.

pub fn read_uid(&self) -> ConvertingReceiver<u32>[src]

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

pub fn get_identity(&self) -> ConvertingReceiver<Identity>[src]

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

impl Clone for HallEffectV2Bricklet[src]

fn clone(&self) -> HallEffectV2Bricklet[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.