oc2_hlapi_v2 0.2.0

A client for the new version of OpenComputers II's HLAPI
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

use std::convert::Infallible;

use uuid::Uuid;

use crate::client::{DeviceBase, HlapiClient, HlapiClientError};

#[derive(Debug, Clone)]
/// A serial device
///
/// [OC2 Docs](https://fnuecke.github.io/oc2/manual/en_us/device/serial.html)
pub struct Serial {
    client: HlapiClient,
    uuid: Uuid,
}

impl Serial {
    /// Gets the address the card is set to
    pub fn get_address(&self) -> Result<u8, HlapiClientError> {
        Ok(self.call("getAddress", &[], &[])?.0)
    }

    /// Gets the base address of the card's registers in memory
    pub fn get_base_address(&self) -> Result<u64, HlapiClientError> {
        Ok(self.call("getBaseAddress", &[], &[])?.0)
    }

    /// Gets the baud rate the card is set to
    pub fn get_baud_rate(&self) -> Result<u32, HlapiClientError> {
        Ok(self.call("getBaudRate", &[], &[])?.0)
    }

    /// Gets the number of data errors since the computer started (how many times traffic arrived at
    /// the wrong baud rate)
    pub fn get_noise_count(&self) -> Result<u32, HlapiClientError> {
        Ok(self.call("getNoiseCount", &[], &[])?.0)
    }

    /// Gets the number of received bytes lost since the computer started
    pub fn get_overrun_count(&self) -> Result<u32, HlapiClientError> {
        Ok(self.call("getOverrunCount", &[], &[])?.0)
    }

    /// Gets how many receive collisions occurred since the computer started
    pub fn get_rx_error_count(&self) -> Result<u32, HlapiClientError> {
        Ok(self.call("getRxErrorCount", &[], &[])?.0)
    }

    /// Gets how many transmit collisions occurred since the computer started
    pub fn get_tx_error_count(&self) -> Result<u32, HlapiClientError> {
        Ok(self.call("getTxErrorCount", &[], &[])?.0)
    }
}

impl DeviceBase for Serial {
    const TYPE: &'static str = "serial";

    type Event = Infallible;

    fn new(client: HlapiClient, uuid: Uuid) -> Result<Self, HlapiClientError> {
        Ok(Self { client, uuid })
    }

    fn uuid_base(&self) -> Uuid {
        self.uuid
    }

    fn client(&self) -> &HlapiClient {
        &self.client
    }
}