Skip to content

Commit c455e60

Browse files
committed
[DOCS] README rephrasing
Starting my redocumentation by correcting some typos I missed, rephrasing some hard-to-understand phrases and aligning lines of the README with how we want them to appear for easier reading (and as such editing) of the raw version.
1 parent d3773bc commit c455e60

1 file changed

Lines changed: 32 additions & 40 deletions

File tree

README.md

Lines changed: 32 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,54 @@
11
CANopenEditor
22
=============
3-
CANopenEditor is a fork from https://github.com/robincornelius/libedssharp, author Robin Cornelius.
4-
Its homepage is https://github.com/CANopenNode/CANopenEditor
3+
CANopenEditor is a fork from [libedssharp, authored by Robin Cornelius](https://github.com/robincornelius/libedssharp).
4+
CANopenEditor's homepage is https://github.com/CANopenNode/CANopenEditor.
55

66
CANopen Object Dictionary Editor:
77
- Imports: CANopen electronic data sheets in EDS or XDD format.
8-
- Exports: CANopen electronic data sheets in EDS or XDD format, documentation, CANopenNode C source files.
9-
- GUI editor for CANopen Object Dictionary, Device information, etc.
8+
- Exports: CANopen electronic data sheets in EDS or XDD format, documentation, CANopenNode C source files and more.
9+
- Interfaces: GUI editor for CANopen Object Dictionary, Device information, etc. CLI client for simple conversions.
1010

11-
CANopen is the internationally standardized (EN 50325-4) ([CiA301](http://can-cia.org/standardization/technical-documents)) higher-layer protocol for embedded control system built on top of CAN. For more information on CANopen see http://www.can-cia.org/
11+
CANopen is the internationally standardized (EN 50325-4) ([CiA301](http://can-cia.org/standardization/technical-documents)) higher-layer protocol for embedded control system built on top of CAN. For more information on CANopen see http://www.can-cia.org/ .
1212

13-
[CANopenNode](https://github.com/CANopenNode/CANopenNode) is free and open source CANopen Stack
13+
[CANopenNode](https://github.com/CANopenNode/CANopenNode) is a free and open source CANopen Stack.
1414

1515

1616
EDSSharp
1717
--------
1818

19-
A C# CanOpen EDS (Electronic Data Sheet) library and GUI editor
19+
A C# CanOpen EDS (Electronic Data Sheet) library, CLI convertor and GUI editor.
2020

21-
This application is designed to load/save/edit and create EDS/DCF/XDC file for
22-
CanOpen and also to generate the object dictionary for CanOpenNode
23-
CO_OD.c and CO_OD.h) to aid development of CanOpenNode devices.
21+
This application is designed to load/save/edit and create EDS/DCF/XDC file for CANopen and also to generate the object dictionary for CANopenNode (CO_OD.c and CO_OD.h) to aid development of CANopenNode devices.
2422

25-
EDS (Electronic Data Sheet) files are text files that define CanOpen Devices.
26-
DCF (Device Configuration File) files are text files that define configured
27-
CanOpenDevices XDD files are an XML version of EDS files
23+
EDS (Electronic Data Sheet) files are text files that define CANopen devices.
24+
DCF (Device Configuration File) files are text files that define configured CANopen devices.
25+
XDD files are an XML version of EDS files.
2826

29-
EDS/DCF are fully defined in the DSP306 standard by the can open standards
30-
body CiA.
27+
EDS/DCF are fully defined in the DSP306 standard by the CANopen standards body: CiA.
3128

32-
The EDS editor on its own is useful without the CanOpenNode specific export and
33-
as of the 0.6-XDD-alpha version the editor can also load/save XDD files.
34-
The GUI also shows PDO mappings and can generate reports
35-
of multiple devices that are loaded into the software.
29+
The EDS editor on its own is useful without the CANopenNode specific export and, as of the 0.6-XDD-alpha version, the editor can also load/save XDD files.
30+
The GUI also shows PDO mappings and can generate reports of multiple devices that are loaded into the software.
3631

37-
The core library can be used without the GUI to implement eds/xdd loading/saving
38-
and parsing etc in other projects.
32+
The core library can be used without the GUI to implement eds/xdd loading/saving and parsing etc in other projects.
3933

4034
Please consider this code experimental and beta quality.
4135
It is a work in progress and is rapidly changing.
4236

43-
Every attempt has been made to comply with the revelant DSP306 and other
44-
standards and EDS files from multiple sources have been tested for loading and
45-
saving as been (at times) validated for errors using EDS conformance tools.
37+
Every attempt has been made to comply with the relevant DSP306 and other standards and EDS files from multiple sources have been tested for loading/saving and as been (at times) validated for errors using EDS conformance tools.
4638

47-
With many thanks to the following contributors for spotting my mistakes and
48-
improving the code
49-
* s-fuchs
50-
* martinwag
51-
* trojanobelix
52-
* many others...
39+
With many thanks to the following contributors for spotting my mistakes and improving the code:
40+
* s-fuchs
41+
* martinwag
42+
* trojanobelix
43+
* many others...
5344

5445
Library
5546
-------
5647

57-
* Read EDS/DCF/XDC file and parse contents to approprate classes
48+
* Read EDS/DCF/XDC file and parse contents to appropriate classes
5849
* Dump EDS/DCF classes via ToString()
5950
* Save EDS/DCF classes back to EDS file
60-
* Export C and H files in CanOpenNode format CO_OD.c and CO_OD.h
51+
* Export C and H files in CANopenNode format CO_OD.c and CO_OD.h
6152
* EDS/DCF supports modules
6253
* EDS/DCF supports compactPDO (read only) *¹
6354
* EDS/DCF supports implict PDO (read only) *¹
@@ -67,6 +58,10 @@ Library
6758
*¹ Read only, in this context, means the EDS/DCF is fully expanded but the compact
6859
forms is not written back, only the expanded form will be saved.
6960

61+
CLI
62+
---
63+
TODO
64+
7065
GUI
7166
---
7267
* Open multiple devices
@@ -77,27 +72,24 @@ GUI
7772
* Delete exisiting OD entries
7873
* Create new Devices
7974
* Add default profiles
80-
* Create profiles that can be added to any project (just save the device xml file to the profiles/
81-
directory, only include the minimum number of objects that you want to auto insert) This will auto add to insert menu
75+
* Create profiles that can be added to any project (just save the device xml file to the profiles/ directory, only include the minimum number of objects that you want to auto insert); This will auto add to insert menu
8276
* Edit Device and File Info sections
8377
* Set RX/TX PDO mappings easily from dropdown lists of available objects
84-
* Add and remove new PDO entries (communication paramaters and mapping) in a single button push
78+
* Add and remove new PDO entries (communication paramaters and mapping) with a single button's push
8579
* Save groups of EDS/XML files as a network object with ability to set concrete node IDs
8680
* View report of all configured PDOs across the network
8781
* View modules and module details present within EDS files
8882
* View/edit actual object values for device configuring/DCF files
8983
* Support for loading XDD files (CanOpen offical XML)
9084
* Support for saving XDD files (CanOpen offical XML)
91-
* Some module info is displayed in GUI showing available modules (eds) and
92-
configured modules (dcf) and what OD entries they reference. Full details such
93-
as subobj extension and fixed subobj are not currently displayed and unless
94-
there is demand probably will not ever be.
85+
* Some module info is displayed in GUI showing available modules (eds) and configured modules (dcf) and what OD entries they reference.
86+
Full details such as subobj extension and fixed subobj are not currently displayed and unless there is demand probably will not ever be.
9587

9688
TODO
9789
----
9890

9991
* Ensure and validate all XDD is loading/save correctly (Looking good so far)
100-
* Add extra Gui fields for accessing extra XDD paramaters not in EDS
92+
* Add extra GUI fields for accessing extra XDD paramaters not in EDS
10193
(all common ones are done, a few special/edge cases remain)
10294
* Look at XDC files and see if we can save config changes and allow editing and
10395
network setup here in the app, partial support is implemented by supporting

0 commit comments

Comments
 (0)