[−][src]Struct tinkerforge::joystick_bricklet::JoystickBricklet
2-axis joystick with push-button
Methods
impl JoystickBricklet
[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) -> JoystickBricklet
[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: JoystickBrickletFunction
) -> Result<bool, GetResponseExpectedError>
[src]
&mut self,
fun: JoystickBrickletFunction
) -> 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 send 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: JoystickBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
[src]
&mut self,
fun: JoystickBrickletFunction,
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 send 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_position_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionEvent>
[src]
&self
) -> ConvertingCallbackReceiver<PositionEvent>
This receiver is triggered periodically with the period that is set by
set_position_callback_period
. The parameter is the position of the
joystick.
The get_position_callback_receiver
receiver is only triggered if the position has changed since the
last triggering.
pub fn get_analog_value_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueEvent>
[src]
&self
) -> ConvertingCallbackReceiver<AnalogValueEvent>
This receiver is triggered periodically with the period that is set by
set_analog_value_callback_period
. The parameters are the
analog values of the joystick.
The get_analog_value_callback_receiver
receiver is only triggered if the values have changed
since the last triggering.
pub fn get_position_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionReachedEvent>
[src]
&self
) -> ConvertingCallbackReceiver<PositionReachedEvent>
This receiver is triggered when the threshold as set by
set_position_callback_threshold
is reached.
The parameters are the position of the joystick.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by set_debounce_period
.
pub fn get_analog_value_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueReachedEvent>
[src]
&self
) -> ConvertingCallbackReceiver<AnalogValueReachedEvent>
This receiver is triggered when the threshold as set by
set_analog_value_callback_threshold
is reached.
The parameters are the analog values of the joystick.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by set_debounce_period
.
pub fn get_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
[src]
This receiver is triggered when the button is pressed.
pub fn get_released_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
[src]
This receiver is triggered when the button is released.
pub fn get_position(&self) -> ConvertingReceiver<Position>
[src]
Returns the position of the joystick. The middle position of the joystick is x=0, y=0.
The returned values are averaged and calibrated (see calibrate
).
If you want to get the position periodically, it is recommended to use the
get_position_callback_receiver
receiver and set the period with
set_position_callback_period
.
pub fn is_pressed(&self) -> ConvertingReceiver<bool>
[src]
Returns true if the button is pressed and false otherwise.
It is recommended to use the get_pressed_callback_receiver
and get_released_callback_receiver
receivers
to handle the button.
pub fn get_analog_value(&self) -> ConvertingReceiver<AnalogValue>
[src]
Returns the values as read by a 12-bit analog-to-digital converter.
Note
The values returned by get_position
are averaged over several samples
to yield less noise, while get_analog_value
gives back raw
unfiltered analog values. The only reason to use get_analog_value
is,
if you need the full resolution of the analog-to-digital converter.
If you want the analog values periodically, it is recommended to use the
get_analog_value_callback_receiver
receiver and set the period with
set_analog_value_callback_period
.
pub fn calibrate(&self) -> ConvertingReceiver<()>
[src]
Calibrates the middle position of the joystick. If your Joystick Bricklet does not return x=0 and y=0 in the middle position, call this function while the joystick is standing still in the middle position.
The resulting calibration will be saved on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.
pub fn set_position_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
[src]
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period with which the get_position_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_position_callback_receiver
receiver is only triggered if the position has changed since the
last triggering.
pub fn get_position_callback_period(&self) -> ConvertingReceiver<u32>
[src]
Returns the period as set by set_position_callback_period
.
pub fn set_analog_value_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
[src]
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period with which the get_analog_value_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_analog_value_callback_receiver
receiver is only triggered if the analog values have
changed since the last triggering.
pub fn get_analog_value_callback_period(&self) -> ConvertingReceiver<u32>
[src]
Returns the period as set by set_analog_value_callback_period
.
pub fn set_position_callback_threshold(
&self,
option: char,
min_x: i16,
max_x: i16,
min_y: i16,
max_y: i16
) -> ConvertingReceiver<()>
[src]
&self,
option: char,
min_x: i16,
max_x: i16,
min_y: i16,
max_y: i16
) -> ConvertingReceiver<()>
Sets the thresholds for the get_position_reached_callback_receiver
receiver.
The following options are possible:
Option | Description |
---|---|
'x' | Receiver is turned off |
'o' | Receiver is triggered when the position is outside the min and max values |
'i' | Receiver is triggered when the position is inside the min and max values |
'<' | Receiver is triggered when the position is smaller than the min values (max is ignored) |
'>' | Receiver is triggered when the position is greater than the min values (max is ignored) |
Associated constants:
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn get_position_callback_threshold(
&self
) -> ConvertingReceiver<PositionCallbackThreshold>
[src]
&self
) -> ConvertingReceiver<PositionCallbackThreshold>
Returns the threshold as set by set_position_callback_threshold
.
Associated constants:
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn set_analog_value_callback_threshold(
&self,
option: char,
min_x: u16,
max_x: u16,
min_y: u16,
max_y: u16
) -> ConvertingReceiver<()>
[src]
&self,
option: char,
min_x: u16,
max_x: u16,
min_y: u16,
max_y: u16
) -> ConvertingReceiver<()>
Sets the thresholds for the get_analog_value_reached_callback_receiver
receiver.
The following options are possible:
Option | Description |
---|---|
'x' | Receiver is turned off |
'o' | Receiver is triggered when the analog values are outside the min and max values |
'i' | Receiver is triggered when the analog values are inside the min and max values |
'<' | Receiver is triggered when the analog values are smaller than the min values (max is ignored) |
'>' | Receiver is triggered when the analog values are greater than the min values (max is ignored) |
Associated constants:
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn get_analog_value_callback_threshold(
&self
) -> ConvertingReceiver<AnalogValueCallbackThreshold>
[src]
&self
) -> ConvertingReceiver<AnalogValueCallbackThreshold>
Returns the threshold as set by set_analog_value_callback_threshold
.
Associated constants:
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICK_BRICKLET_THRESHOLD_OPTION_GREATER
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
[src]
Sets the period with which the threshold receivers
are triggered, if the thresholds
keep being reached.
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
[src]
Returns the debounce period as set by set_debounce_period
.
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' or 'd'.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations
impl Clone for JoystickBricklet
[src]
fn clone(&self) -> JoystickBricklet
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Auto Trait Implementations
impl Send for JoystickBricklet
impl !Sync for JoystickBricklet
impl Unpin for JoystickBricklet
impl !UnwindSafe for JoystickBricklet
impl !RefUnwindSafe for JoystickBricklet
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self