eosc-rs 2.0.0

A wrapper for EOS v2 OSC commands
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

use std::{net::IpAddr, vec};

use rosc::{OscError, OscType};
use snafu::Snafu;

use crate::{
    channel::Channel,
    osc_sender::{OscSender, OscSenderError},
};

pub struct EosDesk {
    osc_sender: OscSender,
}

#[derive(Debug, Snafu)]
pub enum EosDeskError {
    #[snafu(display("failed to create EOS OSC UDP Socket on {to:#?}"))]
    FailedUDPSocket {
        source: std::io::Error,
        to: (IpAddr, u16),
    },

    #[snafu(display("failed to encode OSC packet with destination {address}"))]
    FailedPacketEncoding { source: OscError, address: String },

    #[snafu(display("failed to send UDP packet with data: {data:#?} to {to:#?}"))]
    FailedUDPSend {
        source: std::io::Error,
        data: Vec<u8>,
        to: (IpAddr, u16),
    },
}

impl EosDesk {
    /// Creates an EosDesk that sends messages to the desk at desk
    /// host: What to bind the UDP port to, (0.0.0.0, 8001) is a sensible default
    /// desk: The EOS desk you are connecting to, so the IP of said desk and it's OSC port (8000 by default)
    pub fn new(host: (IpAddr, u16), desk: (IpAddr, u16)) -> Result<Self, OscSenderError> {
        let osc_sender = OscSender::new(host, desk)?;

        Ok(Self { osc_sender })
    }

    /// Executes the stated command. Auto executes by appending ENTER to the end of said command
    /// command: The command to be sent to the desk. e.g: "GROUP 5 FOCUS PALETTE 2"
    pub fn command(&self, command: &str) -> Result<(), OscSenderError> {
        self.osc_sender.send_osc(
            "/eos/newcmd".to_string(),
            vec![OscType::String(format!("{command} ENTER"))],
        )?;

        Ok(())
    }

    /// Creates a channel to be used later.
    pub fn channel(&'_ self, channel: u32) -> Channel<'_> {
        Channel {
            osc_sender: &self.osc_sender,
            channel,
        }
    }

    /// Records the cue at cue number
    /// cue_number: what number is the cue to be recorded? A string to stop floating point errors.
    pub fn record_cue(&self, cue_number: &str, time: f32) -> Result<(), OscSenderError> {
        let command: String = format!("Record Cue {} Time {}", cue_number, time);
        self.command(&command)
    }

    /// Goes to the next cue
    pub fn go(&self) -> Result<(), OscSenderError> {
        self.osc_sender
            .send_osc(" /eos/key/go_0".to_string(), vec![])
    }

    /// Goes to the specified cue
    /// cue: The cue to go to, a string to avoid floating point errors
    pub fn fire(&self, cue: &str) -> Result<(), OscSenderError> {
        self.osc_sender.send_osc(
            " /eos/cue/fire".to_string(),
            vec![OscType::String(cue.to_string())],
        )
    }
}