@@ -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,
162162you can compile a build that generates random vehicle data and sends it via the
163163normal 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
169169The 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
0 commit comments