Home modified by Peter Vranken

Peter Vranken — Fri, 21 Oct 2016 21:39:29 -0000

--- v45
+++ v46
@@ -1,5 +1,3 @@
-[TOC]
-
 [[include repo=code path=doc/wiki/readMe.md]]
 ## Download ##
 [[download_button]]

Home modified by Peter Vranken

Peter Vranken — Fri, 21 Oct 2016 21:38:48 -0000

--- v44
+++ v45
@@ -1,3 +1,5 @@
+[TOC]
+
 [[include repo=code path=doc/wiki/readMe.md]]
 ## Download ##
 [[download_button]]

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:42:01 -0000

--- v43
+++ v44
@@ -1 +1,4 @@
-[[include repo=code path=doc/wiki/home.md]]
+[[include repo=code path=doc/wiki/readMe.md]]
+## Download ##
+[[download_button]]  
+

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:41:28 -0000

--- v42
+++ v43
@@ -1 +1 @@
-[[include repo=files path=readMe]]
+[[include repo=code path=doc/wiki/home.md]]

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:40:43 -0000

--- v41
+++ v42
@@ -1,175 +1 @@
 [[include repo=files path=readMe]]
-
-# comFramework (r174, 17.05.2016) #
-
-Table of contents:
-
-[TOC]
-
-## About this Project ##
-
-This project presents a flexible, widely customizable CAN communication
-interface for embedded applications. It binds signal based application
-code to the frame based hardware layer. It covers the CAN stack from the
-application layer down to the hardware driver layer (not including). A
-dispatcher engine decouples the one or more interrupts, which are
-typically used by the CAN hardware driver for notification of send or
-receive events, from the application task(s); this makes the complete data
-processing at the application side safe, straightforward, race condition
-free programming.
-
-The interface implementation is code generator supported; particularly the
-unpack/pack functions for message (de)composition can be generated. A
-sample integration demonstrates, how to generate much more: Setting
-initial signal values, DLC check, checksum generation/validation, sequence
-counter generation/validation and the implementation of different timing
-patterns is generated in a fully automated fashion. Attributes defined in
-the DBC file(s) support the automation.
-
-We call this project a framework since the interface should be considered
-a suggestion only; the high flexibility of the code generation process
-makes it easy to design different interface architectures, which can reach
-a similar degree of automation with respect to changes of the network
-database(s).
-
-### The DBC code generator ###
-
-The code generator consists of an open source parser for CAN network
-database files (_*.dbc_ or DBC files) with connected general purpose code
-generator. The idea is most simple and most flexible:
-
-The parser transforms the DBC files into an internal data representation,
-which holds all information about the network. This data structure is a
-special form of the parse tree. The structure has been chosen such that it
-is compatible with the template engine StringTemplate V4 by Terence Parr,
-see <http: www.stringtemplate.org=""/>. This template engine is capable to
-render deeply nested data structures and it can therefore transform the
-parse tree in nearly any kind of textual representation. This explains the
-high flexibility/customizability of the whole system.
-
-Just by configuring the templates, the code generator can produce
-different useful representations of the information in the network files,
-like:
-
-- An HTML report with all frames, signals, attributes and all the
-  properties of these
-- An Excel file with all the same (however, only as _*.csv_)
-- C source code and related header files, which implement a CAN interface.
-  The interface will contain the needed data structures, timing related
-  frame processing, validation code and pack and unpack operations to
-  transform signal sets to frames and vice versa. The implementation can
-  be made specific to a particular platform's requirements
-- LaTeX source code for documentation of the interface
-- Interface definition files: If code from a model based code generation
-  environment is linked to the CAN interface (e.g. The Mathworks MATLAB
-  with either their Embedded Coder or with dSPACE TargetLink) then a
-  descripition of the signal interface is essential as these code
-  generators need to be aware of the signal sets and their properties,
-  data types and scaling in the first place. Our code generator can
-  generate the required M scripts or XML files
-- ASAM MCD-2 MC interface description files (_*.a2l_) if the target
-  platform shall be connected to a measurement and calibration tool like
-  ETAS INCA or Vector Informatik CANape
-- AUTOSAR specification code (_*.arxml_). The DBC file contents could by
-  rendered as an AUTOSAR software component, which connects to the
-  ISignals of the COM stack, including all required application data types
-  with scaling and more information
-
-### DBC parser ###
-
-In most automation environments our code generator can be used as raw DBC
-parser for whatever purpose, too. Typically, interpreted languages like
-Perl, Python or Octave's M script are applied in software automation
-environments. If you use any interpreted language then you can configure
-the code generator to render the information in the syntax of your
-scripting language. Run the code generator, run the generated script and
-have the information in the context of your automation environment. The
-configuration of the code generation can be tailored; you will just render
-those parts of the information you really need. No need to develop the
-most complex all embracing data structure. A simple [example for GNU Octave](http://sourceforge.net/p/comframe/wiki/Reusage%20and%20standalone%20usage%20of%20DBC%20parser/#example-the-code-generator-as-dbc-parser-for-gnu-octave-m "DBC parser for GNU Octave")
-is provided.
-
-### excelExporter as auxiliary code generator ###
-
-A second, auxiliary code generator is part of the framework. This is the
-Java application excelExporter. The idea is nearly the same as for the
-main code generator but the input is a set of Excel workbooks instead of
-DBC files. The parse tree can be as simple as a linear list of rows from a
-flat table or a as complex as a deeply nested tree of interrelated data
-items. The concrete data structure depends on the definition of the input.
-The parse tree is rendered by the StringTemplate V4 template engine;
-identical to what has been said for the DBC code generator. The intented
-use case of the auxiliary code generator excelExporter is to support the
-handling of interfaces. Excel files serve as data dictionary of signals,
-variables, diagnostic interface items, etc. and can be translated into
-C/C++ interface implementations, documentation, ASAM MCD-2 MC or
-AUTOSAR interface specifications, etc.
-
-### Status of the project ###
-
-The project now reached the ready-to-use state:
-
-- The CAN interface with its dispatcher engine is distributed as source
-  code; concept and how-to-use are documented in this [Wiki page](http://sourceforge.net/p/comframe/wiki/The%20CAN%20Interface/ "The CAN interface")
-- Two compilable and runnable sample integrations of the CAN interface are
-  distributed with source code and makefiles together with the dispatcher
-  engine. There's a Windows and an Arduino ATmega 2560 real time integration
-- The code generators are distributed as Java application with a number of
-  samples for the [DBC code generator](http://sourceforge.net/p/comframe/code/HEAD/tree/codeGenerator/trunk/samples/
-  "SVN Repository: Code generation samples") and for [excelExporter](http://sourceforge.net/p/comframe/code/HEAD/tree/excelExporter/trunk/samples/ "SVN Repository: excelExporter samples") that
-  demonstrate how templates can look like, which do the transformations
-  mentioned above
-- The [download page](http://sourceforge.net/p/comframe/files "Files") at Sourceforge provides a ZIP archive for download,
-  which bundles all needed tools, files and samples in a ready-to-use
-  folder structure. The archive contains the files of revision r174
-  (17.05.2016 21:50:56) of the Sourceforge [SVN repository](http://sourceforge.net/p/comframe/code/HEAD/tree "SVN")
-
-Support of the project is appreciated to support more kinds of network
-databases. For now, we are restricted to the DBC format. However, this
-format looses importance. New formats like FIBEX will probably supersede
-DBC in the future. Furthermore, different physical bus systems have
-different network database files, like _*.ldf_ for LIN communication.
-Parsers for these input formats are required and - what's more difficult -
-a common data model for all of these buses and network files needs to be
-developed so that the parser becomes a configurable choice but the
-templates can be kept widely independent of the input format.
-
-## Installation ##
-
-comFramework is mainly distributed as a ZIP archive. Some external tools
-like a C compiler are useful. Please find the installation guide as
-[Installation of distributed ZIP archive](http://sourceforge.net/p/comframe/wiki/Installation/
-"Installation").
-
-## Documentation ##
-
-Latest news about the progress of the project can be found as discussion
-thread [What's new](http://sourceforge.net/p/comframe/discussion/news/
-"Latest project news").
-
-The CAN interface is documented in this [Wiki page](http://sourceforge.net/p/comframe/wiki/The%20CAN%20Interface/ "The CAN interface").
-  
-An overview of the documentation and the latest changes of the code
-generator is given in the [readMe](http://svn.code.sf.net/p/comframe/code/codeGenerator/trunk/doc/readMe.html "readMe.html") file of its distribution, or just have a
-look at the [download page](http://sourceforge.net/projects/comframe/files/ "Files").
-
-A growing source of documentation are the Wiki pages of the project,
-please refer to <http: sourceforge.net="" p="" comframe="" wiki="" browse_pages=""/>.
-The Wiki pages shade a light at some most relevant, selected issues; a
-comprehensive, self-contained (printable) manual is not planned.
-
-As of today, we have the following discussions in the Wiki pages:
-
-- [The CAN interface - concept and usage](http://sourceforge.net/p/comframe/wiki/The%20CAN%20Interface/ "The CAN interface")
-- [Home of excelExporter documentation](https://sourceforge.net/projects/excelexporter/ "excelExplorer@Sourceforge")
-- [Compatibility of the DBC parser with real _*.dbc_ files](http://sourceforge.net/p/comframe/wiki/Reusage%20and%20standalone%20usage%20of%20DBC%20parser/#compatibility "Compatibility")
-- [Comparison of this project with the other Sourceforge project *cantools*](http://sourceforge.net/p/comframe/wiki/cantools%20versus%20comFramework's%20Code%20Generator/ "comFramework Code Generator vs. cantools")
-- [Prerequisites, limitations and pitfalls](http://sourceforge.net/p/comframe/wiki/Prerequisites%2C%20Limitations%20and%20Pitfalls/ "Java version, known issues")
-- [Reusability of the DBC file parser in other contexts/applications](http://sourceforge.net/p/comframe/wiki/Reusage%20and%20standalone%20usage%20of%20DBC%20parser/ "Reusage of code, standalone use of DBC parser and compatibility")
-- [Options for conditional code generation](http://sourceforge.net/p/comframe/wiki/Conditional%20code/ "Conditional code generation versus generation of conditional code") 
-- [The use of attributes](http://sourceforge.net/p/comframe/wiki/Attributes%20in%20the%20network%20database/ "How to access attributes in the network database?")
-- [A common pattern how to combine handwritten code with auto-generated
-  code in a beneficial way](http://sourceforge.net/p/comframe/wiki/Attributes%20in%20the%20network%20database/#typical-code-architecture "Typical code architecture")
-- [Sugar on top of inheritance or how to change the copyright notice](http://sourceforge.net/p/comframe/wiki/Sugar%20on%20top%20of%20Inheritance%20or%20how%20to%20change%20the%20copyright%20notice/ "Terence Parr: 'Sugar on top of Inheritance'")
-- [Installation of distributed ZIP archive](http://sourceforge.net/p/comframe/wiki/Installation/
-"Installation")

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:39:42 -0000

--- v40
+++ v41
@@ -1,4 +1,3 @@
-[[include ref=http://sourceforge.net/projects/comframe/readMe.md]]
 [[include repo=files path=readMe]]

 # comFramework (r174, 17.05.2016) #

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:38:46 -0000

--- v39
+++ v40
@@ -1,5 +1,5 @@
 [[include ref=http://sourceforge.net/projects/comframe/readMe.md]]
-[[include repo=files path=readMe.md]]
+[[include repo=files path=readMe]]

 # comFramework (r174, 17.05.2016) #

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:37:40 -0000

--- v38
+++ v39
@@ -1,4 +1,5 @@
 [[include ref=http://sourceforge.net/projects/comframe/readMe.md]]
+[[include repo=files path=readMe.md]]

 # comFramework (r174, 17.05.2016) #

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:30:09 -0000

--- v37
+++ v38
@@ -1,4 +1,4 @@
-[[include ref=https://sourceforge.net/projects/comframe/files/readMe.md/download]]
+[[include ref=http://sourceforge.net/projects/comframe/readMe.md]]

 # comFramework (r174, 17.05.2016) #

Home modified by Peter Vranken

Peter Vranken — Wed, 18 May 2016 20:29:15 -0000

--- v36
+++ v37
@@ -1,4 +1,4 @@
-[[include ref=https://sourceforge.net/projects/comframe/files/readMe.md]]
+[[include ref=https://sourceforge.net/projects/comframe/files/readMe.md/download]]

 # comFramework (r174, 17.05.2016) #

Recent changes to Home

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken

Home modified by Peter Vranken