1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
/* ***********************************************************
* This file was automatically generated on 2024-02-27. *
* *
* Rust Bindings Version 2.0.21 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
//! Determine position, velocity and altitude using GPS.
//!
//! See also the documentation [here](https://www.tinkerforge.com/en/doc/Software/Bricklets/GPS_Bricklet_Rust.html).
use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::GetRequestSender,
};
pub enum GpsBrickletFunction {
GetCoordinates,
GetStatus,
GetAltitude,
GetMotion,
GetDateTime,
Restart,
SetCoordinatesCallbackPeriod,
GetCoordinatesCallbackPeriod,
SetStatusCallbackPeriod,
GetStatusCallbackPeriod,
SetAltitudeCallbackPeriod,
GetAltitudeCallbackPeriod,
SetMotionCallbackPeriod,
GetMotionCallbackPeriod,
SetDateTimeCallbackPeriod,
GetDateTimeCallbackPeriod,
GetIdentity,
CallbackCoordinates,
CallbackStatus,
CallbackAltitude,
CallbackMotion,
CallbackDateTime,
}
impl From<GpsBrickletFunction> for u8 {
fn from(fun: GpsBrickletFunction) -> Self {
match fun {
GpsBrickletFunction::GetCoordinates => 1,
GpsBrickletFunction::GetStatus => 2,
GpsBrickletFunction::GetAltitude => 3,
GpsBrickletFunction::GetMotion => 4,
GpsBrickletFunction::GetDateTime => 5,
GpsBrickletFunction::Restart => 6,
GpsBrickletFunction::SetCoordinatesCallbackPeriod => 7,
GpsBrickletFunction::GetCoordinatesCallbackPeriod => 8,
GpsBrickletFunction::SetStatusCallbackPeriod => 9,
GpsBrickletFunction::GetStatusCallbackPeriod => 10,
GpsBrickletFunction::SetAltitudeCallbackPeriod => 11,
GpsBrickletFunction::GetAltitudeCallbackPeriod => 12,
GpsBrickletFunction::SetMotionCallbackPeriod => 13,
GpsBrickletFunction::GetMotionCallbackPeriod => 14,
GpsBrickletFunction::SetDateTimeCallbackPeriod => 15,
GpsBrickletFunction::GetDateTimeCallbackPeriod => 16,
GpsBrickletFunction::GetIdentity => 255,
GpsBrickletFunction::CallbackCoordinates => 17,
GpsBrickletFunction::CallbackStatus => 18,
GpsBrickletFunction::CallbackAltitude => 19,
GpsBrickletFunction::CallbackMotion => 20,
GpsBrickletFunction::CallbackDateTime => 21,
}
}
}
pub const GPS_BRICKLET_FIX_NO_FIX: u8 = 1;
pub const GPS_BRICKLET_FIX_2D_FIX: u8 = 2;
pub const GPS_BRICKLET_FIX_3D_FIX: u8 = 3;
pub const GPS_BRICKLET_RESTART_TYPE_HOT_START: u8 = 0;
pub const GPS_BRICKLET_RESTART_TYPE_WARM_START: u8 = 1;
pub const GPS_BRICKLET_RESTART_TYPE_COLD_START: u8 = 2;
pub const GPS_BRICKLET_RESTART_TYPE_FACTORY_RESET: u8 = 3;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Coordinates {
pub latitude: u32,
pub ns: char,
pub longitude: u32,
pub ew: char,
pub pdop: u16,
pub hdop: u16,
pub vdop: u16,
pub epe: u16,
}
impl FromByteSlice for Coordinates {
fn bytes_expected() -> usize { 18 }
fn from_le_byte_slice(bytes: &[u8]) -> Coordinates {
Coordinates {
latitude: <u32>::from_le_byte_slice(&bytes[0..4]),
ns: <char>::from_le_byte_slice(&bytes[4..5]),
longitude: <u32>::from_le_byte_slice(&bytes[5..9]),
ew: <char>::from_le_byte_slice(&bytes[9..10]),
pdop: <u16>::from_le_byte_slice(&bytes[10..12]),
hdop: <u16>::from_le_byte_slice(&bytes[12..14]),
vdop: <u16>::from_le_byte_slice(&bytes[14..16]),
epe: <u16>::from_le_byte_slice(&bytes[16..18]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Status {
pub fix: u8,
pub satellites_view: u8,
pub satellites_used: u8,
}
impl FromByteSlice for Status {
fn bytes_expected() -> usize { 3 }
fn from_le_byte_slice(bytes: &[u8]) -> Status {
Status {
fix: <u8>::from_le_byte_slice(&bytes[0..1]),
satellites_view: <u8>::from_le_byte_slice(&bytes[1..2]),
satellites_used: <u8>::from_le_byte_slice(&bytes[2..3]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Altitude {
pub altitude: i32,
pub geoidal_separation: i32,
}
impl FromByteSlice for Altitude {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> Altitude {
Altitude { altitude: <i32>::from_le_byte_slice(&bytes[0..4]), geoidal_separation: <i32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Motion {
pub course: u32,
pub speed: u32,
}
impl FromByteSlice for Motion {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> Motion {
Motion { course: <u32>::from_le_byte_slice(&bytes[0..4]), speed: <u32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct DateTime {
pub date: u32,
pub time: u32,
}
impl FromByteSlice for DateTime {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> DateTime {
DateTime { date: <u32>::from_le_byte_slice(&bytes[0..4]), time: <u32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct CoordinatesEvent {
pub latitude: u32,
pub ns: char,
pub longitude: u32,
pub ew: char,
pub pdop: u16,
pub hdop: u16,
pub vdop: u16,
pub epe: u16,
}
impl FromByteSlice for CoordinatesEvent {
fn bytes_expected() -> usize { 18 }
fn from_le_byte_slice(bytes: &[u8]) -> CoordinatesEvent {
CoordinatesEvent {
latitude: <u32>::from_le_byte_slice(&bytes[0..4]),
ns: <char>::from_le_byte_slice(&bytes[4..5]),
longitude: <u32>::from_le_byte_slice(&bytes[5..9]),
ew: <char>::from_le_byte_slice(&bytes[9..10]),
pdop: <u16>::from_le_byte_slice(&bytes[10..12]),
hdop: <u16>::from_le_byte_slice(&bytes[12..14]),
vdop: <u16>::from_le_byte_slice(&bytes[14..16]),
epe: <u16>::from_le_byte_slice(&bytes[16..18]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct StatusEvent {
pub fix: u8,
pub satellites_view: u8,
pub satellites_used: u8,
}
impl FromByteSlice for StatusEvent {
fn bytes_expected() -> usize { 3 }
fn from_le_byte_slice(bytes: &[u8]) -> StatusEvent {
StatusEvent {
fix: <u8>::from_le_byte_slice(&bytes[0..1]),
satellites_view: <u8>::from_le_byte_slice(&bytes[1..2]),
satellites_used: <u8>::from_le_byte_slice(&bytes[2..3]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct AltitudeEvent {
pub altitude: i32,
pub geoidal_separation: i32,
}
impl FromByteSlice for AltitudeEvent {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> AltitudeEvent {
AltitudeEvent { altitude: <i32>::from_le_byte_slice(&bytes[0..4]), geoidal_separation: <i32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct MotionEvent {
pub course: u32,
pub speed: u32,
}
impl FromByteSlice for MotionEvent {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> MotionEvent {
MotionEvent { course: <u32>::from_le_byte_slice(&bytes[0..4]), speed: <u32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct DateTimeEvent {
pub date: u32,
pub time: u32,
}
impl FromByteSlice for DateTimeEvent {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> DateTimeEvent {
DateTimeEvent { date: <u32>::from_le_byte_slice(&bytes[0..4]), time: <u32>::from_le_byte_slice(&bytes[4..8]) }
}
}
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct Identity {
pub uid: String,
pub connected_uid: String,
pub position: char,
pub hardware_version: [u8; 3],
pub firmware_version: [u8; 3],
pub device_identifier: u16,
}
impl FromByteSlice for Identity {
fn bytes_expected() -> usize { 25 }
fn from_le_byte_slice(bytes: &[u8]) -> Identity {
Identity {
uid: <String>::from_le_byte_slice(&bytes[0..8]),
connected_uid: <String>::from_le_byte_slice(&bytes[8..16]),
position: <char>::from_le_byte_slice(&bytes[16..17]),
hardware_version: <[u8; 3]>::from_le_byte_slice(&bytes[17..20]),
firmware_version: <[u8; 3]>::from_le_byte_slice(&bytes[20..23]),
device_identifier: <u16>::from_le_byte_slice(&bytes[23..25]),
}
}
}
/// Determine position, velocity and altitude using GPS
#[derive(Clone)]
pub struct GpsBricklet {
device: Device,
}
impl GpsBricklet {
pub const DEVICE_IDENTIFIER: u16 = 222;
pub const DEVICE_DISPLAY_NAME: &'static str = "GPS Bricklet";
/// 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 new<T: GetRequestSender>(uid: &str, req_sender: T) -> GpsBricklet {
let mut result = GpsBricklet { device: Device::new([2, 0, 1], uid, req_sender, 0) };
result.device.response_expected[u8::from(GpsBrickletFunction::GetCoordinates) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::GetStatus) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::GetAltitude) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::GetMotion) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::GetDateTime) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::Restart) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(GpsBrickletFunction::SetCoordinatesCallbackPeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(GpsBrickletFunction::GetCoordinatesCallbackPeriod) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::SetStatusCallbackPeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(GpsBrickletFunction::GetStatusCallbackPeriod) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::SetAltitudeCallbackPeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(GpsBrickletFunction::GetAltitudeCallbackPeriod) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::SetMotionCallbackPeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(GpsBrickletFunction::GetMotionCallbackPeriod) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::SetDateTimeCallbackPeriod) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(GpsBrickletFunction::GetDateTimeCallbackPeriod) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(GpsBrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
/// 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`](crate::gps_bricklet::GpsBricklet::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`](crate::gps_bricklet::GpsBricklet::set_response_expected) for the list of function ID constants available for this function.
pub fn get_response_expected(&mut self, fun: GpsBrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
/// 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(&mut self, fun: GpsBrickletFunction, response_expected: bool) -> Result<(), SetResponseExpectedError> {
self.device.set_response_expected(u8::from(fun), response_expected)
}
/// Changes the response expected flag for all setter and callback configuration functions of this device at once.
pub fn set_response_expected_all(&mut self, response_expected: bool) { self.device.set_response_expected_all(response_expected) }
/// 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_api_version(&self) -> [u8; 3] { self.device.api_version }
/// This receiver is triggered periodically with the period that is set by
/// [`set_coordinates_callback_period`]. The parameters are the same
/// as for [`get_coordinates`].
///
/// The [`get_coordinates_callback_receiver`] receiver is only triggered if the coordinates changed
/// since the last triggering and if there is currently a fix as indicated by
/// [`get_status`].
///
/// [`get_coordinates`]: #method.get_coordinates
/// [`get_status`]: #method.get_status
/// [`set_coordinates_callback_period`]: #method.set_coordinates_callback_period
/// [`get_coordinates_callback_receiver`]: #method.get_coordinates_callback_receiver
pub fn get_coordinates_callback_receiver(&self) -> ConvertingCallbackReceiver<CoordinatesEvent> {
self.device.get_callback_receiver(u8::from(GpsBrickletFunction::CallbackCoordinates))
}
/// This receiver is triggered periodically with the period that is set by
/// [`set_status_callback_period`]. The parameters are the same
/// as for [`get_status`].
///
/// The [`get_status_callback_receiver`] receiver is only triggered if the status changed since the
/// last triggering.
pub fn get_status_callback_receiver(&self) -> ConvertingCallbackReceiver<StatusEvent> {
self.device.get_callback_receiver(u8::from(GpsBrickletFunction::CallbackStatus))
}
/// This receiver is triggered periodically with the period that is set by
/// [`set_altitude_callback_period`]. The parameters are the same
/// as for [`get_altitude`].
///
/// The [`get_altitude_callback_receiver`] receiver is only triggered if the altitude changed since
/// the last triggering and if there is currently a fix as indicated by
/// [`get_status`].
pub fn get_altitude_callback_receiver(&self) -> ConvertingCallbackReceiver<AltitudeEvent> {
self.device.get_callback_receiver(u8::from(GpsBrickletFunction::CallbackAltitude))
}
/// This receiver is triggered periodically with the period that is set by
/// [`set_motion_callback_period`]. The parameters are the same
/// as for [`get_motion`].
///
/// The [`get_motion_callback_receiver`] receiver is only triggered if the motion changed since the
/// last triggering and if there is currently a fix as indicated by
/// [`get_status`].
pub fn get_motion_callback_receiver(&self) -> ConvertingCallbackReceiver<MotionEvent> {
self.device.get_callback_receiver(u8::from(GpsBrickletFunction::CallbackMotion))
}
/// This receiver is triggered periodically with the period that is set by
/// [`set_date_time_callback_period`]. The parameters are the same
/// as for [`get_date_time`].
///
/// The [`get_date_time_callback_receiver`] receiver is only triggered if the date or time changed
/// since the last triggering.
pub fn get_date_time_callback_receiver(&self) -> ConvertingCallbackReceiver<DateTimeEvent> {
self.device.get_callback_receiver(u8::from(GpsBrickletFunction::CallbackDateTime))
}
/// Returns the GPS coordinates. Latitude and longitude are given in the
/// [`DD.dddddd°`` format, the value 57123468 means 57.123468°.
/// The parameter ``ns`` and ``ew`` are the cardinal directions for
/// latitude and longitude. Possible values for ``ns`` and ``ew`` are 'N', 'S', 'E'
/// and 'W' (north, south, east and west).
///
/// PDOP, HDOP and VDOP are the dilution of precision (DOP) values. They specify
/// the additional multiplicative effect of GPS satellite geometry on GPS
/// precision. See
/// `here](https://en.wikipedia.org/wiki/Dilution_of_precision_(GPS))__
/// for more information.
///
/// EPE is the Estimated Position Error. This is not the
/// absolute maximum error, it is the error with a specific confidence. See
/// [here](https://www.nps.gov/gis/gps/WhatisEPE.html)__ for more information.
///
/// This data is only valid if there is currently a fix as indicated by
/// [`get_status`].
pub fn get_coordinates(&self) -> ConvertingReceiver<Coordinates> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetCoordinates), payload)
}
/// Returns the current fix status, the number of satellites that are in view and
/// the number of satellites that are currently used.
///
/// Possible fix status values can be:
///
/// Value| Description
/// --- | ---
/// 1| No Fix| :func:[Get Coordinates`| [`get_altitude`] and [`get_motion`] return invalid data
/// 2| 2D Fix| only [`get_coordinates`] and [`get_motion`] return valid data
/// 3| 3D Fix| [`get_coordinates`]| [`get_altitude`] and [`get_motion`] return valid data
///
/// There is also a `blue LED](gps_bricklet_fix_led) on the Bricklet that
/// indicates the fix status.
///
/// Associated constants:
/// * GPS_BRICKLET_FIX_NO_FIX
/// * GPS_BRICKLET_FIX_2D_FIX
/// * GPS_BRICKLET_FIX_3D_FIX
pub fn get_status(&self) -> ConvertingReceiver<Status> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetStatus), payload)
}
/// Returns the current altitude and corresponding geoidal separation.
///
/// This data is only valid if there is currently a fix as indicated by
/// [`get_status`].
pub fn get_altitude(&self) -> ConvertingReceiver<Altitude> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetAltitude), payload)
}
/// Returns the current course and speed. A course of 0° means the Bricklet is
/// traveling north bound and 90° means it is traveling east bound.
///
/// Please note that this only returns useful values if an actual movement
/// is present.
///
/// This data is only valid if there is currently a fix as indicated by
/// [`get_status`].
pub fn get_motion(&self) -> ConvertingReceiver<Motion> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetMotion), payload)
}
/// Returns the current date and time. The date is
/// given in the format ``ddmmyy`` and the time is given
/// in the format ``hhmmss.sss``. For example, 140713 means
/// 14.07.13 as date and 195923568 means 19:59:23.568 as time.
pub fn get_date_time(&self) -> ConvertingReceiver<DateTime> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetDateTime), payload)
}
/// Restarts the GPS Bricklet, the following restart types are available:
///
/// Value| Description
/// --- | ---
/// 0| Hot start (use all available data in the NV store)
/// 1| Warm start (don't use ephemeris at restart)
/// 2| Cold start (don't use time| position| almanacs and ephemeris at restart)
/// 3| Factory reset (clear all system/user configurations at restart)
///
/// Associated constants:
/// * GPS_BRICKLET_RESTART_TYPE_HOT_START
/// * GPS_BRICKLET_RESTART_TYPE_WARM_START
/// * GPS_BRICKLET_RESTART_TYPE_COLD_START
/// * GPS_BRICKLET_RESTART_TYPE_FACTORY_RESET
pub fn restart(&self, restart_type: u8) -> ConvertingReceiver<()> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(restart_type));
self.device.set(u8::from(GpsBrickletFunction::Restart), payload)
}
/// Sets the period with which the [`get_coordinates_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_coordinates_callback_receiver`] receiver is only triggered if the coordinates changed
/// since the last triggering.
pub fn set_coordinates_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
self.device.set(u8::from(GpsBrickletFunction::SetCoordinatesCallbackPeriod), payload)
}
/// Returns the period as set by [`set_coordinates_callback_period`].
pub fn get_coordinates_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetCoordinatesCallbackPeriod), payload)
}
/// Sets the period with which the [`get_status_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_status_callback_receiver`] receiver is only triggered if the status changed since the
/// last triggering.
pub fn set_status_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
self.device.set(u8::from(GpsBrickletFunction::SetStatusCallbackPeriod), payload)
}
/// Returns the period as set by [`set_status_callback_period`].
pub fn get_status_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetStatusCallbackPeriod), payload)
}
/// Sets the period with which the [`get_altitude_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_altitude_callback_receiver`] receiver is only triggered if the altitude changed since
/// the last triggering.
pub fn set_altitude_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
self.device.set(u8::from(GpsBrickletFunction::SetAltitudeCallbackPeriod), payload)
}
/// Returns the period as set by [`set_altitude_callback_period`].
pub fn get_altitude_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetAltitudeCallbackPeriod), payload)
}
/// Sets the period with which the [`get_motion_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_motion_callback_receiver`] receiver is only triggered if the motion changed since the
/// last triggering.
pub fn set_motion_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
self.device.set(u8::from(GpsBrickletFunction::SetMotionCallbackPeriod), payload)
}
/// Returns the period as set by [`set_motion_callback_period`].
pub fn get_motion_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetMotionCallbackPeriod), payload)
}
/// Sets the period with which the [`get_date_time_callback_receiver`] receiver is triggered
/// periodically. A value of 0 turns the receiver off.
///
/// The [`get_date_time_callback_receiver`] receiver is only triggered if the date or time changed
/// since the last triggering.
pub fn set_date_time_callback_period(&self, period: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
self.device.set(u8::from(GpsBrickletFunction::SetDateTimeCallbackPeriod), payload)
}
/// Returns the period as set by [`set_date_time_callback_period`].
pub fn get_date_time_callback_period(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetDateTimeCallbackPeriod), payload)
}
/// 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](isolator_bricklet) is always at
/// position 'z'.
///
/// The device identifier numbers can be found [here](device_identifier).
/// |device_identifier_constant|
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(GpsBrickletFunction::GetIdentity), payload)
}
}