bnr 0.1.2

Pure Rust implementation of the BNR XFS USB communication protocol
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

use crate::{deinit_handle, init_handle, with_handle, DeviceHandle, Result};

use bnr_xfs::{IntermediateOccurredFn, OperationCompletedFn, StatusOccurredFn};

/// Sends the message to open the device.
///
/// Issues a request through the USB to determine if a BNR is connected, and if a BNR is connected and powered,
/// starts the thread to monitor the BNR and to communicate with it.
///
/// Stops secured communication session to make sure that secured session is not active after starting communication.
///
/// This function takes three callback functions as parameters to handle the different events the BNR can send.
pub fn open(
    op_complete_callback: Option<OperationCompletedFn>,
    intermediate_occurred_callback: Option<IntermediateOccurredFn>,
    status_occurred_callback: Option<StatusOccurredFn>,
) -> Result<()> {
    let handle = DeviceHandle::open(
        op_complete_callback,
        intermediate_occurred_callback,
        status_occurred_callback,
    )?;

    init_handle(handle)
}

/// Sends the message to reset the device.
pub fn reset() -> Result<()> {
    with_handle::<()>(|h| h.reset())
}

/// Sends the message to cancel any currently active transactions/commands.
pub fn cancel() -> Result<()> {
    with_handle::<()>(|h| h.cancel())
}

/// Stops secured communication session if started, ends the communication with the BNR and terminates the thread that has been started by a previous `open` call.
pub fn close() -> Result<()> {
    with_handle::<()>(|h| h.close())
}

/// Reboots the BNR. This call puts the BNR in the same state than a power cycle (power off/on).
pub fn reboot() -> Result<()> {
    with_handle::<()>(|h| h.reboot())
}

/// Stops any active sessions on the BNR device.
pub fn stop_session() -> Result<()> {
    with_handle::<()>(|h| h.stop_session())
}

/// De-initializes the global [DeviceHandle] instance.
///
/// **NOTE** users are required to call either [DeviceHandle::open] or [open()] before further BNR
/// device communication.
pub fn destroy() -> Result<()> {
    deinit_handle()
}