pros 0.9.1

Rust bindings for PROS
Documentation 
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

//! # Pros
//! Opinionated bindings for the PROS library and kernel.
//! Not everything in this library is one to one with the PROS API.
//!
//! Advantages over similar libraries or PROS itself:
//! - Pros-rs has an [`Async executor`](async_runtime) which allows for easy and performant asynchronous code.
//! - Simulation support with [`pros-simulator`](https://crates.io/crates/pros-simulator) and any interface with it (e.g. [`pros-simulator-gui`](https://github.com/pros-rs/pros-simulator-gui))
//! - Pros-rs is a real crate on crates.io instead of a template, or similar. This allows for dependency management with cargo.
//!
//! # Usage
//!
//! When using pros, you have a few options for how you want to get started.
//! You have two options: `async` and `sync`.
//! When using async, an async executor is started and you can use it to run code asynchronously without any FreeRTOS tasks.
//! When using sync, if you want to run code asynchronously you must create a FreeRTOS task.
//!
//! Here are some examples of both:
//!
//! ```rust
//! // Async
//! use pros::prelude::*;
//!
//! #[derive(Default)]
//! struct Robot;
//! impl AsyncRobot for Robot {
//!    async fn opcontrol(&mut self) -> Result {
//!       loop {
//!         // Do something
//!        sleep(Duration::from_millis(20)).await;
//!       }
//!    }
//! }
//! async_robot!(Robot);
//! ```
//!
//!```rust
//! // Sync
//! use pros::prelude::*;
//!
//! #[derive(Default)]
//! struct Robot;
//! impl SyncRobot for Robot {
//!   fn opcontrol(&mut self) -> Result {
//!      loop {
//!       // Do something
//!      delay(Duration::from_millis(20));
//!      }
//!    }
//! }
//! sync_robot!(Robot);
//! ```
//!
//! You may have noticed the `#[derive(Default)]` attribute on these Robot structs.
//! If you want to learn why, look at the docs for [`pros_async::async_robot`] or [`pros_sync::sync_robot`].
#![no_std]

#[cfg(feature = "async")]
pub use pros_async as async_runtime;
#[cfg(feature = "core")]
pub use pros_core as core;
#[cfg(feature = "devices")]
pub use pros_devices as devices;
#[cfg(feature = "math")]
pub use pros_math as math;
#[cfg(feature = "panic")]
pub use pros_panic as panic;
#[cfg(feature = "sync")]
pub use pros_sync as sync;
pub use pros_sys as sys;

/// Commonly used features of pros-rs.
/// This module is meant to be glob imported.
pub mod prelude {
    #[cfg(feature = "async")]
    pub use pros_async::{async_robot, block_on, sleep, spawn, AsyncRobot};
    #[cfg(feature = "core")]
    pub use pros_core::{
        dbg, eprint, eprintln,
        error::{PortError, Result},
        io::{BufRead, Read, Seek, Write},
        print, println,
        task::delay,
    };
    #[cfg(feature = "devices")]
    pub use pros_devices::{
        adi::{
            analog::AdiAnalogIn,
            digital::{AdiDigitalIn, AdiDigitalOut},
            encoder::AdiEncoder,
            gyro::AdiGyro,
            motor::AdiMotor,
            potentiometer::{AdiPotentiometer, AdiPotentiometerType},
            pwm::AdiPwmOut,
            solenoid::AdiSolenoid,
            ultrasonic::AdiUltrasonic,
            AdiDevice, AdiPort,
        },
        color::Rgb,
        controller::Controller,
        peripherals::{DynamicPeripherals, Peripherals},
        position::Position,
        screen::{Circle, Line, Rect, Screen, Text, TextFormat, TextPosition, TouchState},
        smart::{
            distance::DistanceSensor,
            expander::AdiExpander,
            gps::GpsSensor,
            imu::InertialSensor,
            link::{Link, RxLink, TxLink},
            motor::{BrakeMode, Direction, Gearset, Motor, MotorControl},
            optical::OpticalSensor,
            rotation::RotationSensor,
            vision::VisionSensor,
            SmartDevice, SmartPort,
        },
    };
    #[cfg(feature = "math")]
    pub use pros_math::{feedforward::MotorFeedforwardController, pid::PidController};
    #[cfg(feature = "sync")]
    pub use pros_sync::{sync_robot, SyncRobot};
}