doc/manual/en/manual.tex
author etisserant
Fri, 25 Apr 2008 12:18:23 +0200
changeset 448 732c33c2d8a7
parent 440 dfcec7403169
child 454 bc000083297a
permissions -rw-r--r--
CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
     1
\documentclass[12pt,english,a4paper]{book}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
     2
\usepackage[T1]{fontenc}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
     3
\usepackage[latin9]{inputenc}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
     4
\usepackage{graphicx}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
     5
\usepackage{amsfonts}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
     6
\usepackage{textcomp}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
     7
\usepackage{color}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
     8
\usepackage{calc}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
     9
\usepackage{longtable}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    10
\usepackage{hyperref}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    11
\usepackage{graphics}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    12
\DeclareGraphicsExtensions{.jpg}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    13
\DeclareGraphicsExtensions{.png}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    14
\hypersetup{colorlinks=true, linkcolor=blue, filecolor=blue, pagecolor=blue, urlcolor=blue}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    15
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    16
%%%%\%%%%%%%% titre, auteurs, date, etc...%%%%%%%%%%%%%%%%%%
249
d328d0d9b88e Some cleanup in latex manual
etisserant
parents: 211
diff changeset
    17
\title{\Huge The CanFestival CANOpen stack manual}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    18
\author{Edouard TISSERANT}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    19
\date{\today}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    20
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    21
\setcounter{secnumdepth}{5}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    22
\renewcommand\thesection{\arabic{section} -}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    23
\renewcommand\thesubsection{\arabic{section}.\arabic{subsection})}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    24
\renewcommand\thesubsubsection{\arabic{section}.\arabic{subsection}.\arabic{subsubsection})}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    25
\renewcommand\theparagraph{\alph{paragraph})}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    26
\renewcommand\thesubparagraph{\roman{subparagraph})}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    27
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    28
\newcommand{\canopen}{CANopen }
392
3788feef57e0 Some typo fixes in the manual, thanks to Yegor Yefremov (VisionSystems)
etisserant
parents: 391
diff changeset
    29
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    30
\begin{document}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    31
{\centering\textsf{\huge The CanFestival \canopen stack manual.}}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    32
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    33
\renewcommand{\contentsname}{CanFestival v3.0 Manual}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    34
\setcounter{tocdepth}{2} \tableofcontents{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    35
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    36
\clearpage{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    37
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    38
\section{Introduction}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    39
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    40
CanFestival is an OpenSource (LGPL and GPL) \canopen framework.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    41
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    42
\subsection{The CanFestival project}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    43
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    44
This project, initiated by Edouard TISSERANT in 2001, has grown thanks
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    45
to Francis DUPIN and other contributors.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    46
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    47
Today, CanFestival focuses on providing an ANSI-C platform independent
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    48
\canopen stack that can be implemented as master or slave nodes on
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    49
PCs, Real-time IPCs, and Microcontrollers.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    50
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    51
CanFestival is a project supported by Lolitech.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    52
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    53
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    54
\subsection{What is \canopen}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    55
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    56
CANopen is a CAN based high level protocol. It defines some protocols
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    57
to :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    58
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    59
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    60
\item Configure a CAN network. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    61
\item Transmit data to a specific node or in broadcast. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    62
\item Administrate the network. For example detecting a not responding node. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    63
\end{enumerate}
392
3788feef57e0 Some typo fixes in the manual, thanks to Yegor Yefremov (VisionSystems)
etisserant
parents: 391
diff changeset
    64
The documentation can be found on the CAN in Automation website :
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    65
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    66
\href{http://www.can-cia.de/canopen}{http://www.can-cia.de/canopen}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    67
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    68
The most important document about \canopen is the normative CiA Draft
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    69
Standard 301, version 4.02. You can now download the specification
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    70
from the CAN in Automation website at no cost.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    71
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    72
To continue reading this document, let us assume that you have read
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    73
some papers introducing \canopen .
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    74
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    75
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    76
\section{CanFestival Features}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    77
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    78
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    79
\subsection{Tools }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    80
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    81
The \canopen library is coming with some tools :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    82
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    83
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    84
\item Object Dictionary editor GUI. WxPython Model-View-Controler based
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    85
GUI, that helps a lot in generating object dictionary source code for
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    86
each node. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    87
\item A configure script, that let you chose compile time options such as
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    88
target CPU/HOST, CAN and TIMER drivers.\\
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    89
 This script has not been generated with autoconf, it has been made
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    90
keeping micro-controller target in mind. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    91
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    92
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
    93
\subsection{Multi-Platform}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    94
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    95
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    96
\item Library source code is C-ANSI. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    97
\item Driver and examples coding conventions merely depend on target specific
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
    98
contributor/compiler. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
    99
\item Unix compatible interfaces and examples should compile and run on
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   100
any Unix system (tested on GNU/Linux and GNU/FreeBSD). 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   101
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   102
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   103
\subsection{\canopen standard conformance}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   104
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   105
\subsubsection{DS-301}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   106
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   107
Supported features should conform to DS301. V.4.02 13 february 2002. 
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   108
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   109
\begin{enumerate}
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   110
\item NMT master and slave
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   111
\item Heartbeat consumer and producer
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   112
\item NodeGuard slave reponder and basic master without tracking
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   113
\item SYNC service
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   114
\item SDO multiples client and server, segmented and expedited
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   115
\item PDO : TPDO and RPDO, with respect to transmission type
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   116
\item PDO mapping from/to OD variables bit per bit. 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   117
\item EMCY : Send and receive and keeps track of emergency objects
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   118
\item Data types : 8 to 64 bits values, fixed length strings.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   119
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   120
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   121
\subsubsection{DS-302}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   122
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   123
Only concise DFC is supported.
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   124
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   125
\section{How to start}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   126
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   127
\subsection{Host requirements}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   128
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   129
What you need on your development workstation.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   130
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   131
\subsubsection{Object Dictionary Editor GUI}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   132
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   133
\begin{enumerate}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   134
\item Python, with 
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   135
\item wxPython modules installed (at least version 2.6.3).
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   136
\item Gnosis xml tools. (Optional can also be installed locally to the project
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   137
automatically with the help of a Makefile. Please see {}``Using Dictionary
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   138
Editor GUI'' ) 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   139
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   140
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   141
\subsubsection{Linux and Unix-likes}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   142
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   143
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   144
\item Linux, FreeBSD, Cygwin or any Unix environment with GNU toolchain. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   145
\item The GNU C compiler (gcc) or any other ANSI-C compiler for your target
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   146
platform. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   147
\item Xpdf, and the official 301\_v04000201.pdf file in order to get GUI
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   148
context sensitive help. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   149
\item GNU Make 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   150
\item Bash and sed 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   151
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   152
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   153
\subsubsection{Windows (for native win32 target)}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   154
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   155
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   156
\item Visual Studio Express 2005 or worst. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   157
\item Microsoft platform SDK (requires Genuine Advantage) 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   158
\item Cygwin (for configuration only) 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   159
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   160
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   161
\subsection{How to get CanFestival}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   162
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   163
Please always use CVS, this is the best way to get the most reactive
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   164
support from the developer community :
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   165
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   166
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   167
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   168
	cvs -d:pserver:anonymous@lolitech.dyndns.org:/canfestival login
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   169
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   170
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   171
(type return, without entering a password)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   172
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   173
Then, enter :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   174
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   175
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   176
	cvs -z3 -d:pserver:anonymous@lolitech.dyndns.org:/canfestival co -P CanFestival-3
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   177
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   178
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   179
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   180
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   181
\section{Understanding Canfestival}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   182
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   183
\subsection{CanFestival Project tree layout}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   184
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   185
Simplified directory structure.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   186
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   187
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   188
./src ANSI-C source of \canopen stack
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   189
./include Exportables Header files
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   190
./drivers Interfaces to specific platforms/HW
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   191
./drivers/unix Linux and Cygwin OS interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   192
./drivers/win32 Native Win32 OS interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   193
./drivers/timers_xeno Xenomai timers/threads (Linux only)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   194
./drivers/timers_kernel Linux kernel timer/threads
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   195
./drivers/timers_unix Posix timers/threads (Linux, Cygwin)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   196
./drivers/can_virtual_kernel Fake CAN network (kernel space)
448
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   197
./drivers/can_serial Serial point to point and PTY hub (*nix only)
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   198
./drivers/can_peak_linux PeakSystem CAN library interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   199
./drivers/can_peak_win32 PeakSystem PCAN-Light interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   200
./drivers/can_uvccm_win32 Acacetus's RS232 CAN-uVCCM interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   201
./drivers/can_virtual Fake CAN network (Linux, Cygwin)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   202
./drivers/hcs12 HCS12 full target interface
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   203
./examples Examples
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   204
./examples/TestMasterSlave 2 nodes, NMT SYNC SDO PDO, win32+unix
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   205
./examples/TestMasterMicroMod 1 node, control Peak I/O Module, unix
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   206
./examples/gene_SYNC_HCS12 Just send periodic SYNC on HCS12
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   207
./examples/win32test Ask some DS301 infos to a node (win32)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   208
./objdictgen Object Dictionary editor GUI
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   209
./objdictgen/config Pre-defined OD profiles
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   210
./objdictgen/examples Some examples/test OD
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   211
./doc Documentation source
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   212
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   213
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   214
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   215
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   216
\subsection{Implement CanFestival in your application}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   217
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   218
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   219
\includegraphics[width=12cm]{Pictures/10000201000003F9000002CF880931E7} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   220
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   221
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   222
\bigskip{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   223
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   224
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   225
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   226
\subsection{CanFestival CAN interfaces}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   227
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   228
Because most CAN controllers and drivers implement FIFOs, CanFestival
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   229
consider sending message as a non blocking operation.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   230
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   231
In order to prevent reentrent calls to the stack, messages reception
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   232
is implemented differently on {\textmu}C and OS.:
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   233
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   234
\begin{enumerate}
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   235
\item {\textmu}C must provide interruption masking, mutually excluding timer and CAN receive interrupts.\\
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   236
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   237
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   238
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   239
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   240
\includegraphics[width=12cm]{Pictures/10000201000003CA0000016604E6A5EF} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   241
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   242
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   243
\item OS must provide a receive thread, a timer thread and a mutex. CAN
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   244
reception should be a bloking operation.\\
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   245
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   246
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   247
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   248
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   249
\includegraphics[width=12cm]{Pictures/10000201000003F9000002CF8B0CDAEA} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   250
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   251
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   252
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   253
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   254
\subsection{CanFestival event scheduling}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   255
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   256
A \canopen node must be able to take delayed actions.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   257
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   258
For instance, periodic sync emission, heartbeat production or SDO timeout
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   259
need to set some alarms that will be called later and do the job.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   260
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   261
{\textmu}C generally do not have enough free timers to handle all
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   262
the \canopen needs directly. Moreover, CanFestival internal data
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   263
may be corrupt by reentrant calls.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   264
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   265
CanFestival implement a micro -scheduler (timer.c). It uses only one
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   266
timer to mimic many timers. It manage an alarm table, and call alarms
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   267
at desired time.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   268
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   269
\begin{center}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   270
\includegraphics[width=12cm]{Pictures/100000000000022C000000DEDAD2140C} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   271
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   272
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   273
Scheduler can handle short clock value ranges limitation found on
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   274
some {\textmu}C. As an example, value range for a 16bit clock counter
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   275
with 4{\textmu}s tick is crossed within 0.26 seconds... Long alarms
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   276
must be segmented.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   277
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   278
Chronogram illustrate a long alarm (A) and a short periodic alarm
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   279
(B), with a A value {\textgreater} clock range {\textgreater}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   280
B value. Values t0...t8 are successive setTimer call parameter values.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   281
t1 illustrates an intermediate call to TimeDispatch, caused by a delay
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   282
longer than clock range. Because of long alarm segmentation, at the
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   283
end of t1, TimeDispatch call will not trig any alarm callback.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   284
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   285
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   286
\includegraphics[width=12cm]{Pictures/1000000000000396000000FFC42573DA} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   287
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   288
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   289
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   290
\section{Linux Target}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   291
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   292
Linux target is default configure target.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   293
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   294
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   295
\subsection{Linux Compilation and installation}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   296
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   297
Call ./configure -- help to see all available compile time options.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   298
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   299
After invoking ./configure with your platform specific switches, just
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   300
type make.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   301
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   302
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   303
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   304
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   305
	./configure [options]
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   306
	make
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   307
	make install
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   308
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   309
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   310
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   311
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   312
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   313
\subsubsection{Standard Linux node}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   314
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   315
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   316
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   317
	./configure --timers=unix
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   318
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   319
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   320
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   321
To do a \canopen node running on PC -Linux, you need :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   322
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   323
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   324
\item A working linux distribution 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   325
\item One or more Peak system PC CAN interface and the last Peak Linux driver
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   326
installed. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   327
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   328
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   329
\subsubsection{Real -Time Linux node}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   330
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   331
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   332
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   333
	./configure --timers=xeno
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   334
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   335
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   336
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   337
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   338
To do a \canopen node running on PC -Linux, you need :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   339
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   340
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   341
\item A working Linux distribution patched with XENOMAI 2.1 or greater. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   342
\item One or more Peak system PC CAN interface and the last Peak Real Time
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   343
Linux driver installed. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   344
\end{enumerate}
391
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   345
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   346
\subsubsection{Linux kernel node}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   347
391
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   348
To do a CANopen node running on PC-Linux in kernel space, you need:
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   349
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   350
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   351
\begin{enumerate}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   352
\item A working Linux distribution with pre-built 2.6.x.x kernel sources
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   353
\item A CAN card driver compatible with CanFestival
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   354
\end{enumerate}
391
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   355
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   356
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   357
\subsubsection{CAN devices}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   358
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   359
Currently supported CAN devices and corresponding configure switch:
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   360
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   361
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   362
\paragraph{Peak systems}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   363
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   364
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   365
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   366
	./configure --can=peak_linux
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   367
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   368
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   369
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   370
PeakSystems CAN interface is automatically chosen as default CAN interface
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   371
if libpcan is present in the system.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   372
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   373
Please download driver at \href{http://www.peak-system.com/linux}{http://www.peak
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   374
-system.com/linux} and follow instructions in order to install driver
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   375
on your system.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   376
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   377
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   378
\paragraph{Socket -Can (http://socketcan.berlios.de)}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   379
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   380
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   381
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   382
	./configure --can=socket
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   383
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   384
448
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   385
\paragraph{Serial}
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   386
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   387
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   388
\begin{verbatim}
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   389
	./configure --can=serial
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   390
\end{verbatim}
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   391
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   392
The CAN serial driver implements a 1:1 serial connection between 2 CAN devices.
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   393
For example, you can connect 2 CANFestival applications via a NULL modem cable.
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   394
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   395
Also with this driver comes a software hub, for up to 16 CANFestival apps to 
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   396
be connected on a single PC, with an optional connection to another CAN driver.
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   397
Note that only the serial driver is supported at this time.  The hub uses ptys 
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   398
(pseudo ttys) available on a *nix like system.
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
   399
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   400
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   401
\paragraph{LinCan}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   402
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   403
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   404
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   405
	./configure --can=lincan
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   406
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   407
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   408
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   409
\paragraph{Virtual CAN interfaces (for test/debug)}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   410
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   411
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   412
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   413
	./configure --can=virtual
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   414
		or, for kernel space:
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   415
	./configure --can=kernel_virtual
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   416
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   417
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   418
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   419
Virtual CAN interface use Unix pipes to emulate a virtual CAN network.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   420
Each message issued from a node is repeat to all other nodes. Currently
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   421
only works with nodes running in the same process, and does not support
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   422
work with Xenomai.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   423
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   424
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   425
\subsection{Testing your CanFestival installation}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   426
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   427
\subsection{User space}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   428
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   429
Sample provided in /example/TestMasterSlave is installed into your
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   430
system during installation.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   431
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   432
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   433
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   434
	TestMasterSlave
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   435
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   436
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   437
392
3788feef57e0 Some typo fixes in the manual, thanks to Yegor Yefremov (VisionSystems)
etisserant
parents: 391
diff changeset
   438
Default CAN driver library is libcanfestival\_can\_virtual.so., which
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   439
will simply pass CAN messages through Unix pipes between Master and
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   440
Slave.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   441
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   442
You may also want to specify different can interface and define some
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   443
CAN ports. Another example using Peak{\textquotesingle}s dual PCMCIA
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   444
(configure and install with --can=peak) :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   445
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   446
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   447
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   448
	TestMasterSlave -l libcanfestival_can_peak.so -s 40 -m 41
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   449
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   450
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   451
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   452
\subsection{Kernel space}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   453
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   454
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   455
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   456
	example/kerneltest
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   457
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   458
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   459
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   460
It's based on TestMasterSlave example
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   461
and has the same functionality. Uses virtual can driver as default
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   462
too. After successful installation you can insert the module by typing:
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   463
modprobe canf\_ktest Module control is done by simple console 'canf\_ktest\_console'
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   464
which is used to start/stop sending data.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   465
391
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   466
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   467
\section{Windows Targets}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   468
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   469
CanFestival can be compiled and run on Windows platform. It is possible
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   470
to use both Cygwin and win32 native runtime environment.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   471
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   472
\subsection{Object Dictionary Editor GUI installation.}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   473
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   474
Please refer to \hyperlink{a821UsingDictionaryEditorGUIoutline}{8.2.1)Using
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   475
Dictionary Editor GUI}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   476
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   477
\subsection{CYGWIN}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   478
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   479
\subsubsection{Requirements}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   480
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   481
Cygwin have to be installed with those packages :
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   482
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   483
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   484
\item gcc 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   485
\item unzip 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   486
\item wget 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   487
\item make 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   488
\end{enumerate}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   489
Currently, the only supported CAN devices are PeakSystems ones, with
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   490
PcanLight driver and library.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   491
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   492
Please download driver at \href{http://www.peak-system.com/themen/download_gb.html}{http://www.peak
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   493
-system.com/themen/download\_gb.html} \ and follow instructions
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   494
in order to install driver on your system.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   495
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   496
Install Cygwin as required, and the driver for your Peak CAN device.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   497
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   498
Open a Cygwin terminal, and follow those instructions:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   499
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   500
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   501
\subsubsection{Cygwin configuration and compilation}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   502
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   503
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   504
\paragraph{A single node with PcanLight and Peak CAN -USB adapter}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   505
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   506
Download the PCAN-Light Zip file for your HW ( URL from download
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   507
page ):
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   508
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   509
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   510
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   511
	wget http://www.peak -system.com/files/usb.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   512
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   513
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   514
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   515
Extract its content into your cygwin home (it will create a {}``Disk''
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   516
directory):
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   517
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   518
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   519
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   520
	unzip usb.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   521
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   522
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   523
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   524
Configure CanFestival3 providing path to the desired PcanLight implementation:
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   525
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   526
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   527
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   528
	cd CanFestival -3
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   529
	export PCAN_INCLUDE=~/Disk/PCAN-Light/Api/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   530
	export PCAN_HEADER=Pcan_usb.h
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   531
	export PCAN_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_usb.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   532
	./configure --can=peak_win32
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   533
	make
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   534
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   535
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   536
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   537
In order to test, you have to use another CanFestival node, connect
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   538
with a CAN cable.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   539
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   540
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   541
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   542
	cp ~/Disk/PCAN-Light/Pcan_usb.dll .
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   543
	./examples/TestMasterSlave/TestMasterSlave \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   544
	-l drivers/can\_peak\_win32/cygcan\_peak\_win32.dll \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   545
	-S 500K -M none
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   546
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   547
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   548
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   549
Then, on the other node :
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   550
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   551
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   552
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   553
	./TestMasterSlave -l my_driver.so -S none -M 500K
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   554
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   555
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   556
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   557
Now messages are being exchanged between master and slave node.
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   558
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   559
\paragraph{Two nodes with PcanLight and Peak dual PCMCIA -CAN adapter}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   560
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   561
Download the PCAN-Light Zip file for your HW ( URL from download
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   562
page ):
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   563
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   564
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   565
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   566
	wget http://www.peak-system.com/files/pccard.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   567
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   568
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   569
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   570
Extract its content into your cygwin home (it will create a {}``Disk''
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   571
directory):
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   572
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   573
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   574
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   575
	unzip pccard.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   576
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   577
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   578
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   579
The configure CanFestival3 providing path to the desired PcanLight
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   580
implementation:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   581
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   582
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   583
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   584
	export PCAN_INCLUDE=~/Disk/PCAN-Light/Api/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   585
	export PCAN_HEADER=Pcan_pcc.h
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   586
	export PCAN_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_pcc.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   587
	export PCAN2_HEADER=Pcan_2pcc.h
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   588
	export PCAN2_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_2pcc.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   589
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   590
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   591
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   592
In order to test, just connect together both CAN ports of the PCMCIA
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   593
card. Don{\textquotesingle}t forget 120ohms terminator.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   594
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   595
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   596
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   597
	cp ~/Disk/PCAN-Light/Pcan_pcc.dll .
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   598
	cp ~/Disk/PCAN-Light/Pcan_2pcc.dll .
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   599
	./examples/TestMasterSlave/TestMasterSlave \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   600
	   -l drivers/can_peak_win32/cygcan_peak_win32.dll
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   601
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   602
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   603
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   604
Messages are then exchanged between master and slave node, both inside
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   605
TestMasterSlave{\textquotesingle}s process.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   606
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   607
\subsection{Visual Studio C++}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   608
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   609
\subsubsection{Requirements}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   610
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   611
Minimal Cygwin installation is required at configuration time in order
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   612
to create specific header files (config.h and cancfg.h). Once this
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   613
files created, cygwin is not necessary any more.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   614
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   615
Project and solution files have been created and tested with Visual
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   616
Studio Express 2005. Be sure to have installed Microsoft Platform
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   617
SDK, as recommended at the end of Visual Studio installation.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   618
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   619
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   620
\subsubsection{Configuration with cygwin}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   621
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   622
Follow instructions given at \hyperlink{Cygwin configuration and compilation}{Cygwin
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   623
configuration and compilation}, but do neither call make nor do tests,
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   624
just do configuration steps. This will create headers files accordingly
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   625
to your configuration parameters, and the desired CAN hardware.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   626
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   627
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   628
\subsubsection{Compilation with Visual Studio}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   629
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   630
You can either load independent {}``{*}.vcproj'' project files
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   631
along your own projects in your own solution or load the provided
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   632
{}``CanFestival -3.vc8.sln'' solution files directly.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   633
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   634
Build CanFestival -3 project first.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   635
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   636
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   637
\paragraph{PcanLight and the can\_peak\_win32 project.}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   638
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   639
Chosen Pcan\_xxx.lib and eventually Pcan\_2xxx.lib files must be added
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   640
to can\_peak\_win32 \ \ project before build of the DLL.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   641
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   642
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   643
\subsubsection{Testing}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   644
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   645
Copy eventually needed dlls (ie : Pcan\_Nxxx.lib) into Release or
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   646
Debug directory, and run the test program:
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   647
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   648
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   649
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   650
	TestMasterSlave.exe -l can_peak_win32.dll
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   651
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   652
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   653
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   654
\subsection{MSYS}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   655
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   656
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   657
\subsubsection{Requirements}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   658
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   659
Download from : http://sourceforge.net/project/showfiles.php?group\_id=2435
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   660
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   661
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   662
\item MSYS-1.0.10.exe 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   663
\item MinGW-5.1.3.exe 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   664
\item mingwPORT (which contains wget-1.9.1) 
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   665
\end{enumerate}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   666
Please download driver at http://www.peak-system.com/themen/download\_gb.html
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   667
and follow instructions in order to install driver on your system.
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   668
Install MSYS and MingW as required, and the driver for your Peak CAN
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   669
device. Open a MSYS terminal, and follow those instructions:\\
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   670
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   671
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   672
\begin{itemize}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   673
\item extract wget-1.9.1-mingwPORT.tar.bz2 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   674
\item copy wget.exe in c:\textbackslash{} msys\textbackslash{} 1.0\textbackslash{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   675
bin\textbackslash{} 
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   676
\item start MSYS and check the file /etc/fstab contain the line c:/MinGW
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   677
/mingw 
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   678
\end{itemize}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   679
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   680
\subsubsection{MSYS configuration and compilation}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   681
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   682
Instructions for compilation are nearly the same as CYGWIN part.
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   683
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   684
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   685
\paragraph{A single node with PcanLight and Peak CAN-USB adapter}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   686
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   687
Download the PCAN-Light Zip file for your HW ( URL from download page
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   688
):
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   689
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   690
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   691
	wget http://www.peak-system.com/files/usb.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   692
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   693
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   694
Extract its content into your MSYS's home (it will create a \char`\"{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   695
Disk\char`\"{} directory):
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   696
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   697
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   698
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   699
	unzip usb.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   700
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   701
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   702
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   703
Configure CanFestival3 providing path to the desired PcanLight implementation:
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   704
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   705
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   706
	cd CanFestival-3
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   707
	export PCAN_INCLUDE=~/Disk/PCAN-Light/Api/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   708
	export PCAN_HEADER=Pcan_usb.h
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   709
	export PCAN_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_usb.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   710
	./configure --can=peak_win32
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   711
	make
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   712
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   713
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   714
In order to test, you have to use another CanFestival node, connect
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   715
with a CAN cable.
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   716
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   717
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   718
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   719
	cp ~/Disk/PCAN-Light/Pcan_usb.dll .
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   720
	./examples/TestMasterSlave/TestMasterSlave \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   721
	  -l drivers/can_peak_win32/cygcan_peak_win32.dll \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   722
	  -S 500K -M none
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   723
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   724
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   725
Then, on the other node :
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   726
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   727
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   728
	./TestMasterSlave -l my_driver.so -S none -M 500K -m 0
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   729
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   730
Now messages are being exchanged between master and slave node.
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   731
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   732
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   733
\paragraph{Two nodes with PcanLight and Peak dual PCMCIA-CAN adapter}
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   734
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   735
Download the PCAN-Light Zip file for your HW ( URL from download page
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   736
):
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   737
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   738
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   739
	wget http://www.peak-system.com/files/pccard.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   740
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   741
Extract its content into your MSYS's home (it will create a \char`\"{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   742
Disk\char`\"{} directory):
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   743
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   744
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   745
	unzip pccard.zip
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   746
\end{verbatim}
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   747
The configure CanFestival3 providing path to the desired PcanLight
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   748
implementation:
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   749
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   750
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   751
	export PCAN_INCLUDE=~/Disk/PCAN-Light/Api/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   752
	export PCAN_HEADER=Pcan_pcc.h}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   753
	export PCAN_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_pcc.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   754
	export PCAN2_HEADER=Pcan_2pcc.h
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   755
	export PCAN2_LIB=~/Disk/PCAN-Light/Lib/Visual\ C++/Pcan_2pcc.lib
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   756
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   757
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   758
In order to test, just connect together both CAN ports of the PCMCIA
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   759
card. Don't forget 120ohms terminator.
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   760
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   761
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   762
	cp~/Disk/PCAN-Light/Pcan_pcc.dll ~.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   763
	cp ~/Disk/PCAN-Light/Pcan_2pcc.dll ~.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   764
	./examples/TestMasterSlave/TestMasterSlave \
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   765
		-l drivers/can\_peak\_win32/cygcan\_peak\_win32.dll -m 0 -s 1
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   766
\end{verbatim}
282
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   767
Messages are then exchanged between master and slave node, both inside
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   768
TestMasterSlave's process.
6afe145df950 Updated manual for msys/mingw build
greg
parents: 249
diff changeset
   769
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   770
\section{Motorola HCS12}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   771
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   772
The examples have been tested on a MC9S12DG255 mounted on a Elektronikladen
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   773
HCS12 T -board.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   774
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   775
Beware that there are few differences in the MSCAN module of the 68HC12
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   776
and HCS12 microcontroller. For a HC12, you must adapt the driver that
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   777
we provide for \ the HCS12.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   778
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   779
For the difference MSCAN HC12/HCS12, see the Motorola application
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   780
note AN2011/D.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   781
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   782
Configure switch:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   783
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   784
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   785
	--target=hcs12
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   786
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   787
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   788
To do a \canopen node running on a microncontroller Motorola MC9S12DP256,
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   789
you need :
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   790
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   791
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   792
\item The compiler GNU gcc for HC11, HC12, HCS12 : m6811 -elf. \\
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   793
 Download the \textbf{release 3.1} at : \href{http://m68hc11.serveftp.org/m68hc11_pkg_rpm.php}{http://m68hc11.serveftp.org/m68hc11\_pkg\_rpm.php} 
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   794
\item A board with this chip. We are using the T -board from Electronikladen. 
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   795
\item At least about 40 kBytes of program memory. 
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   796
\item A tool to flash the memory. (We are using the high cost Lauterbach
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   797
debugger). 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   798
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   799
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   800
\subsection{Running a HCS12 node}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   801
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   802
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   803
\subsubsection{Compiling Canfestival:}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   804
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   805
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   806
	./configure --target=hcs12
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   807
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   808
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   809
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   810
\subsubsection{Compiling and building an example}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   811
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   812
Enter in the folder of an HCS12 example,
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   813
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   814
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   815
	make all
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   816
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   817
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   818
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   819
\subsubsection{Flashing the memory :}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   820
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   821
Use your preferred loader ! If you are using a debugger Lauterbach,
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   822
you can load the bash file : trace32\_flash\_programmer.cmm. It loads
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   823
directly the elf file.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   824
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   825
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   826
\subsubsection{Connecting to a serial RS232 console :}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   827
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   828
Connect the portS(TxD0) of the HCS12 to a console configured at 19200
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   829
bauds 8N1, via a Max232 chip to adapt the electrical levels. On Linux,
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   830
you can use minicom. Connecting to a console is useful to read the
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   831
messages, but not required.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   832
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   833
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   834
\subsubsection{Connecting to the CAN network :}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   835
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   836
Connect the port CAN0 (pin PM0, PM1) to the network via a CAN controller.
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   837
On our board, the CAN controller is a PCA82C250 chip.
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   838
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   839
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   840
\subsubsection{starting the node :}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   841
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   842
Press the reset of your HCS12 board.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   843
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   844
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   845
\section{Example and test program:}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   846
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   847
The {}``examples'' directory contains some test program you can
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   848
use as example for your own developments.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   849
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   850
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   851
\subsection{TestMasterSlave}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   852
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   853
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   854
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   855
  **************************************************************
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   856
  *  TestMasterSlave                                           *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   857
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   858
  *  A simple example for PC. It does implement 2 CanOpen      *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   859
  *  nodes in the same process. A master and a slave. Both     *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   860
  *  communicate together, exchanging periodically NMT, SYNC,  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   861
  *  SDO and PDO. Master configure heartbeat producer time     *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   862
  *  at 1000 ms for slave node-id 0x02 by concise DCF.         *                                  
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   863
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   864
  *   Usage:                                                   *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   865
  *   ./TestMasterSlave  [OPTIONS]                             *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   866
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   867
  *   OPTIONS:                                                 *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   868
  *     -l : Can library ["libcanfestival_can_virtual.so"]     *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   869
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   870
  *    Slave:                                                  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   871
  *     -s : bus name ["0"]                                    *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   872
  *     -S : 1M,500K,250K,125K,100K,50K,20K,10K,none(disable)  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   873
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   874
  *    Master:                                                 *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   875
  *     -m : bus name ["1"]                                    *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   876
  *     -M : 1M,500K,250K,125K,100K,50K,20K,10K,none(disable)  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   877
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   878
  **************************************************************
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   879
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   880
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   881
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   882
Notes aboute use of voncise DCF :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   883
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   884
In this example, Master configure heartbeat producer time
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   885
at 1000 ms for slave node -id 0x02 by concise DCF according DS -302
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   886
profile.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   887
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   888
Index 0x1F22, sub-index 0x00 of the master OD, correspond
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   889
to the number of entries. This equal to the maximum possible nodeId
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   890
(127). Each sub -index points to the Node -ID of the device, to which
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   891
the configuration belongs.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   892
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   893
To add more parameters configurations to the slave, the value
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   894
at sub -index 0x02 must be a binary stream (little -endian) following
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   895
this structure :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   896
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   897
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   898
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   899
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   900
	 (UNS32) nb of entries
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   901
	 (UNS16) index parameter 1
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   902
	 (UNS8) sub -index parameter 1
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   903
	 (UNS32) size data parameter 1
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   904
	 (DOMAIN) data parameter 1
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   905
	 (UNS16) index parameter 2
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   906
	 (UNS8) sub -index parameter 2
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   907
	 (UNS32) size data parameter 2
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   908
	 (DOMAIN) data parameter 2
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   909
	      ....
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   910
	 (UNS16) index parameter n
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   911
	 (UNS8) sub -index parameter n
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   912
	 (UNS32) size data parameter n
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   913
	 (DOMAIN) data parameter n
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   914
	 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   915
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   916
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   917
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   918
So the binary value stream to configure heartbeat producer
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   919
time must be :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   920
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   921
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   922
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   923
	0100000017100002000000e803
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   924
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   925
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   926
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   927
The slave node is configured just before the Master entering
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   928
in Pre\_operational state.
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   929
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   930
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   931
\subsection{gene\_SYNC\_HCS12 :}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   932
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   933
This is a simple \canopen node that only send cyclic SYNC message.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   934
It demonstrate implementation on HCS12 based board.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   935
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   936
\bigskip{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   937
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   938
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   939
391
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   940
\subsection{kerneltest :}
7802a7d5584f Accepted Vladimir Chren linux kernelspace port patch.
etisserant
parents: 284
diff changeset
   941
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   942
Example based on TestMasterSlave slightly modified to suit kernel
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   943
space requisites. It will do the same as TestMasterSlave but in kernel
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   944
space sending kernel messages (displayed by dmesg for example). It
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   945
is designed as external kernel module implemented as character device.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   946
There is a shell script called 'insert.sh', which will insert the
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   947
module and create a new device file /dev/canf\_ktest (used to sending
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   948
commands to module). To actual sending commands you can use simple
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   949
console named 'canf\_ktest\_console'. The module is dependent on a
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   950
another separate module 'canfestival.ko' implementing CanOpen stack
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   951
which exports requisite functions. Canfestival.ko module is then dependent
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   952
on CAN card driver module, by default CAN virtual driver will be loaded.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   953
After installing modules (make install), all dependencies are solved
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   954
automatically by kernel. To run the example type: 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   955
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   956
	sh run.sh
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   957
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   958
It will insert required modules, start console, and after quitting
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   959
console it'll remove modules from kernel.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   960
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   961
\bigskip{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   962
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   963
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   964
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
   965
\subsection{TestMasterMicroMod }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
   966
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   967
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   968
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   969
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   970
  **************************************************************
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   971
  *  TestMasterMicroMod                                        *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   972
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   973
  *  A simple example for PC.                                  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   974
  *  A CanOpen master that control a MicroMod module:          *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   975
  *  - setup module TPDO 1 transmit type                       *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   976
  *  - setup module RPDO 1 transmit type                       *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   977
  *  - setup module hearbeatbeat period                        *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   978
  *  - disable others TPDOs                                    *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   979
  *  - set state to operational                                *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   980
  *  - send periodic SYNC                                      *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   981
  *  - send periodic RPDO 1 to Micromod (digital output)       *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   982
  *  - listen Micromod's TPDO 1 (digital input)                *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   983
  *  - Mapping RPDO 1 bit per bit (digital input)              *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   984
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   985
  *   Usage:                                                   *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   986
  *   ./TestMasterMicroMod  [OPTIONS]                          *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   987
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   988
  *   OPTIONS:                                                 *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   989
  *     -l : Can library ["libcanfestival_can_virtual.so"]     *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   990
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   991
  *    Slave:                                                  *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   992
  *     -i : Slave Node id format [0x01 , 0x7F]                *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   993
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   994
  *    Master:                                                 *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   995
  *     -m : bus name ["1"]                                    *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   996
  *     -M : 1M,500K,250K,125K,100K,50K,20K,10K                *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   997
  *                                                            *
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   998
  **************************************************************
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
   999
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1000
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1001
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1002
\section{Developing a new node}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1003
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1004
Using provided examples as a base for your new node is generally a
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1005
good idea. You can also use the provided {*}.od files as a base for
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1006
your node object dictionary.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1007
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1008
Creating a new \canopen node implies to define the Object Dictionary
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1009
of this node. For that, developer has to provide a C file. This C
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1010
file contains the definition of all dictionary entries, and some kind
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1011
of index table that helps the stack to access some entries directly.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1012
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1013
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1014
\subsection{Using Dictionary Editor GUI}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1015
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1016
The Object Dictionary Editor is a WxPython based GUI that is used
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1017
to create the C file needed to create a new \canopen node.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1018
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1019
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1020
\subsubsection{Installation and usage on Linux}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1021
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1022
You first have to download and install Gnosis XML modules. This is
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1023
automated by a Makefile rule.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1024
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1025
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1026
	cd objdictgen 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1027
	make
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1028
\end{verbatim}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1029
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1030
Now start the editor.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1031
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1032
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1033
	python objdictedit.py [od files...]
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1034
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1035
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1036
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1037
\subsubsection{Installation and usage on Windows}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1038
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1039
Install Python (at least version 2.4) and wxPython (at least version
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1040
2.6.3.2).
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1041
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1042
Cygwin users can install Gnosis XML utils the same as Linux use. Just
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1043
call make.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1044
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1045
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1046
	cd objdictgen
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1047
	make
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1048
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1049
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1050
Others will have to download and install Gnosis XML by hand :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1051
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1052
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1053
	Gnosis Utils:
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1054
	http://freshmeat.net/projects/gnosisxml/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1055
	http://www.gnosis.cx/download/
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1056
	Get latest version.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1057
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1058
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1059
Download CanFestival archive and uncompress it. Use windows file explorer
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1060
to go into CanFestival3\textbackslash{}objdicgten, and double -click
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1061
on objdictedit.py.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1062
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1063
\subsubsection{About}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1064
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1065
The Object Dictionary editor GUI is a python application that use
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1066
the Model-View-Controller design pattern. It depends on WxPython to
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1067
display view on any supported platform.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1068
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1069
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1070
\includegraphics[width=7cm]{Pictures/10000201000001FC000001E5D65E8766} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1071
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1072
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1073
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1074
\subsubsection{Main view}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1075
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1076
Top list let you choose dictionary section, bottom left list is the
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1077
selected index in that dictionary, and bottom right list are edited
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1078
sub -indexes.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1079
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1080
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1081
\includegraphics[width=12cm]{Pictures/10000201000003E7000001C7B0296577} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1082
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1083
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1084
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1085
\includegraphics[width=3cm]{Pictures/10000000000000B6000000DF1EDD1E73} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1086
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1087
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1088
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1089
\includegraphics[width=3cm]{Pictures/10000000000000AC000000C9C3F53FA6} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1090
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1091
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1092
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1093
\includegraphics[width=3cm]{Pictures/100000000000006D000000A31EC8CB54} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1094
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1095
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1096
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1097
\includegraphics[width=3cm]{Pictures/10000000000000AA0000006014F74635} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1098
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1099
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1100
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1101
\subsubsection{New node}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1102
440
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1103
Edit your node name and type. Choose your inherited specific profile.
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1104
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1105
\begin{center}
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1106
\includegraphics[width=11cm]{Pictures/new_node} 
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1107
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1108
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1109
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1110
\subsubsection{Node info}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1111
440
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1112
Edit your node name and type.
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1113
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1114
\begin{center}
dfcec7403169 Fixes in manual ( removed Node ID setting in objdiectedit screenshots)
etisserant
parents: 394
diff changeset
  1115
\includegraphics[width=7cm]{Pictures/node_info} 
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1116
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1117
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1118
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1119
\subsubsection{Profile editor}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1120
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1121
Chose the used profile to edit.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1122
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1123
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1124
\includegraphics[width=4cm]{Pictures/10000000000000AB000000C88F594413} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1125
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1126
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1127
Pick up optional chosen profile entries.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1128
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1129
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1130
\includegraphics[width=11cm]{Pictures/10000201000002DE000001D82D89C224} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1131
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1132
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1133
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1134
\subsubsection{User types}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1135
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1136
Use User Types to implement value boundaries, and string length
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1137
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1138
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1139
\includegraphics[width=11cm]{Pictures/10000201000001C40000010766961D7F} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1140
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1141
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1142
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1143
\subsubsection{Mapped variable}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1144
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1145
Add your own specific dictionary entries and associated mapped variables.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1146
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1147
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1148
\includegraphics[width=11cm]{Pictures/10000201000001C4000000DD129D4661} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1149
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1150
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1151
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1152
\subsubsection{Integrated help}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1153
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1154
Using F1 key, you can get context sensitive help.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1155
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1156
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1157
\includegraphics[width=12cm]{Pictures/10000201000002F30000020B23ED7F67} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1158
\par\end{center}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1159
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1160
In order to do that, official 301\_v04000201.pdf file must be placed
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1161
into doc/ directory, and xpdf must be present on your system.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1162
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1163
F2 key open HTML CanFestival help.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1164
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1165
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1166
\includegraphics[width=12cm]{Pictures/10000201000003440000025ACC3FD2F1} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1167
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1168
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1169
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1170
\subsection{Generating the object Dictionary}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1171
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1172
Once object dictionary has been edited and saved, you have to generate
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1173
object dictionary C code for your CanFestival node.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1174
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1175
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1176
\subsubsection{With GUI}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1177
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1178
Menu entry {}``File/Build Dictionary''.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1179
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1180
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1181
\includegraphics[width=4cm]{Pictures/10000201000000B7000000C66AF89CD5} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1182
\par\end{center}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1183
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1184
Choose C file to create or overwrite. Header file will be also created
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1185
with the same prefix as C file.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1186
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1187
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1188
\subsubsection{With command line}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1189
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1190
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1191
	Usage of objdictgen.py :
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1192
	python objdictgen.py XMLFilePath CfilePath
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1193
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1194
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1195
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1196
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1197
\section{FAQ}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1198
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1199
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1200
\subsection{General}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1201
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1202
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1203
\subsubsection{Does the code compiles on Windows ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1204
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1205
Yes, with both Cygwin and Visual Studio C++. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1206
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1207
Because \canopen layer is coded with C, put a compilation option
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1208
/TC or /TP if you plan to mix C++ files. See the MSDN documentation
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1209
about that.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1210
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1211
448
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1212
\subsubsection{How to fit the library to an other microcontr�ler ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1213
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1214
First, be sure that you have at least 40K bytes of program memory,
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1215
and about 2k of RAM.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1216
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1217
You have to create target specific interface to HW resources. Take
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1218
model on bundled interfaces provided in drivers/ and create your own
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1219
interface. You also have to update Makefile.in files for target specific
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1220
cflags and options. Choose {--}target= configure switch to compile
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1221
your specific interface.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1222
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1223
You are welcome to contribute -back your own interfaces! Other Canfestival
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1224
users will use it and provide feedback, tests and enhancements.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1225
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1226
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1227
\subsubsection{Is CanFestival3 conform to DS301 v.4.02 ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1228
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1229
Thanks to Philippe Foureys (IUT of Valence), a slave node have been
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1230
tested with the National Instrument \canopen Conformance Test. It
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1231
passed the test with success.
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1232
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1233
Some very small unconformity have been found in very unusual situations,
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1234
for example in the SDO code response to wrong messages.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1235
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1236
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1237
\subsection{LINUX}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1238
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1239
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1240
\subsubsection{How to use a Peaksystem CAN board ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1241
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1242
Just install peak driver and then compile and install Canfestival.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1243
Peak driver is detected at compile time.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1244
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1245
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1246
\subsubsection{How to use an unsupported CAN board ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1247
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1248
You have to install the specific driver on your system, with necessary
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1249
libs and headers.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1250
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1251
Use can\_peak.c/h or can\_virtual.c/h as an example, and adapt it
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1252
to your driver API.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1253
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1254
Execute configure script and choose --can=mydriver
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1255
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1256
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1257
\subsection{Win32}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1258
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1259
Compatibility:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1260
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1261
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1262
\item Code was compiled MS VisualStudio 2003.NET and VisualStudio 2005.NET
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1263
for WindowsXP \ with ANSI and UNICODE configurations and for WindowsCE
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1264
5.0. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1265
\item Some preliminary testing was done, but not enough to be used in mission
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1266
critical projects. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1267
\end{enumerate}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1268
Additional Features:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1269
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1270
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1271
\item Non -integral integers support implementation UNS24, UNS40, UNS48
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1272
etc. 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1273
\item When enable debug output with DEBUG\_WAR\_CONSOLE\_ON or DEBUG\_ERR\_CONSOLE\_ON,
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1274
you can navigate in CanFestival source code by double clicking at
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1275
diagnostic lines in VisualStudio.NET 200X Debug Output Window. 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1276
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1277
Custom size integral types such as INTEGER24, UNS40, INTEGER56 etc.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1278
have been defined as 64 bits integers. You will need to replace sizeof(TYPE)
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1279
operators to sizeof\_TYPE definitions in generated code, i.e. replace
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1280
sizeof(UNS40) with sizeof\_UNS40.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1281
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1282
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1283
\subsection{HCS12}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1284
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1285
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1286
\subsubsection{Which board are you using ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1287
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1288
A T -board from elektronikladen with a MC9S12DP256 or MC9S12DG256.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1289
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1290
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1291
\subsubsection{Does the code compile with an other compiler than GNU gcc ?}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1292
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1293
It is known to work with Metrowerks CodeWarrior. Here are some tips
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1294
from Philippe Foureys. :
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1295
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1296
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1297
\paragraph{Interrupt functions}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1298
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1299
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1300
\subparagraph{Code for GCC:
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1301
}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1302
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1303
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1304
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1305
	// prototype
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1306
	void __attribute__((interrupt))timer3Hdl(void):
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1307
	// function
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1308
	void __attribute__((interrupt))timer3Hdl(void){...}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1309
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1310
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1311
	
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1312
\subparagraph{Code for CodeWarrior
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1313
}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1314
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1315
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1316
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1317
	// protoype
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1318
	void interrupt timer3Hdl(void);
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1319
	// function
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1320
	pragma CODE_SEG__NEAR_SEG_NON_BANKED
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1321
	void interrupt timer3Hdl(void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1322
	{...}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1323
	pragma CODE_SEG_DEFAULT\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1324
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1325
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1326
\paragraph{Interrupt lock, unlock
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1327
}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1328
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1329
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1330
\subparagraph{Code for GCC
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1331
}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1332
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1333
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1334
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1335
 void unlock (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1336
 {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1337
   __asm__ __volatile__("cli");
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1338
 }
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1339
 void lock (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1340
 {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1341
   unsigned short mask;
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1342
   __asm__ __volatile__("tpa\n\tsei":"=d"(mask));
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1343
 }
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1344
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1345
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1346
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1347
\subparagraph{Code for CodeWarrior}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1348
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1349
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1350
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1351
void unlock (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1352
	{
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1353
	  __asm("cli");
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1354
	}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1355
	void lock (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1356
	{
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1357
	  unsigned short mask;
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1358
	  __asm
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1359
	 {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1360
	  tpa:tsei:"=d"(mask);
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1361
	 }
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1362
	}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1363
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1364
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1365
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1366
\paragraph{Initialize function}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1367
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1368
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1369
\subparagraph{Code for GCC}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1370
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1371
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1372
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1373
void initCanHCS12 (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1374
{  
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1375
  //Init the HCS12 microcontroler for CanOpen 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1376
  initHCS12();
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1377
   // Init the HCS12  CAN driver
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1378
  const canBusInit bi0 = {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1379
    0,    /* no low power                 */ 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1380
    0,    /* no time stamp                */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1381
    1,    /* enable MSCAN                 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1382
    0,    /* clock source : oscillator (In fact, it is not used)   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1383
    0,    /* no loop back                 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1384
    0,    /* no listen only               */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1385
    0,    /* no low pass filter for wk up */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1386
  CAN_Baudrates[CAN_BAUDRATE_250K],
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1387
    {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1388
      0x00,    /* Filter on 16 bits.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1389
                  See Motorola Block Guide V02.14 fig 4-3 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1390
      0x00, 0xFF, /* filter 0 hight accept all msg      */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1391
      0x00, 0xFF, /* filter 0 low accept all msg        */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1392
      0x00, 0xFF, /* filter 1 hight filter all of  msg  */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1393
      0x00, 0xFF, /* filter 1 low filter all of  msg    */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1394
      0x00, 0xFF, /* filter 2 hight filter most of  msg */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1395
      0x00, 0xFF, /* filter 2 low filter most of  msg   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1396
      0x00, 0xFF, /* filter 3 hight filter most of  msg */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1397
      0x00, 0xFF, /* filter 3 low filter most of  msg   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1398
    }
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1399
};
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1400
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1401
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1402
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1403
\subparagraph{Code for CodeWarrior
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1404
}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1405
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1406
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1407
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1408
void initCanHCS12 (void)
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1409
{  
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1410
  //Init the HCS12 microcontroler for CanOpen 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1411
  initHCS12();
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1412
   // Init the HCS12  CAN driver
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1413
  const canBusInit bi0 = {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1414
    0,    /* no low power                 */ 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1415
    0,    /* no time stamp                */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1416
    1,    /* enable MSCAN                 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1417
    0,    /* clock source : oscillator (In fact, it is not used)   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1418
    0,    /* no loop back                 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1419
    0,    /* no listen only               */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1420
    0,    /* no low pass filter for wk up */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1421
    {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1422
     1, /* clksrc */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1423
     3, /* brp    */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1424
     0, /* sjw    */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1425
     0, /* samp   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1426
     1, /* tseg2  */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1427
     12,/* tseg1  */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1428
    },
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1429
    {
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1430
      0x00,    /* Filter on 16 bits.
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1431
                 See Motorola Block Guide V02.14 fig 4-3 */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1432
      0x00, 0xFF, /* filter 0 hight accept all msg      */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1433
      0x00, 0xFF, /* filter 0 low accept all msg        */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1434
      0x00, 0xFF, /* filter 1 hight filter all of  msg  */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1435
      0x00, 0xFF, /* filter 1 low filter all of  msg    */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1436
      0x00, 0xFF, /* filter 2 hight filter most of  msg */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1437
      0x00, 0xFF, /* filter 2 low filter most of  msg   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1438
      0x00, 0xFF, /* filter 3 hight filter most of  msg */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1439
      0x00, 0xFF, /* filter 3 low filter most of  msg   */
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1440
    }
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1441
};
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1442
\end{verbatim}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1443
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1444
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1445
\subsubsection{Does the code works in banked memory ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1446
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1447
No. Today it seems that the port of gcc is bogged for using the banked
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1448
memory. So, unfortunately, we are limited to 48 Kbytes of memory code.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1449
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1450
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1451
\subsubsection{What GCC version are you using ?}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1452
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1453
We are using the stable RPM release 2.2 :
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1454
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1455
\begin{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1456
\item GNU Gcc 3.0.4. Build 20030501 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1457
\item Newlib 1.10.0 Build 20030421 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1458
\item GNU Binutils 2.12.1 Build 20030427 
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1459
\end{enumerate}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1460
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1461
\section{Documentation resources}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1462
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1463
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1464
\subsection{CIA : Can in Automation }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1465
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1466
\href{http://www.can-cia.de/}{http://www.can -cia.de}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1467
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1468
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1469
\subsection{Resources and training in \canopen 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1470
}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1471
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1472
\href{http://www.esacademy.com/}{http://www.esacademy.com}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1473
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1474
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1475
\subsection{Elektronikladen HCS12 T -board }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1476
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1477
\href{http://www.elektronikladen.de/en_hcs12tb.html}{http://www.elektronikladen.de/en\_hcs12tb.html}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1478
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1479
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1480
\subsection{Gnu gcc compiler for HC12 }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1481
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1482
\href{http://m68hc11.serveftp.org/m68hc11_port.php}{http://m68hc11.serveftp.org/m68hc11\_port.php}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1483
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1484
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1485
\subsection{Motorola documentation on HC12 }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1486
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1487
\href{http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=MC9S12DP256}{http://www.freescale.com/webapp/sps/site/prod\_summary.jsp?code=MC9S12DP256}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1488
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1489
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1490
\subsection{Lauterbach debugger for HC12 }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1491
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1492
\href{http://www.lauterbach.com/}{http://www.lauterbach.com}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1493
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1494
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1495
\subsection{Python language }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1496
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1497
\href{http://www.python.org/}{http://www.python.org}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1498
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1499
\clearpage{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1500
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1501
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1502
\section{About the project}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1503
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1504
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1505
\subsection{Contributors }
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1506
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1507
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1508
\includegraphics[width=10cm]{Pictures/1000020100000258000000832C6FFAB4} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1509
\par\end{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1510
448
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1511
Unit� mixte de recherche INRETS -LCPC
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1512
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1513
sur les Interractions V�hicule -Infrastructure -Conducteur
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1514
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1515
14, route de la mini�re
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1516
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1517
78000 Versailles
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1518
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1519
FRANCE
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1520
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1521
Tel : +33 1 40 43 29 01
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1522
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1523
\href{http://www.inrets.fr/ur/livic}{http://www.inrets.fr/ur/livic}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1524
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1525
\textbf{Contributors :} Francis DUPIN
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1526
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1527
Camille BOSSARD
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1528
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1529
Laurent ROMIEUX
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1530
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1531
\bigskip{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1532
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1533
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1534
\begin{center}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1535
\includegraphics[width=10cm]{Pictures/100002010000013A0000004A96B0C1FF} 
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1536
\par\end{center}
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1537
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1538
LOLITECH
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1539
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1540
204, rue du Haut du Pin
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1541
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1542
88470 Saint -Michel sur Meurthe
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1543
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1544
FRANCE
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1545
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1546
Tel : +33 3 29 52 95 67
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1547
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1548
\href{http://www.lolitech.fr/}{http://www.lolitech.fr}
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1549
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1550
\textbf{Contributors :} Edouard TISSERANT (Original author)
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1551
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1552
Laurent BESSARD
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1553
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1554
\bigskip{}
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1555
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1556
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1557
Many thanks to the other contributors for their great work:
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1558
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1559
Raphael ZULLIGER
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1560
448
732c33c2d8a7 CAN over Serial link (TTY) interface, with serial hub software. Thanks to James Steward.
etisserant
parents: 440
diff changeset
  1561
David DUMINY (st� A6R)
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1562
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1563
Zakaria BELAMRI
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1564
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1565
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1566
\subsection{Getting support}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1567
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1568
Send your feedback and bug reports to \href{mailto:canfestival-devel@lists.sourceforge.net}{canfestival-devel@lists.sourceforge.net}.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1569
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1570
For commercial support, \ training and specific integration and developments,
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1571
please ask LOLITECH (see contributors).
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1572
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1573
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1574
\subsection{Contributing}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1575
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1576
You are free to contribute your specific interfaces back to the project.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1577
This way, you can hope to get support from CanFestival users community.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1578
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1579
Please send your patch to \href{mailto:canfestival-devel@lists.sourceforge.net}{canfestival
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1580
-devel@lists.sourceforge.net}.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1581
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1582
Feel free to create some new predefined DS -4xx profiles ({*}.prf)
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1583
in objdictgen/config, as much as possible respectful to the official
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1584
specifications.
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1585
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1586
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1587
\subsection{License}
393
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1588
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1589
All the project is licensed with LGPL. This mean you can link CanFestival
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1590
with any code without being obliged to publish it.
05ad3ba0201d Big cleanup in manual. Used Lyx for that.
etisserant
parents: 392
diff changeset
  1591
394
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1592
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1593
\begin{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1594
#This file is part of CanFestival, a library implementing CanOpen Stack. 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1595
# 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1596
#Copyright (C): Edouard TISSERANT, Francis DUPIN and Laurent BESSARD 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1597
# 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1598
#See COPYING file for copyrights details. 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1599
# 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1600
#This library is free software; you can redistribute it and/or 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1601
#modify it under the terms of the GNU Lesser General Public 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1602
#License as published by the Free Software Foundation; either 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1603
#version 2.1 of the License, or (at your option) any later version. 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1604
# 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1605
#This library is distributed in the hope that it will be useful, 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1606
#but WITHOUT ANY WARRANTY; without even the implied warranty of 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1607
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1608
#Lesser General Public License for more details. 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1609
# 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1610
#You should have received a copy of the GNU Lesser General Public 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1611
#License along with this library; if not, write to the Free Software 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1612
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1613
\end{verbatim}
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1614
b8755668c9e2 Many changes in manual.tex. Now nearly human readable.
etisserant
parents: 393
diff changeset
  1615
208
05d95c45b388 Manual convertion -> latex -> pdf
nico
parents:
diff changeset
  1616
\end{document}