forked from openxc/vi-firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrelease-README
97 lines (80 loc) · 3.4 KB
/
release-README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
OpenXC Vehicle Interface Firmware
=================================
This archive contains pre-compiled builds of the open source OpenXC vehicle
interface firmware in a few common configurations for each supported platform.
For instructions on how to update your hardware device with one of these files,
check out the OpenXC website:
http://openxcplatform.com/vehicle-interface/firmware.html
## Emulator Build
The files with `emulator` in the name are compiled for each VI platform with
these Makefile options:
'DEBUG': False,
'BOOTLOADER': True,
'TRANSMITTER': False,
'DEFAULT_LOGGING_OUTPUT': "OFF",
'DEFAULT_METRICS_STATUS': False,
'DEFAULT_CAN_ACK_STATUS': False,
'DEFAULT_ALLOW_RAW_WRITE_NETWORK': False,
'DEFAULT_ALLOW_RAW_WRITE_UART': False,
'DEFAULT_ALLOW_RAW_WRITE_USB': True,
'DEFAULT_OUTPUT_FORMAT': "JSON",
'DEFAULT_RECURRING_OBD2_REQUESTS_STATUS': False,
'DEFAULT_POWER_MANAGEMENT': "ALWAYS_ON",
'DEFAULT_USB_PRODUCT_ID': 0x1,
'DEFAULT_EMULATED_DATA_STATUS': True,
'DEFAULT_OBD2_BUS': 1,
'NETWORK': False,
## Translated OBD2 Build
The files with `translated_obd2` in the name are compiled for each VI platform
with these Makeflie options:
'DEBUG': False,
'BOOTLOADER': True,
'TRANSMITTER': False,
'DEFAULT_LOGGING_OUTPUT': "OFF",
'DEFAULT_METRICS_STATUS': False,
'DEFAULT_CAN_ACK_STATUS': False,
'DEFAULT_ALLOW_RAW_WRITE_NETWORK': False,
'DEFAULT_ALLOW_RAW_WRITE_UART': False,
'DEFAULT_ALLOW_RAW_WRITE_USB': True,
'DEFAULT_OUTPUT_FORMAT': "JSON",
'DEFAULT_RECURRING_OBD2_REQUESTS_STATUS': True,
'DEFAULT_POWER_MANAGEMENT': "OBD2_IGNITION_CHECK",
'DEFAULT_USB_PRODUCT_ID': 0x1,
'DEFAULT_EMULATED_DATA_STATUS': False,
'DEFAULT_OBD2_BUS': 1,
'NETWORK': False,
This firmware will query the vehicle to see which of a subset of PIDs are
supported (the list:
https://github.com/openxc/vi-firmware/blob/master/src/obd2.cpp#L41) and set up
recurring requests for those that are, giving each a user-friendly name so they
are output as simple vehicle messages, e.g.:
{"name": "engine_speed", "value": 540}
## Default OBD2 Build
The files with `obd2` in the name are compiled for each VI platform with these
Makeflie options:
'DEBUG': False,
'BOOTLOADER': True,
'TRANSMITTER': False,
'DEFAULT_LOGGING_OUTPUT': "OFF",
'DEFAULT_METRICS_STATUS': False,
'DEFAULT_CAN_ACK_STATUS': False,
'DEFAULT_ALLOW_RAW_WRITE_NETWORK': False,
'DEFAULT_ALLOW_RAW_WRITE_UART': False,
'DEFAULT_ALLOW_RAW_WRITE_USB': True,
'DEFAULT_OUTPUT_FORMAT': "JSON",
'DEFAULT_RECURRING_OBD2_REQUESTS_STATUS': False,
'DEFAULT_POWER_MANAGEMENT': "OBD2_IGNITION_CHECK",
'DEFAULT_USB_PRODUCT_ID': 0x1,
'DEFAULT_EMULATED_DATA_STATUS': False,
'DEFAULT_OBD2_BUS': 1,
'NETWORK': False,
This firmware is ready to received OBD2 requests over USB or Bluetooth (see the
message format: https://github.com/openxc/openxc-message-format) but does *not*
have any pre-defined recurring requests. You probably want this build if you are
sending your own, custom diagnostic requests.
## License
These binaries do not contain any closed source components. They are compiled
soley from the open source OpenXC vehicle interface firmware
<http://vi-firmware.openxcplatform.com/> and contains code covered by a few
different open source licenses
<http://vi-firmware.openxcplatform.com/en/latest/license-disclosure.html>.