Skip to content

Commit ef9adb9

Browse files
committed
README update
1 parent fc962d8 commit ef9adb9

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

crates/powerlink-rs-xdc/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ A `no_std` compatible, high-performance parser and serializer for ETHERNET POWER
44

55
This crate is part of the `powerlink-rs` project. It is designed to parse, validate, provide an ergonomic, strongly-typed Rust API for accessing data from `.xdc` files, and serialize that data back to XML. It is based on the [EPSG DS 311](https://www.br-automation.com/en/technologies/powerlink/service-downloads/technical-documents/) specification.
66

7-
**Work in progress**.
8-
97
## Features
108

119
- **`no_std` Compatible:** Can be used in embedded and bare-metal environments (`alloc` required).
@@ -60,7 +58,7 @@ While the POWERLINK protocol transmits data in **Little Endian** byte order, thi
6058

6159
- **Storage:** Values in `types.rs` (e.g., `Object::data`, `Parameter::actual_value`) are stored as `String` (e.g., `"0x1234"`, `"500"`).
6260
- **Parsing:** The parser does *not* convert these strings into byte vectors or native integers during the initial load. This ensures full fidelity to the XML source (preserving hex vs decimal formatting).
63-
- **Conversion:** Conversion to native Rust types (and subsequently to Little Endian bytes for the network) occurs exclusively in the `converter.rs` module when transforming the data for the `powerlink-rs` core crate.
61+
- **Conversion:** Conversion from these strings to native Rust types (wrapped in the core crate's `ObjectValue` enum) occurs in the `converter.rs` module. The `powerlink-rs` core crate then handles the subsequent serialization to Little Endian bytes for network transmission.
6462

6563
This approach simplifies round-trip serialization (ensuring `save_xdc_to_string` produces XML that matches the input style) and decouples XML formatting from protocol-specific byte ordering.
6664

0 commit comments

Comments
 (0)