Skip to content

Commit 70332e7

Browse files
hardbytehardbyte
committed
README edited online with Bitbucket
0 parents  commit 70332e7

77 files changed

Lines changed: 7839 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.hgflow‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[branchname]
2+
master = default
3+
develop = develop
4+
feature = feature/
5+
release = release/
6+
hotfix = hotfix/
7+
support = support/
8+

‎.hgignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
syntax: glob
2+
build/
3+
dist/
4+
.idea/
5+
pycanlib.egg-info/
6+
version.txt
7+
*.pyc
8+
*.sw[p|o]

‎CONTRIBUTORS.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Ben Powell
2+
Brian Thorne <hardbyte@gmail.com>
3+
Geert Linders
4+
Mark Catley
5+
Phillip Dixon <pdixon@dynamiccontrols.com>
6+
Rose Lu
7+
Karl van Workum
8+
Albert Bloomfield <albert.bloomfield@ampeletricvehicles.com>
9+
Sam Bristow
10+
Ethan Zonca
11+
Robert Kaye
12+
Andrew Beal
13+
Jonas Frid
14+
Tynan McAuley
15+
Bruno Pennati
16+
Jack Jester-Weinstein
17+
Joshua Villyard
18+
Giuseppe Corbelli <giuseppe.corbelli@weightpack.com>

‎LICENSE.txt‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎MANIFEST.in‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
include *.txt
2+
recursive-include doc *.rst

‎README‎

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
python-can
2+
==========
3+
4+
|release| |docs| |build|
5+
6+
.. |release| image:: https://img.shields.io/pypi/v/python-can.svg
7+
:target: https://pypi.python.org/pypi/python-can/
8+
:alt: Latest Version
9+
10+
.. |docs| image:: https://readthedocs.org/projects/python-can/badge/?version=latest
11+
:target: http://python-can.readthedocs.org/en/latest/?badge=latest
12+
:alt: Documentation Status
13+
14+
.. |build| image:: https://drone.io/bitbucket.org/hardbyte/python-can/status.png
15+
:target: https://drone.io/bitbucket.org/hardbyte/python-can/latest
16+
:alt: CI Server
17+
18+
19+
The **C**\ ontroller **A**\ rea **N**\ etwork is a bus standard designed
20+
to allow microcontrollers and devices to communicate with each other. It
21+
has priority based bus arbitration, reliable deterministic
22+
communication. It is used in cars, trucks, wheelchairs and more. See
23+
`wikipedia <http://en.wikipedia.org/wiki/CAN_bus>`__ for more info.
24+
25+
This module provides controller area network support for
26+
`Python <http://python.org/download/>`__.
27+
28+
Configuration File
29+
------------------
30+
31+
In order to use this library a CAN interface needs to be specified. A
32+
method to do this is to create a configuration file.
33+
On Linux systems the config file is searched in the following paths:
34+
35+
1. ``/etc/can.conf``
36+
2. ``$HOME/.can``
37+
3. ``$HOME/.canrc``
38+
39+
On Windows systems the config file is searched in the following paths:
40+
1. ``can.ini`` (current working directory)
41+
2. ``$APPDATA/can.ini``
42+
43+
The configuration file sets the default interface and channel:
44+
45+
::
46+
47+
[default]
48+
interface = <the name of the interface to use>
49+
channel = <the channel to use by default>
50+
51+
Interfaces
52+
----------
53+
54+
The interface available are:
55+
56+
kvaser
57+
~~~~~~
58+
59+
`Kvaser <http://www.kvaser.com>`__'s CANLib SDK for Windows (also
60+
available on Linux)
61+
62+
socketcan
63+
~~~~~~~~~
64+
65+
On linux the socketcan interface is exposed via either:
66+
67+
- socketcan\_ctypes
68+
- socketcan\_native
69+
70+
serial
71+
~~~~~~
72+
73+
A text based interface. For example use over bluetooth with
74+
``/dev/rfcomm0``
75+
76+
pcan
77+
~~~~
78+
79+
`Peak-System <http://www.peak-system.com/>`__'s PCAN-Basic API.
80+
81+
IXXAT
82+
~~~~~
83+
84+
`IXXAT <http://www.ixxat.com/>`__'s Virtual CAN Interface V3 SDK ONLY on Windows.
85+
The Linux ECI SDK is currently unsupported.
86+
On Linux some devices are supported with socketcan.
87+
88+
Installation
89+
------------
90+
91+
GNU/Linux dependencies
92+
----------------------
93+
94+
Reasonably modern Linux Kernels (2.6.25 or newer) have an implementation
95+
of ``socketcan``. This version of python-can will directly use socketcan
96+
if called with Python 3.3 or greater, otherwise that interface is used
97+
via ctypes.
98+
99+
Windows dependencies
100+
--------------------
101+
102+
Kvaser
103+
~~~~~~
104+
105+
To install ``python-can`` using the Kvaser CANLib SDK as the backend:
106+
107+
1. Install the `latest stable release of
108+
Python <http://python.org/download/>`__.
109+
110+
2. Install `Kvaser's latest Windows CANLib
111+
drivers <http://www.kvaser.com/en/downloads.html>`__.
112+
113+
3. Test that Kvaser's own tools work to ensure the driver is properly
114+
installed and that the hardware is working.
115+
116+
PCAN
117+
~~~~
118+
119+
To use the PCAN-Basic API as the backend (which has only been tested
120+
with Python 2.7):
121+
122+
1. Download the latest version of the `PCAN-Basic
123+
API <http://www.peak-system.com/Downloads.76.0.html?>`__.
124+
125+
2. Extract ``PCANBasic.dll`` from the Win32 subfolder of the archive or
126+
the x64 subfolder depending on whether you have a 32-bit or 64-bit
127+
installation of Python.
128+
129+
3. Copy ``PCANBasic.dll`` into the working directory where you will be
130+
running your python script. There is probably a way to install the
131+
dll properly, but I'm not certain how to do that.
132+
133+
Note that PCANBasic API timestamps count seconds from system startup. To
134+
convert these to epoch times, the uptime library is used. If it is not
135+
available, the times are returned as number of seconds from system
136+
startup. To install the uptime library, run ``pip install uptime``.
137+
138+
IXXAT
139+
~~~~~
140+
141+
To install ``python-can`` using the IXXAT VCI V3 SDK as the backend:
142+
143+
1. Install the `latest stable release of
144+
Python <http://python.org/download/>`__.
145+
146+
2. Install `IXXAT's latest Windows VCI V3 SDK
147+
drivers <http://www.ixxat.com/support/file-and-documents-download/drivers/vci-v3-driver-download>`__.
148+
149+
3. Test that IXXAT's own tools (i.e. MiniMon) work to ensure the driver
150+
is properly installed and that the hardware is working.
151+
152+
Install python-can
153+
------------------
154+
155+
You may need to install
156+
`pip <http://www.pip-installer.org/en/latest/installing.html>`__ and
157+
`setuptools <https://pypi.python.org/pypi/setuptools>`__ first.
158+
159+
Two options, install normally with:
160+
161+
::
162+
163+
python setup.py install
164+
165+
Or to do a "development" install of this package to your machine (this
166+
allows you to make changes locally or pull updates from the Mercurial
167+
repository and use them without having to reinstall):
168+
169+
::
170+
171+
python setup.py develop
172+
173+
On linux you will need ``sudo`` rights.
174+
175+
Documentation and Help
176+
----------------------
177+
178+
- The Sphinx documentation for python-can can be viewed online at `python-can.readthedocs.org <https://python-can.readthedocs.org/en/latest/>`__
179+
- Questions can be found on `StackOverflow <https://stackoverflow.com/questions/tagged/can+python>`__ (tagged with python+can)
180+
- `Google groups mailing list <https://groups.google.com/forum/#!forum/python-can>`__

0 commit comments

Comments
 (0)