Skip to content

Commit f1d517f

Browse files
authored
Merge branch 'master' into master
2 parents 77b0754 + 70b8260 commit f1d517f

28 files changed

+187
-146
lines changed

.travis.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1+
#keep Ubuntu 12.04 on Travis to match Vagrant
2+
dist: precise
13
language: c
4+
dist: precise
25
compiler:
36
- clang
47
script: PLATFORM=TESTING make test
58
install:
69
- gem install coveralls-lcov
710
before_install:
811
- sudo apt-get update -qq
9-
- if [ `uname -m` = x86_64 ]; then sudo apt-get install -qq -y libgd2-xpm ia32-libs
12+
- if [ `uname -m` = x86_64 ]; then sudo apt-get install -qq -y libgd2-xpm ia32-libs libsubunit-dev
1013
ia32-libs-multiarch; fi
1114
- travis_wait script/bootstrap.sh
1215
- cd src

CHANGELOG.mkd

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenXC Vehicle Interface Firmware Changelog
22

3-
## v7.2.1-dev
3+
## v7.3.0
44

55
* BREAKING: Removed fine_odometer_since_restart from emulator.
66
* Feature: Added sending evented messages from emulator.
@@ -13,6 +13,15 @@
1313
and the command line. The response will mimic the request's bus, message ID, mode, and PID (if sent).
1414
The response will also include a randomly generated value between 0 and 100.
1515
Recurring diagnostic messages when running emulator firmware are currently not supported.
16+
* Update: Moved Vagrant VM to xenial64. Several updated packages.
17+
* Fix: Fixed a few bugs with C5 support from initial release:
18+
- BLE Broadcast name and MAC
19+
- CAN2 access
20+
- UART debug access
21+
- Updated flash instructions
22+
* Feature: Add PLATFORM command
23+
24+
1625

1726
## v7.2.0
1827

CONTRIBUTING.mkd

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ top of things.
88
## Reporting an Issue
99

1010
* Make sure you have a [GitHub account](https://github.com/signup/free)
11-
* Check if a ticket already exists for your issue on [GitHub](gh-issues).
12-
* If one does not already exist, [create a new ticket](gh-issues)
11+
* Check if a ticket already exists for your issue on [GitHub](https://github.com/openxc/vi-firmware/issues).
12+
* If one does not already exist, [create a new ticket](https://github.com/openxc/vi-firmware/issues/new)
1313
* Clearly describe the issue including steps to reproduce when it is a bug.
1414
* Make sure you include in the earliest version that you know has the issue.
1515

1616
## Making Changes
1717

18-
* If you haven't already, create a new issue on [GitHub](gh-issues) for your bug
18+
* If you haven't already, create a new issue on [GitHub](https://github.com/openxc/vi-firmware/issues/new) for your bug
1919
fix or new feature.
2020
* Fork the repository on GitHub
2121
* Create a topic branch from where you want to base your work.
@@ -30,7 +30,7 @@ top of things.
3030
* Make sure your commit messages are in the [proper format](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
3131
* Make sure you have added the necessary tests for your changes in the
3232
`openxc-it` sub-project
33-
* Run the [full test suite](https://github.com/openxc/vi-firmware/blob/master/README_developers.mkd) to assure nothing else was accidentally broken.
33+
* Run the [full test suite](http://vi-firmware.openxcplatform.com/en/master/testing.html#test-suite) to assure nothing else was accidentally broken.
3434

3535
## Submitting Changes
3636

@@ -42,6 +42,6 @@ top of things.
4242
# Additional Resources
4343

4444
* [General GitHub documentation](http://help.github.com/)
45-
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
45+
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
4646

4747
[gh-issues]: https://github.com/openxc/vi-firmware/issues

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ OpenXC Vehicle Interface Firmware
44

55
.. image:: /docs/_static/logo.png
66

7-
:Version: 7.2.1-dev
7+
:Version: 7.3.0
88
:Web: http://openxcplatform.com
99
:Documentation: http://vi-firmware.openxcplatform.com
1010
:Source: http://github.com/openxc/vi-firmware
@@ -82,7 +82,7 @@ Releasing
8282
License
8383
=======
8484

85-
Copyright (c) 2012-2014 Ford Motor Company
85+
Copyright (c) 2012-2018 Ford Motor Company
8686

8787
Licensed under the BSD license.
8888

Vagrantfile

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# -*- coding: utf-8 -*-
12
# -*- mode: ruby -*-
23
# vi: set ft=ruby :
34

@@ -9,10 +10,31 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
910
# vagrantup.com.
1011

1112
# Every Vagrant virtual environment requires a box to build off of.
12-
config.vm.box = "ubuntu/precise64"
13+
config.vm.box = "ubuntu/xenial64"
14+
15+
# Check for proxy enviroment variable and set it
16+
if ENV['HTTP_PROXY'] || ENV['HTTPS_PROXY']
17+
if Vagrant.has_plugin?("vagrant-proxyconf")
18+
if ENV['HTTP_PROXY']
19+
config.proxy.http = ENV['HTTP_PROXY']
20+
config.apt_proxy.http = ENV['HTTP_PROXY']
21+
end
22+
if ENV['HTTPS_PROXY']
23+
config.proxy.https = ENV['HTTPS_PROXY']
24+
config.apt_proxy.https = ENV['HTTP_PROXY']
25+
end
26+
if ENV['NO_PROXY']
27+
config.proxy.no_proxy = ENV['NO_PROXY']
28+
end
29+
else
30+
abort("ERROR, vagrant-proxyconf not installed run ‘vagrant plugin install vagrant-proxyconf’ to install it")
31+
end
32+
end
1333

34+
1435
config.vm.provision "shell", privileged: false, keep_color: true do |s|
1536
s.inline = "ln -fs /vagrant vi-firmware;"
1637
s.inline += "VAGRANT=1 vi-firmware/script/bootstrap.sh"
38+
1739
end
1840
end

docs/advanced/rtc.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ Real Time Clock
55

66
Real time Clock Configuration
77
------------------------------
8-
For correct time stamping it is necessary that the RTC is configured with the correct time.
8+
For correct time stamping it is necessary that the RTC is configured with the correct time.
99
A new rtc configuration command is added to the `OpenXC message format <https://github.com/openxc/openxc-message-format>`_.
1010

1111
Example JSON command
1212

1313
{ "command": "rtc_configuration", "unix_time": "1448551563"}
1414

15+
To set the RTC to the correct unix time on Windows Git Bash, Mac, or Linux shell, use the following command:
1516

17+
``% TIME=$(date +%s); openxc-control set --time $TIME``

docs/compile/example-builds.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,27 +48,27 @@ want to send diagnostic requests through a VI:
4848
4949
The Makefile will always print the configuration used so you can double check.
5050

51-
* This default configuration will run on a _`Ford reference VI
52-
<http://vi.openxcplatform.com/>` (``PLATFORM`` is ``FORDBOARD``) running the
51+
* This default configuration will run on a `Ford reference VI <http://vi.openxcplatform.com/>`_
52+
(``PLATFORM`` is ``FORDBOARD``) running the
5353
pre-loaded bootloader (``BOOTLOADER`` is ``1``).
5454
* Debug mode is off (``DEBUG`` is ``0``) so no log messages will be output via
5555
USB for maximum performance.
5656
* If the VI configuration :ref:`allows raw CAN writes <raw-write-config>`, they
5757
will only be permitted if set via USB (``DEFAULT_ALLOW_RAW_WRITE_USB`` is ``1``
5858
but the ``*_UART`` and ``*_NETWORK`` versions are ``0``.
5959
* The data sent from the VI will be serialized to JSON in the format defined by
60-
the _`OpenXC message format <https://github.com/openxc/openxc-message-format>`.
60+
the `OpenXC message format <https://github.com/openxc/openxc-message-format>`_.
6161
* The VI will go into sleep mode only when no CAN bus activity is detected for a
6262
few seconds (the ``DEFAULT_POWER_MANAGEMENT`` mode is ``SILENT_CAN``).
6363
* The CAN controllers will be initialized as listen only unless the VI
6464
configuration explicitly states they are writable (``DEFAULT_CAN_ACK_STATUS``
6565
is ``1``). This means that the VI may not work in a bench testing setup where
6666
nothing else on the bus is ACKing.
67-
* :ref:`Mass storage device <msd-storage>` (``MSD_ENABLE`` is ``0``) is disabled
68-
by default and is available on certain C5 devices which have a provision to connect
69-
a SD card. The time intervals at which the data is logged is
67+
* :ref:`Mass storage device <msd-storage>` (``MSD_ENABLE`` is ``0``) is disabled
68+
by default and is available on certain C5 devices which have a provision to connect
69+
a SD card. The time intervals at which the data is logged is
7070
(``DEFAULT_FILE_GENERATE_SECS`` is ``180``) set to 180 seconds by default.
71-
71+
7272
.. NOTE::
7373
There's a shortcut for this default build, using the Fabric tool and an
7474
included script. This will build the default build for the reference VI
@@ -117,7 +117,7 @@ options:
117117
- 0 = TEST_MODE_ONLY
118118
- 0 = DEBUG
119119
- 0 = MSD_ENABLE
120-
- 180 = DEFAULT_FILE_GENERATE_SECS
120+
- 180 = DEFAULT_FILE_GENERATE_SECS
121121
- 0 = DEFAULT_METRICS_STATUS
122122
- 1 = DEFAULT_ALLOW_RAW_WRITE_USB
123123
- 0 = DEFAULT_ALLOW_RAW_WRITE_UART
@@ -162,9 +162,9 @@ to a vehicle, but you don't care about the actual vehicle data being generated,
162162
you can compile a build that generates random vehicle data and sends it via the
163163
normal I/O interfaces.
164164

165-
If you are building an app, you'll want to use a _`trace file
166-
<http://openxcplatform.com/resources/traces.html>` or the _`vehicle simulator
167-
<https://github.com/openxc/openxc-vehicle-simulator>`.
165+
If you are building an app, you'll want to use a `trace file
166+
<http://openxcplatform.com/resources/traces.html>`_ or the `vehicle simulator
167+
<https://github.com/openxc/openxc-vehicle-simulator>`_.
168168

169169
The config a VI to emulate a vehicle:
170170

@@ -202,7 +202,7 @@ There are 2 changes from the default build:
202202
* ``DEFAULT_POWER_MANAGEMENT`` is ``ALWAYS_ON``, so the VI will not go to sleep
203203
while plugged in. Make sure to clear this configuration option before making a
204204
build to run in a vehicle, or you could drain the battery!
205-
205+
206206
.. NOTE::
207207
This build also has a shortcut using the Fabric script. Just add the keyword
208208
``emulator`` before ``build`` in your call to ``fab`` at the command line.
@@ -256,7 +256,7 @@ while this builds the default firmware, ready for OBD2 requests for the chipKIT:
256256
.. code-block:: sh
257257
258258
fab chipkit obd2 build
259-
259+
260260
You can specify the message format with ``json``, ``protobuf``, or ``messagepack``:
261261

262262
.. code-block:: sh

docs/compile/native-development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ installer - during the installation process, select these packages:
4949

5050
.. code-block:: sh
5151
52-
make, gcc-core, patchutils, unzip, python, check, curl, libsasl2, python-setuptools
52+
make, git, gcc-core, patchutils, unzip, python, check, curl, libsasl2, python-setuptools
5353
5454
After it's installed, open a new Cygwin terminal and configure it to ignore
5555
Windows-style line endings in scripts by running this command:

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@
4242

4343
# General information about the project.
4444
project = 'OpenXC Vehicle Interface Firmware'
45-
copyright = '2016, Ford Motor Company'
45+
copyright = '2018, Ford Motor Company'
4646

4747
# The version info for the project you're documenting, acts as replacement for
4848
# |version| and |release|, also used in various other places throughout the
4949
# built documents.
5050
#
5151
# The short X.Y version.
52-
version = '7.2.1-dev'
52+
version = '7.3.0'
5353
# The full version, including alpha/beta/rc tags.
54-
release = '7.2.1-dev'
54+
release = '7.3.0'
5555

5656
# The language for content autogenerated by Sphinx. Refer to documentation
5757
# for a list of supported languages.

docs/config/bit-numbering.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Bit Numbering and Byte Order
77
When dealing with binary data like CAN messages, there are two important details
88
- byte order and bit numbering.
99

10-
Byte order, or _`endianness <http://en.wikipedia.org/wiki/Endianness>`, determines
10+
Byte order, or `endianness <http://en.wikipedia.org/wiki/Endianness>`_, determines
1111
the convention used to interpret a sequence of bytes as a number. Given 4 bytes
1212
of data, e.g. ``0x01 02 03 04``, the endianness determines which byte is the
1313
"zero-th" byte and which is the last. There are only two options: big endian

0 commit comments

Comments
 (0)