fennec-modbus 0.95.2

Modular Modbus client implementation
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

//! Functions for [Fox ESS MQ2200 (MiniQube)][1], [Solakon ONE][2], and Avocado 22 Pro.
//!
//! # Example
//!
//! ```rust,no_run
//! use anyhow::Result;
//! use fennec_modbus::{
//!     contrib::mini_qube,
//!     protocol::address,
//!     tcp::{UnitId, tokio::Client},
//! };
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let state_of_charge = Client::new("battery.iot.home.arpa:502")
//!         .call::<mini_qube::ReadStateOfCharge>(mini_qube::UNIT_ID, address::Const)
//!         .await?;
//!     Ok(())
//! }
//! ```
//!
//! [1]: https://fox-ess.uk/miniqube/
//! [2]: https://www.solakon.de/products/solakon-one

use crate::{
    contrib::types::{DecawattHours, Percentage, Watts},
    protocol::{address, function::ReadHoldingRegisters},
    tcp,
};

pub mod functions;
pub mod schedule;
pub mod types;

/// Default unit ID ("slave ID") for MiniQube over direct TCP connection.
pub const UNIT_ID: tcp::UnitId = tcp::UnitId::Significant(1);

/// Read the battery state-of-health.
pub type ReadStateOfHealth = ReadHoldingRegisters<address::Const<37624>, Percentage<u16>>;

/// Read the battery design capacity.
pub type ReadDesignCapacity = ReadHoldingRegisters<address::Const<37635>, DecawattHours<u16>>;

/// Read the battery total active power (including EPS).
pub type ReadTotalActivePower = ReadHoldingRegisters<address::Const<39134>, Watts<i32>>;

/// Read the battery Emergency Power Supply active power.
pub type ReadEpsActivePower = ReadHoldingRegisters<address::Const<39216>, Watts<i32>>;

/// Read the battery state-of-charge.
pub type ReadStateOfCharge = ReadHoldingRegisters<address::Const<39424>, Percentage<u16>>;

/// Read the battery total energy exported to grid.
pub type ReadTotalGridExportEnergy =
    ReadHoldingRegisters<address::Const<39621>, DecawattHours<u32>>;

/// Read the battery total energy imported from grid.
pub type ReadTotalGridImportEnergy =
    ReadHoldingRegisters<address::Const<39625>, DecawattHours<u32>>;

/// Read the state-of-charge settings in a single transaction.
///
/// Reading three registers in one transaction reduces network latency and ensures atomic consistency
/// compared to three separate read operations.
pub type ReadStateOfChargeSettings =
    ReadHoldingRegisters<address::Const<46609>, types::StateOfChargeSettings>;

/// Read the system minimum allowed state-of-charge.
///
/// Unlike the reserve state-of-charge, this an absolute minimum for any battery state.
pub type ReadMinimumSystemStateOfCharge =
    ReadHoldingRegisters<address::Const<46609>, Percentage<u16>>;

/// Read maximum allowed state-of-charge.
pub type ReadMaximumStateOfCharge = ReadHoldingRegisters<address::Const<46610>, Percentage<u16>>;

/// Read the minimum allowed state-of-charge in the on-grid mode.
///
/// This is also known as reserve state-of-charge.
pub type ReadMinimumStateOfChargeOnGrid =
    ReadHoldingRegisters<address::Const<46611>, Percentage<u16>>;