iec104 0.3.0

A rust implementation of the IEC-60870-5-104 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
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

use snafu::Snafu;

use super::model::PointAddress;
use crate::{server::error::ServerError, types_id::TypeId};

/// Logical failure updating a point (model or broadcast).
#[derive(Debug, Snafu)]
#[snafu(visibility(pub), context(suffix(false)))]
pub enum SetPointError {
	/// No point registered at this address.
	#[snafu(display("unknown point: {address}"))]
	UnknownPoint { address: PointAddress },
	/// The new value variant does not match the registered point type.
	#[snafu(display("type mismatch for point {address}: expected {expected:?}, got {got:?}"))]
	TypeMismatch { address: PointAddress, expected: TypeId, got: TypeId },
	/// Spontaneous ASDU could not be sent to all connections.
	#[snafu(display("failed to broadcast spontaneous ASDU"))]
	BroadcastFailed { source: ServerError },
}

/// Error returned by
/// [`super::RtuServerHandle`](crate::rtu_server::RtuServerHandle) when the
/// actor is gone, register/unregister/bulk-register conflicts, or a
/// [`SetPointError`] occurs.
#[derive(Debug, Snafu)]
#[snafu(visibility(pub), context(suffix(false)))]
pub enum RtuHandleError {
	/// The RTU actor task exited or the channel was closed.
	#[snafu(display("RTU server is no longer running"))]
	Disconnected,
	/// No response from the actor (task panic or drop).
	#[snafu(display("RTU server actor stopped before responding"))]
	ActorStopped,
	/// [`super::RtuServerHandle::register_point`](crate::rtu_server::RtuServerHandle::register_point)
	/// was called for an existing address.
	#[snafu(display("Point already registered: {address}"))]
	AlreadyRegistered { address: PointAddress },
	/// At least one [`PointAddress`] appears more than once in the iterator
	/// passed to
	/// [`super::RtuServerHandle::register_points`](crate::rtu_server::RtuServerHandle::register_points).
	#[snafu(display("register_points input contains duplicate point address(es)"))]
	DuplicateAddressInInput,
	/// [`super::RtuServerHandle::unregister_point`](crate::rtu_server::RtuServerHandle::unregister_point)
	/// was called for an unknown address.
	#[snafu(display("Point not registered: {address}"))]
	NotRegistered { address: PointAddress },
	/// Interrogation group must be in **1..=16** (IEC 60870-5-101).
	#[snafu(display("invalid interrogation group: {group} (expected 1..=16)"))]
	InvalidInterrogationGroup { group: u8 },
	/// Counter interrogation group must be in **1..=4** (IEC 60870-5-101).
	#[snafu(display("invalid counter interrogation group: {group} (expected 1..=4)"))]
	InvalidCounterInterrogationGroup { group: u8 },
	/// [`super::model::PointValue::is_counter_integration`] is required when a
	/// counter group is set.
	#[snafu(display("counter interrogation group applies only to M_IT_* point values"))]
	CounterGroupRequiresCounterPoint,
	/// [`super::RtuServerHandle::set_point`](crate::rtu_server::RtuServerHandle::set_point) failed.
	#[snafu(display("{source}"))]
	SetPoint { source: SetPointError },
}

impl From<SetPointError> for RtuHandleError {
	fn from(source: SetPointError) -> Self {
		Self::SetPoint { source }
	}
}

/// Failure while handling `C_IC_NA_1` on the wire (internal; logged in ingress
/// handler).
#[derive(Debug, Snafu)]
#[snafu(visibility(pub(crate)))]
pub(crate) enum InterrogationError {
	/// ASDU is not `C_IC_NA_1` activation with a handled QOI (e.g. unused
	/// qualifier).
	#[snafu(display("not handled as interrogation by RTU server"))]
	Skipped,
	#[snafu(display("failed to send interrogation activation confirmation: {source}"))]
	SendConfirmation { source: ServerError },
	#[snafu(display("failed to send interrogation data ASDU: {source}"))]
	SendData { source: ServerError },
	#[snafu(display("failed to send interrogation activation termination: {source}"))]
	SendTermination { source: ServerError },
}