moonbit-iec104
Portable IEC 60870-5-104 protocol core for SCADA, gateways, and deterministic simulation.
iec104
scada
telecontrol
protocol
moon add hhxhhx78/moonbit-iec104@0.2.0
Download zipAuthor
Version
0.2.0
License
Apache-2.0
Repository
Last updated
1 hour ago
Downloads
2
README#moonbit-iec104
一个面向 SCADA、变电站自动化、配电网关和协议仿真的 IEC 60870-5-104 协议核心。项目使用 MoonBit 编写，库层不绑定 TCP 实现或操作系统 I/O，便于嵌入网关、测试工具和确定性仿真器。
#项目定位
本项目覆盖 IEC 104 链路层与常用应用层数据模型，重点放在可验证的二进制编解码、链路状态、序号窗口、信息对象和边界行为。网络传输由调用方接入，协议核心因此可以在 native、wasm-gc 等目标上复用。
#核心能力
- APCI I/S/U 帧编解码、15 位发送/接收序号和序号窗口。
- STARTDT、STOPDT、TESTFR 链路状态机、定时器和流式 APDU 解析。
- IEC 104 常用 Type ID、VSQ、传送原因、公共地址和信息体地址模型。
- 单点、双点、步位、归一化值、标度值、短浮点值、累计量及命令对象。
- CP24Time2a、CP56Time2a、质量描述符、地址序列和带时标 ASDU 编解码。
- 点表、历史变更、总召唤/计数量召唤、读命令、时钟同步和命令策略。
- 资源限制、重放保护、CRC、帧统计、健康报告和确定性仿真工作负载。
#快速开始
需要 MoonBit stable 工具链。首次使用时执行：
moon update
moon fmt
moon check --deny-warn --target all
moon build --target wasm-gc
moon test --deny-warn --target wasm-gc运行示例 CLI：
moon run cmd/main
moon run cmd/main -- --help
moon run cmd/main -- --benchmark在库代码中构造并编码一个 I 帧：
///|
let payload = @hhxhhx78/moonbit-iec104.normalized_value_asdu(3, 1, 2300, 0)
///|
let apdu = @hhxhhx78/moonbit-iec104.encode_frame(
@hhxhhx78/moonbit-iec104.information_frame(0, 0, payload),
)#CLI
cmd/main 提供一个不依赖外部服务的可重复示例：默认编码一个归一化测量值 I 帧；--benchmark 执行固定的 10,000 帧编解码工作负载并输出帧数、字节数和校验和；--help 显示用法。宿主机耗时由基准命令外部测量，避免把平台时钟引入协议核心。
#架构
| 层次 | 主要文件 | 职责 |
|---|---|---|
| 链路与帧 | frame_types.mbt, codec.mbt, validation.mbt, state_machine.mbt | APCI、ASDU 基础模型、校验和链路状态 |
| 应用数据 | protocol_domain.mbt, quality.mbt, time_tags.mbt, application_objects.mbt, extended_asdu.mbt | Type ID、地址、质量、时标和信息对象 |
| 服务与状态 | transport_layer.mbt, application_services.mbt, point_store.mbt | 序号窗口、定时器、召唤事务、点表和历史 |
| 工具与可靠性 | wire_tools.mbt, security_limits.mbt, diagnostics_metrics.mbt, health_report.mbt | 字节工具、资源保护、指标和诊断 |
| 仿真与契约 | simulation.mbt, conformance_catalog.mbt, protocol_profiles.mbt, benchmark_api.mbt | 确定性仿真、类型目录、能力协商和基准接口 |
| 示例 | cmd/main | 可运行的最小 CLI |
#基准
基准工作负载由 run_benchmark_workload 定义，输入、输出字节数和 CRC 校验和均是确定的；宿主机实测结果记录在 BENCHMARKS.md，包含执行环境、命令、重复次数和原始输出。重新测量：
1..5 | ForEach-Object { Measure-Command { moon run cmd/main -- --benchmark } }该数据用于比较同一环境下的回归趋势，不代表所有设备或网络部署的吞吐承诺。
#测试
测试覆盖帧编解码、链路状态、Type ID 和地址边界、CP24/CP56 闰年与无效日期、质量位、签名测量值、ASDU 截断/尾随字节、序号回绕、流式输入、点表历史、服务事务、资源限制、CRC 和确定性基准。推荐在本地分别运行：
moon check --deny-warn --target all
moon test --deny-warn --target wasm-gc
moon test --deny-warn --target native#CI
.github/workflows/check.yml 在 Ubuntu、macOS 和 Windows 上安装 MoonBit stable，执行版本检查、依赖更新、格式检查、接口文件一致性、所有目标检查、wasm-gc 构建和测试。CI 使用最小只读仓库权限；本地若缺少某个后端运行时，应以对应平台 CI 结果和明确的本地环境提示为准。
#许可证
本项目采用 Apache License 2.0。
#AdmissionDecision
#ApduParseResult
Incremental APDU parsing result for TCP or serial gateway adapters.
#ApduStreamDecoder
A portable byte accumulator for stream transports.
#ApduStreamDecoder::available_frames
Number of complete frames available in a buffered stream.
#ApduStreamDecoder::new
#ApduStreamDecoder::next
Parse and remove the first complete APDU, preserving partial data.
#ApduStreamDecoder::push
#ApplicationObject
pub struct ApplicationObject {
address : InformationAddress
type_id : ApplicationType
value : ApplicationValue
time_tag : TimeTag?
} derive(Eq, Debug)An address-qualified application object with an optional time tag.
#ApplicationObject::address
#ApplicationObject::is_command
#ApplicationObject::is_measurement
#ApplicationObject::new
fn ApplicationObject::new(address : InformationAddress, value : ApplicationValue, time_tag? : TimeTag) -> Result[ApplicationObject, String]Construct an application object and optionally attach its standard time tag.
#ApplicationObject::summary
Return a type-tagged object as a stable compact summary tuple.
#ApplicationObject::time_tag
#ApplicationObject::type_id
#ApplicationObject::validate
Validate an application object before placing it in an ASDU.
#ApplicationObject::value
#ApplicationType
pub enum ApplicationType {
MSpNa
MSpTa
MDpNa
MDpTa
MStNa
MStTa
MBoNa
MBoTa
MMeNa
MMeTa
MMeNb
MMeTb
MMeNc
MMeTc
MItNa
MItTa
MEpTa
MEpTb
MEpTc
MPsNa
MMeNd
MSpTb
MDpTb
MStTb
MBoTb
MMeTd
MMeTe
MMeTf
MItTb
MEpTd
MEpTe
MEpTf
MEiNa
CScNa
CDcNa
CRcNa
CSeNa
CSeNb
CSeNc
CBoNa
CIcNa
CCiNa
CRdNa
CCsNa
CTsNa
CRpNa
UnknownType(Int)
} derive(Eq, Debug)Standard IEC 104 application type identifiers.
#ApplicationType::has_time_tag
Whether a type carries a CP24 or CP56 time tag.
#ApplicationType::is_control
Whether an application type belongs to control direction data.
#ApplicationType::is_monitoring
Whether an application type belongs to monitor direction data.
#ApplicationType::number
Return an IEC 104 type identifier number.
#ApplicationType::value_width
Preferred information-object payload width, excluding IOA and time tag.
#ApplicationValue
pub enum ApplicationValue {
SinglePointValue(SinglePointValue)
DoublePointValue(DoublePointValue)
StepPositionValue(StepPositionValue)
BitStringValue(UInt)
NormalizedMeasurement(NormalizedValue)
ScaledMeasurement(ScaledValue)
ShortFloatMeasurement(ShortFloatValue)
BinaryCounterMeasurement(BinaryCounterValue)
SingleCommand(Bool, Int)
DoubleCommand(Int, Int)
RegulatingStepCommand(Int, Int)
NormalizedSetPoint(Int, Int)
ScaledSetPoint(Int, Int)
ShortFloatSetPoint(Float, Int)
BitStringCommand(UInt)
InterrogationCommand(Int)
CounterInterrogationCommand(Int)
ReadCommand
ClockSyncCommand(Cp56Time)
TestCommand(Int)
ResetCommand(Int)
DelayCommand(Int)
EndOfInitialization(Int)
RawValue(Bytes)
} derive(Eq, Debug)Values carried by standard IEC 104 information objects.
#AsduEnvelope
pub struct AsduEnvelope {
type_id : ApplicationType
sequence : Bool
cause : CauseOfTransmission
common_address : CommonAddress
objects : Array[ApplicationObject]
} derive(Eq, Debug)A complete ASDU envelope with address-qualified application objects.
#AsduEnvelope::common_address
#AsduEnvelope::new
fn AsduEnvelope::new(type_id : ApplicationType, sequence : Bool, cause : CauseOfTransmission, common_address : CommonAddress, objects : Array[ApplicationObject]) -> Result[AsduEnvelope, Diagnostic]Construct an ASDU envelope and check its object/type relationship.
#AsduEnvelope::objects
#AsduHeader
Common information object address and cause of transmission.
#BenchmarkCase
A repeatable benchmark case with a deterministic workload definition.
#BenchmarkCase::new
fn BenchmarkCase::new(name : String, rounds : Int, payload_size : Int, target : String) -> Result[BenchmarkCase, String]#BenchmarkResult
pub struct BenchmarkResult {
case : BenchmarkCase
encoded_frames : Int
encoded_bytes : Int
checksum : UInt
elapsed_micros : Int
} derive(Eq, Debug)#BenchmarkResult::elapsed_micros
#BenchmarkResult::encoded_bytes
#BenchmarkResult::encoded_frames
#BenchmarkResult::frames_per_second
#BenchmarkResult::megabytes_per_second
#BenchmarkResult::new
fn BenchmarkResult::new(case : BenchmarkCase, workload : BenchmarkWorkload, elapsed_micros : Int) -> Result[BenchmarkResult, String]#BenchmarkSuite
#BenchmarkSuite::add
#BenchmarkSuite::run
fn BenchmarkSuite::run(self : BenchmarkSuite, elapsed_micros : Array[Int]) -> Result[Array[BenchmarkResult], String]Run a deterministic benchmark workload; elapsed time is supplied by the host.
#BenchmarkWorkload
A repeatable workload used by local benchmark runs.
#BenchmarkWorkload::encoded_bytes
#BenchmarkWorkload::encoded_frames
#BenchmarkWorkload::payload_size
#BinaryCounterValue
32-bit binary counter value with sequence and overflow flags.
#BinaryCounterValue::new
fn BinaryCounterValue::new(value : UInt, sequence? : Int, carry? : Bool, adjusted? : Bool, invalid? : Bool) -> Result[BinaryCounterValue, String]#BinaryCounterValue::sequence
#ByteCursor
A bounds-checked cursor for binary protocol decoders.
#ByteCursor::read_bytes
#ByteCursor::seek
#ByteCursor::skip
#ByteStatistics
Per-byte statistics useful for fixture and link diagnostics.
#ByteWriter
A small writer used by application-specific extensions.
#ByteWriter::push_u16
#ByteWriter::push_u24
#Cause
Standard causes of transmission used by IEC 104 application services.
#CauseCategory
Cause of transmission category. The numeric value is kept separate from
the qualifier so applications can preserve vendor extensions.
#CauseCategory::number
Return the standard six-bit cause value.
#CauseOfTransmission
pub struct CauseOfTransmission {
category : CauseCategory
number : Int
positive : Bool
test_flag : Bool
originator : Int
qualifier : Int
} derive(Eq, Debug)Full cause of transmission, including the originator and qualifier bits.
#CauseOfTransmission::flags
Return the four low flag bits in the IEC COT representation.
#CauseOfTransmission::from_number
fn CauseOfTransmission::from_number(number : Int, positive? : Bool, test_flag? : Bool, originator? : Int, qualifier? : Int) -> Result[CauseOfTransmission, String]Construct a cause from a raw standard number while preserving extension data.
#CauseOfTransmission::new
fn CauseOfTransmission::new(category : CauseCategory, positive? : Bool, test_flag? : Bool, originator? : Int, qualifier? : Int) -> Result[CauseOfTransmission, String]Construct a validated cause of transmission.
#CauseOfTransmission::originator
Return the originator address.
#CauseOfTransmission::qualifier
Return the qualifier value.
#CauseOfTransmission::raw
Return the raw cause number.
#ClockSyncTransaction
pub struct ClockSyncTransaction {
request : ServiceRequest
status : ServiceStatus
received : Cp56Time?
applied_at : Int?
} derive(Debug)Clock synchronization service with a deterministic skew calculation.
#ClockSyncTransaction::activate
#ClockSyncTransaction::apply
fn ClockSyncTransaction::apply(self : ClockSyncTransaction, timestamp : Cp56Time, applied_at : Int) -> Result[Int, String]#ClockSyncTransaction::new
#ClockSyncTransaction::received
#ClockSyncTransaction::status
#CommandOutcome
pub struct CommandOutcome {
accepted : Bool
status : ServiceStatus
object : ApplicationObject?
message : String
} derive(Debug)#CommandPolicy
A command authorization policy for host applications.
#CommandPolicy::allow
#CommandPolicy::deny
#CommandPolicy::permits
#CommandPolicy::set_max_qualifier
#CommandQueue
pub struct CommandQueue {
pending : Array[ApplicationObject]
completed : Array[CommandOutcome]
limit : Int
} derive(Debug)A FIFO command queue with explicit outcomes.
#CommandQueue::enqueue
#CommandQueue::outcomes
#CommandQueue::process_one
#CommonAddress
Common address of ASDU values. Zero is reserved for an unassigned station.
#CommonAddress::is_global
Return whether this common address is the global station address.
#CommonAddress::new
Create a two-byte common address.
#CommonAddress::number
Return the numeric common address.
#ConformanceReport
pub struct ConformanceReport {
valid : Bool
type_id : ApplicationType
object_count : Int
expected_width : Int
actual_width : Int
issues : Array[String]
} derive(Eq, Debug)An ASDU consistency report that can be shown in CLI diagnostics.
#ConformanceReport::actual_width
#ConformanceReport::add_issue
#ConformanceReport::expected_width
#ConformanceReport::issues
#ConformanceReport::new
#ConformanceReport::object_count
#ConformanceReport::type_id
#ConnectionParameters
IEC 104 link-layer timing and window parameters.
#ConnectionParameters::default
Default parameters from the commonly deployed IEC 104 profile.
#ConnectionParameters::new
fn ConnectionParameters::new(k : Int, w : Int, t0_seconds : Int, t1_seconds : Int, t2_seconds : Int, t3_seconds : Int) -> Result[ConnectionParameters, String]Validate and construct link-layer parameters.
#CounterInterrogationRequest
pub struct CounterInterrogationRequest {
common_address : CommonAddress
qualifier : Int
created_at : Int
} derive(Eq, Debug)Counter-interrogation request used for historical counter snapshots.
#CounterInterrogationRequest::common_address
#CounterInterrogationRequest::created_at
#CounterInterrogationRequest::new
fn CounterInterrogationRequest::new(common_address : CommonAddress, qualifier : Int, created_at : Int) -> Result[CounterInterrogationRequest, String]#CounterInterrogationRequest::qualifier
#Cp24Time
Three-byte CP24Time2a value used by short time-tagged ASDUs.
#Cp24Time::from_bytes
#Cp56Time
Seven-byte CP56Time2a timestamp.
#Cp56Time::calendar_year
Return the four-digit calendar year represented by the protocol year.
#Cp56Time::from_bytes
#Cp56Time::new
Construct a CP56 timestamp. The year is the two-digit protocol year.
#Cp56Time::ordering_key
A deterministic date-time ordering key.
#Diagnostic
Structured diagnostic returned by validation and service layers.
#Diagnostic::new
#Diagnostic::to_line
Produce a compact human-readable diagnostic line for CLI and logs.
#DiagnosticKind
A stable classification for protocol diagnostics.
#DoublePointValue
Double point information value. IEC 104 reserves state value 0 and 3.
#DoublePointValue::from_byte
#DoublePointValue::new
#DoublePointValue::quality
#EventLog
In-memory event log for examples, tests and host applications.
#Frame
A decoded APCI frame. payload contains the ASDU for I frames.
#Frame::kind
Stable accessors for frame values used by host integrations.
#FrameKind
IEC 60870-5-104 frame kinds.
#FrameMetrics
Counters for protocol throughput and error monitoring.
#FrameMetrics::record_decoded
#FrameMetrics::record_encoded
#FrameMetrics::record_sequence_error
#FrameMetrics::record_service_failure
#GatewayAdmissionPolicy
pub struct GatewayAdmissionPolicy {
max_objects : Int
allow_monitoring : Bool
allow_control : Bool
allowed_types : Array[ApplicationType]
denied_types : Array[ApplicationType]
} derive(Eq, Debug)Admission policy applied before a gateway accepts an ASDU.
#GatewayAdmissionPolicy::allow_type
fn GatewayAdmissionPolicy::allow_type(self : GatewayAdmissionPolicy, type_id : ApplicationType) -> Unit#GatewayAdmissionPolicy::default
#GatewayAdmissionPolicy::deny_type
fn GatewayAdmissionPolicy::deny_type(self : GatewayAdmissionPolicy, type_id : ApplicationType) -> Unit#GatewayAdmissionPolicy::evaluate
fn GatewayAdmissionPolicy::evaluate(self : GatewayAdmissionPolicy, envelope : AsduEnvelope) -> Result[Unit, String]#GatewayAdmissionPolicy::max_objects
#GatewayAdmissionPolicy::new
fn GatewayAdmissionPolicy::new(max_objects : Int, allow_monitoring? : Bool, allow_control? : Bool) -> Result[GatewayAdmissionPolicy, String]#GatewayCounters
Counters exposed by the gateway for operational dashboards.
#GatewayDispatch
pub enum GatewayDispatch {
Forwarded(GatewayEnvelope, GatewayRoute)
Dropped(GatewayEnvelope, String)
} derive(Debug)#GatewayDispatch::envelope
#GatewayDispatch::is_forwarded
#GatewayEnvelope
pub struct GatewayEnvelope {
ingress : Int
egress : Int
common_address : CommonAddress
asdu : AsduEnvelope
received_at : Int
trace_id : String
} derive(Debug)An ASDU together with gateway ingress metadata.
#GatewayEnvelope::common_address
#GatewayEnvelope::new
fn GatewayEnvelope::new(ingress : Int, egress : Int, asdu : AsduEnvelope, received_at : Int, trace_id? : String) -> Result[GatewayEnvelope, String]#GatewayMode
Lifecycle of an in-memory IEC 104 gateway runtime.
#GatewayRoute
pub struct GatewayRoute {
id : Int
source : Int
destination : Int
common_address : CommonAddress?
type_ids : Array[ApplicationType]
enabled : Bool
priority : Int
} derive(Eq, Debug)A route between two logical gateway endpoints.
#GatewayRoute::common_address
#GatewayRoute::new
fn GatewayRoute::new(id : Int, source : Int, destination : Int, common_address? : CommonAddress, type_ids? : Array[ApplicationType], priority? : Int) -> Result[GatewayRoute, String]#GatewayRoute::set_enabled
#GatewayRoute::type_ids
#GatewayRouteTable
Deterministic route table. Higher priority wins; ties use the lower route id.
#GatewayRouteTable::add
#GatewayRouteTable::new
#GatewayRouteTable::remove
#GatewayRouteTable::routes
#GatewayRouteTable::select
fn GatewayRouteTable::select(self : GatewayRouteTable, source : Int, common_address : CommonAddress, type_id : ApplicationType) -> GatewayRoute?#GatewayRouteTable::set_enabled
#GatewayRuntime
pub struct GatewayRuntime {
mode : GatewayMode
routes : GatewayRouteTable
policy : GatewayAdmissionPolicy
inbound : Array[GatewayEnvelope]
outbound : Array[GatewayEnvelope]
dead_letters : Array[GatewayEnvelope]
stores : Array[GatewayStoreBinding]
counters : GatewayCounters
max_queue : Int
last_error : String?
} derive(Debug)Deterministic in-memory routing runtime. Network adapters can feed its queue
and poll the outbound queue without coupling protocol logic to a socket API.
#GatewayRuntime::add_route
#GatewayRuntime::attach_store
fn GatewayRuntime::attach_store(self : GatewayRuntime, binding : GatewayStoreBinding) -> Result[Unit, String]#GatewayRuntime::begin_drain
#GatewayRuntime::counters
#GatewayRuntime::dead_letter_len
#GatewayRuntime::diagnostics
Return a stable, line-oriented diagnostics report for logs and health probes.
#GatewayRuntime::drain
#GatewayRuntime::enqueue
fn GatewayRuntime::enqueue(self : GatewayRuntime, envelope : GatewayEnvelope) -> Result[Unit, String]#GatewayRuntime::ingest_to_store
fn GatewayRuntime::ingest_to_store(self : GatewayRuntime, envelope : GatewayEnvelope) -> Result[Int, String]#GatewayRuntime::new
fn GatewayRuntime::new(max_queue : Int, route_capacity? : Int, policy? : GatewayAdmissionPolicy) -> Result[GatewayRuntime, String]#GatewayRuntime::poll_outbound
#GatewayRuntime::remove_route
#GatewayRuntime::set_policy
#GatewayRuntime::snapshot
#GatewayRuntime::take_dead_letter
#GatewaySnapshot
pub struct GatewaySnapshot {
mode : GatewayMode
routes : Int
queue : Int
outbound : Int
dead_letters : Int
counters : GatewayCounters
last_error : String?
} derive(Eq, Debug)Snapshot suitable for a health endpoint or a periodic metrics export.
#GatewaySnapshot::counters
#GatewayStoreBinding
pub struct GatewayStoreBinding {
common_address : CommonAddress
store : PointStore
accepted : Int
rejected : Int
} derive(Debug)A point store attached to one common address in the gateway.
#GatewayStoreBinding::accepted
#GatewayStoreBinding::common_address
#GatewayStoreBinding::ingest
fn GatewayStoreBinding::ingest(self : GatewayStoreBinding, envelope : GatewayEnvelope) -> Result[Int, String]#GatewayStoreBinding::new
fn GatewayStoreBinding::new(common_address : CommonAddress, history_limit? : Int) -> Result[GatewayStoreBinding, String]#GatewayStoreBinding::rejected
#GatewayStoreBinding::store
#HealthReport
pub struct HealthReport {
state : HealthState
score : Int
checks : Array[String]
warnings : Array[String]
} derive(Eq, Debug)#HealthReport::new
fn HealthReport::new(state : HealthState, score : Int, checks : Array[String], warnings : Array[String]) -> HealthReport#HealthState
Health state suitable for gateway readiness endpoints.
#InformationAddress
The three-byte information object address used by IEC 104.
#InformationAddress::from_octets
fn InformationAddress::from_octets(low : Int, middle : Int, high : Int) -> Result[InformationAddress, String]Construct an information object address from its three octets.
#InformationAddress::high
Return the most significant address octet.
#InformationAddress::is_broadcast
Return whether the address is the protocol's broadcast address.
#InformationAddress::low
Return the least significant address octet.
#InformationAddress::middle
Return the middle address octet.
#InformationAddress::new
Create an information object address in the inclusive 0..0xffffff range.
#InformationAddress::number
Return the numeric address.
#InformationObject
IEC information object values supported by the first stable API.
#Interrogation
pub struct Interrogation {
request : InterrogationRequest
phase : InterrogationPhase
objects_sent : Int
}Small deterministic transaction tracker; data transport remains caller-owned.
#Interrogation::record
#InterrogationPhase
Phases emitted by an interrogation transaction.
#InterrogationPlan
pub struct InterrogationPlan {
request : InterrogationRequest
objects : Array[ApplicationObject]
batch_size : Int
cursor : Int
status : ServiceStatus
} derive(Debug)A total interrogation plan which can be emitted in deterministic batches.
#InterrogationPlan::activate
#InterrogationPlan::new
fn InterrogationPlan::new(request : InterrogationRequest, objects : Array[ApplicationObject], batch_size? : Int) -> Result[InterrogationPlan, String]#InterrogationPlan::next_batch
fn InterrogationPlan::next_batch(self : InterrogationPlan) -> Result[Array[ApplicationObject], String]#InterrogationPlan::request
#InterrogationPlan::status
#InterrogationPlan::terminate
#InterrogationRequest
A total interrogation request, suitable for a master command queue.
#InterrogationRequest::new
#LengthHistogram
A compact histogram for APDU length distribution.
#LengthHistogram::bucket
#LengthHistogram::observe
#LinkState
#MeasurementState
Quality-preserving measurement classification used by point stores.
#MetricsSnapshot
Snapshot an evolving metrics object for export or health endpoints.
#MetricsSnapshot::success_rate
#NegotiationDecision
#NormalizedValue
Normalized signed 16-bit measurement.
#NormalizedValue::new
fn NormalizedValue::new(value : Int, quality? : QualityDescriptor) -> Result[NormalizedValue, String]#NormalizedValue::quality
#Outstation
A compact in-memory outstation used in tests, demos and protocol simulations.
#Outstation::set_normalized
#Outstation::set_single
#Outstation::snapshot_normalized
#Outstation::snapshot_single
#PointChange
pub struct PointChange {
kind : PointChangeKind
address : InformationAddress
revision : Int
timestamp : Int
message : String
} derive(Eq, Debug)#PointChange::new
fn PointChange::new(kind : PointChangeKind, address : InformationAddress, revision : Int, timestamp : Int, message : String) -> PointChange#PointChangeKind
A change recorded by the point store.
#PointDirection
Point direction used by a station data model.
#PointFilter
pub struct PointFilter {
direction : PointDirection?
type_id : ApplicationType?
first_address : InformationAddress?
last_address : InformationAddress?
only_valid : Bool
source : String?
} derive(Eq, Debug)Query constraints for a point-store snapshot.
#PointFilter::from_source
#PointFilter::with_range
fn PointFilter::with_range(self : PointFilter, first : InformationAddress, last : InformationAddress) -> PointFilter#PointFilter::with_type
#PointRecord
pub struct PointRecord {
address : InformationAddress
type_id : ApplicationType
value : ApplicationValue
time_tag : TimeTag?
revision : Int
updated_at : Int
source : String
} derive(Eq, Debug)A stored value with its protocol identity and update metadata.
#PointRecord::new
fn PointRecord::new(object : ApplicationObject, updated_at : Int, revision? : Int, source? : String) -> PointRecord#PointSnapshot
An immutable snapshot of values that can be used to build a response ASDU.
#PointStore
pub struct PointStore {
common_address : CommonAddress
points : Map[Int, PointRecord]
history : Array[PointChange]
history_limit : Int
} derive(Debug)Deterministic point store for outstations, simulators and gateways.
#PointStore::addresses
#PointStore::get
#PointStore::new
fn PointStore::new(common_address : CommonAddress, history_limit? : Int) -> Result[PointStore, String]#PointStore::objects
Convert a store snapshot into application objects for interrogation.
#PointStore::query
#PointStore::remove
fn PointStore::remove(self : PointStore, address : InformationAddress, timestamp : Int) -> Result[PointChange, Diagnostic]#PointStore::upsert
fn PointStore::upsert(self : PointStore, object : ApplicationObject, timestamp : Int, source? : String) -> Result[PointChange, Diagnostic]#ProfileRegistry
#ProfileRegistry::get
#ProfileRegistry::put
#ProfileRegistry::remove
#ProfileRegistry::replace
#ProtocolEvent
A protocol event useful for deterministic simulation and diagnostics.
#ProtocolTimers
pub struct ProtocolTimers {
t0 : TimerState
t1 : TimerState
t2 : TimerState
t3 : TimerState
} derive(Eq, Debug)#ProtocolTimers::expired
#ProtocolTimers::start_t0
#ProtocolTimers::start_t1
#ProtocolTimers::start_t2
#ProtocolTimers::start_t3
#QualityDescriptor
Quality descriptor shared by status and measurement objects.
#QualityDescriptor::flags
#QualityDescriptor::from_byte
Decode the low byte of a QDS value.
#QualityDescriptor::has_status_change
#QualityDescriptor::is_usable
#QualityDescriptor::with_blocked
#QualityDescriptor::with_invalid
#QualityDescriptor::with_not_topical
#QualityDescriptor::with_overflow
#QualityDescriptor::with_substituted
#RateLimiter
A fixed-window rate limiter for commands and diagnostics.
#RateLimiter::new
#ReadTransaction
Read service state for a single information object.
#ReadTransaction::activate
#ReadTransaction::complete
fn ReadTransaction::complete(self : ReadTransaction, object : ApplicationObject) -> Result[ServiceResponse, String]#ReadTransaction::new
#ReadTransaction::reject
#ReplayGuard
Replay guard keyed by APDU checksum and a bounded time interval.
#ReplayGuard::is_replay
#ReplayGuard::remember
#ResourceLimits
Resource limits prevent malformed peers from exhausting a gateway.
#ResourceLimits::max_trace_events
#ResourceLimits::new
fn ResourceLimits::new(max_apdu : Int, max_asdu : Int, max_objects : Int, max_history : Int, max_commands : Int, max_trace_events : Int) -> Result[ResourceLimits, String]#ScaledValue
Signed 16-bit scaled measurement.
#ScaledValue::new
#ScheduledAction
#ScheduledAction::action
#ScheduledAction::new
#SequenceWindow
A validated receive/send sequence window.
#SequenceWindow::acknowledge
#SequenceWindow::receive
#SequenceWindow::reserve_send
#ServiceKind
Application service classes supported by the portable core.
#ServiceRequest
pub struct ServiceRequest {
service : ServiceKind
address : InformationAddress
common_address : CommonAddress
qualifier : Int
created_at : Int
originator : Int
} derive(Eq, Debug)An application service request independent of a transport.
#ServiceRequest::address
#ServiceRequest::common_address
#ServiceRequest::new
fn ServiceRequest::new(service : ServiceKind, address : InformationAddress, common_address : CommonAddress, qualifier : Int, created_at : Int, originator? : Int) -> Result[ServiceRequest, Diagnostic]#ServiceResponse
pub struct ServiceResponse {
request : ServiceRequest
status : ServiceStatus
cause : CauseOfTransmission
objects : Array[ApplicationObject]
message : String
} derive(Debug)A service response with optional application data.
#ServiceResponse::cause
#ServiceResponse::new
fn ServiceResponse::new(request : ServiceRequest, status : ServiceStatus, cause : CauseOfTransmission, objects : Array[ApplicationObject], message? : String) -> ServiceResponse#ServiceResponse::objects
#ServiceResponse::request
#ServiceStatus
Result state used by application transactions.
#Session
A deterministic session state machine. Transport I/O is intentionally injected by callers.
#SessionAction
pub enum SessionAction {
SendStart
SendStop
SendTest
SendSupervisory(Int)
SendInformation(Int)
DeliverInformation(Bytes)
Acknowledge(Int)
Report(Diagnostic)
NoAction
} derive(Debug)A deterministic action emitted by a session driver.
#SessionSnapshot
Host-visible session observation.
#SessionSnapshot::receive_sequence
#SessionSnapshot::send_sequence
#ShortFloatValue
IEEE-754 short floating point measurement.
#ShortFloatValue::new
#ShortFloatValue::quality
#Simulation
pub struct Simulation {
clock : VirtualClock
actions : Array[ScheduledAction]
events : Array[SimulationEvent]
next_ordinal : Int
max_events : Int
} derive(Debug)#Simulation::new
#Simulation::run_until
Run all scheduled actions up to an inclusive timestamp.
#Simulation::schedule
fn Simulation::schedule(self : Simulation, at : Int, action : SimulationAction) -> Result[Unit, String]#Simulation::step
Run the next scheduled action, if any.
#SimulationAction
pub enum SimulationAction {
Receive(Frame)
Publish(ApplicationObject)
AdvanceTimer(String)
Record(String)
} derive(Debug)Work scheduled for a deterministic simulation tick.
#SimulationEvent
pub enum SimulationEvent {
FrameProduced(Int, Frame)
ObjectPublished(Int, ApplicationObject)
TimerAdvanced(Int, String)
Note(Int, String)
SimulationFault(Int, Diagnostic)
} derive(Debug)Results emitted by one simulation step.
#SinglePointValue
Single point information value, including its QDS.
#SinglePointValue::from_byte
#SinglePointValue::new
#SinglePointValue::quality
#StationProfile
pub struct StationProfile {
name : String
common_address : CommonAddress
parameters : ConnectionParameters
supported_types : Array[ApplicationType]
max_objects : Int
tls_required : Bool
} derive(Debug)A station profile exchanged by deployment configuration and test tools.
#StationProfile::common_address
#StationProfile::new
fn StationProfile::new(name : String, common_address : CommonAddress, parameters : ConnectionParameters, supported_types : Array[ApplicationType], max_objects? : Int, tls_required? : Bool) -> Result[StationProfile, String]#StationProfile::parameters
#StationProfile::supported_types
#StationProfile::supports
#StationSimulation
pub struct StationSimulation {
store : PointStore
session : Session
simulation : Simulation
metrics : FrameMetrics
trace : TraceLog
} derive(Debug)A deterministic station simulation composed from a point store and session.
#StationSimulation::events
#StationSimulation::ingest
fn StationSimulation::ingest(self : StationSimulation, object : ApplicationObject, timestamp : Int) -> Result[PointChange, Diagnostic]#StationSimulation::metrics
#StationSimulation::new
fn StationSimulation::new(common_address : CommonAddress, window_size? : Int) -> Result[StationSimulation, String]#StationSimulation::receive
#StationSimulation::run_until
#StationSimulation::schedule
fn StationSimulation::schedule(self : StationSimulation, at : Int, action : SimulationAction) -> Result[Unit, String]#StationSimulation::send
#StationSimulation::session
#StationSimulation::trace
#StatusQuality
Quality descriptor for single and double point status values.
#StatusQuality::as_measurement
#StatusQuality::from_byte
#StepPositionValue
pub struct StepPositionValue {
position : Int
transient : Bool
quality : StatusQuality
} derive(Eq, Debug)Step position value with a signed seven-bit position and transient flag.
#StepPositionValue::new
fn StepPositionValue::new(position : Int, transient? : Bool, quality? : StatusQuality) -> Result[StepPositionValue, String]#StepPositionValue::quality
#StepPositionValue::to_array
#StoreStatistics
Aggregate counts for an in-memory point store.
#StoreTransaction
pub struct StoreTransaction {
pending : Array[(ApplicationObject, Int, String)]
removed : Array[(InformationAddress, Int)]
committed : Bool
} derive(Debug)A transaction that stages changes before committing them to a store.
#StoreTransaction::commit
fn StoreTransaction::commit(self : StoreTransaction, store : PointStore) -> Result[Array[PointChange], Diagnostic]#StoreTransaction::pending_count
#StoreTransaction::stage
fn StoreTransaction::stage(self : StoreTransaction, object : ApplicationObject, timestamp : Int, source? : String) -> Result[Unit, Diagnostic]#StoreTransaction::stage_remove
fn StoreTransaction::stage_remove(self : StoreTransaction, address : InformationAddress, timestamp : Int) -> Result[Unit, Diagnostic]#TimeTag
#TimeTagKind
Tag precision carried by a time-tagged application object.
#TimerState
State of a timer that is driven by a host monotonic clock.
#TraceEvent
#TraceEvent::new
fn TraceEvent::new(timestamp : Int, kind : TraceKind, detail : String, correlation? : Int) -> TraceEvent#TraceKind
A trace event with a monotonic timestamp.
#TraceLog
#TransportMode
#TypeDescriptor
pub struct TypeDescriptor {
type_id : ApplicationType
name : String
direction : PointDirection
time_tag : TimeTagKind
value_width : Int
supported : Bool
command : Bool
} derive(Eq, Debug)Machine-readable description of an IEC 104 application type.
#TypeDescriptor::direction
#TypeId
#UCommand
#VirtualClock
A deterministic monotonic clock for protocol simulations and tests.
#VirtualClock::advance
#VirtualClock::set
#admit_envelope
#admit_inbound
fn admit_inbound(data : Bytes, limits : ResourceLimits, replay : ReplayGuard, now : Int) -> Result[Frame, Diagnostic]Admission pipeline for an inbound APDU.
#application_type
Decode all currently assigned standard IEC 104 type identifiers.
#application_type_catalog
Return the standard catalog used to negotiate object capabilities.
#application_value_is_command
#application_value_is_measurement
#binary_counter_object
fn binary_counter_object(address : InformationAddress, value : UInt, sequence? : Int, time_tag? : TimeTag) -> Result[ApplicationObject, String]#bit_string_object
fn bit_string_object(address : InformationAddress, value : UInt, time_tag? : TimeTag) -> Result[ApplicationObject, String]#calendar_weekday
fn calendar_weekday(year : Int, month : Int, day : Int) -> Result[Int, String]Calculate ISO-like weekday for a Gregorian date: Monday is 1, Sunday is 7.
#cause_category
Decode a standard cause category without rejecting extension values.
#clock_sync_object
fn clock_sync_object(address : InformationAddress, value : Cp56Time) -> Result[ApplicationObject, String]#counter_interrogation_object
fn counter_interrogation_object(address : InformationAddress, qualifier : Int) -> Result[ApplicationObject, String]#crc16_ibm
fn crc16_ibm(data : Bytes) -> UIntCRC-16/IBM helper for gateways that wrap IEC APDUs in a framed channel.
#crc32_ieee
fn crc32_ieee(data : Bytes) -> UIntCRC-32 used by fixture manifests and deterministic transport tests.
#create_interrogation_plan
fn create_interrogation_plan(store : PointStore, request : InterrogationRequest, filter : PointFilter, batch_size? : Int) -> Result[InterrogationPlan, String]Build plans from a point store while retaining type and address boundaries.
#days_in_month
fn days_in_month(year : Int, month : Int) -> Int?Return the number of days in a Gregorian month.
#decode_asdu
Decode an ASDU header and its information objects.
#decode_extended_asdu
Decode a complete address-qualified ASDU.
#decode_frame
Decode one complete APDU. Extra bytes after the declared APDU are rejected.
#decode_signed16
fn decode_signed16(low : Int, high : Int) -> Result[Int, String]Return the signed value represented by a two-byte little-endian field.
#decode_time_tag
Decode the selected tag precision from a byte sequence.
#default_benchmark_suite
Produce the standard local suite used by README benchmark commands.
#diagnostic_kind_examples
Keep all diagnostic categories available to host-side telemetry adapters.
#double_command_object
fn double_command_object(address : InformationAddress, state : Int, qualifier : Int) -> Result[ApplicationObject, String]#double_point_object
fn double_point_object(address : InformationAddress, state : Int, quality? : StatusQuality, time_tag? : TimeTag) -> Result[ApplicationObject, String]#encode_application_object
Encode an IOA-qualified object without the ASDU header.
#encode_asdu
Encode an ASDU header followed by information objects.
#encode_extended_asdu
Encode an address-qualified ASDU into its IEC 104 application payload.
#encode_frame
Encode one APCI frame, including the 0x68 start byte and length byte.
#encode_signed16
Encode a signed value into a little-endian two-byte field.
#encoded_frame_size
Return the number of octets that an encoded frame will occupy.
#end_of_initialization_object
fn end_of_initialization_object(address : InformationAddress, value : Int) -> Result[ApplicationObject, String]#evaluate_command
#frame_fits_apdu
Return a conservative APDU limit check for gateways.
#hex_digit
fn hex_digit(value : Int) -> CharConvert a hexadecimal nibble to a display character.
#information_frame
Create an I frame from a sequence pair and an ASDU payload.
#interrogation_object
fn interrogation_object(address : InformationAddress, qualifier : Int) -> Result[ApplicationObject, String]#milliseconds_since_midnight
fn milliseconds_since_midnight(hour : Int, minute : Int, second : Int, millisecond : Int) -> Result[Int, String]Sum milliseconds since midnight, used by deterministic simulations.
#negotiate_profiles
fn negotiate_profiles(local_profile : StationProfile, remote : StationProfile) -> NegotiationDecision#normalize_quality
fn normalize_quality(value : Int) -> IntClamp a quality byte to the protocol's low eight bits.
#normalized_object
fn normalized_object(address : InformationAddress, value : Int, quality? : QualityDescriptor, time_tag? : TimeTag) -> Result[ApplicationObject, String]#normalized_set_point_object
fn normalized_set_point_object(address : InformationAddress, value : Int, qualifier : Int) -> Result[ApplicationObject, String]#normalized_value_asdu
fn normalized_value_asdu(cause : Int, common_address : Int, value : Int, quality : Int) -> BytesBuild a normalized telemetry value.
#observe_frame_length
Record an APDU length observation.
#ordinal_day
fn ordinal_day(year : Int, month : Int, day : Int) -> Result[Int, String]Convert a month/day pair to a one-based ordinal day.
#parse_apdu_prefix
Parse one APDU from a byte view without requiring a socket implementation.
#parse_vsq
fn parse_vsq(value : Int) -> Result[(Int, Bool), String]Validate a VSQ byte and return its count/sequence pair.
#protocol_event_examples
Standard event constructors for host integrations.
#quality_for_state
Build a quality descriptor from a measurement state.
#regulating_step_command_object
fn regulating_step_command_object(address : InformationAddress, step : Int, qualifier : Int) -> Result[ApplicationObject, String]#reset_command_object
fn reset_command_object(address : InformationAddress, value : Int) -> Result[ApplicationObject, String]#run_benchmark_workload
#scaled_object
fn scaled_object(address : InformationAddress, value : Int, quality? : QualityDescriptor, time_tag? : TimeTag) -> Result[ApplicationObject, String]#scaled_set_point_object
fn scaled_set_point_object(address : InformationAddress, value : Int, qualifier : Int) -> Result[ApplicationObject, String]#sequence_acknowledges
fn sequence_acknowledges(send_cursor : Int, acknowledgement : Int) -> BoolWhether a sequence acknowledgement is valid for a send cursor.
#sequence_before
fn sequence_before(start : Int, candidate : Int, limit : Int) -> BoolWhether candidate is strictly before limit from start.
#sequence_distance
fn sequence_distance(start : Int, end : Int) -> IntDistance from start to end on the 15-bit sequence ring.
#sequence_next
fn sequence_next(value : Int) -> IntReturn the next sequence number on the IEC ring.
#sequence_normalize
fn sequence_normalize(value : Int) -> IntSequence numbers are modulo 32768 in IEC 104.
#sequence_previous
fn sequence_previous(value : Int) -> IntReturn the previous sequence number on the IEC ring.
#short_float_object
fn short_float_object(address : InformationAddress, value : Float, quality? : QualityDescriptor, time_tag? : TimeTag) -> Result[ApplicationObject, String]#short_float_set_point_object
fn short_float_set_point_object(address : InformationAddress, value : Float, qualifier : Int) -> Result[ApplicationObject, String]#single_command_object
fn single_command_object(address : InformationAddress, state : Bool, qualifier : Int) -> Result[ApplicationObject, String]#single_object_asdu
fn single_object_asdu(object : ApplicationObject, cause : CauseOfTransmission, common_address : CommonAddress) -> Result[AsduEnvelope, Diagnostic]Build an ASDU containing one object.
#single_point_asdu
fn single_point_asdu(cause : Int, common_address : Int, ioa : Int, status : Bool, quality : Int) -> BytesBuild a single-point status ASDU.
#single_point_object
fn single_point_object(address : InformationAddress, state : Bool, quality? : StatusQuality, time_tag? : TimeTag) -> Result[ApplicationObject, String]#split_apdus
Split a byte stream into complete APDUs and retain incomplete tails.
#split_milliseconds_since_midnight
fn split_milliseconds_since_midnight(value : Int) -> Result[(Int, Int, Int, Int), String]Split milliseconds since midnight into hour, minute, second and remainder.
#step_position_object
fn step_position_object(address : InformationAddress, position : Int, transient? : Bool, quality? : StatusQuality, time_tag? : TimeTag) -> Result[ApplicationObject, String]#supervisory_frame
Create an S frame acknowledging received I frames.
#test_command_object
fn test_command_object(address : InformationAddress, value : Int) -> Result[ApplicationObject, String]#unnumbered_frame
Create a U frame. The low six control bits are retained by the encoder.
#validate_common_address
#validate_frame
Validate invariants that are independent of a concrete transport.
#validate_information_address
#validate_transport_frame
Validate a frame against transport-level limits before sending it.
Source Files
- api_helpers.mbt
- application.mbt
- application_objects.mbt
- application_services.mbt
- benchmark_api.mbt
- codec.mbt
- compatibility_aliases.mbt
- conformance_catalog.mbt
- diagnostics_metrics.mbt
- extended_asdu.mbt
- frame_types.mbt
- gateway_runtime.mbt
- health_report.mbt
- model.mbt
- point_store.mbt
- protocol_domain.mbt
- protocol_profiles.mbt
- quality.mbt
- security_limits.mbt
- simulation.mbt
- state_machine.mbt
- time_tags.mbt
- transport_layer.mbt
- validation.mbt
- wire_tools.mbt
Portable IEC 60870-5-104 protocol core for SCADA, gateways, and deterministic simulation.
iec104scadatelecontrolprotocol
0.2.0
Apache-2.0
Updated 1 hour ago
2 downloads