OpenXC Vehicle Interface Firmware
Version: | 8.2.1 |
---|---|
Web: | http://openxcplatform.com |
Documentation: | http://vi-firmware.openxcplatform.com |
Source: | http://github.com/openxc/vi-firmware |
Keywords: | vehicle, openxc, embedded |
The OpenXC vehicle interface (VI) firmware runs on a microcontroller connected to one or more CAN buses. It receives either all CAN messages or a filtered subset, performs any unit conversion or factoring required and outputs a generic version to a USB interface.
For more documentation, see the vehicle interface section on the OpenXC website or the vehicle interface documentation.
Installation
For the full build instructions, see the documentation.
Releasing
- Make sure you release the Python library first if there are any updates
- Update
script/bootstrap/ci-requirements.txt
to use released version at PyPI (i.e. the requirement should beopenxc==<latestversion>
) - Make sure you release the openxc-message-format library first if there are any updates
- Update the src/libs/openxc-message-format with
git submodule update --remote
- Checkout next branch and make edits.
- Bump the version using semantic versioning in
-
CHANGELOG.mkd
-README.rst
-src/config.cpp
-docs/index.rst
-docs/conf.py
- Checkout master, merge in next
- Run 'fab release', say yes to the tag and use the format
v0.9.1
- This will run the test suite, tag, and push to GitHub
- Checkout the next branch, and edit the same files to change the version to the
next development release (one patch release up with the
-dev
suffix, e.g.v0.9.2-dev
- Go to https://github.com/openxc/vi-firmware/releases and promote the tag you
just created to a new release - copy and paste the changelog into the
description.
- Attach the
openxc-vi-firmware-*.zip
from thereleases
directory to the release on GitHub
- Attach the
License
Copyright (c) 2012-2018 Ford Motor Company
Licensed under the BSD license.
This repository includes links to other source code repositories (as git submodules) that may be distributed under different licenses. See those individual repositories for more details.