nscope 1.0.0

Communication with nScope devices
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

/***************************************************************************************************
 *
 *  nLabs, LLC
 *  https://nscope.org
 *  Copyright(c) 2020. All Rights Reserved
 *
 *  This file is part of the nScope API
 *
 **************************************************************************************************/

//! This crate provides an interface to the [nScope](https://nscope.org)
//!
//! # Usage
//!
//! This crate is [on crates.io](https://crates.io/crates/nscope) and can be
//! used by adding `nscope` to the dependencies in your project's `Cargo.toml`.
//!
//!
//! # Example
//!
//! ```rust,no_run
//! extern crate nscope;
//! use nscope::LabBench;
//!
//! fn main() {
//!     // Create a LabBench
//!     let bench = LabBench::new().expect("Cannot create LabBench");
//!
//!     // Print the bench to show a list of detected nScopes
//!     println!("{:?}", bench);
//!
//!     // Open an nScope
//!     let nscope = bench.open_first_available(true).expect("Cannot open nScope");
//!
//!     // Turn on analog output channel A1
//!     nscope.a1.turn_on();
//!
//!     // Trigger an auto-triggered sweep of 20 samples at 4.0 Hz sample rate
//!     let sweep_handle = nscope.request(4.0, 20, None);
//!
//!     // Loop through the received data, blocking on each sample until it arrives
//!     for sample in sweep_handle.receiver {
//!         // Print the sample data
//!         println!("{:?}", sample.data);
//!     }
//!
//!     // Turn off the analog output channel A1
//!     nscope.a1.turn_off();
//!
//! }
//! ```


mod lab_bench;
mod scope;
mod version;

pub use lab_bench::LabBench;
pub use lab_bench::NscopeLink;
pub use scope::Nscope;
pub use scope::power::*;
pub use scope::pulse_output::*;
pub use scope::analog_output::*;
pub use scope::analog_input::*;
pub use scope::data_requests::*;
pub use scope::trigger::*;
pub use version::version;