sunspec 0.8.0

SunSpec 1.1 compliant library with tokio support
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

use thiserror::Error;

use crate::model::{Model, ModelAddr};
use crate::models::Models;

use super::ModbusError;

impl<M: Model> Copy for ModelAddr<M> {}

impl<M: Model> Clone for ModelAddr<M> {
    fn clone(&self) -> Self {
        *self
    }
}

/// For every discovered but unknown model to this library
/// this structure is returned.
#[derive(Debug)]
pub struct UnknownModel {
    /// ID of the discovered model
    pub id: u16,
    /// Address of the discovered model
    pub addr: u16,
    /// Length of the discovered model
    pub len: u16,
}

/// The result of a SunSpec model discovery.
#[derive(Debug)]
pub struct DiscoveryResult {
    /// The addresses of the discovered models.
    pub models: Models,
    /// Unknown models with their addresses and lengths.
    pub unknown_models: Vec<UnknownModel>,
}

/// This error is returned when an error occurs during model discovery.
#[derive(Debug, Error)]
pub enum DiscoveryError {
    /// Communication error.
    #[error("Modbus error: {0}")]
    ModbusError(#[from] ModbusError),
    /// The Modbus slave did not provide the "SunS" header at the well known
    /// addresses 0, 40000 or 50000.
    #[error("SunS identifier not found")]
    SunsIdentifierNotFound,
    /// The addresses would overflow while discovering modules. The slave
    /// device seams to be returning garbage data.
    #[error("Address overflow detected")]
    AddressOverflow,
}