You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: README.md
+32-40Lines changed: 32 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,63 +1,54 @@
1
1
CANopenEditor
2
2
=============
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.
5
5
6
6
CANopen Object Dictionary Editor:
7
7
- 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.
10
10
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/ .
12
12
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.
14
14
15
15
16
16
EDSSharp
17
17
--------
18
18
19
-
A C# CanOpen EDS (Electronic Data Sheet) libraryand GUI editor
19
+
A C# CanOpen EDS (Electronic Data Sheet) library, CLI convertor and GUI editor.
20
20
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.
24
22
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.
28
26
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.
31
28
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.
36
31
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.
39
33
40
34
Please consider this code experimental and beta quality.
41
35
It is a work in progress and is rapidly changing.
42
36
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.
46
38
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...
53
44
54
45
Library
55
46
-------
56
47
57
-
* Read EDS/DCF/XDC file and parse contents to approprate classes
48
+
* Read EDS/DCF/XDC file and parse contents to appropriate classes
58
49
* Dump EDS/DCF classes via ToString()
59
50
* 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
61
52
* EDS/DCF supports modules
62
53
* EDS/DCF supports compactPDO (read only) *¹
63
54
* EDS/DCF supports implict PDO (read only) *¹
@@ -67,6 +58,10 @@ Library
67
58
*¹ Read only, in this context, means the EDS/DCF is fully expanded but the compact
68
59
forms is not written back, only the expanded form will be saved.
69
60
61
+
CLI
62
+
---
63
+
TODO
64
+
70
65
GUI
71
66
---
72
67
* Open multiple devices
@@ -77,27 +72,24 @@ GUI
77
72
* Delete exisiting OD entries
78
73
* Create new Devices
79
74
* 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
82
76
* Edit Device and File Info sections
83
77
* 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
85
79
* Save groups of EDS/XML files as a network object with ability to set concrete node IDs
86
80
* View report of all configured PDOs across the network
87
81
* View modules and module details present within EDS files
88
82
* View/edit actual object values for device configuring/DCF files
89
83
* Support for loading XDD files (CanOpen offical XML)
90
84
* 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.
95
87
96
88
TODO
97
89
----
98
90
99
91
* 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
101
93
(all common ones are done, a few special/edge cases remain)
102
94
* Look at XDC files and see if we can save config changes and allow editing and
103
95
network setup here in the app, partial support is implemented by supporting
0 commit comments