nestor-satellite 0.5.0

Rust SDK to write Nestor satellite drivers: pairing, the WebSocket link, text, and WebRTC audio as a feature.
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

//! Write a [Nestor](https://github.com/nestor-home/nestor) satellite in Rust: pair with the core,
//! hold one WebSocket link to it, carry out its intents, report observations and talk in writing,
//! following the `nestor.satellite/1` protocol. With the `voice` feature, it talks aloud too: WebRTC
//! audio, and the device code said with a bundled voice.
//!
//! ```no_run
//! use nestor_satellite::{Device, IDENTIFY, Manifest, Satellite, TokenStore};
//!
//! # async fn run() -> nestor_satellite::Result<()> {
//! let device = Device::new("ecran-cuisine", "raspberry-pi-zero", "cuisine")?;
//! let manifest = Manifest::new(device, [IDENTIFY])?;
//! let tokens = TokenStore::new("~/.config/nestor-satellite/ecran-cuisine.json");
//! let satellite = Satellite::builder("http://nestor.local:8471", manifest, tokens)
//!     .text_display(|text: &str, _last: bool| println!("{text}")) // declares text.display
//!     .text_input() // declares text.input: send lines with satellite.observer().input_text(…)
//!     .build()?;
//! satellite.run().await
//! # }
//! ```
//!
//! Features: `voice` (WebRTC audio with your own [`AudioSource`]/[`AudioSink`]), `audio` (the
//! machine's microphone and speaker through cpal, with `voice`), `cli` (the `nestor-satellite`
//! command).

#[cfg(feature = "voice")]
pub mod audio;
pub mod body;
mod client;
pub mod codes;
#[cfg(feature = "audio")]
pub mod devices;
pub mod dispatch;
mod error;
pub mod i18n;
#[cfg(feature = "voice")]
mod media;
pub mod pairing;
pub mod protocol;
#[cfg(feature = "voice")]
mod speech;
pub mod text;
#[cfg(feature = "voice")]
mod voice;
#[cfg(not(feature = "voice"))]
#[path = "voiceless.rs"]
mod voice;
pub mod wire;

#[cfg(feature = "voice")]
pub use audio::{AudioError, AudioSink, AudioSource, RecordingSink, SilenceSource};
pub use body::{Body, NoBody};
pub use client::{Backoff, Observer, PAIRING_CODE_ENV, PAIRING_URI_ENV, Satellite, SatelliteBuilder};
pub use codes::{Enrollment, EnrollmentCode, PairingUri};
pub use error::{Error, Result};
pub use i18n::Language;
pub use pairing::{Display, Enroller, TokenStore, Voice};
pub use protocol::{
    AUDIO_CAPTURE, AUDIO_PLAYBACK, Behavior, Capability, Device, EXPRESSION, EnrollmentMethod, Expression, HEAD_MOTION,
    IDENTIFY, Manifest, PERSON_DETECTION, PROTOCOL, PairingMethod, ProtocolError, SPEECH_ACTIVITY, Sdk, TEXT_DISPLAY,
    TEXT_INPUT,
};
pub use text::TextDisplay;