search

CANopenNode / CANopenLinux

CANopenNode on Linux devices
Apache License 2.0
117 stars 52 forks source link
canopen canopennode commander embedded gateway linux realtime

readme

CANopenLinux {#readmeCANopenLinux}

CANopenLinux is a CANopen stack running on Linux devices.

It is based on CANopenNode, which is free and open source CANopen Stack and is included as a git submodule.

CANopen is the internationally standardized (EN 50325-4) (CiA301) CAN-based higher-layer protocol for embedded control system. For more information on CANopen see http://www.can-cia.org/.

CANopenLinux homepage is https://github.com/CANopenNode/CANopenLinux

Getting or updating the project

Clone the project from git repository and get submodules:

git clone https://github.com/CANopenNode/CANopenLinux.git
cd CANopenLinux
git submodule init
git submodule update

Update the project:

cd CANopenLinux
git pull # or: git fetch; inspect the changes (gitk); git merge
git submodule update

Usage

Support for CAN interface is part of the Linux kernel, so called SocketCAN. CANopenNode runs on top of SocketCAN, so it should be able to run on any Linux machine, it depends on configuration of the kernel. Examples below was tested on Debian based machines, including Ubuntu and Raspberry PI. It is possible to run tests described below without real CAN interface, because Linux kernel already contains virtual CAN interface.

Windows or Mac users, who don't have Linux installed, can use VirtualBox and install Ubuntu or similar. To get confortable you may like to enroll Introduction to Linux.

CAN interfaces

Virtual CAN interface

It can connect multiple programs inside Linux machine. It can be activated by the following commands:

sudo modprobe vcan
sudo ip link add dev can0 type vcan
sudo ip link set up can0

USB, PCI or similar CAN interface

There are several CAN interfaces on the market which works with Linux SocketCAN. See Linux kernel source, Kconfig files, for supported interfaces by the Linux kernel. For example EMS CPC-USB or PCAN-USB FD. Usually such interface is started with:

sudo ip link set up can0 type can bitrate 250000

Serial slcan interface

Most cheap CAN interface, for example USBtin. It may not be fast enough and may lose messages. Usually it is started with (-s5=250kbps):

sudo slcand -f -o -c -s5 /dev/ttyACM0 can0
sudo ip link set up can0

CAN capes for Raspberry PI or similar

RPI may work wit some of the USB CAN interfaces or with CAN shield like this. CAN shield may not be fast enough and may lose messages.

CAN utilities

SocketCAN userspace utilities and tools contains several useful command line tools for CAN in Linux. Install with:

sudo apt-get install can-utils

In own terminal run candump to display all CAN messages with timestamp:

candump -td -a can0

Running CANopenLinux device

Compile:

cd CANopenLinux
make

Install (copy canopend application to the /usr/bin/ directory):

sudo make install

Display options:

canopend --help

Run on can0 device with CANopen NodeID = 4:

canopend can0 -i 4

If NodeID is not specified, then CANopen LSS protocol may be used. Program can be finished by pressing Ctrl+c or with CANopen reset node command.

After connecting the CANopen Linux device into the CAN(open) network, bootup message is visible. By default device uses Object Dictionary from CANopenNode/example, which contains only communication parameters. With the external CANopen tool all parameters can be accessed and CANopen Linux device can be configured (For example write heartbeat producer time in object 0x1017,0).

When CANopen Linux device is first connected to the CANopen network it shows bootup message and emergency message, because of missing storage files. To avoid emergency message it is necessary to trigger saveAll command (write correct code into parameter 0x1010,1 with SDO command) and restart the program.

Note also, if there are multiple instances of canopend running from the same directory, storage path should be specified for each.

CANopen ASCII command interface

CANopenNode includes CANopen ASCII command interface (gateway) specified by standard CiA309-3. It can be used as a commander for other CANopen devices: NMT master, LSS master, SDO client, etc. In CANopen Linux device command interface is available by default.

To use ASCII command interface on canopend directly just run it with -c "stdio" and type the commands followed by enter in it.

canopend can0 -i 1 -c "stdio"
help
1 write 0x1010 1 vs save
1 reset node

To create CANopen Linux commander device on local socket run:

canopend can0 -i 1 -c "local-/tmp/CO_command_socket"

cocomm

CANopenLinux/cocomm directory contains a small command line program, which establishes socket connection with canopend (CANopen Linux commander device). It sends standardized CANopen commands (CiA309-3) to gateway and prints the responses to stdout and stderr. See cocomm/README.md for usage.

Accessing ASCII command interface with Python

Here is an example of simplified Python program, which works similar as cocomm described above (canoped serves on local socket). Run the program and type 1 r 0x1018 0 u16 for example.

import socket, os

if os.path.exists("/tmp/CO_command_socket"):
    client = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
    client.connect("/tmp/CO_command_socket")
    while True:
        x = "[1] " + input("> ") + "\r\n"
        if "" != x:
            print("SEND:", x.encode("utf-8"))
            client.send(x.encode("utf-8"))
            print("RECEIVE:", client.recv(1024))
    client.close()
else:
    print("Couldn't Connect!")

Creating new project

canopend is a basic CANopen Linux device with optional commander functionalities. However, CANopen device is able to be much more, like (simple) input/output (digital or analog) device according to standard CiA401 or anything else as specified by other CANopen device profiles or own idea.

New project can be started in new directory simply by adding customized makefile, custom Object Dictionary OD.h/c files and custom application source files in Arduino style, which are called from CO_main_basic.c file.

Single or multi threaded application

By default canopend runs in single thread (CO_SINGLE_THREAD option in Makefile). Different events, such as can reception or timer expiration trigger looping through the stack (all code is non-blocking). It requires less system resources.

In multi threaded operation a real-time thread is established besides mainline thread. RT thread runs each millisecond and processes PDOs and optional application code with peripheral read/write, control program or similar. With this configuration race conditions must be taken into account, for example application code running from mainline thread must use CO_(UN)LOCK_OD macros when accessing OD variables.

See also CANopenDemo for examples.

Create new project with KDevelop

Change Log

License

This file is part of CANopenNode, an opensource CANopen Stack. Project home page is https://github.com/CANopenNode/CANopenNode. For more information on CANopen see http://www.can-cia.org/.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.