Initial commit: C++20 SECS-II / HSMS / GEM client + server
A fully containerised SECS/GEM toolchain. Single docker compose project,
no host build tools. 63 unit-test cases / 278 assertions, two demo
executables, end-to-end two-container demo exercising every implemented
capability.
Architecture (bottom-up):
secs2/ E5 SECS-II codec
Item variant over L/A/B/BOOLEAN/I1-8/U1-8/F4/F8
encode/decode big-endian, 1/2/3-byte length encoding
Message SxFy + W-bit + optional root item
to_sml human-readable text rendering
hsms/ E37 HSMS transport (TCP)
Header 10-byte header + SType enum (Data/Select/Deselect/
Linktest/Reject/Separate)
Frame 4-byte length prefix + payload encode/decode
Connection async Asio TCP, NOT-SELECTED -> SELECTED state machine,
T3/T5/T6/T7/T8 timers, system-bytes reply correlation,
graceful close-after-flush separation
endpoint active Client (connect with T5 retry) and passive Server
(accept loop) wrappers over Connection
gem/ E30 GEM logic
ControlStateMachine 5-state E30 control model with operator
actions, host requests, SEMI-mandated ack
codes (OnlineAck, OfflineAck, CommAck), and
a state-change handler
EquipmentDataModel in-memory dictionary: SVIDs, DVIDs, ECIDs
(with EAC), CEIDs, report defs, CEID->report
links, enabled-events set, alarm table
(ALCD, enabled, active), process programs,
host command registry, clock (16-char
YYYYMMDDhhmmsscc with offset)
messages.hpp builders + parsers for every SxFy below
GEM message coverage (full list):
S1F1/F2 Are You There / On Line Data
S1F3/F4 Selected Equipment Status Request / Data
S1F11/F12 Status Variable Namelist Request / Data
S1F13/F14 Establish Communications (+ CommAck)
S1F15/F16 Request OFFLINE (+ OfflineAck)
S1F17/F18 Request ONLINE (+ OnlineAck)
S2F13/F14 Equipment Constant Request / Data
S2F15/F16 EC Send + EquipmentAck (Accept/UnknownEcid/Busy/OutOfRange)
S2F17/F18 Date and Time Request / Data
S2F29/F30 Equipment Constant Namelist Request / Data
S2F31/F32 Date and Time Set Request / TimeAck
S2F33/F34 Define Report + DefineReportAck (5 enum values)
S2F35/F36 Link Event Report + LinkEventAck
S2F37/F38 Enable / Disable Event Report + EnableEventAck
S2F41/F42 Host Command + HostCmdAck (7 values) + per-param CPACKs
S5F1/F2 Alarm Report Send + AlarmAck (ALCD bit-7 set/cleared
+ lower-7 category)
S5F3/F4 Enable/Disable Alarm Send + AlarmAck
S5F5/F6 List Alarms Request / Data (active alarms tagged in ALCD)
S6F11/F12 Event Report Send (equipment-initiated CEID emission
with full report data) + EventReportAck
S7F3/F4 Process Program Send + ProcessProgramAck (7 values)
S7F5/F6 Process Program Request / Data
S7F19/F20 Current EPPD List Request / Data
S10F1/F2 Terminal Display Single (host->equipment) + TerminalAck
S10F3/F4 Terminal Display Single (equipment->host)
Demo apps:
apps/secs_server.cpp passive equipment. Populates the data model
with 3 SVIDs (ControlState, Clock,
EventsEnabled), 2 ECIDs, 3 CEIDs
(ControlStateChanged, AlarmSetEvent,
ProcessStarted), 2 alarms (Chiller Temp High
cat 4, Door Open cat 1), 2 recipes
(RECIPE-A, RECIPE-B), and 4 host commands
(START, STOP, PAUSE, FAULT). Emits S6F11 on
every control state transition + on START;
emits S5F1 + the AlarmSetEvent CEID on FAULT.
Pushes an S10F3 welcome message when the host
comes online.
apps/secs_client.cpp active host. Walks 17 steps: Establish ->
Online -> S1F11 SVID namelist -> S1F3 read ->
S2F29 EC namelist -> S2F13 read ->
S2F17 clock -> S2F33/S2F35/S2F37 dynamic
event subscription -> S2F41 START
(-> receives S6F11) -> S5F5 alarm list ->
S5F3 enable alarm 1 -> S2F41 FAULT
(-> receives S5F1 + S6F11) -> S7F19/S7F5
recipe list + body -> S10F1 terminal ->
S1F15 Offline -> Separate. Handles inbound
S6F11, S5F1, S10F3 primaries.
Testing:
tests/test_secs2.cpp codec round-trip for every format,
byte-layout assertions for known values,
truncation/trailing-byte rejection,
nested list round-trip, SML rendering
tests/test_hsms.cpp header byte layout, data + control
header round-trip, full frame round-
trip with length prefix, short-payload
rejection
tests/test_control_state.cpp every (state, event) pair in the E30
control state machine, including
AlreadyOnline / NotAccept rejections
and idempotent offline-while-offline
tests/test_data_model.cpp SVID/ECID/Alarm/Recipe CRUD, clock
format + parse, host command registry,
full event-report pipeline (define ->
link -> enable -> compose) with
every error path (InvalidVid,
UnknownCeid, UnknownRptid), alarm
set/clear with ALCD bit-7 semantics
tests/test_messages.cpp round-trip + byte-layout for every
builder/parser pair, including S6F11
event reports with mixed item types
Toolchain:
Dockerfile Ubuntu 24.04, g++-13, CMake, Ninja, libasio-dev
docker-compose.yml builder / tests / server / client services,
source bind-mounted, build artifacts in a
named volume so the host tree stays clean
CMakeLists.txt C++20, -Wall -Wextra -Wpedantic, standalone
Asio (ASIO_STANDALONE), doctest via FetchContent
Documentation:
README.md architecture, quick start, demo log
COMPLIANCE.md honest per-capability E5/E30/E37 audit with
spec section refs. Calls out what's implemented,
what's partial (Reject.req, Alarms missing F7/F8,
EC range validation, PP without verify, terminal
single-line only), and what's intentionally not
yet implemented (spooling, S9 error stream,
Documentation S1F19/F20+F21/F22, limits monitoring,
trace data collection, multi-block, material
movement). Does NOT claim "100% GEM-compliant" and
lists the work required to honestly make that claim.
This is Layer 0 + the start of Layer 1 from implementation_plan.md.
The transition-table-driven "spec-as-data" architecture (Layer 1
proper) is not yet implemented; the current code uses imperative
state machines that are structurally ready to be refactored onto
tables.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
#include <doctest/doctest.h>
|
||||
|
||||
#include "secsgem/hsms/frame.hpp"
|
||||
#include "secsgem/hsms/header.hpp"
|
||||
#include "secsgem/secs2/codec.hpp"
|
||||
|
||||
using namespace secsgem::hsms;
|
||||
namespace s2 = secsgem::secs2;
|
||||
|
||||
TEST_CASE("data message header round-trip") {
|
||||
Header h = Header::data_message(0x1234, 1, 13, true, 0xAABBCCDD);
|
||||
auto bytes = h.encode();
|
||||
Header back = Header::decode(bytes.data());
|
||||
|
||||
CHECK(back == h);
|
||||
CHECK(back.stype == SType::Data);
|
||||
CHECK(back.w_bit());
|
||||
CHECK(back.stream() == 1);
|
||||
CHECK(back.function() == 13);
|
||||
CHECK(back.session_id == 0x1234);
|
||||
CHECK(back.system_bytes == 0xAABBCCDD);
|
||||
}
|
||||
|
||||
TEST_CASE("data message header byte layout") {
|
||||
Header h = Header::data_message(0x0001, 1, 1, true, 0x00000001);
|
||||
auto b = h.encode();
|
||||
std::array<uint8_t, 10> expected{0x00, 0x01, 0x81, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01};
|
||||
CHECK(b == expected);
|
||||
}
|
||||
|
||||
TEST_CASE("W-bit clear when no reply expected") {
|
||||
Header h = Header::data_message(0, 6, 11, false, 7);
|
||||
CHECK_FALSE(h.w_bit());
|
||||
CHECK((h.byte2 & 0x80) == 0);
|
||||
CHECK(h.stream() == 6);
|
||||
}
|
||||
|
||||
TEST_CASE("control header layout (Select.req)") {
|
||||
Header h = Header::control(SType::SelectReq, 0x00000005);
|
||||
auto b = h.encode();
|
||||
std::array<uint8_t, 10> expected{0xFF, 0xFF, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x05};
|
||||
CHECK(b == expected);
|
||||
|
||||
Header back = Header::decode(b.data());
|
||||
CHECK(back == h);
|
||||
CHECK(back.stype == SType::SelectReq);
|
||||
}
|
||||
|
||||
TEST_CASE("select.rsp carries status in byte3") {
|
||||
Header h = Header::control(SType::SelectRsp, 5, kControlSessionId, 0,
|
||||
static_cast<uint8_t>(SelectStatus::Ok));
|
||||
CHECK(h.byte3 == 0);
|
||||
Header back = Header::decode(h.encode().data());
|
||||
CHECK(back.stype == SType::SelectRsp);
|
||||
CHECK(back.byte3 == static_cast<uint8_t>(SelectStatus::Ok));
|
||||
}
|
||||
|
||||
TEST_CASE("frame round-trip with body") {
|
||||
s2::Item body_item = s2::Item::list({s2::Item::ascii("MDLN"), s2::Item::ascii("1.0")});
|
||||
std::vector<uint8_t> body = s2::encode(body_item);
|
||||
|
||||
Frame f(Header::data_message(0, 1, 2, false, 42), body);
|
||||
auto wire = f.encode();
|
||||
|
||||
// length prefix counts header + body
|
||||
uint32_t len = (wire[0] << 24) | (wire[1] << 16) | (wire[2] << 8) | wire[3];
|
||||
CHECK(len == kHeaderSize + body.size());
|
||||
CHECK(wire.size() == kLengthPrefixSize + len);
|
||||
|
||||
Frame back = Frame::decode(wire.data() + kLengthPrefixSize, len);
|
||||
CHECK(back.header == f.header);
|
||||
CHECK(back.body == body);
|
||||
CHECK(s2::decode(back.body) == body_item);
|
||||
}
|
||||
|
||||
TEST_CASE("control frame has empty body") {
|
||||
Frame f(Header::control(SType::LinktestReq, 99));
|
||||
auto wire = f.encode();
|
||||
uint32_t len = (wire[0] << 24) | (wire[1] << 16) | (wire[2] << 8) | wire[3];
|
||||
CHECK(len == kHeaderSize);
|
||||
|
||||
Frame back = Frame::decode(wire.data() + kLengthPrefixSize, len);
|
||||
CHECK(back.body.empty());
|
||||
CHECK(back.header.stype == SType::LinktestReq);
|
||||
}
|
||||
|
||||
TEST_CASE("frame decode rejects short payload") {
|
||||
std::vector<uint8_t> tooShort(5, 0);
|
||||
CHECK_THROWS_AS(Frame::decode(tooShort.data(), tooShort.size()), FrameError);
|
||||
}
|
||||
Reference in New Issue
Block a user