Struct tinkerforge::joystick_bricklet::JoystickBricklet
source · pub struct JoystickBricklet { /* private fields */ }
Expand description
2-axis joystick with push-button
Implementations
sourceimpl JoystickBricklet
impl JoystickBricklet
pub const DEVICE_IDENTIFIER: u16 = 210u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Joystick Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> JoystickBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> JoystickBricklet
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: JoystickBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&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.
sourcepub fn set_response_expected(
&mut self,
fun: JoystickBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&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.
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_position_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionEvent>
pub fn get_position_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionEvent>
This receiver is triggered periodically with the period that is set by
Set Position Receiver 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.
sourcepub fn get_analog_value_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueEvent>
pub fn get_analog_value_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueEvent>
This receiver is triggered periodically with the period that is set by
Set Analog Value Receiver 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.
sourcepub fn get_position_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionReachedEvent>
pub fn get_position_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<PositionReachedEvent>
This receiver is triggered when the threshold as set by
Set Position Receiver 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
.
sourcepub fn get_analog_value_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueReachedEvent>
pub fn get_analog_value_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AnalogValueReachedEvent>
This receiver is triggered when the threshold as set by
Set Analog Value Receiver 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
.
sourcepub fn get_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
pub fn get_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
This receiver is triggered when the button is pressed.
sourcepub fn get_released_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
pub fn get_released_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
This receiver is triggered when the button is released.
sourcepub fn get_position(&self) -> ConvertingReceiver<Position>
pub fn get_position(&self) -> ConvertingReceiver<Position>
Returns the position of the Joystick. The value ranges between -100 and
100 for both axis. 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 Receiver Period
.
sourcepub fn is_pressed(&self) -> ConvertingReceiver<bool>
pub fn is_pressed(&self) -> ConvertingReceiver<bool>
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.
sourcepub fn get_analog_value(&self) -> ConvertingReceiver<AnalogValue>
pub fn get_analog_value(&self) -> ConvertingReceiver<AnalogValue>
Returns the values as read by a 12-bit analog-to-digital converter. The values are between 0 and 4095 for both axis.
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 Receiver Period
.
sourcepub fn calibrate(&self) -> ConvertingReceiver<()>
pub fn calibrate(&self) -> ConvertingReceiver<()>
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.
sourcepub fn set_position_callback_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_position_callback_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms 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.
The default value is 0.
sourcepub fn get_position_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_position_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Position Receiver Period
.
sourcepub fn set_analog_value_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
pub fn set_analog_value_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms 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.
The default value is 0.
sourcepub fn get_analog_value_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_analog_value_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Analog Value Receiver Period
.
sourcepub fn set_position_callback_threshold(
&self,
option: char,
min_x: i16,
max_x: i16,
min_y: i16,
max_y: i16
) -> ConvertingReceiver<()>
pub fn set_position_callback_threshold(
&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) |
The default value is (‘x’, 0, 0, 0, 0).
Associated constants:
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICKBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_position_callback_threshold(
&self
) -> ConvertingReceiver<PositionCallbackThreshold>
pub fn get_position_callback_threshold(
&self
) -> ConvertingReceiver<PositionCallbackThreshold>
Returns the threshold as set by Set Position Receiver Threshold
.
Associated constants:
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICKBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_analog_value_callback_threshold(
&self,
option: char,
min_x: u16,
max_x: u16,
min_y: u16,
max_y: u16
) -> ConvertingReceiver<()>
pub fn set_analog_value_callback_threshold(
&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) |
The default value is (‘x’, 0, 0, 0, 0).
Associated constants:
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICKBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_analog_value_callback_threshold(
&self
) -> ConvertingReceiver<AnalogValueCallbackThreshold>
pub fn get_analog_value_callback_threshold(
&self
) -> ConvertingReceiver<AnalogValueCallbackThreshold>
Returns the threshold as set by Set Analog Value Receiver Threshold
.
Associated constants:
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OFF
- JOYSTICKBRICKLET_THRESHOLD_OPTION_OUTSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_INSIDE
- JOYSTICKBRICKLET_THRESHOLD_OPTION_SMALLER
- JOYSTICKBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the threshold receivers
are triggered, if the thresholds
Set Position Receiver Threshold
,Set Analog Value Receiver Threshold
keep being reached.
The default value is 100.
sourcepub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
Returns the debounce period as set by Set Debounce Period
.
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’ or ‘d’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for JoystickBricklet
impl Clone for JoystickBricklet
sourcefn clone(&self) -> JoystickBricklet
fn clone(&self) -> JoystickBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more