package openxc;
+option java_package = "com.openxc";
+option java_outer_classname = "BinaryMessages";
+
message VehicleMessage {
- enum Type { RAW = 1; STRING = 2; NUM = 3; BOOL = 4; }
+ enum Type { RAW = 1; TRANSLATED = 2; DIAGNOSTIC = 3; CONTROL_COMMAND = 4;
+ COMMAND_RESPONSE = 5; }
optional Type type = 1;
-
optional RawMessage raw_message = 2;
- optional TranslatedStringMessage string_message = 3;
- optional TranslatedNumericMessage numerical_message = 4;
- optional TranslatedBooleanMessage boolean_message = 5;
+ optional TranslatedMessage translated_message = 3;
+ optional DiagnosticResponse diagnostic_response = 4;
+ optional ControlCommand control_command = 5;
+ optional CommandResponse command_response = 6;
}
message RawMessage {
optional int32 bus = 1;
optional uint32 message_id = 2;
- optional sint64 data = 3;
+ optional bytes data = 3;
+}
+
+message ControlCommand {
+ enum Type {
+ VERSION = 1;
+ DEVICE_ID = 2;
+ DIAGNOSTIC = 3;
+ PASSTHROUGH = 4;
+ ACCEPTANCE_FILTER_BYPASS = 5;
+ }
+
+ optional Type type = 1;
+ optional DiagnosticControlCommand diagnostic_request = 2;
+ optional PassthroughModeControlCommand passthrough_mode_request = 3;
+ optional AcceptanceFilterBypassCommand acceptance_filter_bypass_command = 4;
+}
+
+message DiagnosticControlCommand {
+ enum Action { ADD = 1; CANCEL = 2; }
+
+ optional DiagnosticRequest request = 1;
+ optional Action action = 2;
+}
+
+message PassthroughModeControlCommand {
+ optional int32 bus = 1;
+ optional bool enabled = 2;
+}
+
+message AcceptanceFilterBypassCommand {
+ optional int32 bus = 1;
+ optional bool bypass = 2;
+}
+
+message CommandResponse {
+ optional ControlCommand.Type type = 1;
+ optional string message = 2;
+ optional bool status = 3;
+}
+
+message DiagnosticRequest {
+ enum DecodedType { NONE = 1; OBD2 = 2; }
+
+ optional int32 bus = 1;
+ optional uint32 message_id = 2;
+ optional uint32 mode = 3;
+ optional uint32 pid = 4;
+ // TODO we are capping this at 8 bytes for now - need to change when we
+ // support multi-frame responses
+ optional bytes payload = 5;
+ optional bool multiple_responses = 6;
+ optional double frequency = 7;
+ optional string name = 8;
+ optional DecodedType decoded_type = 9;
}
-message TranslatedStringMessage {
- optional string name = 1;
- optional string value = 2;
+message DiagnosticResponse {
+ optional int32 bus = 1;
+ optional uint32 message_id = 2;
+ optional uint32 mode = 3;
+ optional uint32 pid = 4;
+ optional bool success = 5;
+ optional uint32 negative_response_code = 6;
+ // TODO we are capping this at 8 bytes for now - need to change when we
+ // support multi-frame responses
+ optional bytes payload = 7;
+ optional double value = 8;
}
-message TranslatedNumericMessage {
- optional string name = 1;
- optional double value = 2;
+message DynamicField {
+ enum Type { STRING = 1; NUM = 2; BOOL = 3; }
+
+ optional Type type = 1;
+ optional string string_value = 2;
+ optional double numeric_value = 3;
+ optional bool boolean_value = 4;
}
-message TranslatedBooleanMessage {
- optional string name = 1;
- optional bool value = 2;
+message TranslatedMessage {
+ enum Type { STRING = 1; NUM = 2; BOOL = 3;
+ EVENTED_STRING = 4; EVENTED_NUM = 5; EVENTED_BOOL = 6;}
+
+ optional Type type = 1;
+ optional string name = 2;
+ optional DynamicField value = 3;
+ optional DynamicField event = 4;
}
-// TODO we should also consider having an enum type, h aving each specific
+// TODO we should also consider having an enum type, having each specific
// message defined as a protobuf