Refactor diagnostic fields for decoding payload.

[apps/low-level-can-service.git] / openxc.proto

diff --git a/openxc.proto b/openxc.proto
index 5413343..5b7e78b 100644 (file)
--- a/openxc.proto
+++ b/openxc.proto
@@ -4,62 +4,81 @@ option java_package = "com.openxc";
 option java_outer_classname = "BinaryMessages";
 
 message VehicleMessage {
-    enum Type { RAW = 1;
-        STRING = 2;
-        BOOL = 3;
-        NUM = 4;
-        EVENTED_NUM = 5;
-        EVENTED_STRING = 6;
-        EVENTED_BOOL = 7;
-    }
+    enum Type { RAW = 1; TRANSLATED = 2; DIAGNOSTIC = 3; CONTROL_COMMAND = 4;
+            COMMAND_RESPONSE = 5; }
 
     optional Type type = 1;
-
     optional RawMessage raw_message = 2;
-    optional StringMessage string_message = 3;
-    optional NumericMessage numeric_message = 4;
-    optional BooleanMessage boolean_message = 5;
-    optional EventedStringMessage evented_string_message = 6;
-    optional EventedBooleanMessage evented_boolean_message = 7;
-    optional EventedNumericMessage evented_numeric_message = 8;
+    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 bytes data = 3;
 }
 
-message StringMessage {
-    optional string name = 1;
-    optional string value = 2;
+message ControlCommand {
+    enum Type { VERSION = 1; DEVICE_ID = 2; DIAGNOSTIC = 3; }
+
+    optional Type type = 1;
+    optional DiagnosticRequest diagnostic_request = 2;
 }
 
-message NumericMessage {
-    optional string name = 1;
-    optional double value = 2;
+message CommandResponse {
+    optional ControlCommand.Type type = 1;
+    optional string message = 2;
 }
 
-message BooleanMessage {
-    optional string name = 1;
-    optional bool value = 2;
+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 EventedStringMessage {
-    optional string name = 1;
-    optional string value = 2;
-    optional string event = 3;
+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 EventedBooleanMessage {
-    optional string name = 1;
-    optional string value = 2;
-    optional bool event = 3;
+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 EventedNumericMessage {
-    optional string name = 1;
-    optional string value = 2;
-    optional double event = 3;
+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, having each specific