dborgards/eds-dcf-net

Purpose and Runtime

EdsDcfNet is a .NET Standard 2.0 C# library for reading, editing, validating, converting, and writing CANopen CiA DS 306 (EDS, DCF, CPJ) and CiA 311 (XDD, XDC) files. It is a library, not a service or web application. Consumers run it in their own .NET process; repository builds require .NET SDK 10/C# 13.

Core project: src/EdsDcfNet/EdsDcfNet.csproj. Usage entry example: examples/EdsDcfNet.Examples/Program.cs.

Public API and Format Routing

CanOpenFile is the public façade. Its canonical format-specific operations (Eds, Dcf, Cpj, Xdd, Xdc) centralize sync/async file, stream, and string I/O, shared read limits, write options, validation, and legacy API delegation.

• src/EdsDcfNet/CanOpenFile.cs

• src/EdsDcfNet/FormatCanOpenOperations.cs

• src/EdsDcfNet/EdsCanOpenOperations.cs

Format operations select the corresponding parser/writer and preserve caller stream ownership. EDS-to-DCF conversion is owned by the EDS operation layer.

Canonical Domain Models

The central boundary is a typed in-memory CANopen model rather than raw document conversion. EDS/XDD map to ElectronicDataSheet; DCF/XDC map to DeviceConfigurationFile; CPJ maps to network/project topology. All device formats expose an editable object dictionary, including objects, sub-objects, lists, typed values, device information, and commissioning.

• src/EdsDcfNet/Models/ICanOpenFileModel.cs

• src/EdsDcfNet/Models/ObjectDictionary.cs

• src/EdsDcfNet/Models/ElectronicDataSheet.cs

• src/EdsDcfNet/Models/DeviceConfigurationFile.cs

• src/EdsDcfNet/Models/NodelistProject.cs

XDD/XDC additionally carry CiA 311 application-process structures.

Input Parsing Pipeline

Format readers translate external text/XML into the canonical models. INI-oriented EDS/DCF/CPJ parsing shares reader and section infrastructure; XML-oriented XDD/XDC parsing uses a secure XML boundary and specialized parsers for device, communication, and application-process sections.

• src/EdsDcfNet/Parsers/CanOpenReaderBase.cs

• src/EdsDcfNet/Parsers/IniParser.cs

• src/EdsDcfNet/Parsers/EdsReader.cs

• src/EdsDcfNet/Parsers/XddReader.cs

• src/EdsDcfNet/Parsers/SecureXmlParser.cs

CanOpenFileOptions governs cross-format input-size constraints, providing a denial-of-service boundary for untrusted input.

Model Editing, Conversion, and Value Semantics

Consumers mutate the model directly. Object-dictionary extensions support indexed lookup, category/PDO queries, and typed parameter reads/writes. Value conversion maps CANopen data types to .NET values and enforces representable ranges. EDS-to-DCF conversion creates a commissioned configuration from a device description.

• src/EdsDcfNet/Extensions/ObjectDictionaryExtensions.cs

• src/EdsDcfNet/Utilities/CanOpenValueConverter.cs

• src/EdsDcfNet/Utilities/ValueConverter.cs

• src/EdsDcfNet/CanOpenNodeId.cs

Validation and Write Guard

Validation is separate from parsing and serialization: it checks commissioning constraints, device metadata, object-list consistency, and object/sub-object validity, returning path-based issues. Write calls optionally invoke this guard and throw ModelValidationException; async paths support cancellation.

• src/EdsDcfNet/Validation/CanOpenModelValidator.cs

• src/EdsDcfNet/Validation/ValidationIssue.cs

• src/EdsDcfNet/CanOpenWriteGuard.cs

• src/EdsDcfNet/CanOpenWriteOptions.cs

Serialization and External Boundaries

Writers serialize canonical models to DS 306 INI-like files or CiA 311 XML. File/stream output is UTF-8 without BOM. Writer failures are translated into format-specific exceptions, with section/element context where available.

• src/EdsDcfNet/Writers/IniWriterBase.cs

• src/EdsDcfNet/Writers/EdsWriter.cs

• src/EdsDcfNet/Writers/DcfWriter.cs

• src/EdsDcfNet/Writers/XddWriter.cs

• src/EdsDcfNet/Writers/XdcWriter.cs

The only material external interoperability targets are CANopen files and the NuGet distribution channel; CI/release automation runs through GitHub Actions and semantic-release.