Add the user guide and technical documentation as Word documents
Two documents, wiki-style so they import cleanly: short titled sections, tables over prose where the content is comparative, and cross-references between sections rather than a narrative that has to be read start to end. MicrOBU-User-Guide.docx is for riders. Features, setup for both hardware paths, what each screen shows, what the five alerts mean in plain language, troubleshooting. No ASN.1, no BTP ports, no bit widths anywhere in it. The alert descriptions and the link states are taken from values/strings.xml so the guide and the interface use the same words. MicrOBU-Technical-Documentation.docx is for supervisors and stakeholders. Architecture, the message path end to end, the serial protocol, the codecs and how they are verified, the full requirements matrix, the bench results, and the decisions. Section 15 is fourteen decisions written as chosen / alternative / reasoning / cost accepted, because the alternative is the part a supervisor asks about and it was previously recorded only in commit messages. Nothing is re-derived. Every measurement is cited from 05-obu-bench-test-2026-08-25.md, 04-transmit-setup.md, asn1/README.md or the commit history. Where a claim has no evidence it is marked as unverified rather than asserted: - 11.6 Phase A success criteria is stated as not met, in its own subsection. The bench proves reception; it cannot prove the use case with two moving stations because nothing on the bench moves. This is the central claim of the project and it needs a real ride. - The tx_custom.c bypass is described as the least defensible component in the system and load bearing, with the reverse-engineered struct layouts and the skipped sanity checking spelled out. - The 5900 MHz transmit story is marked a mitigation for a hypothesis, not a diagnosis, and the isolation test that would settle it is named as not run. - The detection thresholds are presented as untuned engineering estimates in both documents, since presenting them as validated is the easiest and most damaging overstatement available here. Twenty image placeholders, none of them filled. Each is a shaded block carrying a caption and a "Must show" line. For the three screenshots that exist the line names the bench session and section they came from; for the four diagrams that do not exist yet it is a full drawing spec, so the two hardware paths, the message path, the frame layout and the verification loop can be drawn from the document without re-reading the source. references.bib collects the standards as BibTeX for a later publication: EN 302 637-2/3, TS 103 301, SAE J2735, TS 102 894-2, EN 302 636-4-1 and -5-1, TS 103 248, TS 103 097, IEEE 802.11 OCB, plus the C2C-CC white paper and the vendored parser provenance. Also tracks two documents the new ones cite that had never been committed: docs/01-requirements-traceability.md and 04-transmit-setup.md. Section 18.3 lists them as repository sources, which would have been a dangling reference otherwise. Not included, deliberately: the two consider it PDFs cited in section 18.2. They are third-party vendor documentation and redistributing them is a licensing decision, not a documentation one. Still missing: the German user guide. values-de/strings.xml already fixes the terminology for it.
This commit is contained in:
Ashin Walpola
@@ -0,0 +1,151 @@
|
||||
% MicrOBU standards and source references.
|
||||
% Collected for the technical documentation and any later publication.
|
||||
% Keep entry keys stable once cited.
|
||||
|
||||
@techreport{etsi_en_302_637_2,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Vehicular Communications; Basic Set of Applications; Part 2: Specification of Cooperative Awareness Basic Service},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{EN}},
|
||||
number = {302 637-2},
|
||||
note = {CAM encode and decode},
|
||||
}
|
||||
|
||||
@techreport{etsi_en_302_637_3,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Vehicular Communications; Basic Set of Applications; Part 3: Specifications of Decentralized Environmental Notification Basic Service},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{EN}},
|
||||
number = {302 637-3},
|
||||
note = {DENM decode and the HLN-SV transmit profile},
|
||||
}
|
||||
|
||||
@techreport{etsi_ts_103_301,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Vehicular Communications; Basic Set of Applications; Facilities layer protocols and communication requirements for infrastructure services},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{TS}},
|
||||
number = {103 301},
|
||||
note = {SPATEM and MAPEM},
|
||||
}
|
||||
|
||||
@techreport{sae_j2735,
|
||||
author = {{SAE International}},
|
||||
title = {V2X Communications Message Set Dictionary},
|
||||
institution = {SAE International},
|
||||
type = {Standard},
|
||||
number = {J2735},
|
||||
note = {SPATEM and MAPEM message content},
|
||||
}
|
||||
|
||||
@techreport{etsi_ts_102_894_2,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Users and applications requirements; Part 2: Applications and facilities layer common data dictionary},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{TS}},
|
||||
number = {102 894-2},
|
||||
note = {Common data dictionary for all messages},
|
||||
}
|
||||
|
||||
@techreport{etsi_en_302_636_4_1,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Vehicular Communications; GeoNetworking; Part 4: Geographical addressing and forwarding for point-to-point and point-to-multipoint communications; Sub-part 1: Media-Independent Functionality},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{EN}},
|
||||
number = {302 636-4-1},
|
||||
note = {GeoNetworking Basic, Common and SHB headers; verified field by field},
|
||||
}
|
||||
|
||||
@techreport{etsi_en_302_636_5_1,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Vehicular Communications; GeoNetworking; Part 5: Transport Protocols; Sub-part 1: Basic Transport Protocol},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{EN}},
|
||||
number = {302 636-5-1},
|
||||
note = {BTP-B header},
|
||||
}
|
||||
|
||||
@techreport{etsi_ts_103_248,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); GeoNetworking; Port Numbers for the Basic Transport Protocol (BTP)},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{TS}},
|
||||
number = {103 248},
|
||||
note = {BTP destination ports 2001, 2002, 2003, 2004},
|
||||
}
|
||||
|
||||
@techreport{etsi_ts_103_097,
|
||||
author = {{ETSI}},
|
||||
title = {Intelligent Transport Systems (ITS); Security; Security header and certificate formats},
|
||||
institution = {European Telecommunications Standards Institute},
|
||||
type = {{TS}},
|
||||
number = {103 097},
|
||||
note = {Message signing; not implemented in this project},
|
||||
}
|
||||
|
||||
@techreport{ieee_802_11_ocb,
|
||||
author = {{IEEE}},
|
||||
title = {IEEE Standard for Information Technology; Telecommunications and Information Exchange between Systems; Local and Metropolitan Area Networks; Specific Requirements; Part 11: Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications},
|
||||
institution = {Institute of Electrical and Electronics Engineers},
|
||||
type = {Standard},
|
||||
number = {802.11},
|
||||
note = {Operation outside the context of a BSS (OCB), the frame layer used by ITS-G5},
|
||||
}
|
||||
|
||||
@techreport{c2ccc_wp_2324,
|
||||
author = {{Car 2 Car Communication Consortium}},
|
||||
title = {Bicycle Safety Use Cases},
|
||||
institution = {Car 2 Car Communication Consortium},
|
||||
type = {White Paper},
|
||||
number = {C2CCC\_WP\_2324},
|
||||
version = {1.0},
|
||||
year = {2026},
|
||||
month = {5},
|
||||
note = {Source of the five in-scope use cases: IMA-B, IMA-S, RTW-B, LTW-B, SMVA/BCW-B},
|
||||
}
|
||||
|
||||
@techreport{microbu_requirements_v15,
|
||||
author = {{HAW Hamburg}},
|
||||
title = {V2X MicrOBU Android App Requirements},
|
||||
institution = {HAW Hamburg, Urban Mobility Lab},
|
||||
version = {15},
|
||||
note = {The requirements baseline, chapters 0 to 13, 37 pages},
|
||||
}
|
||||
|
||||
@manual{considerit_mqtt_api_v6,
|
||||
author = {{consider it GmbH}},
|
||||
title = {CiT MQTT API Documentation},
|
||||
version = {6},
|
||||
year = {2025},
|
||||
month = {2},
|
||||
note = {The MQTT API used on the CiT One hardware path},
|
||||
}
|
||||
|
||||
@manual{considerit_tx_use_cases_v4,
|
||||
author = {{consider it GmbH}},
|
||||
title = {CiT Transmit Use Cases},
|
||||
version = {4},
|
||||
year = {2025},
|
||||
month = {2},
|
||||
note = {Transmit use case definitions including HLN-SV, causeCode 94},
|
||||
}
|
||||
|
||||
@misc{considerit_cits_parser,
|
||||
author = {{consider it GmbH}},
|
||||
title = {{C-ITS-Parser}},
|
||||
howpublished = {\url{https://github.com/consider-it/C-ITS-Parser}},
|
||||
note = {Commit f457426efc2486fac49a02fc9a1c8c7762d160e9, MIT licensed. Source of the seven vendored ASN.1 modules in \texttt{asn1/}},
|
||||
}
|
||||
|
||||
@misc{asn1tools,
|
||||
title = {{asn1tools}},
|
||||
howpublished = {Python package, version 0.167.0},
|
||||
note = {The independent ASN.1 implementation used as the verification oracle},
|
||||
}
|
||||
|
||||
@misc{its_g5_receiver_firmware_txenabled,
|
||||
author = {{opentrafficmap}},
|
||||
title = {{its-g5-receiver-firmware\_txenabled}},
|
||||
howpublished = {\url{https://codeberg.org/opentrafficmap/its-g5-receiver-firmware_txenabled}},
|
||||
note = {Transmit-enabled fork of the receiver firmware; source of the raw transmit bypass in \texttt{tx\_custom.c}},
|
||||
}
|
||||
Reference in New Issue
Block a user