openinverter-can-tool 0.0.3

Tool to configure and operate openinverter systems over CAN

openinverter CAN tool

A tool to allow configuration and operating of openinverter systems for electric vehicles over a CAN connection.

Features

• Display all available modifiable parameters and read-only values supported by a given inverter firmware version
• Read a specified parameter/value
• Write a new value to a specified parameter
• Display the current value of each parameter/value on a given device
• Save and load all parameters to and from a JSON file
• Runs on Linux, Windows and MacOS with python 3.7+
• Works with any CAN adapter supported by python-can
• Supports stm32-sine 5.24.R or later

Installation

The most recent release may be installed using pip:

    pip install openinverter_can_tool

To install directly from github:

    git clone https://github.com/davefiddes/openinverter_can_tool.git
    cd openinverter_can_tool
    pip install -e .

Linux

Linux users may reduce the potential of package conflicts by installing python dependencies from their package manager. This should be done before running pip.

Fedora

    sudo dnf install python3-setuptools python3-pip python3-click python3-can

Ubuntu/Debian

    sudo apt install python3-setuptools python3-pip python3-click python3-can

Configuration

Before the tool can be used the CAN interface adapter needs to be configured. To do this create ~/.canrc on Linux or %USERPROFILE%/can.conf on Windows. Details on interfaces supported and the configuration file format can be found in the python-can documentation.

An example configuration file for a SocketCAN compatible adapter on Linux would look like:

[default]
interface = socketcan
channel = can0
bitrate = 500000

Note: Before the tool can on Linux run the SocketCAN network interface needs to be started:

    sudo ip link set can0 up type can bitrate 500000

An example configuration file for a SLCAN adapter such as GVRET on Windows would look like:

[default]
interface = slcan
channel = COM8
bitrate = 500000

Tested interfaces:

• Innomaker USB2CAN CAN interface in Linux.

Let me know if you have used a particular CAN interface successfully and I can expand this list.

Usage

The parameters and values supported by a given openinverter firmware will often vary from release to release and by firmware type (e.g. Sine to Field Oriented Control(FOC)). The tool comes with a small collection of parameter databases for recent openinverter releases. These can be found in the parameter-databases directory in the install location.

To get the usage information for the tool run the oic command with no parameters:

    $ oic
    Usage: oic [OPTIONS] COMMAND [ARGS]...

      openinverter CAN Tool allows querying and setting configuration of inverter
      parameters over a CAN connection

    Options:
      -d, --database FILE  openinverter JSON parameter database to use
      -c, --context TEXT   Which python-can configuration context to use
      -n, --node INTEGER   The CAN SDO node ID to communicate with  [default: 1]
      --version            Show the version and exit.
      --help               Show this message and exit.

    Commands:
      dumpall     Dump the values of all available parameters and values
      listparams  List all available parameters and values
      load        Load all parameters from json IN_FILE
      read        Read the value of PARAM from the device
      save        Save all parameters in json to OUT_FILE
      write       Write the value to the parameter PARAM on the device

To read a specific parameter:

    $ oic -d parameter-databases/stm32-sine.5.24.R-foc.json read brakeregen
    brakeregen: -13 [%]

To write a new value to a parameter:

    oic -d parameter-databases/stm32-sine.5.24.R-foc.json write brakeregen -30.5

Development

If you want to be able to change the code while using it, clone it then install it in development mode:

    git clone https://github.com/davefiddes/openinverter_can_tool.git
    cd openinverter_can_tool
    pip install -e .[dev,test]

Unit tests and python code linting can be run on all supported python versions using the tox test framework.

Code is written to conform to PEP8 conventions and enforced by pylint and flake8 linting.